FMX.StdCtrls.TButton Methods

From RAD Studio API Documentation
Jump to: navigation, search


InheritedProtected
_AddRef protected Called when an application uses a component interface.
_Release protected Called when an application releases a component interface.
AbsoluteToLocal public Translates coordinated of the specified Point from an global perspective to a local coordinates of this control.
AbsoluteToLocalVector public Transforms and returns a specified vector from the absolute perspective to the local perspective.
ActionChange protected
AddFreeNotify public Adds AObject to the list of objects to be notified when this TFmxObject is destroyed.
AddObject public Adds the AObject object to the Children list of children attached to this parent object (self).
AddObjectsToList public Adds the children of this object to the given list.
AddToResourcePool protected
AdjustFixedSize protected Sets the fixed size of the control.
AdjustSize protected Sets the size of the control.
AfterConstruction public
AfterDialogKey protected
AfterPaint protected
AncestorParentChanged protected Sends a PM_REFRESH_PARENT message to the presentation layer through its presentation proxy when the parent of an ancestor of this control changes.
AncestorPresentationLoaded protected Notifies child controls that your control has loaded a new presentation.
AncestorVisibleChanged protected Notifies its child controls that the visibility of an ancestor of your control has changed to AVisible, and also notifies its presentation proxy about it if the presentation proxy is loaded.
AnimateColor (deprecated) public Creates a TColorAnimation for this object (self).
AnimateFloat (deprecated) public Creates and runs a TFloatAnimation for this object (self).
AnimateFloatDelay (deprecated) public Creates a TFloatAnimation for this object (self).
AnimateFloatWait (deprecated) public Creates a TFloatAnimation for this object (self) and does not return until the animation is finished.
AnimateInt (deprecated) public Creates and runs a TIntAnimation for this object (self).
AnimateIntWait (deprecated) public Creates a TIntAnimation for this object (self) and does not return until the animation is finished.
ApplyEffect protected Applies effects to the control, if specified.
ApplyStyle protected
ApplyStyleLookup public Sends a PM_APPLY_STYLE_LOOKUP message to the presentation layer through its presentation proxy.
ApplyTriggerEffect public
ApplyTriggers protected
Assign public Copies the contents of another similar object.
AssignTo protected Copies the properties of an object to a destination object.
AsyncSchedule protected Schedules asynch method calls.
BeforeDestruction public Performs any necessary actions before the first destructor is called.
BeforeEffectEnabledChanged protected Executed right before the value of the Enabled property of an effect changes, and provides the value of the property before it changes.
BeginAutoDrag protected Begins the drag operation automatically.
BeginInvoke public Performs an asynchronous call to the method specified by either AProc or AFunc.
BeginUpdate public Marks the start of an update session of the control and its children.
BringChildToFront public
BringToFront public Brings this FMX visual object on top of other overlapping visual controls that are on the same form.
BroadcastGesture protected
CalcTextObjectSize protected Sets the bounds of the TextObject according to the current alignment values of that TextObject.
CanObserve protected
CanRepaint protected
CanTriggerAcceleratorKey protected Determines whether the object reacts to the accelerator key or not.
Capture protected Saves the control that currently captures all the mouse messages.
Change public Calls DoChanged when any of the styled text representation properties of the control changes.
ChangeChildren protected
ChangeName protected Sets the private, internal storage for the Name property to the string passed in NewName.
ChangeOrder protected Sends a PM_CHANGE_ORDER message to the presentation layer through its presentation proxy.
CheckDisposed protected
CheckForAllowFocus protected Verifies whether the current control can receive focus.
CheckHitTest protected
ChildrenAlignChanged protected Executed when the alignment of the children of the control changes.
ChooseAdjustType protected Returns an adjust type based on the provided FixedSize.
ClassInfo public Returns a pointer to the run-time type information (RTTI) table for the object type.
ClassName public Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
ClassNameIs public Determines whether an object is of a specific type.
ClassParent public Returns the type of the immediate ancestor of a class.
ClassType public Returns the class reference for the object's class.
CleanupInstance public Performs finalization on long strings, variants, and interface variables within a class.
Click protected Responds to user clicks.
ClipChildrenChanged protected Sends a PM_SET_CLIP_CHILDREN message to the presentation layer through its presentation proxy with the current value of ClipChildren.
Clone public Returns a new cloned instance of this FMX object.
CMGesture protected
ContainsObject public Returns True if the specified object is a direct child.
ControlTypeChanged protected Notifies about the changes of ControlType.
Create public
CreateChildrenList protected
DblClick protected Responds to user double-clicks.
DefaultHandler public Provides the interface for a method that processes message records.
DefineModelClass protected Returns a class reference to a data model of this presented control.
DefinePresentationName protected Returns the name of the default presentation proxy that your presented control uses.
DefineProperties protected
DeleteChildren public Deletes all the children of this FMX object.
Destroy public
DestroyComponents public Destroys all owned components.
Destroying public Indicates that the component and its owned components are about to be destroyed.
DialogKey protected Processes a dialog key.
Disappear protected
Dispatch public Calls message-handling methods for the object, based on the contents of the Message parameter.
DisposeOf public DisposeOf forces the execution of the destructor code in an object.
DoAbsoluteChanged protected Sends a PM_ABSOLUTE_CHANGED message to the presentation layer through its presentation proxy.
DoActionChange protected TBasicAction.OnChange event dispatcher.
DoActionClientChanged protected Sends a PM_ACTION_CLIENT_CHANGED message to the presentation layer through its presentation proxy.
DoActivate protected
DoAddObject protected
DoApplyStyleLookup protected Executed internally each time ApplyStyleLookup is called for this TStyledControl object.
DoBeginUpdate protected
DoChanged protected Updates the representation of the text that is displayed on the control.
DoDeactivate protected Dispatcher of the OnDeactivate event.
DoDeleteChildren protected
DoEndUpdate protected
DoEnter protected Sends a PM_DO_ENTER message to the presentation layer through its presentation proxy.
DoExit protected Sends a PM_RESET_FOCUS message to the presentation layer through its presentation proxy, followed by a PM_DO_EXIT message.
DoFilterPresentedText protected Filters the string contained in the Text property.
DoGesture protected Processes the unhandled gesturing events.
DoGetUpdateRect protected
DoInsertObject protected
DoInventory protected
DoMatrixChanged protected
DoMouseEnter protected OnMouseEnter event dispatcher.
DoMouseLeave protected OnMouseLeave event dispatcher.
DoPaint protected Processes the painting of the control.
DoRealign protected
DoRemoveObject protected
DoRepeatDelayTimer protected Internally executes every 100 milliseconds if the RepeatClick property is True.
DoRepeatTimer protected Internally executes every 100 milliseconds to perform the OnClick event, if the RepeatClick property is True.
DoResized protected
DoRootChanged protected
DoRootChanging protected DoRootChanging is executed when the root container (typically a form) is defined or changes.
DoSetHeight (deprecated) protected
DoSetSize protected Sends a PM_SET_SIZE message to the presentation layer through its presentation proxy.
DoSetWidth (deprecated) protected
DoStyleChanged protected
DoTextChanged protected Executed when text is changed.
DragDrop protected OnDragDrop event dispatcher.
DragEnd protected OnDragEnd event dispatcher.
DragEnter protected OnDragEnter event dispatcher.
DragLeave protected OnDragLeave event dispatcher.
DragOver protected OnDragOver event dispatcher.
DrawDesignBorder protected
EffectEnabledChanged protected Executed right after the value of the Enabled property of an effect changes, and provides the new value of the property.
EnabledChanged protected Executed right after the value of the Enabled property changes.
EnabledStored protected
EndFunctionInvoke public Blocks the caller until the specified ASyncResult completes.
EndInvoke public Blocks the caller until the specified ASyncResult completes.
EndUpdate public Marks the end of an update session of the control and its children.
EndUpdateNoChanges protected
EnterChildren protected Checks whether the input is taken by the control or by its parent.
EnumControls (deprecated) public Loops through the controls that are children of this control, and runs the specified procedure once per control, with a different control as the first parameter in each call.
EnumObjects public Loops through the children of this object, and runs the specified procedure once per object as the first parameter in each call.
Equals public Checks whether the current instance and the Obj parameter are equal.
Exchange public Exchanges two objects from the children list.
ExecuteAction public Executes an action.
ExitChildren protected
FieldAddress public Returns the address of a published object field.
FillTextFlags protected Returns the filling direction of the control's text.
FindAndCloneStyleResource public Finds the specified resource object and makes a copy.
FindComponent public Indicates whether a given component is owned by the component.
FindStyleResource public Requests from the presentation layer the style resource object with the specified name (AStyleLookup), and returns that object.
FindTarget protected Returns the target control.
FindTextObject protected Returns the resource object that is linked to the current text object.
Free public Destroys an object and frees its associated memory, if necessary.
FreeInstance public Deallocates memory allocated by a previous call to the NewInstance method.
FreeNotification protected
FreeOnRelease public Frees the interface reference for components that were created from COM classes.
FreeStyle protected
GenerateStyleName protected Generates a style lookup name based on the provided AClassName.
GetAbsoluteEnabled protected Getter function for the AbsoluteEnabled property.
GetAbsoluteMatrix protected Getter function for the AbsoluteMatrix property.
GetAbsoluteOpacity protected Getter function for the AbsoluteOpacity property.
GetAbsoluteRect protected Getter function for the AbsoluteRect property.
GetAbsoluteScale protected Getter function for the AbsoluteScale property.
GetAcceleratorChar protected Returns the index of the accelerator character within the text string of the receiver object.
GetAcceleratorCharIndex protected Returns the character key that serves as the keyboard accelerator for the receiver object.
GetAcceptsControls protected Getter function for the AcceptsControls property.
GetActionLinkClass protected
GetAdjustSizeValue protected Requests from the presentation layer the size value used for size adjustment, and returns that value.
GetAdjustType protected Requests from the presentation layer the type of size adjustment used, and returns that type.
GetAlign protected Getter function for the Align property.
GetAllowAlign protected Getter function for the AllowAlign property.
GetAnchorMove protected Getter function for the AnchorMove property.
GetAnchorOrigin protected Getter function for the AnchorOrigin property.
GetAnchorRules protected Getter function for the AnchorRules property.
GetAnchors protected Getter function for the Anchors property.
GetBackIndex protected Gets the index of TStyledControl.
GetBoundsRect protected Getter function for the BoundsRect property.
GetCanFocus protected
GetCanParentFocus protected
GetChildOwner protected Returns the owner of a child component being read from a stream.
GetChildParent protected Returns the parent or, if there is no parent, returns the owner of a child component being read from a stream.
GetChildren protected
GetChildrenMatrix protected Returns the children transformation matrix.
GetChildrenRect protected Getter function for the ChildrenRect property.
GetClipRect protected Getter function for the ClipRect property.
GetContainerHeight protected Getter function for the ContainerHeight property.
GetContainerWidth protected Getter function for the ContainerWidth property.
GetControls protected
GetData protected
GetDefaultSize protected
GetDefaultStyleLookupName protected
GetDefaultTouchTargetExpansion protected
GetDeltaStreams protected
GetDesignInteractive protected Getter function for the DesignInteractive property.
GetDisposed protected Getter for the Disposed property.
GetDragMode protected Getter function for the DragMode property.
GetEffectsRect protected Returns the rectangle occupied by the effects applied over the control.
GetEnumerator public Returns a TComponent enumerator.
GetFirstControlWithGesture protected Requests from the presentation layer a control with the specified interactive gesture among the interactive gestures of its touch manager, and returns that control.
GetFirstControlWithGestureEngine protected
GetFirstVisibleObjectIndex protected
GetHasClipParent protected
GetHashCode public Returns an integer containing the hash code.
GetHeight protected Getter function for the Height property.
GetHintObject protected Returns the custom hint object that manages the hint display.
GetHintString protected Returns the text of the hint.
GetHitTest protected Getter function for the HitTest property.
GetIDsOfNames protected Maps a single member and an optional set of argument names to a corresponding set of integer dispatch identifiers (dispIDs).
GetInterface public Retrieves a specified interface.
GetInterfaceEntry public Returns the entry for a specific interface implemented in a class.
GetInterfaceTable public Returns a pointer to a structure containing all of the interfaces implemented by a given class.
GetLastVisibleObjectIndex protected
GetLeft protected Getter function for the Left property.
GetListOfInteractiveGestures protected
GetLocalRect protected Getter function for the LocalRect property.
GetLocked protected Getter function for the Locked property.
GetMargins protected Getter function for the Margins property.
GetModel protected Returns the data model of your control casted as the specified T class.
GetNamePath public Returns a string used by the Object Inspector.
GetObject protected Returns the current control as a TFmxObject.
GetObservers protected Getter of Observers.
GetOriginalParentSize protected Getter function for the OriginalParentSize property.
GetOwner protected Returns the owner of a component.
GetPadding protected Getter function for the Padding property.
GetParent protected
GetParentClassStyleLookupName protected Getter for the ParentClassStyleLookupName property.
GetParentComponent public Returns the containing component.
GetParentedRect (deprecated) protected Getter function for the ParentedRect property.
GetParentedVisible protected Returns the value of the ParentedVisible property.
GetPopupMenu protected
GetPresentationSuffix protected Returns a suffix for the presentation proxy name that DefinePresentationName returns based on the control type of your control.
GetResourceControl protected Returns the style resource for this control as TControl.
GetResourceLink protected
GetStyleContext protected Returns context for behavior manager.
GetStyleObject protected Gets the style resource object linked to TStyledControl.
GetTabList public
GetTabListClass protected
GetTabStopController protected
GetTextSettingsClass protected
GetTop protected Getter function for the Top property.
GetTypeInfo protected Retrieves the type information for an object.
GetTypeInfoCount protected Returns the number of type information interfaces that an object provides (either 0 or 1).
GetUpdateRect protected Getter function for the UpdateRect property.
GetVisible protected Getter function for the Visible property.
GetWidth protected Getter function for the Width property.
HandleSizeChanged protected Executed right after the value of the Size property changes.
HasHint protected Returns True if the control has an available hint to display.
HasParent public Verifies whether the component has a parent.
HasPresentationProxy public Returns True if the PresentationProxy of your control is loaded or False otherwise.
Hide protected
HitTestChanged protected Sends a PM_HITTEST_CHANGED message to the presentation layer through its presentation proxy when the value of the HitTest property changes.
IgnoreBindingName protected
IgnoreBooleanValue protected
IgnoreFloatValue protected
IgnoreIdentValue protected
IgnoreIntegerValue protected
ImageIndexStored protected Returns True when the ImageIndex property needs to be stored in the fmx-file.
ImagesChanged protected Should be called when the component needs to redraw the image.
Inflate public
InheritsFrom public Determines the relationship of two object types.
InitiateAction protected Calls the action link's Update method if the control is associated with an action link.
InitInstance public Initializes a newly allocated object instance to all zeros and initializes the instance's virtual method table pointer.
InitPresentation protected Sends initialization data to the presentation layer through its presentation proxy.
InsertComponent public Establishes the component as the owner of a specified component.
InsertObject public Adds the object provided in the parameter to the FChildren TList of this object (self), at the specified position (index).
InstanceSize public Returns the size in bytes of each instance of the object type.
InvalidateRect public Adds a rectangle to the update region of the scene.
Invoke protected Provides access to Automation properties and methods when the component wraps an Automation object.
IsChild public Returns True if the specified object is a child.
IsControlRectEmpty protected Returns True if the control rect is empty.
IsHeightStored (deprecated) protected
IsHelpContextStored protected Specifies whether HelpContext is stored.
IsImplementorOf public Indicates whether the component implements a specified interface.
IsPositionStored protected
IsPressedStored protected
IsSizeStored protected
IsUpdating public Returns True if this control is in the middle of one or more update sessions.
IsWidthStored (deprecated) protected
ItemClass public Deprecated. Do not use in applications.
KeyDown protected
KeyUp protected Sends a PM_KEYUP message to the presentation layer through its presentation proxy when a key is released while your presented control has the focus.
KillResourceLink protected
Loaded protected
LoadPresentation public Loads the presentation proxy and initializes the corresponding presentation of your presented control if it is not loaded already.
LocalToAbsolute public Transforms and returns a specified point from the local perspective to the absolute perspective.
LocalToAbsoluteVector public Transforms and returns a specified vector from the local perspective to the absolute perspective.
LocalToScreen protected Transforms and returns a specified point from the local perspective to the screen perspective.
Lock public Locks the current control, so it cannot be changed at design time.
LookupStyleObject public Looks for the style resource object linked to the TStyledControl.
MakeScreenshot public Takes and returns a screenshot of the control.
MethodAddress public Returns the address of a class method by name.
MethodName public Returns the name of a class method by address.
MouseClick protected Calls Click and starts the animation by calling StartTriggerAnimation.
MouseDown protected
MouseMove protected
MouseUp protected
MouseWheel protected OnMouseWheel event dispatcher.
Move protected
NeedStyleLookup public Sends a PM_NEED_STYLE_LOOKUP message to the presentation layer through its presentation proxy to indicate that this control requires to get and apply its style lookup.
NeedUpdateEffects protected
NewInstance public Allocates memory for an instance of an object type and returns a pointer to that new instance.
Notification protected
ObjectAtPoint protected Sends a PM_OBJECT_AT_POINT message to the presentation layer through its presentation proxy to request the control in which P can be found.
ObjectState (deprecated) public Describes the current state of the object.
ObserverAdded protected
operator () public
PaddingChanged protected Executed right after the value of the Padding property changes.
Paint protected Renders the control's surface.
PaintChildren protected Renders the child controls.
Painting protected
PaintInternal protected
PaintTo public Paints the current control to a specified canvas.
PaletteCreated protected Responds when the component is created from the component palette.
ParentChanged protected Sends a PM_REFRESH_PARENT message to the presentation layer through its presentation proxy when the parent of this control changes.
PointInObject public Checks whether the point, specified by the absolute coordinates, belongs to the control area.
PointInObjectLocal public
PrepareForPaint public
QualifiedClassName public Returns the qualified name of the class.
QueryInterface protected Returns a reference to a specified interface if either your presented control or its presentation layer support that interface.
ReadState protected Reads the state of the component.
Realign protected Performs the realignment of the control's children within itself.
RecalcAbsolute public Forces the current control to recalculate the AbsoluteMatrix property.
RecalcAbsoluteNow public Recalculates AbsoluteMatrix.
RecalcEnabled public
RecalcHasClipParent public Forces the current control to recalculate its HasClipParent property.
RecalcHasEffect public Forces the current control to recalculate its HasEffect property.
RecalcOpacity public Requests the presentation layer to recalculate the opacity of the presentation of your control and its child controls based on the value of the AbsoluteOpacity property.
RecalcSize public
RecalcUpdateRect public Forces the current control to recalculate its UpdateRect property.
RecommendSize protected Requests from the presentation layer a recommended size for your control based on the specified wished size, and returns the size that the presentation layer recommends.
RecycleResourceLink protected
ReferenceInterface public Establishes or removes internal links that cause this component to be notified when the implementer of a specified interface is destroyed.
Release (deprecated) public Marks this TFmxObject object for delayed deletion.
ReleaseCapture protected Prevents the control from currently capturing all the mouse messages.
Released (deprecated) public Returns True if this object has been released from memory.
ReloadPresentation public Reloads the presentation of your control.
RemoveComponent public Removes a specified component specified from the component's Components list.
RemoveFreeNotification public Disables the destruction notification that was enabled by FreeNotification.
RemoveFreeNotifications protected Notifies all owned components of the owner component's imminent destruction.
RemoveFreeNotify public Removes the given object from the free notifications list.
RemoveFromResourcePool protected
RemoveObject public Removes a children object from its parent.
Repaint public Forces the control to repaint its image on the screen.
RepaintJointArea class protected
RepaintRect protected
RequestStyleData protected Requests the style value for a presented control (passed as a TValue).
ResetChildrenIndices protected
ResetChildrenIndicesSpan protected
ResetFocus public Removes the focus from a control
Resize protected OnResize event dispatcher.
RestoreButtonState protected
SafeCallException public Handles exceptions in methods declared using the safecall calling convention.
ScreenToLocal protected Transforms and returns a specified point from the screen perspective to the local perspective.
SearchInto protected
SendChildToBack public
SendToBack public Sends this FMX visual object to the background letting other overlapping visual controls that are on the same form to be on top of it.
SetAcceptsControls protected Setter function for the AcceptsControls property.
SetAdjustSizeValue protected Sends a PM_SET_ADJUST_SIZE message to the presentation layer through its presentation proxy.
SetAdjustType protected Sends a PM_SET_ADJUST_SIZE message to the presentation layer through its presentation proxy.
SetAlign protected Setter function for the Align property.
SetAncestor protected Clears or sets csAncestor state in the component's ComponentState property.
SetAnchorMove protected Setter function for the AnchorMove property.
SetAnchors protected Setter function for the Anchors property.
SetBounds public Sets the boundaries of the current control.
SetBoundsRect protected Setter function for the BoundsRect property.
SetChildOrder protected Sets the visual ordering of a child control.
SetData protected
SetDesign public Sets the csDesigning in TComponentState. Used internally by the IDE.
SetDesigning protected Ensures that components inserted at design time have their design-mode flag set.
SetDesignInstance protected Ensures that components inserted at design time have their design-mode flag set.
SetDragMode protected Setter function for the DragMode property.
SetEnabled protected Setter of Enabled.
SetFocus public Sets the focus to the current control, if CanFocus is True.
SetHeight protected Setter function for the Height property.
SetHelpContext protected Setter method for the HelpContext property.
SetHelpKeyword protected Setter method for the HelpKeyword property.
SetHint protected Setter for the Hint property.
SetInline protected Sets the csInline bit of the component's ComponentState property.
SetInPaintTo protected Sets the InPaintTo property.
SetIsPressed protected
SetLeft protected Setter function for the Left property.
SetName protected
SetNewScene public Sets a new Scene for the current control.
SetParent protected Protected setter implementation for the Parent property.
SetParentComponent protected
SetPopupMenu protected Setter function for the PopupMenu property.
SetRoot public Sets the Root property of each child in the children list.
SetSize protected
SetStaysPressed protected
SetStyledSettings protected Setter method for the StyledSettings property.
SetSubComponent public Identifies whether the component is a subcomponent.
SetText protected This property is used to change the displayed text.
SetTextInternal protected Sets a new value to the Text property in TPresentedTextControl.
SetTextSettings protected Setter method for the TextSettings property.
SetTop protected Setter function for the Top property.
SetVisible protected Sends a PM_SET_VISIBLE message to the presentation layer through its presentation proxy with Value as the new visibility value.
SetWidth protected Setter function for the Width property.
ShouldTestMouseHits public Indicates whether a control should be ignored in ObjectAtPoint.
Show protected
ShowContextMenu protected Displays the PopupMenu context menu of this control on the specified ScreenPosition screen point.
ShowInDesigner public
Sort public Sorts the children in the children list using the specified sorting procedure.
StartTriggerAnimation public
StartTriggerAnimationWait public
StopPropertyAnimation public Stops the animation of the specified property of this FMX object.
StyleDataChanged protected
StyledSettingsStored protected Indicates whether the set of styled text representation properties stored in StyledSettings differs from the default set for this control.
StyleLookupChanged protected
SupportsPaintStage protected
SupportsPlatformService protected
Tap protected
ToggleStaysPressed protected
ToString public
TouchManager protected
TriggerAcceleratorKey protected Allows the object to perform an action when the accelerator key is pressed.
UnitName public Returns the name of the unit where the class is defined.
UnitScope public Returns the class's unit scope.
UnloadPresentation public Unloads the previously-loaded presentation of your control.
UpdateAction public Updates the state of an action.
UpdateAnchorRules protected
Updated protected
UpdateEffects public Updates the effects of the current control and of the control's parent.
UpdateExplicitBounds protected Updates the explicit bounds' properties of the control.
UpdateRegistry protected Provides the interface for a method that adds type library and version information to the Registry on components that implement COM interfaces.
UpdateTextObject protected Updates the text of the TextObject.
Updating protected Sets the csUpdating state in the component's ComponentState property.
ValidateContainer protected Determines whether an object can be inserted into a container.
ValidateInsert protected Provides the interface for a method that validates a child component before it is inserted.
ValidateRename protected Ensures that renaming an owned component does not create a name conflict.
VisibleChanged protected Executed right after the value of the Visible property changes.
VisibleStored protected Returns True when the Visible property needs to be stored in the fmx-file.
WriteState protected Writes the state of the component.


Retrieved from "https://docwiki.embarcadero.com/Libraries/Tokyo/e/index.php?title=FMX.StdCtrls.TButton_Methods&oldid=470026"