IStatusBar Interface Reference

The main interface More...

Inherits IDispatch.

Public Member Functions
HRESULT	About (void)
	Displays the control's credits More...
HRESULT	GetBorders ([in, out, defaultvalue(0)] OLE_YSIZE_PIXELS *horizontalBorder,[in, out, defaultvalue(0)] OLE_XSIZE_PIXELS *verticalBorder,[in, out, defaultvalue(0)] OLE_XSIZE_PIXELS *interPanelBorder)
	Retrieves the control's border sizes More...
HRESULT	HitTest ([in] OLE_XPOS_PIXELS x,[in] OLE_YPOS_PIXELS y,[in, out] HitTestConstants *hitTestDetails,[out, retval] IStatusBarPanel **ppHitPanel)
	Hit-tests the specified point More...
HRESULT	LoadSettingsFromFile ([in] BSTR file,[out, retval] VARIANT_BOOL *pSucceeded)
	Loads the control's settings from the specified file More...
HRESULT	Refresh (void)
	Advises the control to redraw itself
HRESULT	SaveSettingsToFile ([in] BSTR file,[out, retval] VARIANT_BOOL *pSucceeded)
	Saves the control's settings to the specified file More...

Properties
AppearanceConstants	Appearance [get, set]
	Controls the style of the control's outer border More...
OLE_COLOR	BackColor [get, set]
	Specifies the control's background color More...
BorderStyleConstants	BorderStyle [get, set]
	Controls the style of the control's inner border More...
BSTR	CustomCapsLockText [get, set]
	Specifies the custom text displayed by panels that display the status of the CAPS LOCK key More...
BSTR	CustomInsertKeyText [get, set]
	Specifies the custom text displayed by panels that display the status of the INS key More...
BSTR	CustomKanaLockText [get, set]
	Specifies the custom text displayed by panels that display the status of the KANA LOCK key More...
BSTR	CustomNumLockText [get, set]
	Specifies the custom text displayed by panels that display the status of the NUM LOCK key More...
BSTR	CustomScrollLockText [get, set]
	Specifies the custom text displayed by panels that display the status of the SCROLL LOCK key More...
DisabledEventsConstants	DisabledEvents [get, set]
	Controls which events are fired More...
VARIANT_BOOL	DontRedraw [get, set]
	Controls redrawing of the control More...
VARIANT_BOOL	Enabled [get, set]
	Controls whether the control accepts user input More...
IFontDisp	Font [get, set]
	Specifies the control's font More...
VARIANT_BOOL	ForceSizeGripperDisplay [get, set]
	Controls visibility of the size gripper More...
LONG	HoverTime [get, set]
	Controls when the MouseHover event is fired More...
OLE_HANDLE	hWnd [get]
	Retrieves the control's window handle More...
OLE_YSIZE_PIXELS	MinimumHeight [get, set]
	Specifies the control's minimum height More...
IPictureDisp	MouseIcon [get, set]
	Controls the control's mouse cursor More...
MousePointerConstants	MousePointer [get, set]
	Controls the control's mouse cursor More...
IStatusBarPanels	Panels [get]
	Retrieves the control's panels More...
IStatusBarPanel	PanelToAutoSize [get, set]
	Specifies the panel that is auto-sized to fill up the remaining space More...
VARIANT_BOOL	RegisterForOLEDragDrop [get, set]
	Controls the control's behavior in drag'n'drop operations More...
VARIANT_BOOL	RightToLeftLayout [get, set]
	Controls the control's right-to-left features More...
VARIANT_BOOL	ShowToolTips [get, set]
	Specifies whether the control displays any tooltips More...
VARIANT_BOOL	SimpleMode [get, set]
	Specifies whether the control consists of multiple panels More...
IStatusBarPanel	SimplePanel [get]
	Retrieves the StatusBarPanel object used to edit the simple mode settings More...
VARIANT_BOOL	SupportOLEDragImages [get, set]
	Controls the control's behavior in drag'n'drop operations More...
VARIANT_BOOL	UseSystemFont [get, set]
	Specifies whether the control uses the system font More...
BSTR	Version [get]
	Retrieves the control's version More...

Detailed Description

The main interface

This is the control's main interface. It wraps the control window.

See Also

_IStatusBarEvents

Member Function Documentation

HRESULT About

(

void

)

Displays the control's credits

Displays some information about this control and its author.

HRESULT GetBorders	(	[in, out, defaultvalue(0)] OLE_YSIZE_PIXELS *	horizontalBorder,
		[in, out, defaultvalue(0)] OLE_XSIZE_PIXELS *	verticalBorder,
		[in, out, defaultvalue(0)] OLE_XSIZE_PIXELS *	interPanelBorder
	)

Retrieves the control's border sizes

Retrieves the size (in pixels) of the control's borders.

Parameters

[out]	horizontalBorder	The size of the control's horizontal border.
[out]	verticalBorder	The size of the control's vertical border.
[out]	interPanelBorder	The size of each vertical border between the control's panels.

See Also

IStatusBarPanel::GetRectangle

HRESULT HitTest	(	[in] OLE_XPOS_PIXELS	x,
		[in] OLE_YPOS_PIXELS	y,
		[in, out] HitTestConstants *	hitTestDetails,
		[out, retval] IStatusBarPanel **	ppHitPanel
	)

Hit-tests the specified point

Retrieves the control's parts that lie below the point ('x'; 'y').

Parameters

[in]	x	The x-coordinate (in pixels) of the point to check. It must be relative to the control's upper-left corner.
[in]	y	The y-coordinate (in pixels) of the point to check. It must be relative to the control's upper-left corner.
[in,out]	hitTestDetails	Receives a value specifying the exact part of the control the specified point lies in. Any of the values defined by the HitTestConstants enumeration is valid.

Returns

The panel that the specified point belongs to. Nothing, if no panel was "hit" or if the control is in simple mode.

See Also

HitTestConstants

HRESULT LoadSettingsFromFile	(	[in] BSTR	file,
		[out, retval] VARIANT_BOOL *	pSucceeded
	)

Loads the control's settings from the specified file

Parameters

[in]

file

The file to read from.

Returns

True if the settings could be loaded; otherwise False.

See Also

SaveSettingsToFile

HRESULT SaveSettingsToFile	(	[in] BSTR	file,
		[out, retval] VARIANT_BOOL *	pSucceeded
	)

Saves the control's settings to the specified file

Parameters

[in]

file

The file to write to.

Returns

True if the settings could be saved; otherwise False.

See Also

LoadSettingsFromFile

Property Documentation

AppearanceConstants Appearance

getset

Controls the style of the control's outer border

Retrieves or sets the kind of border that is drawn around the control. Any of the values defined by the AppearanceConstants enumeration is valid.

See Also

BorderStyle, AppearanceConstants

OLE_COLOR BackColor

getset

Specifies the control's background color

Retrieves or sets the control's background color. If set to -1, the system's default color is used.

See Also

IStatusBarPanel::ForeColor

BorderStyleConstants BorderStyle

getset

Controls the style of the control's inner border

Retrieves or sets the kind of inner border that is drawn around the control. Any of the values defined by the BorderStyleConstants enumeration is valid.

See Also

Appearance, BorderStyleConstants

BSTR CustomCapsLockText

getset

Specifies the custom text displayed by panels that display the status of the CAPS LOCK key

Retrieves or sets the text being used for panels whose Content property is set to pcCapsLock. If set to an empty string, the key's localized name is used.

See Also

IStatusBarPanel::Content, IStatusBarPanel::Text, CustomInsertKeyText, CustomKanaLockText, CustomNumLockText, CustomScrollLockText

BSTR CustomInsertKeyText

getset

Specifies the custom text displayed by panels that display the status of the INS key

Retrieves or sets the text being used for panels whose Content property is set to pcInsertKey. If set to an empty string, the key's localized name is used.

See Also

IStatusBarPanel::Content, IStatusBarPanel::Text, CustomCapsLockText, CustomKanaLockText, CustomNumLockText, CustomScrollLockText

BSTR CustomKanaLockText

getset

Specifies the custom text displayed by panels that display the status of the KANA LOCK key

Retrieves or sets the text being used for panels whose Content property is set to pcKanaLock. If set to an empty string, the key's localized name is used.

See Also

IStatusBarPanel::Content, IStatusBarPanel::Text, CustomCapsLockText, CustomInsertKeyText, CustomNumLockText, CustomScrollLockText

BSTR CustomNumLockText

getset

Specifies the custom text displayed by panels that display the status of the NUM LOCK key

Retrieves or sets the text being used for panels whose Content property is set to pcNumLock. If set to an empty string, the key's localized name is used.

See Also

IStatusBarPanel::Content, IStatusBarPanel::Text, CustomCapsLockText, CustomInsertKeyText, CustomKanaLockText, CustomScrollLockText

BSTR CustomScrollLockText

getset

Specifies the custom text displayed by panels that display the status of the SCROLL LOCK key

Retrieves or sets the text being used for panels whose Content property is set to pcScrollLock. If set to an empty string, the key's localized name is used.

See Also

IStatusBarPanel::Content, IStatusBarPanel::Text, CustomCapsLockText, CustomInsertKeyText, CustomKanaLockText, CustomNumLockText

DisabledEventsConstants DisabledEvents

getset

Controls which events are fired

Retrieves or sets the events that won't be fired. Disabling events increases performance. Any combination of the values defined by the DisabledEventsConstants enumeration is valid.

See Also

DisabledEventsConstants

VARIANT_BOOL DontRedraw

getset

Controls redrawing of the control

Enables or disables automatic redrawing of the control. Disabling redraw while doing large changes on the control (like adding many panels) may increase performance. If set to False, the control will redraw itself automatically; otherwise not.

VARIANT_BOOL Enabled

getset

Controls whether the control accepts user input

Enables or disables the control for user input. If set to True, it reacts to user input; otherwise not.

IFontDisp Font

getset

Specifies the control's font

Retrieves or sets the control's font. It's used to draw the panels' text.

See Also

UseSystemFont, IStatusBarPanel::Text

VARIANT_BOOL ForceSizeGripperDisplay

getset

Controls visibility of the size gripper

Retrieves or sets whether the control displays the size gripper in situations where the parent window's and the control's window styles would lead to the size gripper not being displayed.

Attention

Changing this property destroys and recreates the control.

LONG HoverTime

getset

Controls when the MouseHover event is fired

Retrieves or sets the number of milliseconds the mouse cursor must be located over the control's client area before the MouseHover event is fired. If set to -1, the system hover time is used.

See Also

_IStatusBarEvents::MouseHover

OLE_HANDLE hWnd

get

Retrieves the control's window handle

Retrieves the control's window handle.

Remarks

This property is read-only.

See Also

_IStatusBarEvents::RecreatedControlWindow, _IStatusBarEvents::DestroyedControlWindow

OLE_YSIZE_PIXELS MinimumHeight

getset

Specifies the control's minimum height

Retrieves or sets the minimum height (in pixels) of the control's drawing area.

Remarks

The drawing area's actual height depends on the selected font.

See Also

Font

IPictureDisp MouseIcon

getset

Controls the control's mouse cursor

Retrieves or sets a user-defined mouse cursor. It's used if MousePointer is set to mpCustom.

See Also

MousePointer, MousePointerConstants

MousePointerConstants MousePointer

getset

Controls the control's mouse cursor

Retrieves or sets the cursor's type that's used if the mouse cursor is placed within the control's client area. Any of the values defined by the MousePointerConstants enumeration is valid.

See Also

MouseIcon, MousePointerConstants

IStatusBarPanels Panels

get

Retrieves the control's panels

Retrieves a collection object wrapping the panels.

Remarks

This property is read-only.

See Also

IStatusBarPanels

IStatusBarPanel PanelToAutoSize

getset

Specifies the panel that is auto-sized to fill up the remaining space

Retrieves or sets the panel whose width is changed automatically so that it fills up the remaining space. If set to Nothing, no panel is sized automatically.

See Also

Panels, IStatusBarPanel::PreferredWidth

VARIANT_BOOL RegisterForOLEDragDrop

getset

Controls the control's behavior in drag'n'drop operations

Retrieves or sets whether the control is registered as a target for OLE drag'n'drop. If set to True, the control accepts OLE drag'n'drop actions; otherwise not.

See Also

SupportOLEDragImages, _IStatusBarEvents::OLEDragEnter

VARIANT_BOOL RightToLeftLayout

getset

Controls the control's right-to-left features

Retrieves or sets the control's general layout. If set to True, the layout direction is right to left (e. g. the size gripper will be displayed at the control's left border); otherwise it is left to right.

See Also

IStatusBarPanel::RightToLeftText

VARIANT_BOOL ShowToolTips

getset

Specifies whether the control displays any tooltips

Enables or disables tooltips. If set to True, the control displays panel-specific tooltips; otherwise not.

Attention

Changing this property destroys and recreates the control.

See Also

IStatusBarPanel::ToolTipText, _IStatusBarEvents::SetupToolTipWindow

VARIANT_BOOL SimpleMode

getset

Specifies whether the control consists of multiple panels

Enables or disables simple mode. In simple mode, the status bar consists of a single panel. If set to True, the control is in simple mode; otherwise not.

See Also

Panels, SimplePanel, _IStatusBarEvents::ToggledSimpleMode

IStatusBarPanel SimplePanel

get

Retrieves the StatusBarPanel object used to edit the simple mode settings

Retrieves a StatusBarPanel object wrapping the control's default panel that is displayed in simple mode.

Remarks

This property is read-only.

See Also

IStatusBarPanel, SimpleMode, Panels

VARIANT_BOOL SupportOLEDragImages

getset

Controls the control's behavior in drag'n'drop operations

Retrieves or sets whether the control creates an IDropTargetHelper object, so that a drag image can be displayed during OLE drag'n'drop. If set to True, the control creates the object; otherwise not.

Remarks

Requires shell32.dll version 5.0 or higher.

See Also

RegisterForOLEDragDrop, IDropTargetHelper

VARIANT_BOOL UseSystemFont

getset

Specifies whether the control uses the system font

Retrieves or sets whether the control uses the system's default status bar font or the font specified by the Font property. If set to True, the system font; otherwise the specified font is used.

See Also

Font

BSTR Version

get

Retrieves the control's version

Remarks

This property is read-only.