LabelTemplate Property

Summary

Gets or sets the template used when creating labels for this AnnAutomationObject

Syntax

Java

Objective-C

WinRT C#

C++

public virtual string LabelTemplate { get; set; }

Public Overridable Property LabelTemplate As String

public virtual string LabelTemplate {get; set;}

@property (nonatomic,copy) NSString* labelTemplate;

public String getLabelTemplate() 
public void setLabelTemplate(String value)

 <br/>get_LabelTemplate();<br/>set_LabelTemplate(value);<br/>Object.defineProperty('LabelTemplate');

public:  
   virtual property String^ LabelTemplate 
   { 
      String^ get() 
      void set(String^ value) 
   }

Property Value

The template used when creating labels for this AnnAutomationObject. The default value is null (no label is created).

Remarks

When the automation object creates new object from this template. It can use the values of NextNumber and LabelTemplate to automatically create a label and set its value for the new object.

If the value of LabelTemplate is null (The default value), then the automation object will not try to create a new label as follows:

If the value of LabelTemplate is null, then new label is created.
Else, the automation will check if the object has a label in its AnnObject.Labels collection with the name "AnnObjectName". This label is created by default by LEADTOOLS whenever a new AnnObject is created. The automation will then set the value of the label to LabelTemplate. If the template contain the string "##", it will be replaced by the value of NextNumber (Default of 1) and NextNumber is then incremented by 1.