CustomLinkPropertyToField#

Qualified name: delphivcl.CustomLinkPropertyToField

class CustomLinkPropertyToField#

Bases: LinkPropertyToFieldDelegate

Represents the base class for linking a property of a component to a field. The TCustomLinkPropertyToField class implements the functionality for linking a property of a component to a field.

Tip: The user input to this component is not monitored using an observer.

Methods

BindMethodsToEvents

Connects methods to component events if they are named using the following pattern: Prefix_ComponentName_EventName.

CanActivate

Lets the wrapper binding component indicate whether a delegate (or contained) binding component may be activated.

ClearGeneratedExpressions

Clears all the generated bindings expressions, at once, for the quick binding component this delegate wraps onto.

Create

Creates an instance of the TContainedBindComponent class.

Destroy

Destroys an instance of the TContainedBindComponent class.

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.

Loaded

Initializes the component after the form file has been read into memory.

RequiresControlHandler

Used internally for observing purposes.

Attributes

Active

Embarcadero Technologies does not currently have any additional information.

AutoActivate

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.

Category

Specifies a category for this component.

ClassName

Returns the TObject.ClassName

ComObject

Specifies the interface reference implemented by the component.

Component

Specifies the component that this wrapping binding component references.

ComponentCount

Returns the owned component count

ComponentIndex

Indicates the position of the component in its owner's Components property array.

ComponentProperty

Specifies the name of the property of the component that this wrapping binding component references.

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

ControlComponent

Specifies the component that will be bound to the source component, by means of LiveBindings.

CustomFormat

Embarcadero Technologies does not currently have any additional information.

DataSource

Specifies a TDataSource object to which this delegate component links.

DesignInfo

Contains information used by the Form designer.

DisplayName

Returns a string containing the name of this component.

FieldName

Specifies the field name that this wrapping binding component references.

Index

Returns the index of this component in the bindings list.

LookupDataSource

Embarcadero Technologies does not currently have any additional information.

LookupKeyFieldName

Embarcadero Technologies does not currently have any additional information.

LookupValueFieldName

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>

Owner

Returns the Component Owner

Tag

Stores a NativeInt integral value as a part of a component.

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.

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_”.

CanActivate(Sender: Component) Boolean#

Lets the wrapper binding component indicate whether a delegate (or contained) binding component may be activated. Data.Bind.Components.TCustomLinkPropertyToField.CanActivate inherits from Data.Bind.Components.TBindComponentDelegate.CanActivate. All content below this line refers to Data.Bind.Components.TBindComponentDelegate.CanActivate. Lets the wrapper binding component indicate whether a delegate (or contained) binding component may be activated. The CanActivate method returns True if the delegate (or contained) binding component can be activated, False otherwise.

ClearGeneratedExpressions(Sender: Component)#

Clears all the generated bindings expressions, at once, for the quick binding component this delegate wraps onto. Data.Bind.Components.TCustomLinkPropertyToField.ClearGeneratedExpressions inherits from Data.Bind.Components.TBindComponentDelegate.ClearGeneratedExpressions. All content below this line refers to Data.Bind.Components.TBindComponentDelegate.ClearGeneratedExpressions. Clears all the generated bindings expressions, at once, 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.

ComponentCount#

Returns the owned component count

Components#

Returns an iterator over the owned components

Create(AOwner: Component)#

Creates an instance of the TContainedBindComponent class. Data.Bind.Components.TCustomLinkPropertyToField.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.

Destroy()#

Destroys an instance of the TContainedBindComponent class. Data.Bind.Components.TCustomLinkPropertyToField.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.

GenerateExpressions(Sender: Component)#

Automatically generates the bindings expressions for the quick binding component this delegate wraps onto. Data.Bind.Components.TCustomLinkPropertyToField.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.TCustomLinkPropertyToField.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.

Loaded()#

Initializes the component after the form file has been read into memory. Data.Bind.Components.TCustomLinkPropertyToField.Loaded inherits from System.Classes.TComponent.Loaded. All content below this line refers to System.Classes.TComponent.Loaded. Initializes the component after the form file has been read into memory. Do not call the protected Loaded method. The streaming system calls this method after it loads the component’s form from a stream. When the streaming system loads a form or data module from its form file, it first constructs the form component by calling its constructor, then reads its property values from the form file. After reading all the property values for all the components, the streaming system calls the Loaded methods of each component in the order the components were created. This gives the components a chance to initialize any data that depends on the values of other components or other parts of itself.

Note: All references to sibling components are resolved by the time Loaded is called. Loaded is the first place that sibling pointers can be used after being streamed in. As implemented in TComponent, Loaded clears the csLoading flag in the ComponentState property, indicating that the component is no longer loading.

Warning: Loaded may be called multiple times on inherited forms. It is called every time a level of inheritance is streamed in. Do not allocate memory in an overridden Loaded method without first checking that the memory has not been allocated in a previous call.

LookupDataSource#

Embarcadero Technologies does not currently have any additional information.

LookupKeyFieldName#

Embarcadero Technologies does not currently have any additional information.

LookupValueFieldName#

Embarcadero Technologies does not currently have any additional information.

Owner#

Returns the Component Owner

RequiresControlHandler()#

Used internally for observing purposes. Data.Bind.Components.TCustomLinkPropertyToField.RequiresControlHandler inherits from Data.Bind.Components.TBindComponentDelegate.RequiresControlHandler. All content below this line refers to Data.Bind.Components.TBindComponentDelegate.RequiresControlHandler. Used internally for observing purposes.