Equinox Online Help - Language Reference - A to Z

Home

Get

Applies to
SyntaxGet PropertyName, ObjectExpression, ResultItem
Action[Statement] Retrieves a property value from a form object.
ScopeOnly usable in form methods.
Notes

This statement retrieves the value of the specified property from a form object. eg You could find out what the foreground colour was set to. ObjectExpression specifies the object name of the object as a string. If supplied as a constant, it must be enclosed in quotation marks. If the object name is ambiguous, the property of the first name that matches is returned. Object names are assigned to objects in the Property dialog of the form editor.

The PropertyName argument specifies the property to be retrieved. The different object types and their properties are listed in the Properties section.

The value of the property is returned into ResultItem. This may be a variable, workarea, or field.

The system workarea SysError is set to a non-zero value if an error occurs, otherwise zero.

CategoryForms
See Also ChangeEditLine, ChangeGroup, ChangeObject, ChangePage, CurrentEventName, CurrentGroupName, CurrentObjectName, CurrentPageName, DefaultHelp, EnableGroup, EnablePage, IsPageScroll, NextObjectName, Set, SetDefaultHelp, SetEquinoxTitle, SetPageScroll, SetPageTitle, ShowPage
Example

This example retrieves the protection property of a Save button on a form.

number SaveButtonProtection

Get protection, "SaveButton", SaveButtonProtection