SysCommonAction¶

Qualified name: delphifmx.SysCommonAction

class SysCommonAction¶

Bases: CustomAction

A base class for standard actions that provides system functionality. TSysCommonAction extends the TCustomAction class redeclaring properties and events, used in system actions, with the published visibility. These are the following: CustomText, Enabled, HelpContext, HelpKeyword, HelpType, Hint, SecondaryShortCuts, ShortCut, Visible, UnsupportedArchitectures, OnCanActionExec, OnUpdate. The published scope of properties and events provides the possibility to use the Object Inspector for editing values of these properties and defining event handlers at design time. Standard actions descending from TSysCommonAction are the following:

TFileExit TWindowClose TFileHideApp TFileHideAppOthers.

Methods

`Execute`	Generates an OnExecute event.
`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.
`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
`CustomText`	CustomText is a user text.
`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.
`OnCanActionExec`	Callable[[CustomAction, bool], None]:
`OnHint`	Callable[[str, bool], None]:
`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.

CustomText¶

CustomText is a user text. Some actions can, by default, automatically set the Text property. For example, in the TFileExit standard action, the Text property has the Quit <Application.Title> value. To set your own value, set the value of the Text property to the value of the CustomText property.

Type:: str

Enabled¶

Specifies the enabled state for the action. The value of Enabled can be propagated to all client controls and client menu items linked to the action.

Type:: bool

Execute()¶: Generates an OnExecute event.

HelpContext¶

Keeps the integer context ID that identifies the Help topic for the action. HelpContext specifies the integer context ID to identify the Help topic to show when invoking Help for the action. The value of HelpContext can be propagated to all client controls and client menu items linked to the action. See also IsHelpLinked. HelpContext is only used when htContext is selected in the HelpType property.

Note: To use Help, you need to enable Help in your application. When your application supports usage of the appropriate Help system, then it can show Help topics from the associated Help file. When a client control has focus and the user presses the F1 key, the control uses the value of the HelpContext property to invoke the online Help that shows the topic with this context ID. The target topic is uniquely identified by a HelpContext context ID value.

Type:: int

HelpKeyword¶

Contains the keyword string that identifies the Help topic for the action. The value of HelpKeyword can be propagated to all client controls and client menu items linked to the action. HelpKeyword is only used when htKeyword is selected in the HelpType property.

Note: To use Help, you need to enable Help in your application. When your application supports usage of the appropriate Help system, then it can show Help topics from the associated Help file. When a client control has focus and the user presses the F1 key, the control uses the HelpKeyword property’s value to invoke the online Help showing the topic with this keyword.

Type:: str

HelpType¶

Keeps whether to use the HelpContext or HelpKeyword property to identify the Help topic. The value of HelpType can be propagated to all client controls and client menu items linked to the action. HelpType can keep one of the following constants:

htContext instructs to use the HelpContext property to identify the Help topic to show when invoking Help. htKeyword instructs to use the HelpKeyword property to identify the Help topic to show when invoking Help.

Type:: HelpType

Hint¶

Stores the Help hint text. Hint holds the hint string indicating the hint text for the action. Hint contains the text strings that appear in a pop-up box (or in a status bar) when the user moves the mouse over screen elements. This hint string can be propagated to clients of the action to controls, menu items, and other GUI elements.

Note: VCL controls support hint strings containing three parts that can be shown in separate locations (see Vcl.Controls.TControl.Hint).

Type:: str

ImageIndex¶

Stores an index in a list of images. ImageIndex is a zero-based index in a list of images. TContainedAction does not provide the actual list of images, only implementations of actions in GUI application frameworks provide such a property. In general, this list of images contains images that are associated with controls and menu items that use this action. The value of ImageIndex can be propagated to all client controls and client menu items linked to the action.

Note: When ImageIndex is -1, this means that the list does not contain any images. In typical implementations of controls, an image is drawn at the leftmost position in the control, and a control’s text is drawn to the right of the image. If ImageIndex is -1, then a control does not offset the text to the right to reserve a placeholder for the image. Otherwise, if ImageIndex is not -1, then the control’s text is always drawn with the offset to the right to reserve a place for drawing an image.

Type:: int

OnCanActionExec¶: Callable[[CustomAction, bool], None]:

OnHint¶: Callable[[str, bool], None]:

SecondaryShortCuts¶

Stores shortcuts (in addition to ShortCut) for triggering the action. Actions can execute in response to multiple shortcut key combinations. SecondaryShortCuts lists all the shortcut key combinations (other than the one specified by the ShortCut property) that can trigger the action. This lets you provide additional, secondary shortcuts. When the user types one of the key combinations listed in SecondaryShortCuts, the action’s Execute method is called.

Type:: CustomShortCutList

ShortCut¶

Shortcut that triggers the action. The value of Shortcut can be propagated to all client controls and client menu items linked to the action.

Type:: int

UnsupportedArchitectures¶

Defines the set of unsupported CPU architectures. The TArchitecture type defines the arIntelX86 and arIntelX64 constants that identify the processor architectures Intel x86 and Intel x64. Use UnsupportedArchitectures to identify sets of unsupported processor architectures.

Type:: Architectures

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

Visible¶

Stores whether the action representation is visible. Visible specifies the visible state for the action (True means visible, False means invisible). This Visible value is propagated to a client of the action if IsVisibleLinked method of the action link linking the client to the action returns True. If the Visible of an action is False and IsVisibleLinked of an action link returns True, then the Visible of the client (a control, menu item, or others) is also set False and this client is also invisible. Typically, IsVisibleLinked of an action link returns False if the action belongs to TCustomViewAction. Otherwise, when the action belongs to TAction, then IsVisibleLinked of an action link returns True. That is, TCustomViewAction is used when one need to provide visible representation of clients of actions that have Visible set True.

Type:: bool