`FormLabelledItem`

Allows access to built-in label objects associated with the derived form item.

Example

app = pf.GetApplication()
project = app:NewProject()

form = pf.Form.New()

    -- Create a form item that are derived from 'FormLabelItem'
    
formFileSaveAsBrowser = pf.FormFileSaveAsBrowser.New("File name")

    -- Add item to the form

form:Add(formFileSaveAsBrowser)

    -- Obtain the 'FormLabelledItem'

formLabelledItem = formFileSaveAsBrowser:LabelItem()

    -- Set the label invisible

formLabelledItem.Visible = false

form:Run()

Inheritance

The FormLabelledItem object is derived from the FormItem object.

The following objects are derived (specialisations) from the FormLabelledItem object:

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)

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.

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

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.