cToolbar.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: cToolbar

Properties

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets the number of pixels by which to pad out buttons with the CTBAutosize property set.

AutosizeButtonPadding [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lPadding	Long

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant

Procedure Attributes

Attribute	Value
Description	Gets/sets the caption of a button.

ButtonCaption [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant
	ByVal	sCaption	String

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant

Procedure Attributes

Attribute	Value
Description	Gets/sets whether a button is checked or not (if the button has the checked or check group style)

ButtonChecked [Let] - Public

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

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Returns the number of buttons in a toolbar.

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant

Procedure Attributes

Attribute	Value
Description	Gets/sets whether a button is enabled.

ButtonEnabled [Let] - Public

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

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant

ButtonHot [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant
	ByVal	bHot	Boolean

Procedure Attributes

Attribute	Value
Description	Gets/sets whether a button in a flat toolbar appears in the hot state (i.e. looks like the mouse is over it)

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant

Procedure Attributes

Attribute	Value
Description	Gets/sets the zero based index of a button's image.

ButtonImage [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant
	ByVal	iImage	Long

ButtonIndex [Get] - Public (Return Datatype: Integer)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant

Procedure Attributes

Attribute	Value
Description	Returns the zero based index of a button given its key or position.

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	iButton	Long

Procedure Attributes

Attribute	Value
Description	Returns the key of a button given its position.

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant

Procedure Attributes

Attribute	Value
Description	Gets/sets whether a button is pressed.

ButtonPressed [Let] - Public

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

ButtonStyle [Get] - Public (Return Datatype: ECTBToolButtonSyle)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant

ButtonStyle [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant
	ByVal	eStyle	ECTBToolButtonSyle

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant

Procedure Attributes

Attribute	Value
Description	Gets/sets whether button text will be truncated if the button text is too long.

ButtonTextEllipses [Let] - Public

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

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant

Procedure Attributes

Attribute	Value
Description	Gets/sets whether the caption for a button is visible or not.

ButtonTextVisible [Let] - Public

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

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant

Procedure Attributes

Attribute	Value
Description	Gets/sets whether button text will wrap onto a newline if it is too long.

ButtonTextWrap [Let] - Public

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

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant

Procedure Attributes

Attribute	Value
Description	Gets/sets the tool tip shown for a button.

ButtonToolTip [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant
	ByVal	sToolTip	String

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant

Procedure Attributes

Attribute	Value
Description	Gets/sets whether a button is visible in the toolbar.

ButtonVisible [Let] - Public

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

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant

ButtonWidth [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant
	ByVal	lWidth	Variant

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	eButton	ECTBChevronAdditionalButtons

ChevronButton [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	eButton	ECTBChevronAdditionalButtons
	ByVal	bState	Boolean

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	eButton	ECTBChevronAdditionalButtons

ChevronButtonCaption [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	eButton	ECTBChevronAdditionalButtons
	ByVal	sCaption	String

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant

ControlStretch [Let] - Public

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

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

No Parameters

DrawStyle [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	eStyle	ECTBToolbarDrawStyle

DropDownAlign [Get] - Public (Return Datatype: ECTBDropDownAlign)

No Parameters

DropDownAlign [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	eAlign	ECTBDropDownAlign

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Returns the window handle of the control.

ImageFile [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sFile	String

Procedure Attributes

Attribute	Value
Description	Sets a bitmap file to be used as the source of the buttons images.

ImagePicture [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	picThis	StdPicture

Procedure Attributes

Attribute	Value
Description	Sets a picture object to be used as the source of the button's images.

ImagePicture [Set] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	picThis	StdPicture

ImageResourcehInstance [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	hInstance	Long

Procedure Attributes

Attribute	Value
Description	Sets the hInstance of the binary containing the resource specified in ImageResourceID.

ImageResourceID [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lResourceId	Long

Procedure Attributes

Attribute	Value
Description	Sets a resource id to be used as the source of the button's images.

ImageSource [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	eType	ECTBImageSourceTypes

Procedure Attributes

Attribute	Value
Description	Sets the type of image (file, picture, resource, image list or standard image list) to be used as the source of the button's images.

ImageStandardBitmapType [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	eType	ECTBStandardImageSourceTypes

Procedure Attributes

Attribute	Value
Description	Sets the standard image list bitmap to be used to generate the button images.

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

No Parameters

ListStyle [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	bState	Boolean

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets the maximum allowable button height.

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets the maximum allowable button width.

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

No Parameters

TitleBarModifier [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	bState	Boolean

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets the height of the toolbar.

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets the width of the toolbar.

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

No Parameters

Wrappable [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	bState	Boolean

Subroutines

AddButton - Public

Optional	ByVal/ByRef	Variable	Datatype
Optional	ByVal	sTip	String("")
Optional	ByVal	iImage	Integer(-1)
Optional	ByVal	vButtonBefore	Long(-1)
Optional	ByVal	xLarge	Integer(0)
Optional	ByVal	sButtonText	String
Optional	ByVal	eButtonStyle	ECTBToolButtonSyle
Optional	ByVal	sKey	String("")

Procedure Attributes

Attribute	Value
Description	Adds a button to the toolbar, optionally setting the buttons text, tool tip, image and style at the same time.

AddControl - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lhWnd	Long
Optional	ByVal	vButtonBefore	Variant
Optional	ByVal	sKey	String("")

Procedure Attributes

Attribute	Value
Description	Adds a control (such as a combo box) to the toolbar, optionally setting the control's key and which button it is added before.

ButtonSize - Public

Optional	ByVal/ByRef	Variable	Datatype
		xWidth	Integer
		xHeight	Integer

Procedure Attributes

Attribute	Value
Description	Gets the rectangle of a button.

ChevronPress - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	x	Long
	ByVal	Y	Long

CreateFromMenu - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByRef	cMenu	Object

Procedure Attributes

Attribute	Value
Description	Sets up a toolbar based on a cPopupMenu object so the toolbar can act as the form's menu.

CreateFromMenu2 - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByRef	cMenu	Object
Optional	ByVal	eStyle	ECTBToolbarFromMenuStyle
Optional	ByVal	sMenuParentKey	String

CreateToolbar - Public

Optional	ByVal/ByRef	Variable	Datatype
Optional		ButtonSize	Integer(16)
Optional		StyleList	Boolean
Optional		WithText	Boolean
Optional		Wrappable	Boolean
Optional		PicSize	Integer

Procedure Attributes

Attribute	Value
Description	Initialises a toolbar for use.

DestroyToolBar - Public

No Parameters

Procedure Attributes

Attribute	Value
Description	Destroys the toolbar and all resources associated with it.

GetComCtrlVersionInfo - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByRef	lMajor	Long
	ByRef	lMinor	Long
Optional	ByRef	lBuild	Long

Procedure Attributes

Attribute	Value
Description	Returns the system's COMCTL32.DLL version.

GetDropDownPosition - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	ID	Integer
	ByRef	x	Long
	ByRef	Y	Long

Procedure Attributes

Attribute	Value
Description	Returns the position to show a drop-down menu for a button in response to the DropDownPress event.

pMenuClick - Friend

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	hWndToolbar	Long
	ByVal	iButton	Long

RemoveButton - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vButton	Variant

Procedure Attributes

Attribute	Value
Description	Removes a button from the toolbar.

ResizeToolbar - Public

No Parameters

Procedure Attributes

Attribute	Value
Description	Resizes the toolbar.

SetControl - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lhWnd	Long
	ByVal	vButton	Variant

Procedure Attributes

Attribute	Value
Description	Places a control over the specified button. Similar to AddControl, but modifies an existing button.

setDroppedButton - Friend

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	iButton	Long
	ByVal	bState	Boolean

SetImageList - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vThis	Variant
Optional	ByVal	eType	ECTBImageListTypes(CTBImageListNormal)

Procedure Attributes

Attribute	Value
Description	Sets the image list to be used for standard, hot or disabled button images.

Functions

AltKeyPress - Friend (Return Datatype: Boolean)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	eKeyCode	KeyCodeConstants
	ByVal	bKeyUp	Boolean
	ByVal	bAlt	Boolean
	ByVal	bShift	Boolean

InMenuLoop - Friend (Return Datatype: Boolean)

No Parameters

RaiseButtonClick - Public (Return Datatype: Variant)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	iIDButton	Long

Procedure Attributes

Attribute	Value
Description	Causes a button click to occur.

Event Declares

ButtonClick - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lButton	Long

CustomiseBegin - Public

No Parameters

CustomiseCanDelete - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lButton	Long
	ByRef	bCanDelete	Boolean

CustomiseCanInsertBefore - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lButton	Long
	ByRef	bCanInsert	Boolean

CustomiseHelpPressed - Public

No Parameters

CustomiseResetPressed - Public

No Parameters

DropDownPress - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lButton	Long

HotItemChange - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	iNew	Long
	ByVal	iOld	Long
	ByVal	eReason	ECTBHotItemChangeReasonConstants