FormSeparator
A Separator item. Separators are used to visually group (or separate) items on a form. Both horizontal and vertical separators are available.
Example
form = cf.Form.New() checkbox1 = cf.FormCheckBox.New("Check box 1.") checkbox2 = cf.FormCheckBox.New("Check box 2.") checkbox3 = cf.FormCheckBox.New("Check box 3.") checkbox4 = cf.FormCheckBox.New("Check box 4.") checkbox5 = cf.FormCheckBox.New("Check box 5.") -- Create separators initialised to horizontal horizontalSeparator1 = cf.FormSeparator.New(cf.Enums.FormSeparatorEnum.Horizontal) horizontalSeparator2 = cf.FormSeparator.New(cf.Enums.FormSeparatorEnum.Horizontal) -- Add items to form layout form:Add(checkbox1) form:Add(horizontalSeparator1) form:Add(checkbox2) form:Add(checkbox3) form:Add(horizontalSeparator2) form:Add(checkbox4) form:Add(checkbox5) form:Run()
Inheritance
The FormSeparator object is derived from the FormItem object.
Usage locations
The FormSeparator object can be accessed from the following locations:
- Static functions
- FormSeparator object has static function New(FormSeparatorEnum).
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)
- Type
- The object type string. (Read only string)
- Visible
- Controls the item visibility. Setting the visibility of an item to false will also hide items or their contents. (Read/Write boolean)
Constructor Function List
- New (orientation FormSeparatorEnum)
- Create a new separator item. (Returns a FormSeparator object.)
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
- Type
- The object type string.
- Type
- string
- Access
- Read only
- 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
Static Function Details
- New (orientation FormSeparatorEnum)
- Create a new separator item.
- Input Parameters
- orientation(FormSeparatorEnum)
- The separator orientation which is either Horizontal or Vertical.
- Return
- FormSeparator
- The newly created Separator item.