FMX.Controls.TControlAction Methods

From RAD Studio API Documentation
Jump to: navigation, search

_AddRefprotectedCalled when an application uses a component interface.
_ReleaseprotectedCalled when an application releases a component interface.
AfterConstructionpublicResponds after the last constructor has executed.
AssignpublicCopies the contents of another similar object.
AssignToprotectedCopies the properties of this action to a destination action.
AsyncScheduleprotectedSchedules asynch method calls.
BeforeDestructionpublicPerforms any necessary actions before the first destructor is called.
BeginInvokepublicPerforms an asynchronous call to the method specified by either AProc or AFunc.
ChangeprotectedGenerates an OnChange event.
ChangeNameprotectedSets the private, internal storage for the Name property to the string passed in NewName.
ClassInfopublicReturns a pointer to the run-time type information (RTTI) table for the object type.
ClassNamepublicReturns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
ClassNameIspublicDetermines whether an object is of a specific type.
ClassParentpublicReturns the type of the immediate ancestor of a class.
ClassTypepublicReturns the class reference for the object's class.
CleanupInstancepublicPerforms finalization on long strings, variants, and interface variables within a class.
CreateShortCutListprotectedCreates the TShortCutList object for the action.
CustomTextChangedprotectedIntroduces an interface for a function that is called when the CustomText property for the action changes.
DefaultHandlerpublicProvides the interface for a method that processes message records.
DefinePropertiesprotectedImplements a method for storing an action object's unpublished data on a stream such as a form file.
DestroyComponentspublicDestroys all owned components.
DestroyingpublicIndicates that the component and its owned components are about to be destroyed.
DispatchpublicCalls message-handling methods for the object, based on the contents of the Message parameter.
DisposeOfpublicDisposeOf forces the execution of the destructor code in an object.
DoHintpublicCalls the OnHint event handler.
EndFunctionInvokepublicBlocks the caller until the specified ASyncResult completes.
EndInvokepublicBlocks the caller until the specified ASyncResult completes.
EqualspublicChecks whether the current instance and the Obj parameter are equal.
ExecutepublicResponds when a client control "fires".
ExecuteActionpublicExecutes an action.
ExecuteTargetpublicIntroduces an interface for invoking an action on a target client component or control.
FieldAddresspublicReturns the address of a published object field.
FindComponentpublicIndicates whether a given component is owned by the component.
FreepublicDestroys an object and frees its associated memory, if necessary.
FreeInstancepublicDeallocates memory allocated by a previous call to the NewInstance method.
FreeNotificationpublicEnsures that AComponent is notified that the component is going to be destroyed.
FreeOnReleasepublicFrees the interface reference for components that were created from COM classes.
GetChildOwnerprotectedReturns the owner of a child component being read from a stream.
GetChildParentprotectedReturns the parent or, if there is no parent, returns the owner of a child component being read from a stream.
GetChildrenprotectedEnumerates all child components.
GetDisposedprotectedGetter for the Disposed property.
GetEnumeratorpublicReturns a TComponent enumerator.
GetHashCodepublicReturns an integer containing the hash code.
GetIDsOfNamesprotectedMaps a single member and an optional set of argument names to a corresponding set of integer dispatch identifiers (dispIDs).
GetInterfacepublicRetrieves a specified interface.
GetInterfaceEntrypublicReturns the entry for a specific interface implemented in a class.
GetInterfaceTablepublicReturns a pointer to a structure containing all of the interfaces implemented by a given class.
GetNamePathpublicReturns a string used by the Object Inspector.
GetObserversprotectedGetter of Observers.
GetOwnerprotectedReturns the owner of a component.
GetParentComponentpublicReturns the action list containing the action.
GetTypeInfoprotectedRetrieves the type information for an object.
GetTypeInfoCountprotectedReturns the number of type information interfaces that an object provides (either 0 or 1).
HandleShortCutprotectedExecutes the action when the user types one of its shortcuts.
HandlesTargetpublicIntroduces an interface for verifying that the type and state of a target component or control are appropriate for the action.
HasParentpublicIndicates whether the action is contained in an action list.
InheritsFrompublicDetermines the relationship of two object types.
InitInstancepublicInitializes a newly allocated object instance to all zeros and initializes the instance's virtual method table pointer.
InsertComponentpublicEstablishes the component as the owner of a specified component.
InstanceSizepublicReturns the size in bytes of each instance of the object type.
InvokeprotectedProvides access to Automation properties and methods when the component wraps an Automation object.
IsDialogKeypublicChecks whether the specified keyboard key corresponds to one of the action's shortcuts.
IsImplementorOfpublicIndicates whether the component implements a specified interface.
IsSupportedInterfaceprotectedReturns True if this action can be realized on the current platform.
MethodAddresspublicReturns the address of a class method by name.
MethodNamepublicReturns the name of a class method by address.
NewInstancepublicAllocates memory for an instance of an object type and returns a pointer to that new instance.
operator ()publicC++ conversion of a TComponent into a System.Classes.IInterfaceComponentReference or a System.IInterface, depending on casting.
QualifiedClassNamepublicReturns the qualified name of the class.
QueryInterfaceprotectedReturns a reference to a specified interface if the current component supports that interface.
ReadStateprotectedReads the state of the action.
ReferenceInterfacepublicEstablishes or removes internal links that cause this component to be notified when the implementer of a specified interface is destroyed.
RegisterChangesprotectedAssociates the action with an action link.
RemoveComponentpublicRemoves a specified component specified from the component's Components list.
RemoveFreeNotificationpublicDisables the destruction notification that was enabled by FreeNotification.
RemoveFreeNotificationsprotectedNotifies all owned components of the owner component's imminent destruction.
SafeCallExceptionpublicHandles exceptions in methods declared using the safecall calling convention.
SecondaryShortCutsCreatedprotectedRetrieves whether the list stored in the SecondaryShortCuts property is created.
SetAncestorprotectedClears or sets csAncestor state in the component's ComponentState property.
SetAutoCheckprotectedSets the specified Value to the AutoCheck property of the action, and propagates this Value to all clients of the action.
SetCaptionprotectedSets the specified Value to the Caption property of the action, and propagates this Value to all the clients of the action.
SetCheckedprotectedSets the specified Value to the Checked property of the action, and propagates this Value to all clients of the action.
SetChildOrderprotectedSets the visual ordering of a child control.
SetDesigningprotectedEnsures that components inserted at design time have their design-mode flag set.
SetDesignInstanceprotectedEnsures that components inserted at design time have their design-mode flag set.
SetGroupIndexprotectedSets the specified Value to the GroupIndex property of the action and properly handles the ON or OFF state of the Checked properties of all actions in the group specified by Value.
SetHelpContextprotectedSets the Help context ID for the action and action's clients.
SetHelpKeywordprotectedDefines the Help keyword for the action and action's clients.
SetHelpTypeprotectedSets the HelpType property for the action and action's clients.
SetHintprotectedSets the Hint property for the action and action's clients to a new Value.
SetImageIndexprotectedSets the new Value of the ImageIndex property for the action and action's clients.
SetInlineprotectedSets the csInline bit of the component's ComponentState property.
SetNameprotectedSets the Name and Caption properties of the action.
SetOnExecuteprotectedAssigns an OnExecute event handler for the action and for all clients.
SetParentComponentpublicSets the action list containing the action.
SetShortCutprotectedSets the new Value of the ShortCut property for the action and action's clients.
SetStatusActionprotectedSets the new Value of the StatusAction property for the action and action's clients.
SetSubComponentpublicIdentifies whether the component is a subcomponent.
SetTargetprotectedSets the value of the Target property.
SuspendedpublicReturns True if the action list of the action is suspended.
ToStringpublicReturns a string containing the class name.
UnitNamepublicReturns the name of the unit where the class is defined.
UnitScopepublicReturns the class's unit scope.
UnRegisterChangesprotectedBreaks the association between the action and the action link.
UpdateActionpublicUpdates the state of an action.
UpdatedprotectedClears the csUpdating state in the component's ComponentState property when the component finishes updating.
UpdateRegistryprotectedProvides the interface for a method that adds type library and version information to the Registry on components that implement COM interfaces.
UpdateSupportedprotectedUpdateSupported is called when the Supported property can be changed.
UpdateTargetpublicIntroduces an interface for a method of notifying a client when the action updates itself.
UpdatingprotectedSets the csUpdating state in the component's ComponentState property.
ValidateContainerprotectedDetermines whether an object can be inserted into a container.
ValidateInsertprotectedProvides the interface for a method that validates a child component before it is inserted.
ValidateRenameprotectedEnsures that renaming an owned component does not create a name conflict.
WriteStateprotectedWrites the state of the component.