CustomStatusBar¶

Qualified name: delphivcl.CustomStatusBar

class CustomStatusBar¶

Bases: WinControl

TCustomStatusBar is the base class for objects that represent status bars. TCustomStatusBar component is the base class for status bar controls. Status bars consist of a row of panels, usually aligned at the bottom of a form, that display information about an application as it runs. Each panel is represented by a TStatusPanel object listed in the Panels property. TCustomStatusBar is intended only as a base class. To add a status bar to a form, use a TCustomStatusBar descendant such as TStatusBar.

Methods

`CanFocus`	TWinControl.CanFocus() Indicates whether a control can receive focus.
`ExecuteAction`	TCustomStatusBar.ExecuteAction(Action: BasicAction) -> bool Processes actions for the status bar.
`FlipChildren`	TCustomStatusBar.FlipChildren(AllLevels: bool) -> None Reverses the positions of the status bar's panels.
`SetBounds`	TCustomStatusBar.SetBounds(ALeft: int, ATop: int, AWidth: int, AHeight: int) -> None Sets the Left, Top, Width, and Height properties all at once.
`SetFocus`	TWinControl.SetFocus() Gives the input focus to the control.

Attributes

`Action`	Specifies the action associated with the control.
`Align`	Determines how the control aligns within its container (parent control).
`AlignDisabled`	Indicates child control realignment disabled.
`AlignWithMargins`	Specifies whether a control should be constrained by margins.
`Anchors`	Specifies how the control is anchored to its parent.
`AutoHint`	Specifies whether the status bar's text is set automatically to the current hint.
`BiDiMode`	Specifies the bidirectional mode for the control.
`BoundsRect`	Specifies the bounding rectangle of the control, expressed in the coordinate system of the parent control.
`Brush`	Determines the color and pattern used for painting the background of the control.
`Canvas`	Provides runtime access to the status bar's drawing surface.
`ClassName`	Returns the TObject.ClassName
`ClientHeight`	Specifies the height of the control's client area in pixels.
`ClientOrigin`	Specifies the screen coordinates (in pixels) of the upper-left corner of a control's client area.
`ClientRect`	Specifies the size of a control's client area in pixels.
`ClientWidth`	Specifies the horizontal size of the control's client area in pixels.
`ComObject`	Specifies the interface reference implemented by the component.
`ComponentCount`	Returns the owned component count
`ComponentIndex`	Indicates the position of the component in its owner's Components property array.
`ComponentState`	Describes the current state of the component, indicating when a component needs to avoid certain actions.
`ComponentStyle`	Governs the behavior of the component.
`Components`	Returns an iterator over the owned components
`Constraints`	Specifies the size constraints for the control.
`ControlCount`	Returns the count of contained controls
`ControlState`	Specifies the current state of a control at run time.
`ControlStyle`	Determines style characteristics of the control.
`Controls`	Returns an iterator over contained controls
`CurrentPPI`	Embarcadero Technologies does not currently have any additional information.
`Cursor`	Specifies the image used to represent the mouse pointer when it passes into the region covered by the control.
`CustomHint`	CustomHint is a custom hint for the control.
`DesignInfo`	Contains information used by the Form designer.
`DockClientCount`	Specifies the number of controls that are docked on the windowed control.
`DockClients`	Control:
`DockManager`	Specifies the control's docking manager interface.
`DockOrientation`	DockOrientation specifies how the control is docked relative to other controls docked in the same parent.
`DockSite`	Specifies whether the control can be the target of drag-and-dock operations.
`DoubleBuffered`	Determines whether the control's image is rendered directly to the window or painted to an in-memory bitmap first.
`DoubleBufferedMode`	DoubleBufferedMode:
`Enabled`	Controls whether the control responds to mouse, keyboard, and timer events.
`ExplicitHeight`	Specifies the explicit vertical size of the control in pixels.
`ExplicitLeft`	Specifies the explicit horizontal pixel coordinate of the left edge of a component relative to its parent.
`ExplicitTop`	Specifies the explicit vertical pixel coordinate of the top edge of a component relative to its parent.
`ExplicitWidth`	Specifies the explicit horizontal size of the control in pixels.
`Floating`	Specifies whether the control is floating.
`FloatingDockSiteClass`	Specifies the class of the temporary control that hosts the control when it is floating.
`Focused`	Determines whether the control has input focus.
`Handle`	Provides access to the underlying Windows screen object for the control.
`HandleAllocated`	Reports whether a screen object handle exists for the control.
`Height`	Specifies the vertical size of the control in pixels.
`HelpContext`	The HelpContext property contains the numeric context ID that identifies the Help topic for the control.
`HelpKeyword`	The HelpKeyword property contains the keyword string that identifies the Help topic for the control.
`HelpType`	Specifies whether the control's context-sensitive Help topic is identified by a context ID or by keyword.
`Hint`	Hint contains the text string that appears when the user moves the mouse over the control.
`HostDockSite`	Specifies the control in which the control is docked.
`IsDrawingLocked`	IsDrawingLocked property returns True when redrawing for this control is locked.
`LRDockWidth`	Specifies the width of the control when it is docked horizontally.
`Left`	Specifies the horizontal coordinate of the left edge of a component relative to its parent.
`Margins`	Specifies the margins of the control.
`MouseInClient`	Indicates whether the mouse pointer is currently in the client area of the control.
`Name`	Specifies the name of the component as referenced in code.
`Observers`	Indicates the TObservers object added to the TComponent.
`Owner`	Returns the Component Owner
`Padding`	Specifies the padding of a control.
`Panels`	Lists the panels (TStatusPanel objects) in the status bar.
`Parent`	Returns/Sets the Control Parent
`ParentCustomHint`	Specifies where a control looks for its custom hint.
`ParentDoubleBuffered`	ParentDoubleBuffered defers the DoubleBuffered property of this component to the value of the parent's DoubleBuffered property.
`ParentWindow`	Reference to parent's underlying control.
`PixelsPerInch`	Embarcadero Technologies does not currently have any additional information.
`RedrawDisabled`	RedrawDisabled property returns True when redrawing for this control is locked.
`ScaleFactor`	Embarcadero Technologies does not currently have any additional information.
`ShowHint`	ShowHint specifies whether to show the Help Hint when the mouse pointer moves over the control.
`Showing`	Indicates whether the control is showing on the screen.
`SimplePanel`	Determines whether the status bar displays a single panel or multiple panels.
`SimpleText`	Contains a text string to be displayed in the status panel when SimplePanel is True.
`SizeGrip`	Determines whether the status bar is resizable at run time.
`StyleElements`	Specifies the style elements that are used by the control.
`StyleName`	Embarcadero Technologies does not currently have any additional information.
`TBDockHeight`	Specifies the height of the control when it is docked vertically.
`TabOrder`	Indicates the position of the control in its parent's tab order.
`TabStop`	Determines whether the user can tab to a control.
`Tag`	Stores a NativeInt integral value as a part of a component.
`Top`	Specifies the Y coordinate of the upper-left corner of a control, relative to its parent or containing control in pixels.
`Touch`	Specifies the touch manager component associated with the control.
`UndockHeight`	Specifies the height of the control when it is floating.
`UndockWidth`	Specifies the width of the control when it is floating.
`UseDockManager`	Specifies whether the docking manager is used in drag-and-dock operations.
`UseSystemFont`	Specifies whether the status bar uses the system font.
`VCLComObject`	Represents information used internally by components that support COM.
`Visible`	Specifies whether the component appears onscreen.
`VisibleDockClientCount`	Specifies the number of visible controls that are docked on the windowed control.
`Width`	Specifies the horizontal size of the control or form in pixels.

AutoHint¶

Specifies whether the status bar’s text is set automatically to the current hint. Use AutoHint to specify whether the status bar’s text is set automatically to the current hint. When AutoHint is True, the status bar automatically responds to hint actions by displaying the long version of the hint’s text in the first panel.

Type:: bool

CanFocus()¶: Indicates whether a control can receive focus.

Canvas¶

Provides runtime access to the status bar’s drawing surface. The read-only Canvas property provides access to the status bar’s drawing surface that you can use when implementing a handler for the OnDrawPanel event.

Type:: Canvas

ControlCount¶: Returns the count of contained controls

Controls¶: Returns an iterator over contained controls

ExecuteAction(Action: BasicAction) → bool¶: Processes actions for the status bar. When an action executes, the application makes a series of calls to respond to that action. If, in the course of that processing, the application identifies the status bar as a potential target of the action, it calls the status bar’s ExecuteAction method. If the action in a hint action (THintAction), ExecuteAction checks the AutoHint property, and if it is true, displays the hint and returns true. Otherwise, it allows the inherited method to respond to any other actions. The Action parameter specifies the action that was invoked. ExecuteAction returns true if the action was successfully dispatched, and false if the component could not handle the action.

FlipChildren(AllLevels: bool) → None¶: Reverses the positions of the status bar’s panels. FlipChildren iterates through the panels of the status bar, reversing their order but otherwise leaving their properties intact. AllLevels specifies whether FlipChildren should be called recursively on the control’s children. TCustomStatusBar ignores this parameter when reversing the panels.

Focused¶: Determines whether the control has input focus.

Handle¶: Provides access to the underlying Windows screen object for the control.

HandleAllocated¶: Reports whether a screen object handle exists for the control.

Panels¶

Lists the panels (TStatusPanel objects) in the status bar. The Panels property holds a TStatusPanels, that is, a collection of TStatusPanel objects. At design time, you can add, remove, or modify panels with the Panels editor. To open the Panels editor, select the Panels property in the Object Inspector, then double-click in the Value column to the right or click the ellipsis (…) button. At design time, you can add, remove, or modify panels with the Panels editor:

To open the Panels editor from the the Object Inspector, select the Panels property and either double-click in the Value column to the right or click the ellipsis (…) button. To open the Panels editor from the Form Designer, right-click TStatusBar and select Panels editor from the context menu.

Type:: StatusPanels

ParentWindow¶: Reference to parent’s underlying control.

SetBounds(ALeft: int, ATop: int, AWidth: int, AHeight: int) → None¶: Sets the Left, Top, Width, and Height properties all at once. TCustomStatusBar overrides SetBounds in order to update the size grip. ALeft, ATop, AWidth, and AHeight specify the new values for the Left, Top, Width, and Height properties, respectively.

SetFocus()¶: Gives the input focus to the control.

Showing¶: Indicates whether the control is showing on the screen.

SimplePanel¶

Determines whether the status bar displays a single panel or multiple panels. If SimplePanel is set to True, the status bar consists of a single panel displaying the text in SimpleText. If SimplePanel is set to False, the status bar displays a separate panel for each item in its Panels property.

Note: When SimplePanel is False, you cannot use the SimpleText property to display text in the status bar. Instead, you must set the Text property on one of the panel objects.

Type:: bool

SimpleText¶

Contains a text string to be displayed in the status panel when SimplePanel is True.

Note: Microsoft Windows XP and earlier versions limited the size of the string to 127 chars. Under Microsoft Windows Vista, Windows 7, or later Windows operating systems, SimpleText has no such limit.

Type:: str

SizeGrip¶

Determines whether the status bar is resizable at run time. If SizeGrip is set to True, the status bar has a triangular grip on the lower right corner. The user can resize the status bar by dragging the grip with the mouse. A size grip will not be drawn unless the Parent property refers to the child of a TCustomForm descendant with a BorderStyle of bsSizeable or bsSizeToolWin.

Note: If Align is set to alBottom, alRight, or alClient, the sizing grip will not work. If the Alignment property of the last panel in the status bar is set to taRightJustify, the sizing grip will truncate the panel’s text.

Type:: bool

UseSystemFont¶

Specifies whether the status bar uses the system font. UseSystemFont specifies whether the status bar uses the system font. To change fonts, use the Font property.

Type:: bool