Control_GetProperty Method
Description
This method returns the value of a control property.
Parameters
- MyControlReference
- Reference to the control in the form of MyProject_MyForm_MyControl.
- ProjectFile
- String identifying the project as it was passed in LoadProject.
- DialogName
- String identifying the dialog by name.
- ControlName
- String identifying the control by name.
- PropertyName
- String identifying the property by name.
Return Values
Returns the following according to the situation:
- The value of which the type depends on the property. May be a list just like any other type.
- Nil if the control is not found, the property does not exist or the property is read-only.
AutoLISP Syntax
The recommended convention is passing the control identifier directly:
 Copy Code |
|---|
(Odcl_Control_GetProperty MyControlReference [as Reference] PropertyName [as String]) |
An alternative convention is to identify the control by providing the project file, the dialog name and the control name:
| Copy Code |
|---|
(Odcl_Control_GetProperty ProjectFile [as String] DialogName [as String] ControlName [as String] PropertyName [as String]) |
Remarks
Does not apply to dialogs.
See the property of interest to know what string to pass.
Applies For
ActiveX, AngleSlider, Animation, BlockList, BlockView, CheckBox, ComboBox, DwgList, DwgPreview, Frame, GraphicButton, EditableGrid, Grid (Hatch), HtmlControl, ImageCombo, Label, ListBox, ListView, MonthPicker, Option, OptionList, PictureBox, ProgressBar, Rectangle, ScrollBar, SliderBar, SlideView, SpinButton, Splitter, TabControl, TextBox, TextButton, TreeControl, UrlLink.
Example
| Copy Code |
|---|
; Get the control enabled state (Setq rValue (Odcl_Control_GetProperty MyProject_MyForm_MyControl "Enabled")) |