Related Data ListBox
The Control
Actions
When the Related Data ListBox Control is selected in the Central pane, the Actions section on the ribbon is updated to display the following items:
Convert To Changes the type of the selected control to another one maintaining all properties that are common to both Control Types (style, font, value, etc). Depending on the selected control type, different options are available. For example, the table container c
Move Down This action is applicable to controls that are immediate children of Container Controls. When pressed, it moves the selected control below its current position (shifting the below control above it).
Move Up This action is applicable to controls that are immediate children of Container Controls. When pressed, it moves the selected control above its current position (shifting the above control below it).
Events
Occurs before the item is saved.
Args: (form: pf.Form, args: pf.IItemEventArgs): any
Occurs when the control's value is being edited
Args: (form: pf.Form, args: pf.IItemEventArgs): any
Occurs when the control's value is being evaluated
Args: (form: pf.Form, args: pf.IEventArgs)
Occurs before each group item is displayed. You can create the actual content of each group item and return the value.
Args: (form: pf.Form, args: pf.IListBoxGroupItemEventArgs): any
Occurs before each item is displayed. You can create the actual content of each item and return the value.
Args: (form: pf.Form, args: pf.IItemEventArgs): any
Occurs when the cell is created
Args: (form: pf.Form, args: pf.IListBoxItemEventArgs): any
Occurs when the column filtering function is called.
Args: (form: pf.Form, args: pf.IListBoxColumnFilterArgs)
Occurs when the column filtering functionality is created.
Args: (form: pf.Form, args: pf.IListBoxCreateColumnFilterArgs)
Occurs when the item's editing has completed
Args: (form: pf.Form, args: pf.IItemEventArgs): any
Occurs when the control's value changes.
Args: (form: pf.Form, args: pf.IItemEventArgs)
Occurs when a MenuItem is double clicked.
Args: (form: pf.Form, args: pf.IItemEventArgs)
Occurs after OnFormInitializing (Includes are loaded, Control Events are handled)
Args: (form: pf.Form, args: pf.IEventArgs)
Occurs when a new row is added.
Args: (form: pf.Form, args: pf.IListBoxFormAddedEventArgs): any
Occurs when the selected item changes.
Args: (form: pf.Form, args: pf.IItemEventArgs)
Occurs after the Value of a control has changed.
Args: (form: pf.Form, args: pf.IValueChangedEventArgs)
This event is being called, each time the user changes the value.
Args: (form: pf.Form, args: pf.IValueChangedEventArgs)
Occurs before the Value of a control changes. You can cancel the change by setting args.Cancel to true.
Args: (form: pf.Form, args: pf.IValueChangingEventArgs)
Occurs after the value provider retrieved data for this control.
Args: (form: pf.Form, args: pf.IEventArgs)
Properties
Appearance
When selected, the filter button of each column is always shown. By default, the filter buttons appear when the user hovers over the column header.
The CSS Clear Property specifies what elements can float beside the cleared element and on which side.
Sets the color of the active row.
The float CSS property places an element on the left or right side of its container, allowing text and inline elements to wrap around it.
This font-style property allows you to make text appear italicized (i.e. sloped, or slanted)
Sets the foreground color of the control.
The text-align property specifies the horizontal alignment of the text displayed
Sets what will be displayed in a tooltip when the user hovers over the control.
Behavior
When this checkbox is selected, the previously expanded item collapses in order for the newly selected item to expand.
Gets or sets if the ValueChange event triggers the ValueChange event of the parent form.
Specifies whether this control should be disabled when form is offline.
Specifies whether this control should be hidden when form is offline.
Specifies whether this control is required when form is offline.
Specify whether to display a wait message or not when the control's values are loading.
Sets the item visible or not during initialization
Sets the message to be displayed while the control's values are loading.
Column Groups
Column Headers
Toggles the headers visibility to hidden/visible.
Data Binding
This is a free text field, where one can enter comments or other notes. Comments are only visible in the designer.
Gets or sets the code that returns the default value for this control.
The name which will hold the control's stored value
Allows you to change the value returned by the control (when GetValue() is called).
Allows you to change the value set to the actual control (when SetValue(value) is called).
Enabled State
Groups
Layout
Sets the maximum height.
Sets the maximum width.
Sets the minimum height.
Sets the minimum width.
Sets whether the control's text should be wrapped or not.
Miscellaneous
Specify the conditions under which the control will be enabled/disabled.
Specify the conditions under which the control will be visible/hidden