Vcl.ActnMenus.TCustomMenuButton Methods

From RAD Studio API Documentation
Jump to: navigation, search


InheritedProtected
_AddRefprotectedCalled when an application uses a component interface.
_ReleaseprotectedCalled when an application releases a component interface.
ActionChangeprotectedResponds when the action associated with the control changes.
AdjustSizeprotectedSets the size of the control as determined by the AutoSize property.
AfterConstructionpublicResponds after the last constructor has executed.
AssignpublicCopies the contents of another similar object.
AssignToprotectedOverrides the inherited AssignTo function to enable assignments to TAction objects.
AsyncScheduleprotected
BeforeDestructionpublicPerforms any necessary actions before the first destructor is called.
BeginAutoDragprotectedBegins automatic drag.
BeginDragpublicStarts the dragging of a control.
BeginInvokepublicPerforms an asynchronous call to the method specified by either AProc or AFunc.
BringToFrontpublicPuts the control in front of all other controls in its parent control.
CalcBoundspublicCalculates the size of the control.
CalcCursorPosprotectedGives the coordinates of the cursor, with respect to the origin of the control.
CalcLayoutprotectedComputes the layout of the menu item.
CanAutoSizeprotectedIndicates whether the control can resize itself automatically to accommodate its contents.
CanObserveprotected
CanResizeprotectedOnCanResize event dispatcher.
ChangedprotectedSends a CM_CHANGED message to the control.
ChangeNameprotectedSets the private, internal storage for the Name property to the string passed in NewName.
ChangeScaleprotected
CheckDisposedprotectedThis method is deprecated.
CheckNonMainThreadUsagepublicRaised an EInvalidOperation exception when called on a non-main thread and RaiseOnNonMainThreadUsage is set to True.
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.
ClickpublicExecutes the control's function.
ClientToParentpublicTranslates client coordinates to parent coordinates.
ClientToScreenpublicTranslates a given point from client area coordinates to global screen coordinates.
CMDesignHitTestprotected
CMDialogCharprotectedCalled when a predefined special key is pressed on Vcl.ActnCtrls.TCustomActionToolBar.
CMEnabledChangedprotectedRepaints the surface of the custom button control when the control is enabled or disabled.
CMFontChangedprotected
CMItemDropPointprotected
CMItemSelectedprotected
CMMouseEnterprotected
CMMouseLeaveprotectedResponds when the mouse leaves the button control area.
CMTextChangedprotectedResponds when the button's caption changes.
ConstrainedResizeprotectedNotify control of resize with constraints.
CreatepublicCreates an instance of TCustomMenuButton.
CreateTouchManagerprotectedInstantiates a touch manager.
DblClickprotectedOnDblClick event dispatcher.
DefaultDockImageprotectedHandles the painting and erasing of a dock image.
DefaultHandlerpublicProvides message handling for all messages that do not have specific handlers.
DefaultScalingFlagsprotected
DefinePropertiesprotectedProvides methods to read and write the IsControl property to a stream such as a form file.
DesignWndProcpublic
DestroypublicDestroys an instance of TCustomMenuButton.
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.
DockpublicUsed internally to dock the control.
DockTrackNoTargetprotectedHandles dragging of the control over an invalid docking target.
DoContextPopupprotectedIs an OnContextPopup event dispatcher.
DoDockprotectedDocking event dispatcher.
DoDragDropprotectedExecutes the drag-and-drop operation.
DoEndDockprotectedIs an OnEndDock event dispatcher.
DoEndDragprotectedIs an OnEndDrag event dispatcher.
DoGestureprotectedProcesses the unhandled gesturing events.
DoGetGestureOptionsprotectedReturns the interactive gestures and their options.
DoMouseWheelprotectedProcesses mouse wheel motion.
DoMouseWheelDownprotectedIs an OnMouseWheelDown event dispatcher.
DoMouseWheelUpprotectedIs an OnMouseWheelUp event dispatcher.
DoStartDockprotectedIs an OnStartDockevent dispatcher.
DoStartDragprotected
DragCanceledprotectedProvides the interface for a method that responds to the cancellation of a drag.
DragDroppublicPerforms actions and generates an OnDragDrop event.
DraggingpublicIndicates whether a control is being dragged.
DragOverprotectedIs an OnDragOver event dispatcher.
DrawBackgroundprotectedDraws a background image on the control.
DrawDesignFocusprotected
DrawDragDockImageprotectedDraws the dock image for the control.
DrawDragDropPointprotected
DrawFrameprotectedDraws a frame around the button control.
DrawGlyphprotectedDraws a symbol on the control.
DrawLargeGlyphprotectedDraws a large image on the control.
DrawSeparatorprotected
DrawShadowedTextprotectedDraws a text and its shadow on the control.
DrawTextprotected
DrawTextBiDiModeFlagspublicReturns the text flags that reflect the current setting of the BiDiMode property.
DrawTextBiDiModeFlagsReadingOnlypublicReturns the text flag to add that indicates whether the control's text should read from right to left.
EndDragpublicStops a control from being dragged any further.
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.
EraseDragDockImageprotectedErases the dock image for the control.
ExecuteActionpublicExecutes an action.
FieldAddresspublicReturns the address of a published object field.
FindComponentpublicIndicates whether a given component is owned by the component.
FindImageListprotected
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.
GetActionprotected
GetActionLinkClassprotectedReturns the appropriate action link class that is associated with the control class.
GetAllocatedWindowHandleprotected
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.
GetClientOriginprotectedReturns the screen coordinates of the upper-left corner of the control's client area.
GetClientRectprotectedReturns a rectangle defining the client area of the control.
GetControlsAlignmentpublicIndicates how text is aligned within the control.
GetCurrentPPIprotected
GetDeltaStreamsprotected
GetDesignDpiprotectedObtains the design Dpi for the form where the control was designed.
GetDeviceContextprotectedReturns a device context for the control.
GetDisposedprotectedGetter for the Disposed property.
GetDockEdgeprotectedReturns the edge on which another control should be docked when it is dragged over the control.
GetDPIForDesignerprotected
GetDragImagesprotectedReturns the control's image list containing the image to be displayed while dragging.
GetDragModeprotectedReturns the value of the DragMode property.
GetEnabledprotectedReturns the value of the Enabled property.
GetEnumeratorpublicReturns a TComponent enumerator.
GetFloatingprotectedReturns the value of the Floating property.
GetFloatingDockSiteClassprotectedReturns the class used for the control when it is floating.
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).
GetImageSizeprotected
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.
GetPaletteprotectedReturns the handle to a palette for use by the control.
GetParentComponentpublicReturns the parent of the control.
GetParentCurrentDpiprotectedObtains the current Dpi for parent control, or the current control Dpi if there is no parent.
GetPopupMenuprotectedReturns the pop-up menu associated with the control.
GetSeparatorprotected
GetShowCaptionprotected
GetShowShortCutprotectedGetter method for the ShowShortCut property.
GetStyleNamepublicReturns a string specifying the name of this component style.
GetSystemMetricspublicReturns Windows metrics for a control.
GetTextBufpublicRetrieves the control's text, copies it into a buffer, and returns the number of characters copied.
GetTextLenpublicReturns the length of the control's text.
GetTypeInfoprotectedRetrieves the type information for an object.
GetTypeInfoCountprotectedReturns the number of type information interfaces that an object provides (either 0 or 1).
HasGlyphprotected
HasParentpublicIndicates whether the control has a parent.
HidepublicMakes the control invisible.
InheritsFrompublicDetermines the relationship of two object types.
InitiateActionpublicCalls the action client's Update method if the control is associated with an action client.
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.
InvalidatepublicCompletely repaints the control.
InvokeprotectedProvides access to Automation properties and methods when the component wraps an Automation object.
IsCheckedprotected
IsCustomStyleActivepublic
IsGroupedprotected
IsImplementorOfpublicIndicates whether the component implements a specified interface.
IsLightStyleColorpublicReturns True when AColor is a light color.
IsRightToLeftpublicIndicates whether the control should be reversed right to left.
IsTouchPropertyStoredprotectedChecks whether the associated touch manager stored any of the given options.
KeyedpublicExecutes the button's function in response to a keyboard command.
LoadedprotectedInitializes the custom button control after it is loaded from a stream.
ManualDockpublicDocks the control.
ManualFloatpublicUndocks the control.
MethodAddresspublicReturns the address of a class method by name.
MethodNamepublicReturns the name of a class method by address.
MouseActivateprotectedTriggers a TMouseActivateEvent event.
MouseDownprotected
MouseMoveprotectedResponds to mouse moving over the custom button control area.
MouseUpprotected
MouseWheelHandlerpublicDispatches messages received from a mouse wheel.
NewInstancepublicAllocates memory for an instance of an object type and returns a pointer to that new instance.
NotificationprotectedResponds to notifications indicating that components are being created or destroyed.
ObserverAddedprotected
operator ()publicC++ conversion of a TComponent into a System.Classes.IInterfaceComponentReference or a System.IInterface, depending on casting.
Paintprotected
PaletteChangedprotectedResponds to changes in the system's palette by realizing the control's palette.
ParentToClientpublicTranslate parent coordinates to client coordinates.
PerformpublicResponds as if the control received a specified Windows message.
PositionChangedprotectedRepositions the control.
PositionDockRectprotectedPositions the docking rectangle according to the current drag-and-dock state.
QualifiedClassNamepublicReturns the qualified name of the class.
QueryInterfaceprotectedReturns a reference to a specified interface if the current component supports that interface.
ReadStateprotectedPrepares the control for having its properties assigned values read from a stream.
ReferenceInterfacepublicEstablishes or removes internal links that cause this component to be notified when the implementer of a specified interface is destroyed.
RefreshpublicRepaints the control on the screen.
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.
RepaintpublicForces the control to repaint its image on the screen.
ReplaceDockedControlpublicDocks the control in the place where another control is already docked.
RequestAlignprotected
ResetUsageDataprotected
ResizeprotectedRespond to control resize.
SafeCallExceptionpublicHandles exceptions in methods declared using the safecall calling convention.
ScaleConstraintsprotectedScales the values of the Constraints property to the given ratio.
ScaleForPPIpublicAdjusts the scaling of the current control for the specified Pixels Per Inch (PPI).
ScaleMarginsprotectedScales the values of the Margins property to the given ratio.
ScaleRectSizepublicScales Value rectangle size using the current ScaleFactor.
ScaleValuepublicThe overloaded ScaleValue methods return a measure passed as parameter scaled by the current scale factor for the control (the value of the ScaleFactor read-only property).
ScreenToClientpublicConverts the screen coordinates of a specified point on the screen to client coordinates.
SendCancelModeprotectedCancels the modal state of the control.
SendDockNotificationprotectedSends a Windows message to the control's host dock site.
SendToBackpublicPuts a windowed control behind all other windowed controls, or puts a non-windowed control behind all other non-windowed controls.
SetActionClientprotectedSets the control's action client.
SetAncestorprotectedClears or sets csAncestor state in the component's ComponentState property.
SetAutoSizeprotectedSets the value of the AutoSize property.
SetBiDiModeprotectedSets the control's bidirectional mode.
SetBoundspublicSets the Left, Top, Width, and Height properties all at once.
SetChildOrderprotectedSets the visual ordering of a child control.
SetCustomHintprotectedSets the value of the CustomHint property.
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.
SetDesignVisiblepublicMakes a control visible at design time.
SetDragModeprotectedSets the drag mode for the control.
SetDropPointprotected
SetEnabledprotectedSets the value of the Enabled property.
SetGlyphLayoutprotectedSets the glyph layout of the control button.
SetInlineprotectedSets the csInline bit of the component's ComponentState property.
SetNameprotectedSets the name of the control.
SetParentprotectedSets the parent of the control.
SetParentBiDiModeprotectedSpecifies whether the control uses its parent's BiDiMode.
SetParentComponentpublicSets the parent for the control.
SetSelectedprotectedRepresents the setter method for the Selected property.
SetStyleElementsprotected
SetStyleNameprotected
SetSubComponentpublicIdentifies whether the component is a subcomponent.
SetTextBufpublicSets the text of the control.
SetZOrderprotectedRepositions the control in its parent's control list, thereby changing position onscreen.
ShowpublicMakes a control visible.
StyleServicespublic
ToStringpublicReturns a string containing the class name.
UnitNamepublicReturns the name of the unit where the class is defined.
UnitScopepublicReturns the class's unit scope.
UpdatepublicProcesses any pending paint messages immediately.
UpdateActionpublicUpdates the state of an action.
UpdateBoundsRectprotectedChanges the Top, Left, Width, and Height properties of the control, but does not update its screen image and bypasses all resize events.
UpdatedprotectedClears the csUpdating state in the component's ComponentState property when the component finishes updating.
UpdateExplicitBoundsprotectedAttempts to update the values of the control's explicit bounds to those of its current bounds.
UpdateRegistryprotectedProvides the interface for a method that adds type library and version information to the Registry on components that implement COM interfaces.
UpdateSelectionprotected
UpdateStyleElementsprotectedCalled when the StyleElements property changes.
UpdateTextBoundsprotected
UpdatingprotectedSets the csUpdating state in the component's ComponentState property.
UseRightToLeftAlignmentpublicSpecifies whether the control's alignment should be reversed right-to-left.
UseRightToLeftReadingpublicSpecifies whether the control is using a right-to-left reading order.
UseRightToLeftScrollBarpublicSpecifies whether the vertical scroll bar appears on the left side of the control.
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.
VisibleChangingprotectedProvides the interface for a method that responds to changes in the control's visibility.
WMLButtonDblClkprotectedCalled when the user double-clicks the left mouse button while the cursor is in the client area of a button control.
WMSetTextprotected
WndProcprotectedProvides specific message responses for the control.
WriteStateprotectedWrites the state of the component.