FPDoc Onlineexperiment

TCommonDialogAction class

In unit StdActns

Dialog action used to create, configure, display, and execute a dialog form.

Declaration

pascal

TCommonDialogAction = class(TCustomAction)

Inheritance

Descends from it: TColorSelect TFileAction TFontEdit TSearchAction

Description

TCommonDialogAction is the base class for standard actions which display a dialog form, such as: TFileAction, TSearchAction, TFontEdit, TColorSelect.

TCommonDialogAction introduces methods used to get the class type for an associated dialog form, and to create the form instance displayed when the action is executed. It includes overridden methods to enable or execute the action for a target control. Event handlers are included which are signalled when the action is updated or executed, and to respond to accept and cancel buttons on its dialog form.

Do not create instances of TCommonDialogAction; use one of its descendent classes which provides the correct dialog form for the action.

See also

Properties

`ExecuteResult`	public	ExecuteResult - the result of the execution: True if successful.
`BeforeExecute`	public	BeforeExecute - event handler for performance before execution of the action.

Methods

`DoAccept`	protected	DoAccept - perform the code for the OnAccept event.
`DoBeforeExecute`	protected	Performs the BeforeExecute notification event when assigned.
`DoCancel`	protected	Signals the OnCancel event handler (when assigned).
`GetDialogClass`	protected	Returns the class type for the dialog associated with this action.
`CreateDialog`	protected	Create a new instance of the class type needed for the dialog in the action.
`Create`	public	Constructor for the class instance.
`Handlestarget`	public	Indicates whether the action is supported for the specified target.
`ExecuteTarget`	public	Executes the action on the target control.

Events

`OnAccept`	public	OnAccept - event handler for a press of the Accept button.
`OnCancel`	public	OnCancel - event handler for a press of the Cancel button.
`OnUpdate`	published	Event triggered when the application is idle.

Fields

FDialog protected FDialog - local variable holding the Dialog associated with this action.

Inherited

From TCustomAction (35)

AssignTo AutoCheck Caption Checked Destroy DisableIfNoHandler DoHint Enabled Execute Grayed GroupIndex HandleShortCut HelpContext HelpKeyword HelpType Hint ImageIndex OnHint SavedEnabledState SecondaryShortCuts SetAutoCheck SetCaption SetChecked SetEnabled SetGroupIndex SetHelpContext SetHelpKeyword SetHelpType SetHint SetImageIndex SetName SetShortCut SetVisible ShortCut Visible

From TContainedAction (8)

ActionList Category GetParentComponent HasParent Index ReadState SetParentComponent Update

From TBasicAction (13)

ActionComponent Change ClientCount Clients GetClient Notification OnChange OnExecute 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.