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

Manages a collection of StatusBarPanel objects More...

Inherits IDispatch.

Public Member Functions

HRESULT Add ([in] BSTR panelText,[in] LONG PreferredWidth,[in, defaultvalue(pcText)] PanelContentConstants Content,[in, defaultvalue(alLeft)] AlignmentConstants Alignment,[in, defaultvalue(pbsSunken)] PanelBorderStyleConstants BorderStyle,[in, defaultvalue(0)] LONG PanelData,[in, defaultvalue(-1)] LONG insertAt,[out, retval] IStatusBarPanel **ppAddedPanel)
 Adds a panel to the status bar More...
 
HRESULT Count ([out, retval] LONG *pValue)
 Counts the panels in the collection More...
 
HRESULT Remove ([in] LONG panelIndex)
 Removes the specified panel in the collection from the status bar More...
 
HRESULT RemoveAll (void)
 Removes all panels in the collection from the status bar More...
 

Properties

IStatusBarPanel Item ([in] LONG panelIndex) [get]
 Retrieves a StatusBarPanel object from the collection More...
 

Detailed Description

Manages a collection of StatusBarPanel objects

This interface provides easy access (including filtering) to collections of StatusBarPanel objects. A StatusBarPanels object is used to group panels that have certain properties in common.

See Also
_IStatusBarPanelsEvents, IStatusBarPanel, IStatusBar

Member Function Documentation

HRESULT Add ( [in] BSTR  panelText,
[in] LONG  PreferredWidth,
[in, defaultvalue(pcText)] PanelContentConstants  Content,
[in, defaultvalue(alLeft)] AlignmentConstants  Alignment,
[in, defaultvalue(pbsSunken)] PanelBorderStyleConstants  BorderStyle,
[in, defaultvalue(0)] LONG  PanelData,
[in, defaultvalue(-1)] LONG  insertAt,
[out, retval] IStatusBarPanel **  ppAddedPanel 
)

Adds a panel to the status bar

Adds a panel with the specified properties at the specified position in the control and returns a StatusBarPanel object wrapping the inserted panel.

Parameters
[in]panelTextThe new 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.
[in]preferredWidthThe new panel's preferred width in pixels.
[in]contentThe new panel's content type. Any of the values defined by the PanelContentConstants enumeration is valid.
[in]alignmentThe alignment of the new panel's text. Any of the values defined by the AlignmentConstants enumeration is valid.
[in]borderStyleThe kind of border that is drawn around the new panel. Any of the values defined by the PanelBorderStyleConstants enumeration is valid.
[in]panelDataA Long value that will be associated with the panel.
[in]insertAtThe new panel's zero-based index. If set to -1, the panel will be inserted as the last panel.
Returns
The inserted panel.
See Also
Count, Remove, RemoveAll, IStatusBarPanel::Text, IStatusBarPanel::PreferredWidth, IStatusBarPanel::Content, IStatusBarPanel::Alignment, IStatusBarPanel::BorderStyle, IStatusBarPanel::PanelData, IStatusBarPanel::Index, IStatusBar::PanelToAutoSize, PanelContentConstants, AlignmentConstants, PanelBorderStyleConstants
HRESULT Count ( [out, retval] LONG *  pValue)

Counts the panels in the collection

Retrieves the number of StatusBarPanel objects in the collection.

Returns
The number of elements in the collection.
See Also
Add, Remove, RemoveAll
HRESULT Remove ( [in] LONG  panelIndex)

Removes the specified panel in the collection from the status bar

Parameters
[in]panelIndexA value that identifies the status bar panel to be removed.
Remarks
The control always contains at least one panel.
See Also
Add, Count, RemoveAll
HRESULT RemoveAll ( void  )

Removes all panels in the collection from the status bar

Remarks
The control always contains at least one panel.
See Also
Add, Count, Remove

Property Documentation

IStatusBarPanel Item([in] LONG panelIndex)
get

Retrieves a StatusBarPanel object from the collection

Retrieves a StatusBarPanel object from the collection that wraps the panel identified by panelIndex.

Parameters
[in]panelIndexA value that identifies the status bar panel to be retrieved.
Remarks
This is the default property of the IStatusBarPanels interface.
This property is read-only.
See Also
IStatusBarPanel, Add, Remove