cCombo.ctl

Project: VB6ExtraGUI
Version: 3.0.0
Report Date: 08/06/2023 12:06:10

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

User Control: cCombo

Properties

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets whether items should be regarded as sorted by the Auto-Completion code.

AutoCompleteItemsAreSorted [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	bState	Boolean

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets whether the Auto Completion code allows items not in the list to be typed in.

AutoCompleteListItemsOnly [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	bState	Boolean

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets whether the drop down portion of the control is visible.

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Sets whether the control will attempt to automatically complete the user's typing into the text box portion of the combo.

DoAutoComplete [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	bState	Boolean

DrawStyle [Get] - Public (Return Datatype: ECCXDrawMode)

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets the way in which items in the control will be drawn.

DrawStyle [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	eStyle	ECCXDrawMode

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets the width of the drop-down portion of the combo box.

DropDownWidth [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
		lWidth	Long

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

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	eStyle	ECCXExtendedStyle

Procedure Attributes

Attribute	Value
Description	Gets/sets extended style properties of the control, e.g. case sensitivity and whether images shown in the edit portion.

ExtendedStyle [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	eStyle	ECCXExtendedStyle
	ByVal	bState	Boolean

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets whether the control drops down in response to the Return key rather than F4.

ExtendedUI [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 default font used to draw the control's items.

Font [Set] - Public

Optional	ByVal/ByRef	Variable	Datatype
		fntThis	StdFont

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets the window handle of the control.

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets the window handle of the drop-down combo portion of the combo box control.

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets the window handle of the ComboBoxEx container of the combo box control.

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Returns the window handle of the Edit portion of the combo box control.

ImageList [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByRef	vThis	Variant

Procedure Attributes

Attribute	Value
Description	Associates an ImageList with the ComboBoxEx control. This can be a Microsoft COMCTL32 ImageList or any valid Image List handle.

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lIndex	Long

Procedure Attributes

Attribute	Value
Description	Gets/sets a long value associated with an item in the control's list.

ItemData [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lIndex	Long
	ByVal	lData	Long

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lIndex	Long

Procedure Attributes

Attribute	Value
Description	Gets/sets the 0-based icon index associated with an item in the control's list.

ItemIcon [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lIndex	Long
	ByVal	lIcon	Long

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lIndex	Long

Procedure Attributes

Attribute	Value
Description	Gets/sets the 0-based icon index to be used when the item is selected associated with an item in the control's list.

ItemIconSelected [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lIndex	Long
	ByVal	lIcon	Long

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lIndex	Long

Procedure Attributes

Attribute	Value
Description	Gets/sets the indentation of an item in the control's list. Indentation is set in multiples of the ImageList icon size, or defaulting to 16 pixels if there is no ImageList.

ItemIndent [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lIndex	Long
	ByVal	lIndent	Long

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lIndex	Long

Procedure Attributes

Attribute	Value
Description	Gets/sets the text for a list item in the control.

List [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lIndex	Long
	ByVal	sItem	String

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

No Parameters

Procedure Attributes

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

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets the currently selected item in the control.

ListIndex [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lIndex	Long

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets the maximum length of text which can be typed into the edit portion of the control.

MaxLength [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lLength	Long

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets the ListIndex of the last item added to the control.

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets whether the control redraws itself in response to changes. Set to False to speed up the addition of items.

Redraw [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	bState	Boolean

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets the length of the selected text in the control.

SelLength [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lLength	Long

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets the 0-based index of the first selected character in the text portion of the control.

SelStart [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lStart	Long

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets the selected text from the text portion of the control.

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

No Parameters

Procedure Attributes

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

Sorted [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	bState	Boolean

Style [Get] - Public (Return Datatype: ECCXComboStyle)

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets whether the control appears as a Drop-Down Combo, a Drop-Down List or a Simple Combo.

Style [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	eStyle	ECCXComboStyle

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets the text in the text portion of the control.

Text [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sText	String

Subroutines

AddItem - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sText	String

Procedure Attributes

Attribute	Value
Description	Adds an item to the list.

AddItemAndData - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sText	String
Optional	ByVal	iIcon	Long(-1)
Optional	ByVal	iIconSelected	Long(-1)
Optional	ByVal	lItemData	Long(0)
Optional	ByVal	lIndent	Long(0)

Procedure Attributes

Attribute	Value
Description	Adds an item to the list, optionally setting other properties at the same time. Quicker if you want to set multiple properties for each item being added.

AutoCompleteKeyPress - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByRef	iKeyAscii	Integer

Procedure Attributes

Attribute	Value
Description	The code automatically run in response to a key down when DoAutoComplete is set True.

Clear - Public

No Parameters

Procedure Attributes

Attribute	Value
Description	Removes all items from the ComboBox's list.

InsertItem - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sText	String
Optional	ByVal	lIndexBefore	Long(-1)

Procedure Attributes

Attribute	Value
Description	Same as AddItem but instead Inserts the item into the control.

InsertItemAndData - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sText	String
Optional	ByVal	lIndexBefore	Long(-1)
Optional	ByVal	iIcon	Long(-1)
Optional	ByVal	iIconSelected	Long(-1)
Optional	ByVal	lItemData	Long(0)
Optional	ByVal	lIndent	Long(0)

Procedure Attributes

Attribute	Value
Description	Same as AddItemAndData but instead inserts the item and associated information into the control.

RemoveItem - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lIndex	Long

Procedure Attributes

Attribute	Value
Description	Removes an Item from the control.

ShowDropDown - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	bState	Boolean

Procedure Attributes

Attribute	Value
Description	Forces the drop-down portion of the control to show.

Functions

FindItemIndex - Public (Return Datatype: Long)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sToFind	String
Optional	ByVal	bExactMatch	Boolean(False)

Procedure Attributes

Attribute	Value
Description	Attempts to find the specified item, either exactly matching or partially matching, and returns the index if found or -1 otherwise.

TranslateAccelerator - Friend (Return Datatype: Long)

Optional	ByVal/ByRef	Variable	Datatype
		lpMsg	Msg

Event Declares

AutoCompleteSelection - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sItem	String
	ByVal	lIndex	Long

BeginEdit - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	iIndex	Long

Change - Public

No Parameters

Click - Public

No Parameters

CloseUp - Public

No Parameters

DblClick - Public

No Parameters

DrawItem - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	ItemIndex	Long
	ByVal	hDC	Long
	ByVal	bSelected	Boolean
	ByVal	bEnabled	Boolean
	ByVal	LeftPixels	Long
	ByVal	TopPixels	Long
	ByVal	RightPixels	Long
	ByVal	BottomPixels	Long
	ByVal	hFntOld	Long

DropDown - Public

No Parameters

EndEdit - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	iIndex	Long
	ByVal	bChanged	Boolean
	ByVal	sText	String
	ByVal	eWHy	ECCXEndEditReason
	ByVal	iNewIndex	Long

KeyDown - Public

Optional	ByVal/ByRef	Variable	Datatype
		KeyCode	Integer
		Shift	Integer

KeyPress - Public

Optional	ByVal/ByRef	Variable	Datatype
		KeyAscii	Integer

KeyUp - Public

Optional	ByVal/ByRef	Variable	Datatype
		KeyCode	Integer
		Shift	Integer

RequestDropDownResize - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByRef	lLeft	Long
	ByRef	lTop	Long
	ByRef	lRight	Long
	ByRef	lBottom	Long
	ByRef	bCancel	Boolean