FormDirectoryBrowser
A directory browser item. When working with multiple files, it is often simplest to specify only the directory where the files are located. When generating multiple files, it is also useful to specify where the files should be stored. The directory browser is then a tool for navigating through the operating system's directory structures to set an active directory of interest.
Example
form = cf.Form.New("Export data") dirBrowser = cf.FormDirectoryBrowser.New("Output directory:") form:Add(dirBrowser) -- Run the form and retrieve the selection form:Run() selectedPath = dirBrowser.Value
Inheritance
The FormDirectoryBrowser object is derived from the FormLabelledItem object.
Usage locations
The FormDirectoryBrowser object can be accessed from the following locations:
- Static functions
- FormDirectoryBrowser object has static function New(string).
- FormDirectoryBrowser object has static function New().
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)
- Value
- The directory path. (Read/Write string)
- Visible
- Controls the item visibility. Setting the visibility of an item to false will also hide items or their contents. (Read/Write boolean)
Method List
- ClearCallBack ()
- Clear the function that will be called when the check box state changes.
- LabelItem ()
- Returns the built-in label object associated with the form item. This allows access to the label like a normal form label. (Returns a FormLabel object.)
- SetCallBack (callback function)
- Set the function that will be called when the item's action has triggered.
Constructor Function List
- New (label string)
- Create a new directory browser item. (Returns a FormDirectoryBrowser object.)
- New ()
- Create a new directory browser item. (Returns a FormDirectoryBrowser 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
- Value
- The directory path.
- Type
- string
- 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
Method Details
- ClearCallBack ()
- Clear the function that will be called when the check box state changes.
- LabelItem ()
- Returns the built-in label object associated with the form item. This allows access to the label like a normal form label.
- Return
- FormLabel
- The form label item.
- SetCallBack (callback function)
- Set the function that will be called when the item's action has triggered.
- Input Parameters
- callback(function)
- The function call back.
Static Function Details
- New (label string)
- Create a new directory browser item.
- Input Parameters
- label(string)
- The item label.
- Return
- FormDirectoryBrowser
- The directory browser item created.
- New ()
- Create a new directory browser item.
- Return
- FormDirectoryBrowser
- The directory browser item created.