Table of Contents

TTMSFNCCustomToolBarButton Class

Base class for all toolbar button controls; adds drop-down split button support, layout modes, compact/large state, and options-menu text.

API unit family: TMSFNCToolBar Inherits from: TTMSFNCDefaultToolBarButton

Syntax

TTMSFNCCustomToolBarButton = class(TTMSFNCDefaultToolBarButton)

Properties

Name Description
CanCopy When True, this element can be copied to the compact popup toolbar. Set to False to exclude it from the compact view. (inherited from TTMSFNCCustomToolBarElement)
ControlIndex Zero-based index of this control within the toolbar's control list. Set internally during layout; do not change at runtime. (inherited from TTMSFNCCustomToolBarElement)
DownState Programmatic down (pressed) state of the button. Set to True to keep the button visually pressed. (inherited from TTMSFNCDefaultToolBarButton)
PopupPlacement Anchor side of the screen where the drop-down popup appears relative to the button. (inherited from TTMSFNCDefaultToolBarButton)

Methods

Name Description
CloseDropDown Closes the drop-down popup if it is open. (inherited from TTMSFNCDefaultToolBarButton)
Draw Renders the button onto the given graphics canvas within the specified rectangle. (inherited from TTMSFNCDefaultToolBarButton)
DropDown Opens the drop-down popup associated with this button. (inherited from TTMSFNCDefaultToolBarButton)
GetBitmap Returns the first bitmap from the Bitmaps collection, or nil if none is set. (inherited from TTMSFNCDefaultToolBarButton)
GetDropDownButtonControl Returns the companion drop-down button rendered when DropDownKind is ddkDropDownButton, or nil otherwise. Returns the companion drop-down button rendered when DropDownKind is ddkDropDownButton, or nil otherwise.
GetPopupControl Returns the internal popup control used for drop-down content. (inherited from TTMSFNCDefaultToolBarButton)
LoadSettingsFromFile Loads button settings from a JSON file.
LoadSettingsFromStream Loads button settings from a stream containing JSON.