BasicAction¶
Qualified name: delphivcl.BasicAction
- class BasicAction¶
Bases:
ComponentTBasicAction is the ancestor class for all action objects. TBasicAction introduces the fundamental behavior for an action. Descendants of TBasicAction add functionality for containment in an action list, for being categorized, and for specializing their behavior tailored to particular clients such as controls or menu items. Use TBasicAction if you want to create an action for an object that is neither a menu item nor a control.
Methods
TBasicAction.Execute() Generates an OnExecute event.
TBasicAction.ExecuteTarget(Target: Object) -> None Introduces an interface for invoking an action on a target client component or control.
TBasicAction.HandlesTarget(Target: Object) -> bool Introduces an interface for verifying that the type and state of a target component or control are appropriate for the action.
Embarcadero Technologies does not currently have any additional information.
TBasicAction.Update() Provides an opportunity to execute centralized code when an application is idle.
TBasicAction.UpdateTarget(Target: Object) -> None Introduces an interface for a method of notifying a client when the action updates itself.
Attributes
Indicates the client component that caused this action to execute.
ClassNameReturns the TObject.ClassName
ComObjectSpecifies the interface reference implemented by the component.
ComponentCountReturns the owned component count
ComponentIndexIndicates the position of the component in its owner's Components property array.
ComponentStateDescribes the current state of the component, indicating when a component needs to avoid certain actions.
ComponentStyleGoverns the behavior of the component.
ComponentsReturns an iterator over the owned components
DesignInfoContains information used by the Form designer.
NameSpecifies the name of the component as referenced in code.
ObserversIndicates the TObservers object added to the TComponent.
OwnerReturns the Component Owner
TagStores a NativeInt integral value as a part of a component.
VCLComObjectRepresents information used internally by components that support COM.
- ActionComponent¶
Indicates the client component that caused this action to execute.
- Execute()¶
Generates an OnExecute event.
- ExecuteTarget(Target: Object) None¶
Introduces an interface for invoking an action on a target client component or control. ExecuteTarget does nothing in TBasicAction. ExecuteTarget was introduced in TBasicAction so that descendants can override it to initiate the action on the target. For example, an edit action that performs copying might copy the contents of an edit control to the clipboard.
- HandlesTarget(Target: Object) bool¶
Introduces an interface for verifying that the type and state of a target component or control are appropriate for the action. HandlesTarget does nothing in TBasicAction. HandlesTarget was introduced in TBasicAction so that descendants can override it to check the type and state of a target. HandlesTarget can verify any information about a target that is relevant for the action. HandlesTarget returns True if the target meets the specified criteria, False otherwise.
- Suspended()¶
Embarcadero Technologies does not currently have any additional information.
- Update()¶
Provides an opportunity to execute centralized code when an application is idle.
- UpdateTarget(Target: Object) None¶
Introduces an interface for a method of notifying a client when the action updates itself. UpdateTarget does nothing in TBasicAction. UpdateTarget was introduced in TBasicAction so that descendants can override it to correspondingly update a target when the action updates.