TimoSoft StatusBar  1.3.3.129
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Pages
IStatusBarPanel Interface Reference

Wraps an existing panel More...

Inherits IDispatch.

Public Member Functions

HRESULT GetRectangle ([in, out, defaultvalue(0)] OLE_XPOS_PIXELS *xLeft,[in, out, defaultvalue(0)] OLE_YPOS_PIXELS *yTop,[in, out, defaultvalue(0)] OLE_XPOS_PIXELS *xRight,[in, out, defaultvalue(0)] OLE_YPOS_PIXELS *yBottom)
 Retrieves the panel's bounding rectangle More...
 

Properties

AlignmentConstants Alignment [get, set]
 Controls the alignment of the panel's text More...
 
PanelBorderStyleConstants BorderStyle [get, set]
 Controls the style of the panel's border More...
 
PanelContentConstants Content [get, set]
 Specifies the type of the panel's content More...
 
LONG CurrentWidth [get]
 Retrieves the panel's current width More...
 
VARIANT_BOOL Enabled [get, set]
 Specifies whether the panel's content is drawn disabled More...
 
OLE_COLOR ForeColor [get, set]
 Specifies the panel's text color More...
 
OLE_HANDLE hIcon [get, set]
 Specifies the handle of the icon displayed in the panel More...
 
LONG Index [get]
 Retrieves the panel's zero-based index More...
 
LONG MinimumWidth [get, set]
 Specifies the panel's minimum width More...
 
LONG PanelData [get, set]
 Specifies the panel's associated data More...
 
VARIANT_BOOL ParseTabs [get, set]
 Controls processing of tabulators in the panel's text More...
 
LONG PreferredWidth [get, set]
 Specifies the panel's preferred width More...
 
VARIANT_BOOL RightToLeftText [get, set]
 Controls the control's right-to-left features More...
 
BSTR Text [get, set]
 Specifies the panel's text More...
 
BSTR ToolTipText [get, set]
 Specifies the panel's tooltip text More...
 

Detailed Description

Wraps an existing panel

This interface is a wrapper around a panel within the control.

See Also
_IStatusBarPanelEvents, IStatusBarPanels, IStatusBar, _IStatusBarEvents

Member Function Documentation

HRESULT GetRectangle ( [in, out, defaultvalue(0)] OLE_XPOS_PIXELS *  xLeft,
[in, out, defaultvalue(0)] OLE_YPOS_PIXELS *  yTop,
[in, out, defaultvalue(0)] OLE_XPOS_PIXELS *  xRight,
[in, out, defaultvalue(0)] OLE_YPOS_PIXELS *  yBottom 
)

Retrieves the panel's bounding rectangle

Retrieves the panel's bounding rectangle (in pixels) within the control's client area.

Parameters
[out]xLeftThe x-coordinate (in pixels) of the bounding rectangle's left border relative to the control's upper-left corner.
[out]yTopThe y-coordinate (in pixels) of the bounding rectangle's top border relative to the control's upper-left corner.
[out]xRightThe x-coordinate (in pixels) of the bounding rectangle's right border relative to the control's upper-left corner.
[out]yBottomThe y-coordinate (in pixels) of the bounding rectangle's bottom border relative to the control's upper-left corner.
Remarks
This method is not supported in simple mode.
See Also
PreferredWidth

Property Documentation

AlignmentConstants Alignment
getset

Controls the alignment of the panel's text

Retrieves or sets the alignment of the panel's text. Any of the values defined by the AlignmentConstants enumeration is valid.

Remarks
This property is not supported in simple mode.
See Also
Text, ParseTabs, AlignmentConstants
PanelBorderStyleConstants BorderStyle
getset

Controls the style of the panel's border

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

See Also
IStatusBar::BorderStyle, PanelBorderStyleConstants
PanelContentConstants Content
getset

Specifies the type of the panel's content

Retrieves or sets the panel's content type. Any of the values defined by the PanelContentConstants enumeration is valid.

Remarks
This property is not supported in simple mode.
See Also
PanelContentConstants
LONG CurrentWidth
get

Retrieves the panel's current width

Retrieves the panel's current width in pixels.

See Also
IStatusBar::PanelToAutoSize, PreferredWidth, MinimumWidth
VARIANT_BOOL Enabled
getset

Specifies whether the panel's content is drawn disabled

Retrieves or sets whether this panel's content is drawn disabled. If set to True, the content is drawn normal; otherwise it is drawn in disabled style.

Remarks
This property is not supported in simple mode.
See Also
hIcon, Text, Content, IStatusBar::Enabled
OLE_COLOR ForeColor
getset

Specifies the panel's text color

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

Remarks
This property is not supported in simple mode.
See Also
IStatusBar::BackColor
OLE_HANDLE hIcon
getset

Specifies the handle of the icon displayed in the panel

Retrieves or sets the panel's icon handle.

Remarks
The previously set icon does NOT get destroyed automatically.
See Also
Text, Content
LONG Index
get

Retrieves the panel's zero-based index

Retrieves a zero-based index identifying this panel.

Remarks
Adding or removing panels changes other panels' indices.
This is the default property of the IStatusBarPanel interface.
This property is read-only.
LONG MinimumWidth
getset

Specifies the panel's minimum width

Retrieves or sets the panel's minimum width in pixels. If the panel is automatically sized, its width won't decrease below the minimum width.

Remarks
This property is not supported in simple mode.
See Also
IStatusBar::PanelToAutoSize, CurrentWidth, PreferredWidth
LONG PanelData
getset

Specifies the panel's associated data

Retrieves or sets the Long value associated with the panel. Use this property to associate any data with the panel.

VARIANT_BOOL ParseTabs
getset

Controls processing of tabulators in the panel's text

Retrieves or sets whether the tabulators in this panel's text are parsed to create a multi-column panel. If set to True, the tabulators are parsed; otherwise not.

Remarks
Requires comctl32.dll version 5.80 or higher.
See Also
Text, Alignment
LONG PreferredWidth
getset

Specifies the panel's preferred width

Retrieves or sets the panel's preferred width in pixels.

Remarks
This property is not supported in simple mode.
See Also
IStatusBar::PanelToAutoSize, CurrentWidth, MinimumWidth
VARIANT_BOOL RightToLeftText
getset

Controls the control's right-to-left features

Retrieves or sets the panel's reading direction. If set to True, the panel's text reads from right to left; otherwise from left to right.

See Also
IStatusBar::RightToLeftLayout
BSTR Text
getset

Specifies the panel's text

Retrieves or sets the panel's text. Up to comctl32.dll version 6.0 the maximum number of characters in this text is 127. Beginning with comctl32.dll version 6.10 the text length isn't limited anymore.

Remarks
This is the default property of the IStatusBarPanel interface.
See Also
hIcon, Content, ParseTabs
BSTR ToolTipText
getset

Specifies the panel's tooltip text

Retrieves or sets the panel's tooltip text.

See Also
IStatusBar::ShowToolTips, _IStatusBarEvents::SetupToolTipWindow