CustomViewAction¶

Qualified name: delphifmx.CustomViewAction

class CustomViewAction¶

Bases: CustomAction

A base class for actions that show a specified component when executed. Descendants of TCustomViewAction can be associated with a component that is made visible when the action executes. TCustomViewAction extends TCustomAction declaring the component that the action shows when it executes. TObjectViewAction extends the TCustomViewAction class that defines the FmxObject property and keeps the component value that should be the TFmxObject type object in this case. Descendants of TObjectViewAction are associated with the TFmxObject type component that is made visible when the action executes. TVirtualKeyboard and TViewAction are standard actions that descend from TObjectViewAction. Contrary to ordinary actions (like TAction, TControlAction, TCustomValueRangeAction, and so on) TCustomViewAction (and its descendants) does not distribute changes in values of Caption, Enabled, Checked, GroupIndex, ShortCut, Visible, and OnExecute properties to the respective properties of clients linked with action links.

Methods

`Execute`	Generates an OnExecute event.
`HandlesTarget`	Introduces an interface for verifying that the type and state of a target component or control are appropriate for the action.
`Update`	Provides an opportunity to execute centralized code when an application is idle.

Attributes

`ActionComponent`	Indicates the client component that caused this action to execute.
`ActionList`	Holds the action list to which the action belongs.
`AutoCheck`	Controls whether the Checked property toggles when the action executes.
`Caption`	Represents the caption of the action.
`Category`	Group or category where the action belongs.
`Checked`	Indicates whether client controls and menu items appear checked.
`ClassName`	Returns the TObject.ClassName
`ComObject`	Specifies the interface reference implemented by the component.
`Component`	Keeps a component that executes an action and whose image becomes visible during the action execution.
`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
`DesignInfo`	Contains information used by the Form designer.
`DisableIfNoHandler`	Indicates whether the action's clients should be disabled if no OnExecute event handler is found.
`Enabled`	Specifies the enabled state for the action.
`GroupIndex`	Indicates a group of actions in one action list.
`HelpContext`	Keeps the integer context ID that identifies the Help topic for the action.
`HelpKeyword`	Contains the keyword string that identifies the Help topic for the action.
`HelpType`	Keeps whether to use the HelpContext or HelpKeyword property to identify the Help topic.
`HideIfUnsupportedInterface`	Defines whether the UnSupported action can be visible and accessible.
`Hint`	Stores the Help hint text.
`ImageIndex`	Stores an index in a list of images.
`Index`	Specifies the index of the action in its action list.
`Name`	Specifies the name of the component as referenced in code.
`Observers`	Indicates the TObservers object added to the TComponent.
`Owner`	Returns the Component Owner
`SecondaryShortCuts`	Stores shortcuts (in addition to ShortCut) for triggering the action.
`ShortCut`	Shortcut that triggers the action.
`ShortCutPressed`	Specifies that the action is fired by pressing a keyboard key, not by clicking with the mouse.
`StatusAction`	Stores the status for an input field in an action.
`Supported`	Defines whether the action can work on the current platform and CPU architecture.
`Tag`	Stores a NativeInt integral value as a part of a component.
`Target`	Defines the component for which the action is executed.
`Text`	Represents the caption of the action.
`UnsupportedArchitectures`	Defines the set of unsupported CPU architectures.
`UnsupportedPlatforms`	Defines the set of unsupported OS platforms.
`VCLComObject`	Represents information used internally by components that support COM.
`Visible`	Stores whether the action representation is visible.

ActionComponent¶: Indicates the client component that caused this action to execute.

Component¶

Keeps a component that executes an action and whose image becomes visible during the action execution.

Type:: Component

Execute()¶: Generates an OnExecute event.

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. FMX.ActnList.TCustomViewAction.HandlesTarget inherits from System.Classes.TBasicAction.HandlesTarget. All content below this line refers to System.Classes.TBasicAction.HandlesTarget. 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.

Update()¶: Provides an opportunity to execute centralized code when an application is idle.