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

Properties

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets whether the tabs appear as buttons instead of tabs. If set at run-time, call the Rebuild method to recreate the control with the new style.

Buttons [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	bState	Boolean

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets the height of the client area of the tab control.

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets the left position of the client area of the tab control.

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets the top position of the client area of the tab control.

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets the width of the client area of the tab control.

CoolTabs [Get] - Public (Return Datatype: ETabCoolTabStyle)

No Parameters

CoolTabs [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	eState	ETabCoolTabStyle

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

No Parameters

Procedure Attributes

Attribute	Value
Description	If the tab control has the Buttons style set, gets/sets whether the buttons are flat. If set at run-time, call the Rebuild method to recreate the control with the new style.

FlatButtons [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	bState	Boolean

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

No Parameters

Procedure Attributes

Attribute	Value
Description	If the tab control has the Buttons and FlatButtons styles set, gets/sets whether a flat toolbar-style separator is displayed between the buttons. If set at run-time, call the Rebuild method to recreate the control with the new style.

FlatSeparators [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 by the tab control.

Font [Set] - Public

Optional	ByVal/ByRef	Variable	Datatype
		sFont	StdFont

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets whether tab control tracks the mouse and highlights tabs pointed to by the cursor or not. If set at run-time, call the Rebuild method to recreate the control with the new style.

HotTrack [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	bState	Boolean

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets the Window handle of the control. Use TabCtrlhWnd if you want the hWnd of the tab itself.

ImageList [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByRef	vImageList	Variant

Procedure Attributes

Attribute	Value
Description	Associates an Image List with the control. Use either a COMCTL32.OCX Image List, a vbAccelerator Image List or COMCTL32.DLL hImageList handle as the parameter.

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant

Procedure Attributes

Attribute	Value
Description	Gets the numeric index of a tab given the key.

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets whether tabs appear on more than one line or not. If changed at run-time, call the Rebuild method to recreate the control with the new style.

MultiLine [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	bState	Boolean

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

No Parameters

OwnerDraw [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	bState	Boolean

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets whether text in the tabs in the control is right aligned. If set at run-time, call the Rebuild method to recreate the control with the new style.

RightJustify [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	bState	Boolean

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets the index of the selected tab.

TabAlign [Get] - Public (Return Datatype: ETabAlignConstants)

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets the alignment of the tabs in the control (left, top, right or bottom). If changed at run-time, call the Rebuild method to make the alignment change take effect.

TabAlign [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	eAlign	ETabAlignConstants

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

No Parameters

Procedure Attributes

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

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

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets the hWnd of the Tab Control.

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant

TabImage [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 the image list image to display for a tab.

TabImage [Let] - Public

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

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant

Procedure Attributes

Attribute	Value
Description	Gets/sets a long value to associate with a tab.

TabItemData [Let] - Public

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

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lIndex	Long

Procedure Attributes

Attribute	Value
Description	Gets/sets the key to associate with a tab.

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

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant

Procedure Attributes

Attribute	Value
Description	Gets/sets the text which appears in a tab.

Subroutines

AddTab - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sText	String
Optional	ByVal	iIconIndex	Long(-1)
Optional	ByVal	vKeyBefore	Long(-1)
Optional	ByVal	sKey	String
Optional	ByVal	lItemData	Long

Procedure Attributes

Attribute	Value
Description	Adds or inserts a tab.

Rebuild - Public

No Parameters

Procedure Attributes

Attribute	Value
Description	Rebuilds the tab control. Use this if you change any of the style properties at run-time to allow the style change to take effect.

RemoveAllTabs - Public

No Parameters

Procedure Attributes

Attribute	Value
Description	Removes all tabs from the control.

RemoveTab - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant

Procedure Attributes

Attribute	Value
Description	Removes a tab from the control.

SelectTab - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant
Optional	ByVal	bNoEvents	Boolean(False)

Procedure Attributes

Attribute	Value
Description	Selects a tab in the control.

SetPadding - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	xPixels	Long
	ByVal	yPixels	Long

Functions

TranslateAccelerator - Friend (Return Datatype: Long)

Optional	ByVal/ByRef	Variable	Datatype
		lpMsg	VBOleGuids.Msg

Event Declares

BeforeClick - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lTab	Long
	ByRef	bCancel	Boolean

DrawItem - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lTab	Long
	ByVal	hdc	Long
	ByVal	bSelected	Boolean
	ByVal	bHot	Boolean
		LeftPixels	Long
		TopPixels	Long
		RightPixels	Long
		BottomPixels	Long
	ByRef	bDoDefault	Boolean

MeasureItem - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lTab	Long
	ByRef	WidthPixels	Long
	ByRef	HeightPixels	Long
	ByRef	bDoDefault	Boolean

TabClick - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lTab	Long

TabRightClick - Public

No Parameters