Use the GETPROPERTY command to capture the current properties of forms, form controls, applications, reports, report controls, labels, and label controls. There is also a GETPROPERTY function.
Options
APPLICATION ApplicationProperty
Specifies to capture an application property such as the CAPS Lock status, or the application title
TABLE_COLUMN ColumnProperty
Specifies to capture a table's column value
BLOB_EDITOR BlobEditorProperty
Specifies to capture a status of the BLOB Editor utility
Component ID
Specifies the unique identifier assigned to a control (e.g. DB Edit). The Component ID within the GETPROPERTY function must match the unique identifier listed in the control properties. The "Component ID" field is located in the Object Properties for all forms, reports, labels and controls. A "Component ID" option is also located in the speed menu list when you right click on a report/label control.
ControlProperty
The name of the form/report/label object's property you wish to get the value for
LOADWINDOW WindowProperty
Specifies to capture the load window property such as the caption or title. The LOADWINDOW parameter is only supported in R:Compiler
RBA_FORM ApplicationFormProperty
Specifies to capture an application form property such as the current theme, the enabled status for an action, or a caption
RBASE_FORM FormProperty
Specifies to capture a form property such as height, width, etc.
REPORT ReportProperty
Specifies to capture a report property such as the report name, the total page count, or the number of tables used in the report
VarName
The variable name with resulting value as text
Tips:
•The properties of any form control objects can be captured with assigned Component ID values ONLY.
•Always use the current QUOTES character around the variable name.
•The resulting variable value will be TEXT. To manipulate any values to INTEGER, use the INT, FLOAT, or other conversion function.
•To change any property of a form control after the form is displayed, use the PROPERTY command(s) within the "On After Start" EEP section of the Form Properties.
Notes:
•The complete list of GETPROPERTY command parameters are available within the FormProperties.pdf and FormProperties_TOC.pdf PDF documents, which are provided within the R:BASE program directory and are available for download at the R:BASE Technologies Support page: http://www.rbase.com/support/
•An optional syntax builder add-on product called R:Docs, containing all PROPERTY/GETPROPERTY commands and parameters constructed in an R:BASE application, is also available. Please contact the R:BASE Technologies Sales Staff at sales@rbase.com if you wish to acquire an annual subscription to the stand-alone R:Docs database and application.
Examples:
Example 01.
Gets the current color of any control. The resulting variable vColor will contain the current color name of that form control, such as: BLUE
GETPROPERTY ComponentID COLOR 'vColor'
Example 02.
Gets the current alignment of any control. The resulting variable vAlignment will contain the current alignment of that form control, such as: LEFT
GETPROPERTY ComponentID ALIGNMENT 'vAlignment'
Example 03.
Gets the current status of animated GIF control. The resulting variable vGIFAct will contain the current Animated option of Animated GIF Control property, such as: TRUE
GETPROPERTY ComponentID ANIMATE 'vGIFAct'
Example 04.
Gets the current caption value of any control. The resulting variable vCaption will contain the current text caption of that form control.
GETPROPERTY ComponentID CAPTION 'vCaption'
Example 05.
Gets the width of form. The resulting variable vWidth will contain the form width.
GETPROPERTY RBASE_FORM WIDTH 'vWidth'
Example 06.
Gets the height of form. The resulting variable vHeight will contain the form height.
GETPROPERTY RBASE_FORM HEIGHT 'vHeight'
Example 07.
Gets the left coordinates of form. The resulting variable vLeft will contain the form left coordinates.
GETPROPERTY RBASE_FORM LEFT 'vLeft'
Example 08.
Gets the right coordinates of form. The resulting variable vRight will contain the form right coordinates.
GETPROPERTY RBASE_FORM RIGHT 'vRight'
Example 09.
After capturing the Left and Top coordinates, use the INT Function to convert the TEXT value to an INTEGER value.
GETPROPERTY RBASE_FORM LEFT 'vLeft'
GETPROPERTY RBASE_FORM TOP 'vTop'
SET VAR vLeftPixel INTEGER = (INT(.vLeft))
SET VAR vTopPixel INTEGER = (INT(.vTop))
