StatusBar#

Qualified name: delphivcl.StatusBar

class StatusBar#

Bases: CustomStatusBar

TStatusBar represents a status bar. The TStatusBar component is 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. The SimplePanel property can be used to toggle the status bar at runtime between a single- and multiple-panel display.

Methods

`CanFocus`	Indicates whether a control can receive focus.
`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.
`BorderWidth`	Specifies the width of the control's border.
`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.
`Color`	Specifies the background color of the control.
`ComObject`	Specifies the interface reference implemented by the component.
`ComponentCount`	Indicates the number of components owned by the component.
`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`	<Delphi indexed property Components of type TComponent at 21141642500>
`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`	<Delphi indexed property DockClients of type TWinControl at 211416EE520>
`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.
`DragCursor`	Specifies the image used to represent the mouse pointer when the control is being dragged.
`DragKind`	Specifies whether the control is being dragged normally or for docking.
`DragMode`	Specifies how the control initiates drag-and-drop or drag-and-dock operations.
`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.
`Font`	Specifies the attributes of text written on or in the control.
`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.
`OnClick`	<Delphi property OnClick of type TStatusBar at 211419CFF90>
`OnContextPopup`	<Delphi property OnContextPopup of type TStatusBar at 211419D0060>
`OnCreatePanelClass`	<Delphi property OnCreatePanelClass of type TStatusBar at 211419D0130>
`OnDblClick`	<Delphi property OnDblClick of type TStatusBar at 211419D0200>
`OnDragDrop`	<Delphi property OnDragDrop of type TStatusBar at 211419D02D0>
`OnDragOver`	<Delphi property OnDragOver of type TStatusBar at 211419D03A0>
`OnDrawPanel`	<Delphi property OnDrawPanel of type TStatusBar at 211419D0C90>
`OnEndDock`	<Delphi property OnEndDock of type TStatusBar at 211419D0470>
`OnEndDrag`	<Delphi property OnEndDrag of type TStatusBar at 211419D0540>
`OnGesture`	<Delphi property OnGesture of type TStatusBar at 211419D0610>
`OnHint`	<Delphi property OnHint of type TStatusBar at 211419D06E0>
`OnMouseActivate`	<Delphi property OnMouseActivate of type TStatusBar at 211419D07B0>
`OnMouseDown`	<Delphi property OnMouseDown of type TStatusBar at 211419D0880>
`OnMouseEnter`	<Delphi property OnMouseEnter of type TStatusBar at 211419D0950>
`OnMouseLeave`	<Delphi property OnMouseLeave of type TStatusBar at 211419D0A20>
`OnMouseMove`	<Delphi property OnMouseMove of type TStatusBar at 211419D0AF0>
`OnMouseUp`	<Delphi property OnMouseUp of type TStatusBar at 211419D0BC0>
`OnResize`	<Delphi property OnResize of type TStatusBar at 211419D0D60>
`OnStartDock`	<Delphi property OnStartDock of type TStatusBar at 211419D0E30>
`OnStartDrag`	<Delphi property OnStartDrag of type TStatusBar at 211419D0F00>
`Owner`	Indicates the component that is responsible for streaming and freeing this component.
`Padding`	Specifies the padding of a control.
`Panels`	Lists the panels (TStatusPanel objects) in the status bar.
`Parent`	Specifies the parent of the control.
`ParentBiDiMode`	Specifies whether the control uses its parent's BiDiMode.
`ParentColor`	Specifies where a control looks for its color information.
`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.
`ParentFont`	Specifies where a control looks for its font information.
`ParentShowHint`	Specifies where a control looks to find out if its Help Hint should be shown.
`ParentWindow`	Reference to parent's underlying control.
`PixelsPerInch`	Embarcadero Technologies does not currently have any additional information.
`PopupMenu`	Specifies the pop-up menu associated with the control.
`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.
`WindowProc`	<Delphi property WindowProc of type TControl at 211418EC1C0>

Action#: Specifies the action associated with the control. Action is the action object that is associated with the control. Actions allow an application to centralize the response to user commands. When a control is associated with an action, the action determines the appropriate properties and events of the control (such as whether the control is enabled or how it responds to an OnClick event). To create actions at design time, place an action list component on a form or data module. Double-click the action list to bring up the action list editor. Add actions in the editor using its context menu. Once the actions have been added using the Action List editor, they appear in the drop-down list for the Action property in the Object Inspector.

Align#

Determines how the control aligns within its container (parent control). Use Align to align a control to the top, bottom, left, or right of a form or panel and have it remain there even if the size of the form, panel, or component that contains the control changes. When the parent is resized, an aligned control also resizes so that it continues to span the top, bottom, left, or right edge of the parent. For example, to use a panel component with various controls on it as a tool palette, change the panel’s Align value to alLeft. The value of alLeft for the Align property of the panel guarantees that the tool palette remains on the left side of the form and always equals the client height of the form. The default value of Align is alNone, which means a control remains where it is positioned on a form or panel.

Tip: If Align is set to alClient, the control fills the entire client area so that it is impossible to select the parent form by clicking it. In this case, select the parent by selecting the control on the form and pressing ESC, or by using the Object Inspector. Any number of child components within a single parent can have the same Align value, in which case they stack up along the edge of the parent. The child controls stack up in z-order. To adjust the order in which the controls stack up, drag the controls into their desired positions.

Note: To cause a control to maintain a specified relationship with an edge of its parent, but not necessarily lie along one edge of the parent, use the Anchors property instead.

Anchors#

Specifies how the control is anchored to its parent. Use Anchors to ensure that a control maintains its current position relative to an edge of its parent, even if the parent is resized. When its parent is resized, the control holds its position relative to the edges to which it is anchored. If a control is anchored to opposite edges of its parent, the control stretches when its parent is resized. For example, if a control has its Anchors property set to [akLeft, akRight], the control stretches when the width of its parent changes. Anchors is enforced only when the parent is resized. Thus, for example, if a control is anchored to opposite edges of a form at design time and the form is created in a maximized state, the control is not stretched because the form is not resized after the control is created.

Note: If a control should maintain contact with three edges of its parent (hugging one side of the parent and stretching the length of that side), use the Align property instead. Unlike Anchors, Align allows controls to adjust to changes in the size of other aligned sibling controls as well as changes to the parent’s size.

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.

BiDiMode#: Specifies the bidirectional mode for the control. Use BiDiMode to enable the control to adjust its appearance and behavior automatically when the application runs in a locale that reads from right to left instead of left to right. The bidirectional mode controls the reading order for the text, the placement of the vertical scroll bar, and whether the alignment is changed. Alignment does not change for controls that are known to contain number, date, time, or currency values. For example, with data-aware controls, the alignment does not change for the following field types: ftSmallint, ftInteger, ftWord, ftFloat, ftCurrency, ftBCD, ftDate, ftTime, ftDateTime, ftAutoInc.

BorderWidth#: Specifies the width of the control’s border. Use BorderWidth to get or set the width of the control’s border. Graphics or text drawn by the control is clipped to the area within the border.

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

Color#: Specifies the background color of the control. Use Color to read or change the background color of the control. If a control’s Vcl.Controls.TControl.ParentColor property is True, then changing the Color property of the control’s parent automatically changes the Color property of the control. When the value of the Color property is changed, the control’s ParentColor property is automatically set to False. The Color of a TLabel is always the color of the background unless you set TLabel.Transparent to False.

Constraints#

Specifies the size constraints for the control. Use Constraints to specify the minimum and maximum width and height of the control. When Constraints contains maximum or minimum values, the control cannot be resized to violate those constraints.

Note: Constraints apply to the height of the form. However, the height of the form depends on how large Windows makes the title bar. For example, Windows XP uses much larger title bars than other windowing systems. To work around this, note the ClientHeight when you design your form and set the constraints in the FormCreate event. In the following example, ClientHeight is represented by x: Constraints.MinHeight?:= x + Height - ClientHeight. Warning: Do not set up constraints that conflict with the value of the Align or Anchors property. When these properties conflict, the response of the control to resize attempts is not well-defined.

ControlCount#: Returns the count of contained controls

Controls#: Returns an iterator over contained controls

DoubleBuffered#

Determines whether the control’s image is rendered directly to the window or painted to an in-memory bitmap first. When DoubleBuffered is false, the windowed control paints itself directly to the window. When DoubleBuffered is true, the windowed control paints itself to an in-memory bitmap that is then used to paint the window. Double buffering reduces the amount of flicker when the control repaints, but is more memory intensive. When a windowed control is a dock site and has an associated dock manager, it must be double-buffered.

Note: Some controls, such as TRichEdit, can’t paint themselves into a bitmap. For such controls, DoubleBuffered must be set to false.

DragCursor#

Specifies the image used to represent the mouse pointer when the control is being dragged. Use the DragCursor property to change the cursor image presented when the control is being dragged.

Note: To make a custom cursor available for the DragCursor property, see the Cursor property.

DragKind#: Specifies whether the control is being dragged normally or for docking. Use DragKind to get or set whether the control participates in drag-and-drop operations or drag-and-dock operations.

DragMode#: Specifies how the control initiates drag-and-drop or drag-and-dock operations. Use DragMode to control when the user can drag the control. Disable the drag-and-drop or drag-and-dock capability at run time by setting the DragMode property value to dmManual. Enable automatic dragging by setting DragMode to dmAutomatic. For more information about dmManual and dmAutomatic, see TDragMode.

Enabled#

Controls whether the control responds to mouse, keyboard, and timer events. Use Enabled to change the availability of the control to the user. To disable a control, set Enabled to False. Some disabled controls appear dimmed (for example: buttons, check boxes, labels), while others (container controls) simply lose their functionality without changing their appearance. If Enabled is set to False, the control ignores mouse, keyboard, and timer events. To re-enable a control, set Enabled to True.

Note: This property applies to all TControl descendants.

Focused#: Determines whether the control has input focus.

Font#

Specifies the attributes of text written on or in the control. To change to a new font, specify a new TFont object. To modify a font, change the value of the Charset, Color, Height, Name , Pitch, Size, or Style of the TFont object.

Note: Changing the font color of the Caption is not supported for some controls (such as TButton). In most cases, there is an alternate control you can use whose Font property will change the color of the caption or text (such as TBitBtn or TSpeedButton).

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

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

OnClick#: <Delphi property OnClick of type TStatusBar at 211419CFF90>

OnContextPopup#: <Delphi property OnContextPopup of type TStatusBar at 211419D0060>

OnCreatePanelClass#: <Delphi property OnCreatePanelClass of type TStatusBar at 211419D0130>

OnDblClick#: <Delphi property OnDblClick of type TStatusBar at 211419D0200>

OnDragDrop#: <Delphi property OnDragDrop of type TStatusBar at 211419D02D0>

OnDragOver#: <Delphi property OnDragOver of type TStatusBar at 211419D03A0>

OnDrawPanel#: <Delphi property OnDrawPanel of type TStatusBar at 211419D0C90>

OnEndDock#: <Delphi property OnEndDock of type TStatusBar at 211419D0470>

OnEndDrag#: <Delphi property OnEndDrag of type TStatusBar at 211419D0540>

OnGesture#: <Delphi property OnGesture of type TStatusBar at 211419D0610>

OnHint#: <Delphi property OnHint of type TStatusBar at 211419D06E0>

OnMouseActivate#: <Delphi property OnMouseActivate of type TStatusBar at 211419D07B0>

OnMouseDown#: <Delphi property OnMouseDown of type TStatusBar at 211419D0880>

OnMouseEnter#: <Delphi property OnMouseEnter of type TStatusBar at 211419D0950>

OnMouseLeave#: <Delphi property OnMouseLeave of type TStatusBar at 211419D0A20>

OnMouseMove#: <Delphi property OnMouseMove of type TStatusBar at 211419D0AF0>

OnMouseUp#: <Delphi property OnMouseUp of type TStatusBar at 211419D0BC0>

OnResize#: <Delphi property OnResize of type TStatusBar at 211419D0D60>

OnStartDock#: <Delphi property OnStartDock of type TStatusBar at 211419D0E30>

OnStartDrag#: <Delphi property OnStartDrag of type TStatusBar at 211419D0F00>

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.

ParentBiDiMode#: Specifies whether the control uses its parent’s BiDiMode. Use ParentBiDiMode to get or set whether the control uses its parent’s BiDiMode. When ParentBiDiMode is true, the control’s BiDiMode property is always equal to that of its parent. If ParentBiDiMode is false, the control uses its own BiDiMode property. Set ParentBiDiMode to true for all controls in a form to ensure that the entire user interface adjusts to Middle Eastern locales in a uniform manner. When the value of the control’s BiDiMode property changes, ParentBiDiMode becomes false automatically.

ParentColor#: Specifies where a control looks for its color information. To have a control use the same color as its parent control, set ParentColor to True. If ParentColor is False, the control uses its own Color property. Set ParentColor to True for all controls to ensure that all the controls on a form have a uniform appearance. For example, if ParentColor is True for all controls in a form, changing the background color of the form to gray causes all the controls on the form to also have a gray background. When the value of a control’s Color property changes, ParentColor becomes False automatically.

ParentDoubleBuffered#: ParentDoubleBuffered defers the DoubleBuffered property of this component to the value of the parent’s DoubleBuffered property. ParentDoubleBuffered is a boolean indicating that the DoubleBuffered property of this component is overridden by the value of the parent’s DoubleBuffered property.

ParentFont#: Specifies where a control looks for its font information. To have a control use the same font as its parent control, set ParentFont to true. If ParentFont is false, the control uses its own Font property. Many controls default ParentFont to true so that all the controls in a form or other container present a uniform appearance. When the value of a control’s Font property changes, ParentFont becomes false automatically. When ParentFont is true for a form, the form uses the default font. Currently, the default font is Tahoma 8 pt.

ParentShowHint#

Specifies where a control looks to find out if its Help Hint should be shown. Use ParentShowHint to ensure that all the controls on a form either uniformly show their Help Hints or uniformly do not show them. If ParentShowHint is True, the control uses the ShowHint property value of its parent. If ParentShowHint is False, the control uses the value of its own ShowHint property. To provide Help Hints only for selected controls on a form, set the ShowHint property for those controls that should have Help Hints to True, and ParentShowHint becomes False automatically.

Note: Enable or disable all Help Hints for the entire application using the ShowHint property of the application object.

ParentWindow#: Reference to parent’s underlying control.

PopupMenu#: Specifies the pop-up menu associated with the control. Assign a value to PopupMenu to make a pop-up menu appear when the user selects the control and clicks the right mouse button. If the TPopupMenu’s AutoPopup property is True, the pop-up menu appears automatically. If the menu’s AutoPopup property is False, display the menu with a call to its Popup method from the control’s OnContextPopup event handler.

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

ShowHint#

ShowHint specifies whether to show the Help Hint when the mouse pointer moves over the control. ShowHint determines whether the Help Hint appears for the control. The Help Hint is the value of the TControl.Hint property. The Help Hint appears in a box just beneath the control when the mouse pointer moves over the control. To enable Help Hints for a particular control, two conditions must be satisfied:

The application’s ShowHint property must be True. Either the control’s own ShowHint property must be True, or the control’s ParentShowHint property must be True and its parent’s ShowHint property must be True. For example, imagine a check box within a group box. If the ShowHint property of the group box is True and the ParentShowHint property of the check box is True, but the ShowHint property of the check box is False, the check box still displays its Help Hint. Changing the ShowHint value automatically sets the ParentShowHint property to False.

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.

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.

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.

StyleElements#: Specifies the style elements that are used by the control. Use StyleElements to customize the style of the control. If a custom style is enabled, you can enable or disable style elements in the control. StyleElements is a set of values that specify which elements of the current style are to be applied to this control. By default, all the elements of the style are enabled.

StyleName#: Embarcadero Technologies does not currently have any additional information.

Touch#

Specifies the touch manager component associated with the control. Use the Touch property to access gesturing options associated with a control. Touch specifies a class of type TTouchManager. Touch is used to:

Associate a TGestureManager. (TGestureManager manages all the gestures that can be used by the control.) Select the standard, interactive, or custom gestures to associate with the control. (You can also connect each gesture to an action; see Assigning Actions to Gestures.) Specify a set of options for interactive or tablet gestures.

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.

Visible#: Specifies whether the component appears onscreen. Use the Visible property to control the visibility of the control at run time. If Visible is True, the control appears. If Visible is False, the control is not visible. Calling the Show method sets the control’s Visible property to True. Calling the Hide method sets it to False. For TCustomForm descendants, the Show and ShowModal methods set Visible to True and bring the form to the front of all open windows. For TTabSheet descendants, Visible does not control the visibility of the control at run time. For more information, see the description of the TabVisible property.