cStatusBar.ctl

Project: VB6GUI
Version: 3.0.0
Report Date: 08/06/2023 12:06:14

By: Yaron Goali (WISERBIT DOT COM) for Microncode.com

User Control: cStatusBar

Properties

BackColor [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	oColor	OLE_COLOR

Procedure Attributes

Attribute	Value
Description	Gets/sets the back colour of the status bar control.

BackColor [Get] - Public (Return Datatype: OLE_COLOR)

No Parameters

Enabled [Get] - Public (Return Datatype: Boolean)

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets whether the control is enabled.

Enabled [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	bState	Boolean

Font [Get] - Public (Return Datatype: StdFont)

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets the font used to draw the status bar panels.

Font [Set] - Public

Optional	ByVal/ByRef	Variable	Datatype
		fntThis	StdFont

ImageList [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
		vThis	Variant

Procedure Attributes

Attribute	Value
Description	Associates an ImageList with the status bar. The ImageList can either be a COMCTL32.OCX image list, a vbAccelerator image list or a long hImageList handle to an image list created using the COMCTL32.DLL API.

PanelCount [Get] - Public (Return Datatype: Long)

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets the number of panels in the status bar.

PanelFitToContents [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant
	ByVal	bState	Boolean

Procedure Attributes

Attribute	Value
Description	Gets/sets whether a panel should automatically size to its contents.

PanelFitToContents [Get] - Public (Return Datatype: Boolean)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant

PanelhIcon [Get] - Public (Return Datatype: Long)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant

Procedure Attributes

Attribute	Value
Description	Gets/sets an icon handle to draw in a panel. If reading this property, do not call DestroyIcon the returned hIcon - it is a handle to the actual icon used by the control, not a copy. If setting this property, the hIcon will be automatically destroyed w

PanelhIcon [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant
	ByVal	hIcon	Long

PanelIcon [Get] - Public (Return Datatype: Long)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant

Procedure Attributes

Attribute	Value
Description	Gets/sets the 0 based index of an image in the associated image list to display in a panel.

PanelIcon [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant
	ByVal	iImgIndex	Long

PanelIdealWidth [Get] - Public (Return Datatype: Long)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant

Procedure Attributes

Attribute	Value
Description	Gets/sets the width of the panel calculated for auto-sizing panels.

PanelIdealWidth [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant
	ByVal	lWidth	Long

PanelIndex [Get] - Public (Return Datatype: Long)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant

Procedure Attributes

Attribute	Value
Description	Returns the index of a panel given the panel's key.

PanelKey [Get] - Public (Return Datatype: Variant)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lIndex	Long

Procedure Attributes

Attribute	Value
Description	Gets/sets the key used to identify a panel.

PanelKey [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lIndex	Long
	ByVal	vKey	Variant

PanelMinWidth [Get] - Public (Return Datatype: Long)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant

Procedure Attributes

Attribute	Value
Description	Gets/sets the minimum allowable width for a panel. Note that icons and the sizing grip add additional width to the minimum.

PanelSpring [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant
	ByVal	bState	Boolean

Procedure Attributes

Attribute	Value
Description	Gets/sets whether a panel springs to fit the available space. Only one panel at a time can have the spring property set to true.

PanelSpring [Get] - Public (Return Datatype: Boolean)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant

PanelStyle [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant
	ByVal	eStyle	ESTBRPanelStyle

Procedure Attributes

Attribute	Value
Description	Gets/sets the style used to draw a panel.

PanelStyle [Get] - Public (Return Datatype: ESTBRPanelStyle)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant

PanelText [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant
	ByVal	sText	String

Procedure Attributes

Attribute	Value
Description	Gets/sets the text to show in a panel.

PanelText [Get] - Public (Return Datatype: String)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant

PanelToolTipText [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant
	ByVal	sText	String

Procedure Attributes

Attribute	Value
Description	Gets/sets the tool tip text to show in a panel. Note that tool tips are only displayed for panels that have an icon and either have no text or not all text is visible in the panel.

PanelToolTipText [Get] - Public (Return Datatype: String)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant

SimpleMode [Get] - Public (Return Datatype: Boolean)

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets whether the status bar works in simple mode (a single panel only) or normal mode,

SimpleMode [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	bState	Boolean

SimpleStyle [Get] - Public (Return Datatype: ESTBRSimplePanelStyle)

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets the style used to draw the status bar when it is in Simple Mode.

SimpleStyle [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	eStyle	ESTBRSimplePanelStyle

SimpleText [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sText	String

Procedure Attributes

Attribute	Value
Description	Gets/sets the text displayed in the status bar when in simple mode. Note this text is independent of any panels added to the control.

SimpleText [Get] - Public (Return Datatype: String)

No Parameters

SizeGrip [Get] - Public (Return Datatype: Boolean)

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets whether a sizing grip will be displayed at the right-hand bottom corner of the status bar.

SizeGrip [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	bSizeGrip	Boolean

Subroutines

GetPanelRect - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant
Optional	ByRef	iLeftPixels	Long
Optional	ByRef	iTopPixels	Long
Optional	ByRef	iRightPixels	Long
Optional	ByRef	iBottomPixels	Long

Procedure Attributes

Attribute	Value
Description	Gets the outside bounding rectangle of a panel in the control.

RedrawPanel - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant

Procedure Attributes

Attribute	Value
Description	Forces a panel to redraw.

Functions

AddPanel - Public (Return Datatype: Long)

Optional	ByVal/ByRef	Variable	Datatype
Optional	ByVal	eStyle	ESTBRPanelStyle(estbrStandard)
Optional	ByVal	sText	String("")
Optional	ByVal	sToolTipText	String("")
Optional	ByVal	iImgIndex	Long(-1)
Optional	ByVal	lMinWidth	Long(64)
Optional	ByVal	bSpring	Boolean(False)
Optional	ByVal	bFitContents	Boolean(False)
Optional	ByVal	lItemData	Long(0)
Optional	ByVal	sKey	String("")
Optional	ByVal	vKeyBefore	Variant

Procedure Attributes

Attribute	Value
Description	Adds or inserts a panel to the status bar control.

RemovePanel - Public (Return Datatype: Variant)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant

Procedure Attributes

Attribute	Value
Description	Removes a panel from the control.

Event Declares

Click - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	iPanel	Long
	ByVal	x	Single
	ByVal	Y	Single
	ByVal	eButton	MouseButtonConstants

DblClick - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	iPanel	Long
	ByVal	x	Single
	ByVal	Y	Single
	ByVal	eButton	MouseButtonConstants

DrawItem - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lHDC	Long
	ByVal	iPanel	Long
	ByVal	lLeftPixels	Long
	ByVal	lTopPixels	Long
	ByVal	lRightPixels	Long
	ByVal	lBottomPixels	Long

Resize - Public

No Parameters

Timer - Public

No Parameters