Sign in Join
FPDoc Onlineexperiment

TAction class

In unit ActnList

TAction is the basic action object used in the LCL.

Declaration

pascal
TAction = class(TCustomAction)

Inheritance

  1. TAction
  2. TCustomAction
  3. TContainedAction
  4. TBasicAction
  5. TComponent
  6. TPersistent
  7. TObject

Descends from it: TDataSetAction TEditAction THelpAction

Description

TAction is the basic action object used in the LCL. It redeclares many properties inherited from TCustomAction on the public section, but does not add any new features. For more details look at the See Also section for TCustomAction.

The properties of each Action can be modified at design time in the Object Inspector.

See also

Properties

AutoCheckpublishedAutoCheck - whether the control (e.g. a CheckBox) is to be automatically checked.
CaptionpublishedThe Caption to be used if this action is associated with a visible component.
CheckedpublishedWhether the check box control associated with the action is Checked (default False).
DisableIfNoHandlerpublishedPrevents the action from executing if an OnExecute handler is not assigned in the action.
EnabledpublishedEnabled - whether this action is able to be used (default is True).
GroupIndexpublishedGroupIndex- Index of the action within its group.
HelpContextpublishedHelpContext - the index for a context-based help message.
HelpKeywordpublishedHelpKeyWord - the keyword of a context-based help message.
HelpTypepublishedHelpType - the sort of help message to be offered: default Context-based.
HintpublishedHint - a pop-up message that appears when the mouse hovers over an object.
ImageIndexpublishedImageIndex - the index number of the image to be associated with this action.
SecondaryShortCutspublishedSecondaryShortCuts - a stringlist containing shortcuts.
ShortCutpublishedShortCut- an index to a shortcut list.
VisiblepublishedVisible - is this action visible? (default True).

Methods

CreatepublicConstructor for the class instance.

Events

OnExecutepublishedEvent called when action is executed.
OnHintpublishedOnHint - action to be taken when a hint is required.
OnUpdatepublishedEvent handler signalled to update an action when the application is idle.

Inherited

From TCustomAction (20)

AssignTo Destroy DoHint Execute Grayed HandleShortCut SavedEnabledState SetAutoCheck SetCaption SetChecked SetEnabled SetGroupIndex SetHelpContext SetHelpKeyword SetHelpType SetHint SetImageIndex SetName SetShortCut SetVisible

From TContainedAction (8)

ActionList Category GetParentComponent HasParent Index ReadState SetParentComponent Update

From TBasicAction (14)

ActionComponent Change ClientCount Clients ExecuteTarget GetClient HandlesTarget Notification OnChange RegisterChanges SetOnExecute Suspended UnRegisterChanges UpdateTarget

From TComponent (68)

_AddRef _Release BeforeDestruction CanObserve ChangeName ComObject ComponentCount ComponentIndex Components ComponentState ComponentStyle DefineProperties DesignInfo DestroyComponents Destroying ExecuteAction FindComponent FreeNotification FreeOnRelease GetChildOwner GetChildParent GetChildren GetDeltaStreams GetEnumerator GetIDsOfNames GetNamePath GetObservers GetOwner GetTypeInfo GetTypeInfoCount iicrGetComponent InsertComponent Invoke IsImplementorOf Loaded Loading Name ObserverAdded Observers OnGetDeltaStreams Owner PaletteCreated QueryInterface ReadDeltaState ReadDeltaStream ReferenceInterface RemoveComponent RemoveFreeNotification RemoveFreeNotifications SafeCallException SetAncestor SetChildOrder SetDesigning SetDesignInstance SetInline SetSubComponent Tag ToString TToStringNameMode UpdateAction Updated UpdateRegistry Updating ValidateContainer ValidateInsert ValidateRename VCLComObject WriteState

From TPersistent (4)

Assign FPOAttachObserver FPODetachObserver FPONotifyObservers

From TObject (37)

AfterConstruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandler DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName newinstance QualifiedClassName StringMessageTable SystemHasExtendedRTTI UnitName

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.