Servoy 2020 Documentation
Child pages
  • Component
Skip to end of metadata
Go to start of metadata

Refresh page Apr 14, 2024 00:48

Supported Clients
SmartClient WebClient NGClient

Methods Summary
Object getClientProperty(key) Gets the specified client property for the element based on a key.
Object getDesignProperties() Get the design-time properties of an element.
Object getDesignTimeProperty(key) Get a design-time property of an element.
String getElementType() Returns the type of a specified element.
String getFormName() Returns the name of the form.
String getName() Returns the name of an element.
void putClientProperty(key, value) Sets the value for the specified element client property key.

Methods Details

getClientProperty(key)

 
Gets the specified client property for the element based on a key.

NOTE: Depending on the operating system, a user interface property name may be available.

Parameters

Object key user interface key (depends on operating system)

Returns

Object The value of the property for specified key.

Supported Clients

SmartClient,WebClient,NGClient

Sample

var property = %%elementName%%.getClientProperty('ToolTipText');

getDesignProperties()

 
Get the design-time properties of an element.

Returns

Object

Supported Clients

SmartClient,WebClient,NGClient

Sample

var prop = forms.orders.elements.mylabel.getDesignProperties()

getDesignTimeProperty(key)

 
Get a design-time property of an element.

Parameters

String key the name of the property

Returns

Object

Supported Clients

SmartClient,WebClient,NGClient

Sample

var prop = forms.orders.elements.mylabel.getDesignTimeProperty('myprop')

getElementType()

 
Returns the type of a specified element.

Returns

String The display type of the element as String.

Supported Clients

SmartClient,WebClient,NGClient

Sample

var et = %%elementName%%.getElementType();

getFormName()

 
Returns the name of the form. (may be empty string as well)

Returns

String The name of the form.

Supported Clients

SmartClient,WebClient,NGClient

Sample

var name = %%elementName%%.getFormName();

getName()

 
Returns the name of an element. (may be null as well)

Returns

String The name of the element.

Supported Clients

SmartClient,WebClient,NGClient

Sample

var name = %%elementName%%.getName();

putClientProperty(key, value)

 
Sets the value for the specified element client property key.

NOTE: Depending on the operating system, a user interface property name may be available.

Parameters

Object key user interface key (depends on operating system)
Object value a predefined value for the key

Supported Clients

SmartClient,WebClient,NGClient

Sample

%%elementName%%.putClientProperty('ToolTipText','some text');

  • No labels