TdxCustomStatusBar Class

The base class for status bar controls.

Declaration

TdxCustomStatusBar = class(
    TcxControl,
    IdxSkinSupport
)

Remarks

Status bars are horizontal panels designed to display information on the current application state (the caret position in a document, key states, custom indicators, etc.).

Status Bar Panels

Use the Panels property to manage panels. You can switch each panel between the following styles/usage scenarios:

TdxStatusBarContainerPanelStyle

A panel designed to embed a control (a TControl descendant instance).

TdxStatusBarKeyboardStatePanelStyle

Indicates Caps Lock, Num Lock, Scroll Lock, and Insert key states.

TdxStatusBarStateIndicatorPanelStyle

A panel that can display simple colored indicators.

TdxStatusBarTextPanelStyle

A text label panel.

TdxStatusBarToolbarPanelStyle

A panel designed to embed a toolbar. This panel type is designed for the TdxRibbonStatusBar control.

Main API Members

The list below outlines key members of the TdxCustomStatusBar class. These members allow you to manage status bar panels and configure general appearance settings.

Appearance Settings

BorderWidth

Adjusts border width for the status bar.

DefaultUseGlobalSkin

Enables or disables synchronization with global skin and palette for all status bar controls in the application.

Images

Specifies the image source for UI icons.

LookAndFeel

Provides access to look & feel settings.

Content-Related and User Interaction Options

OnHint

Allows you to customize AutoHint mode behavior for text-based panels.

Panels

Provides access to the panel collection.

SimplePanelStyle

Allows you to display a single text panel instead of all panels defined in the Panels collection.

SizeGrip

Specifies if the status bar displays a size grip.

Code Examples

Create Three Status Bar Panels

The following code example creates indicator, text label, and keyboard status panels in a TdxStatusBar control:

Delphi

uses
  dxStatusBar;  // Declares the TdxStatusBar control and related types
// ...

procedure TMyForm.FormCreate(Sender: TObject);
var
  ATextPanel, AIndicatorPanel, AKeyboardPanel: TdxStatusBarPanel;
  AIndicators: TdxStatusBarStateIndicators;
  AKeyboardPanelStyle: TdxStatusBarKeyboardStatePanelStyle;
begin
  dxStatusBar1.Panels.BeginUpdate;  // Initiates the following batch change
  try
    // Create and configure an indicator panel
    AIndicatorPanel := dxStatusBar1.Panels.Add;
    AIndicatorPanel.PanelStyleClass := TdxStatusBarStateIndicatorPanelStyle;
    AIndicators := TdxStatusBarStateIndicatorPanelStyle(AIndicatorPanel.PanelStyle).Indicators;
    AIndicators.Add.IndicatorType := sitRed;  // Creates a red indicator
    // Create and configure a text panel
    ATextPanel := dxStatusBar1.Panels.Add;
    ATextPanel.PanelStyleClass := TdxStatusBarTextPanelStyle;
    (ATextPanel.PanelStyle as TdxStatusBarTextPanelStyle).Font.Style := [fsBold];
    ATextPanel.Text := 'Disconnected';  // Defines a status message for the created text panel
    ATextPanel.Fixed := False;  // Disables panel width limitations
    // Create and configure a keyboard status panel
    AKeyboardPanel := dxStatusBar1.Panels.Add;
    AKeyboardPanel.PanelStyleClass := TdxStatusBarKeyboardStatePanelStyle;
    AKeyboardPanelStyle := AKeyboardPanel.PanelStyle as TdxStatusBarKeyboardStatePanelStyle;
    // Hide the scroll lock status
    AKeyboardPanelStyle.KeyboardStates := [dxksCapsLock, dxksNumLock, dxksInsert];
  finally
    dxStatusBar1.Panels.EndUpdate;  // Calls EndUpdate regardless of the batch operation's success
  end;
end;

C++

#include "dxStatusBar.hpp"  // Declares the TdxStatusBar control and related types

// Add the following linker directive to the corresponding CPP source file:
#pragma link "dxStatusBar"  // Required to use dxStatusBar.hpp declarations

void __fastcall TMyForm::FormCreate(TObject *Sender)
{
  TdxStatusBarPanel *ATextPanel;
  TdxStatusBarPanel *AIndicatorPanel;
  TdxStatusBarPanel *AKeyboardPanel;
  TdxStatusBarStateIndicators *AIndicators;
  TdxStatusBarKeyboardStatePanelStyle *AKeyboardPanelStyle;

  dxStatusBar1->Panels->BeginUpdate();  // Initiates the following batch change
  try
  {
    // Create and configure an indicator panel
    AIndicatorPanel = dxStatusBar1->Panels->Add();
    AIndicatorPanel->PanelStyleClass = __classid(TdxStatusBarStateIndicatorPanelStyle);
    AIndicators =
      static_cast<TdxStatusBarStateIndicators*>(
        static_cast<TdxStatusBarStateIndicatorPanelStyle*>(AIndicatorPanel->PanelStyle)->Indicators);
    AIndicators->Add()->IndicatorType = sitRed;  // Creates a red indicator

    // Create and configure a text panel
    ATextPanel = dxStatusBar1->Panels->Add();
    ATextPanel->PanelStyleClass = __classid(TdxStatusBarTextPanelStyle);
    static_cast<TdxStatusBarTextPanelStyle*>(ATextPanel->PanelStyle)->Font->Style = TFontStyles() << fsBold;
    ATextPanel->Text = "Disconnected";  // Defines a status message for the created text panel
    ATextPanel->Fixed = false;  // Disables panel width limitations

    // Create and configure a keyboard status panel
    AKeyboardPanel = dxStatusBar1->Panels->Add();
    AKeyboardPanel->PanelStyleClass = __classid(TdxStatusBarKeyboardStatePanelStyle);
    AKeyboardPanelStyle =
      static_cast<TdxStatusBarKeyboardStatePanelStyle*>(AKeyboardPanel->PanelStyle);

    // Hide the scroll lock status
    AKeyboardPanelStyle->KeyboardStates =
      TdxStatusBarKeyboardStates() << dxksCapsLock << dxksNumLock << dxksInsert;
  }
  __finally
  {
    dxStatusBar1->Panels->EndUpdate();  // Calls EndUpdate regardless of the batch operation's success
  }
}

Create and Populate Indicator Panels

The following code example creates an indicator panel in an existing TdxStatusBarPanel component and populates the panel with five different indicators:

Delphi

uses
  dxStatusBar;  // Declares the TdxStatusBarPanel component and all related types
// ...

var
  AIndicatorPanel: TdxStatusBarPanel;
  AIndicators: TdxStatusBarStateIndicators;
begin
  AIndicatorPanel := dxStatusBar1.Panels.Add;
  AIndicatorPanel.PanelStyleClass := TdxStatusBarStateIndicatorPanelStyle;
  AIndicators := (AIndicatorPanel.PanelStyle as TdxStatusBarStateIndicatorPanelStyle).Indicators;
  AIndicators.BeginUpdate;  // Initiates the following batch change
  try
    AIndicators.Add.IndicatorType := sitRed;
    AIndicators.Add.IndicatorType := sitYellow;
    AIndicators.Add.IndicatorType := sitGreen;
    AIndicators.Add.IndicatorType := sitPurple;
    AIndicators.Add.IndicatorType := sitOff;
  finally
    AIndicators.EndUpdate;  // Calls EndUpdate regardless of the batch operation's success
  end;
end;

C++

#include "dxStatusBar.hpp"  // Declares the TdxStatusBarPanel component and all related types

// Add the following linker directive to the corresponding CPP source file:
#pragma link "dxStatusBar"  // Required to use dxStatusBar.hpp declarations

  // ...
  TdxStatusBarPanel *AIndicatorPanel;
  TdxStatusBarStateIndicators *AIndicators;

  AIndicatorPanel = dxStatusBar1->Panels->Add();
  AIndicatorPanel->PanelStyleClass = __classid(TdxStatusBarStateIndicatorPanelStyle);
  AIndicators = dynamic_cast<TdxStatusBarStateIndicatorPanelStyle*>(AIndicatorPanel->PanelStyle)->Indicators;
  AIndicators->BeginUpdate();  // Initiates the following batch change
  try
  {
    AIndicators->Add()->IndicatorType = sitRed;
    AIndicators->Add()->IndicatorType = sitYellow;
    AIndicators->Add()->IndicatorType = sitGreen;
    AIndicators->Add()->IndicatorType = sitPurple;
    AIndicators->Add()->IndicatorType = sitOff;
  }
  __finally
  {
    AIndicators->EndUpdate();  // Calls EndUpdate regardless of the batch operation's success
  }

Terminal TdxCustomStatusBar Class Descendants

Do not use the TdxCustomStatusBar class directly. Use the following descendants instead:

TdxRibbonStatusBar

A status bar component designed for the Ribbon UI.

TdxStatusBar

A simple status bar.

Implements

IdxSkinSupport

Inheritance

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl

TcxCustomControl

TcxControl

TdxCustomStatusBar