CustomLinkListControlToField#

Qualified name: delphivcl.CustomLinkListControlToField

class CustomLinkListControlToField#

Bases: LinkControlToFieldDelegate

Represents the base class for linking a list control to a field. The TCustomLinkListControlToField class implements the functionality for linking a list control, such as TListBox, to a field.

Tip: If the direction is bidirectional, then the control must support the IEditLinkObserver interface.

Methods

`BindMethodsToEvents`	Connects methods to component events if they are named using the following pattern: Prefix_ComponentName_EventName.
`ClearExpressionProperties`	Embarcadero Technologies does not currently have any additional information.
`Create`	Creates an instance of the TContainedBindComponent class.
`Destroy`	Destroys an instance of the TContainedBindComponent class.
`FillList`	Embarcadero Technologies does not currently have any additional information.
`GenerateExpressions`	Automatically generates the bindings expressions for the quick binding component this delegate wraps onto.
`GetDelegates`	Gets the delegate (or contained) binding components that this wrapper binding component uses to execute expressions and respond to user input.
`GetParentComponent`	Returns the parent of a component.
`HasParent`	Indicates whether the component has a parent to handle its filing.

Attributes

`Active`	Embarcadero Technologies does not currently have any additional information.
`AutoActivate`	Embarcadero Technologies does not currently have any additional information.
`AutoBufferCount`	Embarcadero Technologies does not currently have any additional information.
`BindLink`	Embarcadero Technologies does not currently have any additional information.
`BindingsList`	Specifies a list that holds the binding expressions.
`BufferCount`	Embarcadero Technologies does not currently have any additional information.
`Category`	Specifies a category for this component.
`ClassName`	Returns the TObject.ClassName
`ComObject`	Specifies the interface reference implemented by the component.
`ComponentCount`	Returns the owned component count
`ComponentIndex`	Indicates the position of the component in its owner's Components property array.
`ComponentState`	Describes the current state of the component, indicating when a component needs to avoid certain actions.
`ComponentStyle`	Governs the behavior of the component.
`Components`	Returns an iterator over the owned components
`Control`	Embarcadero Technologies does not currently have any additional information.
`ControlComponent`	Specifies the component that will be bound to the source component, by means of LiveBindings.
`ControlMemberName`	Embarcadero Technologies does not currently have any additional information.
`CustomFormat`	Embarcadero Technologies does not currently have any additional information.
`CustomParse`	Embarcadero Technologies does not currently have any additional information.
`DataSource`	Specifies a TBaseLinkingBindSource object to which this delegate component links.
`DesignInfo`	Contains information used by the Form designer.
`Direction`	Embarcadero Technologies does not currently have any additional information.
`DisplayName`	Returns a string containing the name of this component.
`FieldName`	Embarcadero Technologies does not currently have any additional information.
`FillBreakCustomFormat`	Specifies a custom expression that is used with the field defined by the FillBreakFieldName property.
`FillBreakFieldName`	Specifies the field used to determine a break.
`FillBreakGroups`	Specifies a collection of break value ranges.
`FillExpressions`	Specifies additional optional expressions to use when filling the list control.
`FillHeaderCustomFormat`	Specifies a custom expression that is used with the field defined by the FillHeaderFieldName property.
`FillHeaderExpressions`	Specifies a collection of expressions to fill a list header.
`FillHeaderFieldName`	Specifies the field to display in the list header.
`Index`	Returns the index of this component in the bindings list.
`ListItemStyle`	Embarcadero Technologies does not currently have any additional information.
`Name`	Specifies the name of the component as referenced in code.
`Observers`	Indicates the TObservers object added to the TComponent.
`OnActivated`	<Delphi property OnActivated of type TBindComponentDelegate at 211412F1B30>
`OnActivating`	<Delphi property OnActivating of type TBindComponentDelegate at 211412F1A60>
`OnAssignedValue`	<Delphi property OnAssignedValue of type TBindComponentDelegate at 211412F18C0>
`OnAssigningValue`	<Delphi property OnAssigningValue of type TBindComponentDelegate at 211412F17F0>
`OnEvalError`	<Delphi property OnEvalError of type TBindComponentDelegate at 211412F1990>
`OnFilledList`	<Delphi property OnFilledList of type TCustomLinkListControlToField at 211414F98F0>
`OnFilledListItem`	<Delphi property OnFilledListItem of type TCustomLinkListControlToField at 211414F9750>
`OnFillingList`	<Delphi property OnFillingList of type TCustomLinkListControlToField at 211414F9820>
`OnFillingListItem`	<Delphi property OnFillingListItem of type TCustomLinkListControlToField at 211414F9680>
`Owner`	Returns the Component Owner
`Tag`	Stores a NativeInt integral value as a part of a component.
`UseEvalShortcuts`	Determines whether this binding component delegate uses evaluation shortcuts (True) or not (False).
`VCLComObject`	Represents information used internally by components that support COM.

Active#: Embarcadero Technologies does not currently have any additional information.

AutoActivate#: Embarcadero Technologies does not currently have any additional information.

AutoBufferCount#: Embarcadero Technologies does not currently have any additional information.

BindLink#: Embarcadero Technologies does not currently have any additional information.

BindMethodsToEvents(prefix)#: Connects methods to component events if they are named using the following pattern: Prefix_ComponentName_EventName. Example: def handle_button1_OnClick(Sender): pass The function returns a list of tuples. Each tuple contains the name of the component, the name of the event and the method object assigned to the event. Note that the prefix parameter is optional and will default to “handle_”.

BufferCount#: Embarcadero Technologies does not currently have any additional information.

ClearExpressionProperties()#: Embarcadero Technologies does not currently have any additional information.

ComponentCount#: Returns the owned component count

Components#: Returns an iterator over the owned components

Control#: Embarcadero Technologies does not currently have any additional information.

ControlMemberName#: Embarcadero Technologies does not currently have any additional information.

Create(AOwner: Component)#: Creates an instance of the TContainedBindComponent class. Data.Bind.Components.TCustomLinkListControlToField.Create inherits from Data.Bind.Components.TContainedBindComponent.Create. All content below this line refers to Data.Bind.Components.TContainedBindComponent.Create. Creates an instance of the TContainedBindComponent class.

CustomFormat#: Embarcadero Technologies does not currently have any additional information.

CustomParse#: Embarcadero Technologies does not currently have any additional information.

Destroy()#: Destroys an instance of the TContainedBindComponent class. Data.Bind.Components.TCustomLinkListControlToField.Destroy inherits from Data.Bind.Components.TContainedBindComponent.Destroy. All content below this line refers to Data.Bind.Components.TContainedBindComponent.Destroy. Destroys an instance of the TContainedBindComponent class.

Direction#: Embarcadero Technologies does not currently have any additional information.

FieldName#: Embarcadero Technologies does not currently have any additional information.

FillBreakCustomFormat#: Specifies a custom expression that is used with the field defined by the FillBreakFieldName property. For instance, the expression StrCopy(%s, 0, 1); causes a break when the first character of the field is different. This property is optional.

FillBreakFieldName#: Specifies the field used to determine a break. This property is optional.

FillBreakGroups#: Specifies a collection of break value ranges. The break value falls within an item in this collection. The display value associated with the item is displayed in the header. This property is optional.

FillExpressions#: Specifies additional optional expressions to use when filling the list control. Use this collection when multiple expressions are needed to fill an item in the list. For instance, you can use FillExpressions in order to populate a FireMonkey list box item Text and Detail properties. Use the FillDisplayCustomFormat and FillDisplayCustomFormat properties in order to fill the Text property and add an item to the FillExpressions collection, for the Detail property.

FillHeaderCustomFormat#: Specifies a custom expression that is used with the field defined by the FillHeaderFieldName property. For instance, the expression StrCopy(%s, 0, 1); displays the first character of the field in the header. This property is optional.

FillHeaderExpressions#: Specifies a collection of expressions to fill a list header. This property is optional.

FillHeaderFieldName#: Specifies the field to display in the list header. If FillBreakFieldName and FillBreakCustomFormat are blank, then the value determined using FillHeaderFieldName and FillBreakCustomFormat controls breaks. This is the only required field to cause breaking.

FillList()#: Embarcadero Technologies does not currently have any additional information.

GenerateExpressions(Sender: Component)#: Automatically generates the bindings expressions for the quick binding component this delegate wraps onto. Data.Bind.Components.TCustomLinkListControlToField.GenerateExpressions inherits from Data.Bind.Components.TBindComponentDelegate.GenerateExpressions. All content below this line refers to Data.Bind.Components.TBindComponentDelegate.GenerateExpressions. Automatically generates the bindings expressions for the quick binding component this delegate wraps onto. For more information regarding the quick binding components, please refer to the New LiveBinding topic, the Quick Binding Components Reference section.

GetDelegates()#: Gets the delegate (or contained) binding components that this wrapper binding component uses to execute expressions and respond to user input. Data.Bind.Components.TCustomLinkListControlToField.GetDelegates inherits from Data.Bind.Components.TBindComponentDelegate.GetDelegates. All content below this line refers to Data.Bind.Components.TBindComponentDelegate.GetDelegates. Gets the delegate (or contained) binding components that this wrapper binding component uses to execute expressions and respond to user input.

GetParentComponent()#: Returns the parent of a component.

HasParent()#: Indicates whether the component has a parent to handle its filing.

ListItemStyle#: Embarcadero Technologies does not currently have any additional information.

OnFilledList#: <Delphi property OnFilledList of type TCustomLinkListControlToField at 211414F98F0>

OnFilledListItem#: <Delphi property OnFilledListItem of type TCustomLinkListControlToField at 211414F9750>

OnFillingList#: <Delphi property OnFillingList of type TCustomLinkListControlToField at 211414F9820>

OnFillingListItem#: <Delphi property OnFillingListItem of type TCustomLinkListControlToField at 211414F9680>

Owner#: Returns the Component Owner

UseEvalShortcuts#: Determines whether this binding component delegate uses evaluation shortcuts (True) or not (False).