FormItem
The structure of all form items. All form items share a set of common properties that are listed here.
Example
form = cf.Form.New() -- Create a variety of form items checkbox = cf.FormCheckBox.New("Export electric near fields.") label = cf.FormLabel.New("Item 1") dirBrowser = cf.FormDirectoryBrowser.New("Output directory:") form:Add(checkbox) form:Add(label) form:Add(dirBrowser) -- All form items share the Enabled and Visible properties checkbox.Enabled = false label.Enabled = false dirBrowser.Visible = false form:Run()
Inheritance
The following objects are derived (specialisations) from the FormItem object:
Usage locations
The FormItem object can be accessed from the following locations:
- Methods
- FormScrollAreaItemCollection collection has method Items().
- FormScrollAreaItemCollection collection has method Item(number).
- FormScrollAreaItemCollection collection has method Item(string).
- FormLayoutItemCollection collection has method Items().
- FormLayoutItemCollection collection has method Item(number).
- FormLayoutItemCollection collection has method Item(string).
- FormGroupBoxItemCollection collection has method Items().
- FormGroupBoxItemCollection collection has method Item(number).
- FormGroupBoxItemCollection collection has method Item(string).
- FormItemCollection collection has method Items().
- FormItemCollection collection has method Item(number).
- FormItemCollection collection has method Item(string).
Property List
- Enabled
- Controls the item enabled state. Setting the enabled state of an item to false will also disable items or their contents. (Read/Write boolean)
- FixedHeight
- The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the height of the item. Setting the fixed height to zero or a negative value will restore the default/auto setting and the height will be dynamically determined. The fixed height takes precedence over the minimum height and thus the minimum height is ignored when a fixed height is set. (Read/Write number)
- FixedWidth
- The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the width of the item. Setting the fixed width to zero or a negative value will restore the default/auto setting and the width will be dynamically determined. The fixed width takes precedence over the minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write number)
- ItemHeight
- The height of the item in pixels. (Read only number)
- ItemWidth
- The width of the item in pixels. (Read only number)
- MinimumHeight
- The minimum height of the item in pixels. When the height is dynamically determined, it will not be less than the minimum height setting. The minimum height value will only be used when the FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or a negative value will restore the default/auto setting where no minimum height is enforced. (Read/Write number)
- MinimumWidth
- The minimum width of the item in pixels. When the width is dynamically determined, it will not be less than the minimum width setting. The minimum width value will only be used when the FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or a negative value will restore the default/auto setting where no minimum width is enforced. (Read/Write number)
- Visible
- Controls the item visibility. Setting the visibility of an item to false will also hide items or their contents. (Read/Write boolean)
Property Details
- Enabled
- Controls the item enabled state. Setting the enabled state of an item to false will also disable items or their contents.
- Type
- boolean
- Access
- Read/Write
- FixedHeight
- The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the height of the item. Setting the fixed height to zero or a negative value will restore the default/auto setting and the height will be dynamically determined. The fixed height takes precedence over the minimum height and thus the minimum height is ignored when a fixed height is set.
- Type
- number
- Access
- Read/Write
- FixedWidth
- The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the width of the item. Setting the fixed width to zero or a negative value will restore the default/auto setting and the width will be dynamically determined. The fixed width takes precedence over the minimum width and thus the minimum width is ignored when a fixed width is set.
- Type
- number
- Access
- Read/Write
- ItemHeight
- The height of the item in pixels.
- Type
- number
- Access
- Read only
- ItemWidth
- The width of the item in pixels.
- Type
- number
- Access
- Read only
- MinimumHeight
- The minimum height of the item in pixels. When the height is dynamically determined, it will not be less than the minimum height setting. The minimum height value will only be used when the FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or a negative value will restore the default/auto setting where no minimum height is enforced.
- Type
- number
- Access
- Read/Write
- MinimumWidth
- The minimum width of the item in pixels. When the width is dynamically determined, it will not be less than the minimum width setting. The minimum width value will only be used when the FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or a negative value will restore the default/auto setting where no minimum width is enforced.
- Type
- number
- Access
- Read/Write
- Visible
- Controls the item visibility. Setting the visibility of an item to false will also hide items or their contents.
- Type
- boolean
- Access
- Read/Write