DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Enter additional information related to this 'class' inside the {div} macro with 'id=description'



Property Summary
String
dataProvider
The dataprovider of the component.
Boolean
displaysTags
Flag that enables or disables merging of data inside components using tags (placeholders).
Boolean
enabled
The enable state of the component, default true.
String
format
The format that should be applied when displaying data(using dataProviderID) in the label/button.
Number
labelSize
Label (header) size property.
String
location
The x and y position of the component, in pixels, separated by a comma.
String
name
The name of the component.
String
text
The text that is displayed inside the component.
String
titleDataProvider
Dataprovider for header text to field component
Boolean
titleDisplaysTags
Flag for header text to field component that enables or disables merging of data inside components using tags (placeholders).
String
titleText
Header text to component
Boolean
titleVisible
Boolean
visible
The visible property of the component, default true.



Property Details

dataProvider

The dataprovider of the component.

Returns

String
 

displaysTags

Flag that enables or disables merging of data inside components using tags (placeholders).
Tags (or placeholders) are words surrounded by %%on each side. There are data tags and
standard tags. Data tags consist in names of dataproviders surrounded by%%. Standard tags
are a set of predefined tags that are made available by the system.

See the "Merging data" section for more details about tags.

The default value of this flag is "false", that is merging of data is disabled by default.

Returns

Boolean
 

enabled

The enable state of the component, default true.

Returns

Boolean - enabled state
 

format

The format that should be applied when displaying data(using dataProviderID) in the label/button.
Some examples are "#%", "dd-MM-yyyy", "MM-dd-yyyy", etc.

Returns

String
 

labelSize

Label (header) size property.
Sets the header size on a label. Valid values are between 'h1' to 'h6',
default value is 'h4'.
The numbers match the heading tags h1 to h6 as used in html.

Returns

Number
 

location

The x and y position of the component, in pixels, separated by a comma.

Returns

String
 

name

The name of the component. Through this name it can also accessed in methods.

Returns

String
 

text

The text that is displayed inside the component.

Returns

String
 

titleDataProvider

Dataprovider for header text to field component

Returns

String
 

titleDisplaysTags

Flag for header text to field component that enables or disables merging of data inside components using tags (placeholders).
Tags (or placeholders) are words surrounded by %%on each side. There are data tags and
standard tags. Data tags consist in names of dataproviders surrounded by%%. Standard tags
are a set of predefined tags that are made available by the system.

See the "Merging data" section for more details about tags.

The default value of this flag is "false", that is merging of data is disabled by default.

Returns

Boolean
 

titleText

Header text to component

Returns

String
 

titleVisible

Returns

Boolean
 

visible

The visible property of the component, default true.

Returns

Boolean - visible property