Skip to main content

ObjectOptions

ObjectOptions

Summary

Method
GetProperty
SetProperty
Property
none

Methods

GetProperty

Returns the current value of a property.

void GetProperty(Name)
Parameters
NameThe name of the property to retrieve.
Return Value
Variant. Current value of the named property. Empty if no value has been set.

SetProperty

Sets the value of a property.

void SetProperty(Name, Value)
Parameters
NameThe name of the property to set.
ValueValue to assign to property.
Return Value
Boolean. True if the property exists and value is valid.

Properties

Values of any type may be assigned to any named property, however, only certain properties are recognized for each object type. Recognized properties are expected to have values of a particular type (or of a type that can be converted to the expected type).

Properties supported by ObjectButton

PropertyExpected TypeDescription
AlignIntegerA combination of values from the ButtonOptions enumeration specifying the alignment of text within the button rectangle.
GreyedBooleanTrue to create a disabled button (displayed greyed out).
HeightIntegerHeight to make button in pixels.
InvertBooleanTrue to display the button inverted (white text in a black rectangle).
WidthIntegerWidth to make button in pixels.

Properties supported by ObjectInputEcho

PropertyExpected TypeDescription
CharSetStringSingle-character string specifying character to use for echoing input, e.g. '*' if input is for a password or PIN.
SpacingIntegerOne of the spacing values from the InputEchoOptions enumeration.
UnderlineBooleanFalse to turn off display of underlines to indicate input echo character positions.

Properties supported by ObjectRadioButton

PropertyExpected TypeDescription
GroupStringName of group to which a radio button belongs. Required.
CheckedBooleanTrue if the radio button is initially selected.

If multiple radio buttons in a group are created with Checked=true, the last one added will be the one selected.