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

User Control: cListBar

Properties

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

No Parameters

Procedure Attributes


Attribute	Value
Description	Gets/sets the background colour of the bar. The special value -1 sets the colour to the default.

BackColor [Let] - Public


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	oColor	OLE_COLOR

ButtonWidth [Get] - Public (Return Datatype: Single)

No Parameters

Procedure Attributes


Attribute	Value
Description	Gets/sets the width of buttons in the control. Use this property to set the width of the control: note the actual width will vary depending on whether the scroll bar is shown.

ButtonWidth [Let] - Public


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	fButtonWidth	Single

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

No Parameters

Procedure Attributes


Attribute	Value
Description	Gets/sets the font used to draw the items in the control.

Font [Let] - Public


Optional	ByVal/ByRef	Variable	Datatype
		fnt	StdFont

Font [Set] - Public


Optional	ByVal/ByRef	Variable	Datatype
		fnt	StdFont

ImageList [Let] - Public


Optional	ByVal/ByRef	Variable	Datatype
	ByRef	vImageList	Variant



Procedure Attributes


Attribute	Value
Description	Sets the ImageList used to draw the control. If using a VB ImageList, set to the ImageList object, otherwise if using an API-based ImageList pass in the hImageList or hIml property. Set to 0 to clear the ImageList.

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


Optional	ByVal/ByRef	Variable	Datatype
		vKey	Variant



Procedure Attributes


Attribute	Value
Description	Gets/sets the caption for the specified item.

ItemCaption [Let] - Public


Optional	ByVal/ByRef	Variable	Datatype
		vKey	Variant
	ByVal	sCaption	String

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

No Parameters

Procedure Attributes


Attribute	Value
Description	Gets the number of items in the control.

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


Optional	ByVal/ByRef	Variable	Datatype
		vKey	Variant



Procedure Attributes


Attribute	Value
Description	Gets/sets a long value associated with an item.

ItemData [Let] - Public


Optional	ByVal/ByRef	Variable	Datatype
		vKey	Variant
	ByVal	lItemData	Long

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


Optional	ByVal/ByRef	Variable	Datatype
		vKey	Variant



Procedure Attributes


Attribute	Value
Description	Gets/sets whether the specified item is enabled or not.

ItemEnabled [Let] - Public


Optional	ByVal/ByRef	Variable	Datatype
		vKey	Variant
	ByVal	bEnabled	Boolean

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


Optional	ByVal/ByRef	Variable	Datatype
		vKey	Variant



Procedure Attributes


Attribute	Value
Description	Gets/sets the 0-based index of the icon for the specified item.

ItemIcon [Let] - Public


Optional	ByVal/ByRef	Variable	Datatype
		vKey	Variant
	ByVal	lIconIndex	Long

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


Optional	ByVal/ByRef	Variable	Datatype
		vKey	Variant



Procedure Attributes


Attribute	Value
Description	Gets the index of the specified item in the control.

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


Optional	ByVal/ByRef	Variable	Datatype
		vKey	Variant



Procedure Attributes


Attribute	Value
Description	Gets/sets the key associated with the specified item in the control.

ItemKey [Let] - Public


Optional	ByVal/ByRef	Variable	Datatype
		vKey	Variant
	ByVal	sKey	String

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


Optional	ByVal/ByRef	Variable	Datatype
		vKey	Variant



Procedure Attributes


Attribute	Value
Description	Gets/sets whether an item is selected or not. Either no items or one item can be selected.

ItemSelected [Let] - Public


Optional	ByVal/ByRef	Variable	Datatype
		vKey	Variant
	ByVal	bSelected	Boolean

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


Optional	ByVal/ByRef	Variable	Datatype
		vKey	Variant



Procedure Attributes


Attribute	Value
Description	Gets/sets a string value associated with the specified item.

ItemTag [Let] - Public


Optional	ByVal/ByRef	Variable	Datatype
		vKey	Variant
	ByVal	sTag	String

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


Optional	ByVal/ByRef	Variable	Datatype
		vKey	Variant



Procedure Attributes


Attribute	Value
Description	Gets/sets the tooltip to display for the specified item.

ItemToolTip [Let] - Public


Optional	ByVal/ByRef	Variable	Datatype
		vKey	Variant
	ByVal	sToolTip	String

ScaleMode [Get] - Public (Return Datatype: ScaleModeConstants)

No Parameters

Procedure Attributes


Attribute	Value
Description	Gets/sets the scale mode used for the control.

ScaleMode [Let] - Public


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	eMode	ScaleModeConstants

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

No Parameters

Procedure Attributes


Attribute	Value
Description	Gets the selected item in the control. Use the ItemSelected property to set the selected index.

Subroutines

Add - Public


Optional	ByVal/ByRef	Variable	Datatype
Optional	ByVal	sKey	String("")
Optional	ByVal	sCaption	String("")
Optional	ByVal	lIconIndex	Long(-1)
Optional	ByVal	sToolTip	String("")
Optional	ByVal	bEnabled	Boolean(True)
Optional	ByVal	sTag("")
Optional	ByVal	lItemData(0)
Optional		KeyBefore	Variant



Procedure Attributes


Attribute	Value
Description	Adds or inserts a new item to the bar.

Clear - Public

No Parameters

Procedure Attributes


Attribute	Value
Description	Clears all items from the control.

EnsureItemVisible - Public


Optional	ByVal/ByRef	Variable	Datatype
		vKey	Variant



Procedure Attributes


Attribute	Value
Description	Ensures the specified item is in view, scrolling if required.

Remove - Public


Optional	ByVal/ByRef	Variable	Datatype
		vKey	Variant



Procedure Attributes


Attribute	Value
Description	Removes the specified item from the control.

Functions

GetControlInfo - Friend (Return Datatype: Long)


Optional	ByVal/ByRef	Variable	Datatype
		pCI	CONTROLINFO

OnMnemonic - Friend (Return Datatype: Long)


Optional	ByVal/ByRef	Variable	Datatype
		pMsg	Msg

Event Declares

BarRightClick - Public


Optional	ByVal/ByRef	Variable	Datatype
		x	Single
		y	Single

ItemClick - Public


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lIndex	Long

ItemRightClick - Public


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lIndex	Long
		x	Single
		y	Single

KeyDown - Public


Optional	ByVal/ByRef	Variable	Datatype
		KeyCode	KeyCodeConstants
		Shift	ShiftConstants

KeyPress - Public


Optional	ByVal/ByRef	Variable	Datatype
		KeyAscii	Integer

KeyUp - Public


Optional	ByVal/ByRef	Variable	Datatype
		KeyCode	KeyCodeConstants
		Shift	ShiftConstants

MouseDown - Public


Optional	ByVal/ByRef	Variable	Datatype
		Button	MouseButtonConstants
		Shift	ShiftConstants
		x	Single
		y	Single

MouseMove - Public


Optional	ByVal/ByRef	Variable	Datatype
		Button	MouseButtonConstants
		Shift	ShiftConstants
		x	Single
		y	Single

MouseUp - Public


Optional	ByVal/ByRef	Variable	Datatype
		Button	MouseButtonConstants
		Shift	ShiftConstants
		x	Single
		y	Single

Resize - Public

No Parameters

SelectionChanged - Public


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lIndex	Long