The main interface More...

Public Member Functions
HRESULT	About (void)
	Displays the control's credits
HRESULT	AutoSize (void)
	Advises the control to resize itself to the best extent
HRESULT	CountAcceleratorOccurrences ([in] SHORT accelerator,[out, retval] LONG *pCount)
	Counts the buttons that use the specified character as accelerator character
HRESULT	CreateButtonContainer ([in, optional] VARIANT Buttons,[out, retval] IToolBarButtonContainer **ppContainer)
	Creates a new `ToolBarButtonContainer` object
HRESULT	Customize (void)
	Displays a dialog that allows customizing the tool bar
HRESULT	DisplayChevronPopupWindow ([in] OLE_XPOS_PIXELS x,[in] OLE_YPOS_PIXELS y)
	Creates and displays a popup window with the hidden tool bar buttons
HRESULT	GetClosestInsertMarkPosition ([in] OLE_XPOS_PIXELS x,[in] OLE_YPOS_PIXELS y,[in, out] InsertMarkPositionConstants relativePosition,[in, out] IToolBarButton toolButton,[in, out, defaultvalue(0)] VARIANT_BOOL isOverButton)
	Proposes a position for the control's insertion mark
HRESULT	GetCommandForHotkey ([in] ModifierKeysConstants modifierKeys,[in] SHORT acceleratorKeyCode,[out, retval] LONG *pCommandID)
	Retrieves the command ID that is registered for the specified shortcut key combination
HRESULT	GetInsertMarkPosition ([in, out] InsertMarkPositionConstants relativePosition,[in, out] IToolBarButton *toolButton)
	Retrieves the position of the control's insertion mark
HRESULT	HitTest ([in] OLE_XPOS_PIXELS x,[in] OLE_YPOS_PIXELS y,[in, out] HitTestConstants hitTestDetails,[out, retval] IToolBarButton *ppHitButton)
	Hit-tests the specified point
HRESULT	HitTestChevronToolBar ([in] OLE_XPOS_PIXELS x,[in] OLE_YPOS_PIXELS y,[in, out] HitTestConstants hitTestDetails,[out, retval] IToolBarButton *ppHitButton)
	Hit-tests the specified point
HRESULT	LoadDefaultImages ([in] SystemImageListTypeConstants imageListType,[out, retval] LONG *pImageCount)
	Loads a system's default image list
HRESULT	LoadSettingsFromFile ([in] BSTR file,[out, retval] VARIANT_BOOL *pSucceeded)
	Loads the control's settings from the specified file
HRESULT	LoadToolBarStateFromRegistry ([in] BSTR subKeyName,[in] BSTR valueName,[in, defaultvalue(0x80000001)] OLE_HANDLE hParentKey,[out, retval] VARIANT_BOOL *pSucceeded)
	Loads the control's state from the specified value in the registry
HRESULT	OLEDrag ([in, defaultvalue(NULL)] LONG pDataObject,[in, defaultvalue(odeCopyOrMove)] OLEDropEffectConstants supportedEffects,[in, defaultvalue(-1)] OLE_HANDLE hWndToAskForDragImage,[in, defaultvalue(NULL)] IToolBarButtonContainer draggedButtons,[in, defaultvalue(-1)] LONG itemCountToDisplay,[out, retval] OLEDropEffectConstants *pPerformedEffects)
	Enters OLE drag'n'drop mode
HRESULT	Refresh (void)
	Advises the control to redraw itself
HRESULT	RegisterHotkey ([in] ModifierKeysConstants modifierKeys,[in] SHORT acceleratorKeyCode,[in] LONG commandID)
	Connects a command ID with a shortcut key combination
HRESULT	SaveSettingsToFile ([in] BSTR file,[out, retval] VARIANT_BOOL *pSucceeded)
	Saves the control's settings to the specified file
HRESULT	SaveToolBarStateToRegistry ([in] BSTR subKeyName,[in] BSTR valueName,[in, defaultvalue(0x80000001)] OLE_HANDLE hParentKey,[out, retval] VARIANT_BOOL *pSucceeded)
	Saves the control's state to the specified value in the registry
HRESULT	SetButtonRowCount ([in] LONG rowCount,[in, defaultvalue(-1)] VARIANT_BOOL allowMoreRows,[in, out, defaultvalue(0)] OLE_XSIZE_PIXELS controlWidth,[in, out, defaultvalue(0)] OLE_YSIZE_PIXELS controlHeight)
	Sets the number of rows used to display the tool bar buttons
HRESULT	SetHotButton ([in] IToolBarButton newHotButton,[in, defaultvalue(hbccbOther)] HotButtonChangingCausedByConstants hotButtonChangeReason,[in, defaultvalue(0)] HotButtonChangingAdditionalInfoConstants additionalInfo,[out, retval] IToolBarButton *ppPreviousHotButton)
	Sets the control's hot button
HRESULT	SetInsertMarkPosition ([in] InsertMarkPositionConstants relativePosition,[in] IToolBarButton *toolButton)
	Sets the position of the control's insertion mark
HRESULT	UnregisterHotkey ([in] ModifierKeysConstants modifierKeys,[in] SHORT acceleratorKeyCode)
	Disconnects a command ID from a shortcut key combination
Properties
VARIANT_BOOL	AllowCustomization `[get, set]`
	Specifies whether the tool bar can be customized
VARIANT_BOOL	AlwaysDisplayButtonText `[get, set]`
	Specifies whether button texts are always displayed
VARIANT_BOOL	AnchorHighlighting `[get, set]`
	Controls the highlighting of buttons
AppearanceConstants	Appearance `[get, set]`
	Controls the style of the control's outer border
SHORT	AppID `[get]`
BSTR	AppName `[get]`
BSTR	AppShortName `[get]`
BackStyleConstants	BackStyle `[get, set]`
	Specifies how the control's background is drawn
BorderStyleConstants	BorderStyle `[get, set]`
	Controls the style of the control's inner border
LONG	Build `[get]`
OLE_YSIZE_PIXELS	ButtonHeight `[get, set]`
	Controls the buttons' height
LONG	ButtonRowCount `[get]`
	Retrieves the number of rows used to display the tool bar buttons
IToolBarButtons	Buttons `[get]`
	Retrieves the control's buttons
ButtonStyleConstants	ButtonStyle `[get, set]`
	Controls the buttons' appearance
ButtonTextPositionConstants	ButtonTextPosition `[get, set]`
	Controls the layout of the button captions
OLE_XSIZE_PIXELS	ButtonWidth `[get, set]`
	Controls the buttons' width
BSTR	CharSet `[get]`
VARIANT_BOOL	CommandEnabled ([in] LONG commandID) `[get, set]`
	Controls whether the specified command can be executed
DisabledEventsConstants	DisabledEvents `[get, set]`
	Controls which events are fired
VARIANT_BOOL	DisplayMenuDivider `[get, set]`
	Specifies whether a thin line is drawn on top of the control
VARIANT_BOOL	DisplayPartiallyClippedButtons `[get, set]`
	Specifies whether buttons, that are partially clipped, are displayed
VARIANT_BOOL	DontRedraw `[get, set]`
	Controls redrawing of the control
LONG	DragClickTime `[get, set]`
	Controls the speed of automatic button clicking during drag'n'drop
DragDropCustomizationModifierKeyConstants	DragDropCustomizationModifierKey `[get, set]`
	Specifies how the tool bar can be customized using drag'n'drop
IToolBarButtonContainer	DraggedButtons `[get]`
	Retrieves the buttons currently dragged
OLE_XSIZE_PIXELS	DropDownGap `[get, set]`
	Controls the buttons' inner layout
VARIANT_BOOL	Enabled `[get, set]`
	Controls whether the control accepts user input
OLE_XSIZE_PIXELS	FirstButtonIndentation `[get, set]`
	Controls the buttons' alignment
VARIANT_BOOL	FocusOnClick `[get, set]`
	Controls when the control accepts the keyboard focus
IFontDisp	Font `[get, set]`
	Specifies the control's font
OLE_HANDLE	hChevronMenu `[get]`
	Retrieves the window handle of the tool bar that is displayed as part of the chevron popup window
OLE_COLOR	HighlightColor `[get, set]`
	Specifies the control's 3D highlight color
OLE_HANDLE	hImageList ([in] ImageListConstants imageList,[in, defaultvalue(0)] LONG imageListIndex) `[get, set]`
	Specifies one of the control's associated imagelist
OLE_XSIZE_PIXELS	HorizontalButtonPadding `[get, set]`
	Controls the buttons' inner layout
OLE_XSIZE_PIXELS	HorizontalButtonSpacing `[get, set]`
	Controls the buttons' alignment
OLE_XSIZE_PIXELS	HorizontalIconCaptionGap `[get, set]`
	Controls the buttons' inner layout
HAlignmentConstants	HorizontalTextAlignment `[get, set]`
	Controls the horizontal alignment of the button texts
IToolBarButton	HotButton `[get, set]`
	Specifies the control's hot button
LONG	HoverTime `[get, set]`
	Controls when the `MouseHover` event is fired
OLE_HANDLE	hWnd `[get]`
	Retrieves the control's window handle
OLE_HANDLE	hWndChevronToolBar `[get]`
	Retrieves the window handle of the tool bar that is displayed as part of the chevron popup window
OLE_HANDLE	hWndToolTip `[get, set]`
	Specifies the tooltip control's window handle
OLE_YSIZE_PIXELS	IdealHeight `[get]`
	Retrieves the control's ideal height
OLE_XSIZE_PIXELS	IdealWidth `[get]`
	Retrieves the control's ideal width
LONG	ImageListCount `[get]`
	Retrieves the number of image lists associated with the control
OLE_COLOR	InsertMarkColor `[get, set]`
	Specifies the color of the control's insertion mark
VARIANT_BOOL	IsRelease `[get]`
OLE_XSIZE_PIXELS	MaximumButtonWidth `[get, set]`
	Controls the buttons' width
OLE_YSIZE_PIXELS	MaximumHeight `[get]`
	Retrieves the control's maximum height
LONG	MaximumTextRows `[get, set]`
	Controls the drawing of button texts
OLE_XSIZE_PIXELS	MaximumWidth `[get]`
	Retrieves the control's maximum width
MenuBarThemeConstants	MenuBarTheme `[get, set]`
	Controls the control's appearance in menu mode
VARIANT_BOOL	MenuMode `[get, set]`
	Specifies whether the control is used as a menu bar replacement
OLE_XSIZE_PIXELS	MinimumButtonWidth `[get, set]`
	Controls the buttons' width
IPictureDisp	MouseIcon `[get, set]`
	Controls the control's mouse cursor
MousePointerConstants	MousePointer `[get, set]`
	Controls the control's mouse cursor
VARIANT_BOOL	MultiColumn `[get, set]`
	Specifies whether the buttons are organized in multiple columns if the control's orientation is vertical
IUnknown	NativeDropTarget `[get]`
	Retrieves the native tool bar control's `IDropTarget` implementation
NormalDropDownButtonStyleConstants	NormalDropDownButtonStyle `[get, set]`
	Controls the appearance of drop-down buttons
OLEDragImageStyleConstants	OLEDragImageStyle `[get, set]`
	Specifies the appearance of the OLE drag images generated by the control
OrientationConstants	Orientation `[get, set]`
	Controls the control's orientation
VARIANT_BOOL	ProcessContextMenuKeys `[get, set]`
	Specifies whether the `ContextMenu` event can be invoked using the keyboard
BSTR	Programmer `[get]`
VARIANT_BOOL	RaiseCustomDrawEventOnEraseBackground `[get, set]`
	Specifies whether the `CustomDraw` event is raised when erasing the control's background
RegisterForOLEDragDropConstants	RegisterForOLEDragDrop `[get, set]`
	Controls the control's behavior in drag'n'drop operations
RightToLeftConstants	RightToLeft `[get, set]`
	Controls the control's right-to-left features
OLE_COLOR	ShadowColor `[get, set]`
	Specifies the control's 3D shadow color
VARIANT_BOOL	ShowDragImage `[get, set]`
	Controls the visibility of the control's drag image
VARIANT_BOOL	ShowToolTips `[get, set]`
	Specifies whether the control displays any tooltips
SuggestedIconSizeConstants	SuggestedIconSize `[get]`
	Retrieves which icon size should be used
VARIANT_BOOL	SupportOLEDragImages `[get, set]`
	Controls the control's behavior in drag'n'drop operations
BSTR	Tester `[get]`
VARIANT_BOOL	UseMnemonics `[get, set]`
	Specifies how ampersands in button texts are handled
VARIANT_BOOL	UseSystemFont `[get, set]`
	Specifies whether the control uses the system font
BSTR	Version `[get]`
	Retrieves the control's version
OLE_YSIZE_PIXELS	VerticalButtonPadding `[get, set]`
	Controls the buttons' inner layout
OLE_YSIZE_PIXELS	VerticalButtonSpacing `[get, set]`
	Controls the buttons' alignment
VAlignmentConstants	VerticalTextAlignment `[get, set]`
	Controls the vertical alignment of the button texts
VARIANT_BOOL	WrapButtons `[get, set]`
	Specifies whether buttons may be wrapped to multiple lines

Detailed Description

The main interface

This is the calendar control's main interface. It wraps the control window.

See also:: _IToolBarEvents

Member Function Documentation

HRESULT About ( void )

Displays the control's credits

Displays some information about this control and its author.

HRESULT AutoSize ( void )

Advises the control to resize itself to the best extent

See also:: IdealWidth, IdealHeight

HRESULT CountAcceleratorOccurrences	(	[in] SHORT	accelerator,
		[out, retval] LONG *	pCount
	)

Counts the buttons that use the specified character as accelerator character

Retrieves the number of tool bar buttons that use the specified character as accelerator character.

Parameters:

[in] accelerator The accelerator character for which to count the buttons.

Returns:: The number of buttons with the specified accelerator character.

See also:: IToolBarButton::Text, _IToolBarEvents::MapAccelerator

HRESULT CreateButtonContainer	(	[in, optional] VARIANT	Buttons,
		[out, retval] IToolBarButtonContainer **	ppContainer
	)

Creates a new ToolBarButtonContainer object

Retrieves a new ToolBarButtonContainer object and fills it with the specified buttons.

Parameters:

[in] buttons The button(s) to add to the collection. May be either Empty, a button ID, a ToolBarButton object or a ToolBarButtons collection.

Returns:: The created ToolBarButtonContainer object.

See also:: IToolBarButtonContainer::Clone, IToolBarButtonContainer::Add

HRESULT Customize ( void )

Displays a dialog that allows customizing the tool bar

See also:: AllowCustomization, DragDropCustomizationModifierKey, _IToolBarEvents::QueryInsertButton, _IToolBarEvents::CustomizedControl

HRESULT DisplayChevronPopupWindow	(	[in] OLE_XPOS_PIXELS	x,
		[in] OLE_YPOS_PIXELS	y
	)

Creates and displays a popup window with the hidden tool bar buttons

Creates a popup window that contains the tool bar buttons that are currently not visible and displays this window at the specified location.

Parameters:

[in]	x	The x-coordinate (in pixels relative to the screen's upper-left corner) at which the popup window will be displayed.
[in]	y	The y-coordinate (in pixels relative to the screen's upper-left corner) at which the popup window will be displayed.

See also:: _IReBarEvents::ChevronClick

HRESULT GetClosestInsertMarkPosition	(	[in] OLE_XPOS_PIXELS	x,
		[in] OLE_YPOS_PIXELS	y,
		[in, out] InsertMarkPositionConstants *	relativePosition,
		[in, out] IToolBarButton **	toolButton,
		[in, out, defaultvalue(0)] VARIANT_BOOL *	isOverButton
	)

Proposes a position for the control's insertion mark

Retrieves the insertion mark position that is closest to the specified point.

Parameters:

[in]	x	The x-coordinate (in pixels) of the point for which to retrieve the closest insertion mark position. It must be relative to the control's upper-left corner.
[in]	y	The y-coordinate (in pixels) of the point for which to retrieve the closest insertion mark position. It must be relative to the control's upper-left corner.
[out]	relativePosition	The insertion mark's position relative to the specified button. The following values, defined by the `InsertMarkPositionConstants` enumeration, are valid: `impBefore`, `impAfter`, `impNowhere`.
[out]	toolButton	The button at which the insertion mark should be displayed.
[out]	isOverButton	If `True`, the specified position is over or near the button specified by `toolButton`; otherwise it is over the control's background or outside the control's client area.

Remarks:: If toolButton is not Nothing, but relativePosition is impNowhere, the specified position is directly over the button specified by toolButton.

See also:: SetInsertMarkPosition, GetInsertMarkPosition, InsertMarkPositionConstants

HRESULT GetCommandForHotkey	(	[in] ModifierKeysConstants	modifierKeys,
		[in] SHORT	acceleratorKeyCode,
		[out, retval] LONG *	pCommandID
	)

Retrieves the command ID that is registered for the specified shortcut key combination

Retrieves the command ID that has been registered for the specified shortcut key combination.

Parameters:

[in]	modifierKeys	Specifies which modifier keys must be pressed to trigger the command. Any combination of the values specified by the `ModifierKeysConstants` enumeration is valid.
[in]	acceleratorKeyCode	Specifies the virtual key code of the key that must be pressed to trigger the command.

Returns:: The command ID that is triggered if the key combination is pressed. If no command is registered for the specified hot key, -1 is returned.

See also:: RegisterHotkey, UnregisterHotkey, _IToolBarEvents::ExecuteCommand, ModifierKeysConstants

HRESULT GetInsertMarkPosition	(	[in, out] InsertMarkPositionConstants *	relativePosition,
		[in, out] IToolBarButton **	toolButton
	)

Retrieves the position of the control's insertion mark

Parameters:

[out]	relativePosition	The insertion mark's position relative to the specified button. The following values, defined by the `InsertMarkPositionConstants` enumeration, are valid: `impBefore`, `impAfter`, `impNowhere`.
[out]	toolButton	The button at which the insertion mark is displayed.

See also:: SetInsertMarkPosition, GetClosestInsertMarkPosition, InsertMarkPositionConstants

HRESULT HitTest	(	[in] OLE_XPOS_PIXELS	x,
		[in] OLE_YPOS_PIXELS	y,
		[in, out] HitTestConstants *	hitTestDetails,
		[out, retval] IToolBarButton **	ppHitButton
	)

Hit-tests the specified point

Retrieves the control's parts that lie below the point ('x'; 'y').

Parameters:

[in]	x	The x-coordinate (in pixels) of the point to check. It must be relative to the control's upper-left corner.
[in]	y	The y-coordinate (in pixels) of the point to check. It must be relative to the control's upper-left corner.
[in,out]	hitTestDetails	Receives a value specifying the exact part of the control the specified point lies in. Any of the values defined by the `HitTestConstants` enumeration is valid.

Returns:: The tool bar button that the specified point belongs to. Nothing, if no button was "hit".

See also:: HitTestChevronToolBar, HitTestConstants

HRESULT HitTestChevronToolBar	(	[in] OLE_XPOS_PIXELS	x,
		[in] OLE_YPOS_PIXELS	y,
		[in, out] HitTestConstants *	hitTestDetails,
		[out, retval] IToolBarButton **	ppHitButton
	)

Hit-tests the specified point

Retrieves the chevron tool bar control's parts that lie below the point ('x'; 'y').

Parameters:

[in]	x	The x-coordinate (in pixels) of the point to check. It must be relative to the chevron tool bar control's upper-left corner.
[in]	y	The y-coordinate (in pixels) of the point to check. It must be relative to the chevron tool bar control's upper-left corner.
[in,out]	hitTestDetails	Receives a value specifying the exact part of the control the specified point lies in. Any of the values defined by the `HitTestConstants` enumeration is valid.

Returns:: The tool bar button that the specified point belongs to. Nothing, if no button was "hit".

See also:: HitTest, HitTestConstants

HRESULT LoadDefaultImages	(	[in] SystemImageListTypeConstants	imageListType,
		[out, retval] LONG *	pImageCount
	)

Loads a system's default image list

Loads one of the system's default image lists, so that the images can be used as button images. For valid predefined image indexes see the SystemImageIndexConstants enumeration.

Parameters:

[in] imageListType The image list to load. Any of the values specified by the SystemImageListTypeConstants enumeration is valid.

Returns:: The number of images that the loaded image list contains.

See also:: hImageList, IToolBarButton::IconIndex, SystemImageListTypeConstants, SystemImageIndexConstants

HRESULT LoadSettingsFromFile	(	[in] BSTR	file,
		[out, retval] VARIANT_BOOL *	pSucceeded
	)

Loads the control's settings from the specified file

Parameters:

[in] file The file to read from.

Returns:: True if the settings could be loaded; otherwise False.

See also:: SaveSettingsToFile, LoadToolBarStateFromRegistry

HRESULT LoadToolBarStateFromRegistry	(	[in] BSTR	subKeyName,
		[in] BSTR	valueName,
		[in, defaultvalue(0x80000001)] OLE_HANDLE	hParentKey,
		[out, retval] VARIANT_BOOL *	pSucceeded
	)

Loads the control's state from the specified value in the registry

Parameters:

[in]	subKeyName	The name of the sub key (relative to `hParentKey`) in the registry where to load the tool bar state from.
[in]	valueName	The name of the registry value where to load the tool bar state from.
[in]	hParentKey	The handle of the parent key of `subKeyName`. By default this is `HKEY_CURRENT_USER`.

Returns:: True if the state could be loaded; otherwise False.

See also:: SaveToolBarStateToRegistry, LoadSettingsFromFile

HRESULT OLEDrag	(	[in, defaultvalue(NULL)] LONG *	pDataObject,
		[in, defaultvalue(odeCopyOrMove)] OLEDropEffectConstants	supportedEffects,
		[in, defaultvalue(-1)] OLE_HANDLE	hWndToAskForDragImage,
		[in, defaultvalue(NULL)] IToolBarButtonContainer *	draggedButtons,
		[in, defaultvalue(-1)] LONG	itemCountToDisplay,
		[out, retval] OLEDropEffectConstants *	pPerformedEffects
	)

Enters OLE drag'n'drop mode

Parameters:

[in]	pDataObject	A pointer to the `IDataObject` implementation to use during OLE drag'n'drop. If not specified, the control's own implementation is used.
[in]	supportedEffects	A bit field defining all drop effects you want to support. Any combination of the values defined by the `OLEDropEffectConstants` enumeration (except `odeScroll`) is valid.
[in]	hWndToAskForDragImage	The handle of the window, that will receive the `DI_GETDRAGIMAGE` message to specify the drag image to use. If -1, the control creates the drag image itself. If `SupportOLEDragImages` is set to `False`, no drag image is used.
[in]	draggedButtons	A collection object containing the buttons to drag. This parameter is used to generate the drag image, if `hWndToAskForDragImage` is set to -1.
[in]	itemCountToDisplay	The number to display in the item count label of Aero drag images. If set to 0 or 1, no item count label is displayed. If set to -1, the number of buttons contained in the `draggedButtons` collection is displayed in the item count label. If set to any value larger than 1, this value is displayed in the item count label.

Returns:: The performed drop effect. Any of the values defined by the OLEDropEffectConstants enumeration (except odeScroll) is valid.

See also:: _IToolBarEvents::ButtonBeginDrag, _IToolBarEvents::ButtonBeginRDrag, _IToolBarEvents::OLEStartDrag, _IToolBarEvents::OLEGiveFeedback, _IToolBarEvents::OLEQueryContinueDrag, SupportOLEDragImages, OLEDragImageStyle, OLEDropEffectConstants, DI_GETDRAGIMAGE

HRESULT RegisterHotkey	(	[in] ModifierKeysConstants	modifierKeys,
		[in] SHORT	acceleratorKeyCode,
		[in] LONG	commandID
	)

Connects a command ID with a shortcut key combination

Connects a command ID with a shortcut key combination so that pressing the key combination triggers the command.

Parameters:

[in]	modifierKeys	Specifies which modifier keys must be pressed to trigger the command. Any combination of the values specified by the `ModifierKeysConstants` enumeration is valid.
[in]	acceleratorKeyCode	Specifies the virtual key code of the key that must be pressed to trigger the command.
[in]	commandID	Specifies the command to trigger if the key combination is pressed. If the command is triggered, the `ExecuteCommand` event is fired.

See also:: UnregisterHotkey, GetCommandForHotkey, _IToolBarEvents::ExecuteCommand, ModifierKeysConstants

HRESULT SaveSettingsToFile	(	[in] BSTR	file,
		[out, retval] VARIANT_BOOL *	pSucceeded
	)

Saves the control's settings to the specified file

Parameters:

[in] file The file to write to.

Returns:: True if the settings could be saved; otherwise False.

See also:: LoadSettingsFromFile, SaveToolBarStateToRegistry

HRESULT SaveToolBarStateToRegistry	(	[in] BSTR	subKeyName,
		[in] BSTR	valueName,
		[in, defaultvalue(0x80000001)] OLE_HANDLE	hParentKey,
		[out, retval] VARIANT_BOOL *	pSucceeded
	)

Saves the control's state to the specified value in the registry

Parameters:

[in]	subKeyName	The name of the sub key (relative to `hParentKey`) in the registry where to store the tool bar state.
[in]	valueName	The name of the registry value where to store the tool bar state.
[in]	hParentKey	The handle of the parent key of `subKeyName`. By default this is `HKEY_CURRENT_USER`.

Returns:: True if the state could be saved; otherwise False.

See also:: LoadToolBarStateFromRegistry, SaveSettingsToFile, _IToolBarEvents::InitializeToolBarStateRegistryStorage

HRESULT SetButtonRowCount	(	[in] LONG	rowCount,
		[in, defaultvalue(-1)] VARIANT_BOOL	allowMoreRows,
		[in, out, defaultvalue(0)] OLE_XSIZE_PIXELS *	controlWidth,
		[in, out, defaultvalue(0)] OLE_YSIZE_PIXELS *	controlHeight
	)

Sets the number of rows used to display the tool bar buttons

Sets the number of rows used to display the tool bar buttons.

Parameters:

[in]	rowCount	The number of rows that the control shall display the tool bar buttons in.
[in]	allowMoreRows	If set to `True`, the control is allowed to create more rows than specified by `rowCount`, for instance if the control's width is too small to display all buttons with the specified number of rows. If set to `False`, the control won't create more rows than specified.
[out]	controlWidth	Receives the control's width (in pixels) after the buttons have been reorganized.
[out]	controlHeight	Receives the control's height (in pixels) after the buttons have been reorganized.

Remarks:: The control does not break button groups, therefore the resulting number of rows might be different than specified.

See also:: ButtonRowCount, WrapButtons, IToolBarButton::FollowedByLineBreak

HRESULT SetHotButton	(	[in] IToolBarButton *	newHotButton,
		[in, defaultvalue(hbccbOther)] HotButtonChangingCausedByConstants	hotButtonChangeReason,
		[in, defaultvalue(0)] HotButtonChangingAdditionalInfoConstants	additionalInfo,
		[out, retval] IToolBarButton **	ppPreviousHotButton
	)

Sets the control's hot button

Sets the control's hot button. The hot button is the button under the mouse cursor. If set to Nothing, the control does not have a hot button.
Other than the HotButton property, this method allows specifying additional parameters and returns the previous hot button.

Parameters:

[in]	newHotButton	The tool bar button to set as the control's hot button. If `Nothing`, the control's hot button is cleared.
[in]	hotButtonChangeReason	The reason for changing the hot button. This value is passed to the `HotButtonChanging` event. Any combination of the values defined by the `HotButtonChangingCausedByConstants` enumeration is valid.
[in]	additionalInfo	Additional information describing the change of the hot button. This value is passed to the `HotButtonChanging` event. Any combination of the values defined by the `HotButtonChangingAdditionalInfoConstants` enumeration is valid.

Returns:: The control's previous hot button. This may be Nothing.

Remarks:: This method fails if the ButtonStyle property is set to bst3D.
Specifying the hbcaiDoDropDownClick flag in the additionalInfo parameter causes a programmatic click on the new hot button's drop-down arrow.

See also:: HotButton, ButtonStyle, _IToolBarEvents::HotButtonChanging, HotButtonChangingCausedByConstants, HotButtonChangingAdditionalInfoConstants, IToolBarButton::DropDownStyle

HRESULT SetInsertMarkPosition	(	[in] InsertMarkPositionConstants	relativePosition,
		[in] IToolBarButton *	toolButton
	)

Sets the position of the control's insertion mark

Parameters:

[in]	relativePosition	The insertion mark's position relative to the specified button. Any of the values defined by the `InsertMarkPositionConstants` enumeration is valid.
[in]	toolButton	The button at which to show the insertion mark. If set to `Nothing`, the insertion mark is removed.

See also:: GetInsertMarkPosition, GetClosestInsertMarkPosition, InsertMarkColor, RegisterForOLEDragDrop, InsertMarkPositionConstants

HRESULT UnregisterHotkey	(	[in] ModifierKeysConstants	modifierKeys,
		[in] SHORT	acceleratorKeyCode
	)

Disconnects a command ID from a shortcut key combination

Removes the connection of a shortcut key combination with a command ID so that pressing the key combination no longer triggers the command.

Parameters:

[in]	modifierKeys	Specifies which modifier keys must be pressed to trigger the command. Any combination of the values specified by the `ModifierKeysConstants` enumeration is valid.
[in]	acceleratorKeyCode	Specifies the virtual key code of the key that must be pressed to trigger the command.

See also:: RegisterHotkey, GetCommandForHotkey, ModifierKeysConstants

Property Documentation

VARIANT_BOOL AllowCustomization [get, set]

Specifies whether the tool bar can be customized

Retrieves or sets whether the control can be customized via comctl32's built-in customization features. If set to True, the built-in customization features are enabled; otherwise not.

Remarks:: The built-in customization features include a dialog for button management, that can be opened by double-clicking the control, and the capability to manage buttons using drag'n'drop.

See also:: DragDropCustomizationModifierKey, Customize

VARIANT_BOOL AlwaysDisplayButtonText [get, set]

Specifies whether button texts are always displayed

Retrieves or sets whether the visibility of button's texts can be set on a per-button basis. If set to True, the IToolBarButton::DisplayText property is ignored and button texts are always displayed; otherwise the visibility of the text depends on the setting of the IToolBarButton::DisplayText property.

Remarks:: This property is ignored, if the ButtonTextPosition is not set to btpRightToIcon.

See also:: ButtonTextPosition, IToolBarButton::Text, IToolBarButton::DisplayText

VARIANT_BOOL AnchorHighlighting [get, set]

Controls the highlighting of buttons

Retrieves or sets whether the highlighted button remains highlighted until another button is highlighted. If set to True, the highlighted button remains highlighted even if the mouse cursor is moved outside the control's client area. The button remains highligthed until another button is highlighted. If set to False, the highlighting is removed as soon as the mouse cursor leaves the button's bounding rectangle.

See also:: HotButton

AppearanceConstants Appearance [get, set]

Controls the style of the control's outer border

Retrieves or sets the kind of border that is drawn around the control. Any of the values defined by the AppearanceConstants enumeration is valid.

See also:: BorderStyle, AppearanceConstants

SHORT AppID [get]

BSTR AppName [get]

BSTR AppShortName [get]

BackStyleConstants BackStyle [get, set]

Specifies how the control's background is drawn

Retrieves or sets how the control's background is drawn. Any of the values defined by the BackStyleConstants enumeration is valid.

Remarks:: The BackStyle property should be set to bksOpaque, if the Orientation property is set to oVertical and the control is not placed inside a rebar control.

See also:: ButtonStyle, Orientation, BackStyleConstants

BorderStyleConstants BorderStyle [get, set]

Controls the style of the control's inner border

Retrieves or sets the kind of inner border that is drawn around the control. Any of the values defined by the BorderStyleConstants enumeration is valid.

See also:: Appearance, BorderStyleConstants

LONG Build [get]

OLE_YSIZE_PIXELS ButtonHeight [get, set]

Controls the buttons' height

Retrieves or sets the height (in pixels) of a button. If set to 0, the system's default button height is used.

See also:: ButtonWidth, IdealHeight

LONG ButtonRowCount [get]

Retrieves the number of rows used to display the tool bar buttons

Retrieves the number of rows used to display the tool bar buttons.

Remarks:: This property is read-only.

See also:: SetButtonRowCount, WrapButtons

IToolBarButtons Buttons [get]

Retrieves the control's buttons

Retrieves a collection object wrapping the tool bar buttons.

Remarks:: This property is read-only.

See also:: IToolBarButtons

ButtonStyleConstants ButtonStyle [get, set]

Controls the buttons' appearance

Retrieves or sets the appearance of the tool bar buttons. Any of the values defined by the ButtonStyleConstants enumeration is valid.

Remarks:: The ButtonStyle property should be set to bst3D, if the Orientation property is set to oVertical and the control is not placed inside a rebar control.

See also:: ButtonTextPosition, Orientation, ButtonStyleConstants

ButtonTextPositionConstants ButtonTextPosition [get, set]

Controls the layout of the button captions

Retrieves or sets the position of the button texts relative to the button icons. Any of the values defined by the ButtonTextPositionConstants enumeration is valid.

See also:: ButtonStyle, IToolBarButton::Text, ButtonTextPositionConstants

OLE_XSIZE_PIXELS ButtonWidth [get, set]

Controls the buttons' width

Retrieves or sets the width (in pixels) of a button. If set to 0, the system's default button width is used.

See also:: ButtonHeight, MinimumButtonWidth, MaximumButtonWidth

BSTR CharSet [get]

VARIANT_BOOL CommandEnabled [get, set]

Controls whether the specified command can be executed

Enables or disables a command for execution. If set to True, the control will fire the ExecuteCommand event if the command's associated button or menu entry is clicked or its associated hotkey is pressed; otherwise not.

Parameters:

[in] commandID The unique ID of the command to enable or disable.

Remarks:: If a tool bar button with the specified command ID exists, it will be enabled or disabled when setting this property.

See also:: Enabled, IToolBarButton::Enabled, RegisterHotkey, _IToolBarEvents::ExecuteCommand

DisabledEventsConstants DisabledEvents [get, set]

Controls which events are fired

Retrieves or sets the events that won't be fired. Disabling events increases performance. Any combination of the values defined by the DisabledEventsConstants enumeration is valid.

See also:: DisabledEventsConstants

VARIANT_BOOL DisplayMenuDivider [get, set]

Specifies whether a thin line is drawn on top of the control

Retrieves or sets whether a thin line is drawn on top of the control, that visually separates the tool bar from the menu. If set to True, the divider is displayed; otherwise not.

Attention:: Changing this property may destroy and recreate the control window.

VARIANT_BOOL DisplayPartiallyClippedButtons [get, set]

Specifies whether buttons, that are partially clipped, are displayed

Retrieves or sets whether partially clipped buttons are displayed or hidden. If set to True, partially clipped buttons are displayed; otherwise hidden.

Remarks:: This property is ignored, if the WrapButtons property is set to True.
This property cannot be set to False, if the Orientation property is set to oVertical.

See also:: Buttons, WrapButtons, Orientation, OrientationConstants

VARIANT_BOOL DontRedraw [get, set]

Controls redrawing of the control

Enables or disables automatic redrawing of the control. Disabling redraw while doing large changes on the control may increase performance. If set to False, the control will redraw itself automatically; otherwise not.

LONG DragClickTime [get, set]

Controls the speed of automatic button clicking during drag'n'drop

Retrieves or sets the number of milliseconds the mouse cursor must be placed over a button during a drag'n'drop operation before this button will be clicked automatically. If set to 0, auto-clicking is disabled. If set to -1, the system's double-click time is used.

See also:: RegisterForOLEDragDrop, _IToolBarEvents::OLEDragMouseMove

DragDropCustomizationModifierKeyConstants DragDropCustomizationModifierKey [get, set]

Specifies how the tool bar can be customized using drag'n'drop

Retrieves or sets the modifier key that must be pressed to customize the tool bar (i. e. move buttons) using drag'n'drop. Any of the values defined by the DragDropCustomizationModifierKeyConstants enumeration is valid.

Remarks:: If the AllowCustomization property is set to False, this property is ignored.

See also:: AllowCustomization, Customize, DragDropCustomizationModifierKeyConstants

IToolBarButtonContainer DraggedButtons [get]

Retrieves the buttons currently dragged

Retrieves a collection object wrapping the buttons that are currently dragged. These are the same buttons that were passed to the OLEDrag method.

Remarks:: This property is read-only.

See also:: OLEDrag, IToolBarButtonContainer, Buttons

OLE_XSIZE_PIXELS DropDownGap [get, set]

Controls the buttons' inner layout

Retrieves or sets the extra space in pixels between a button's text and its drop down section. If set to -1, the system's default value is used.

Remarks:: This property is ignored if the ButtonTextPosition property is set to a value other than btpRightToIcon or if the NormalDropDownButtonStyle property is set to a value other than nddbsSplitButton.

See also:: HorizontalButtonPadding, HorizontalIconCaptionGap, ButtonTextPosition, NormalDropDownButtonStyle

VARIANT_BOOL Enabled [get, set]

Controls whether the control accepts user input

Enables or disables the control for user input. If set to True, it reacts to user input; otherwise not.

See also:: CommandEnabled, IToolBarButton::Enabled

OLE_XSIZE_PIXELS FirstButtonIndentation [get, set]

Controls the buttons' alignment

Retrieves or sets the number of pixels between the control's left edge and the left edge of the first button in a row.

See also:: HorizontalButtonSpacing

VARIANT_BOOL FocusOnClick [get, set]

Controls when the control accepts the keyboard focus

Retrieves or sets whether the control accepts the keyboard focus always or only if it is required to support keyboard navigation. If set to True, the control accepts the keyboard focus always. If set to False, keyboard focus is accepted in the following situations:

The control is in menu mode and the user closes the currently displayed menus by pressing the [ESC] button. In this case the control will actively steal the focus. It will set the focus back to the previously focused control if the user presses the [ESC] button again.
The focus is set to the control by walking through the dialog's tab order (using the [TAB] button).

See also:: MenuMode

IFontDisp Font [get, set]

Specifies the control's font

Retrieves or sets the control's font. It's used to draw the button captions.

Remarks:: This property isn't supported for themed tool bars (except on Windows XP).

See also:: UseSystemFont

OLE_HANDLE hChevronMenu [get]

Retrieves the window handle of the tool bar that is displayed as part of the chevron popup window

The chevron popup that the control may display is a simple popup menu (if the control is in menu mode) or a popup window that contains a tool bar control. This property retrieves the handle of the popup menu.

Remarks:: This property is read-only.

See also:: hWndChevronToolBar, DisplayChevronPopupWindow

OLE_COLOR HighlightColor [get, set]

Specifies the control's 3D highlight color

Retrieves or sets the color used by the control to draw highlighted parts of tool bar buttons. If set to -1, the default color is used.

Remarks:: This property isn't supported for themed tool bars.

See also:: ShadowColor

OLE_HANDLE hImageList [get, set]

Specifies one of the control's associated imagelist

Retrieves or sets the handle of the specified imagelist.

Parameters:

[in]	imageList	The imageList to retrieve or set. Most of the values defined by the `ImageListConstants` enumeration is valid.
[in]	imageListIndex	The zero-based index of the image list of the type specified by `imageList`. The tool bar buttons' icons can be taken from different image lists, e. g. the 1st button's icon can be from image list A, the 2nd button's icon from image list B and so on.

Remarks:: The previous imagelist does NOT get auto-destroyed.

See also:: IToolBarButton::IconIndex, IToolBarButton::ImageListIndex, ImageListCount, SuggestedIconSize, ImageListConstants

OLE_XSIZE_PIXELS HorizontalButtonPadding [get, set]

Controls the buttons' inner layout

Retrieves or sets the number of pixels in horizontal direction between a button's border and its content. If set to -1, the system's default value is used.

Remarks:: Padding is applied to automatically-sized buttons only.
This property is ignored if the AlwaysDisplayButtonText property is set to False.

See also:: VerticalButtonPadding, HorizontalIconCaptionGap, HorizontalButtonSpacing, IToolBarButton::AutoSize, AlwaysDisplayButtonText

OLE_XSIZE_PIXELS HorizontalButtonSpacing [get, set]

Controls the buttons' alignment

Retrieves or sets the number of pixels between buttons in horizontal direction.

Remarks:: Requires comctl32.dll version 6.0 or higher.

See also:: VerticalButtonSpacing, HorizontalIconCaptionGap, FirstButtonIndentation, HorizontalButtonPadding

OLE_XSIZE_PIXELS HorizontalIconCaptionGap [get, set]

Controls the buttons' inner layout

Retrieves or sets the number of pixels in horizontal direction between a button's icon and its text. If set to -1, the system's default value is used.

Remarks:: This property is ignored if the ButtonTextPosition property is set to a value other than btpRightToIcon.

See also:: HorizontalButtonPadding, DropDownGap, VerticalButtonSpacing, VerticalButtonSpacing, ButtonTextPosition

HAlignmentConstants HorizontalTextAlignment [get, set]

Controls the horizontal alignment of the button texts

Retrieves or sets the horizontal alignment of the button texts. Any of the values defined by the HAlignmentConstants enumeration is valid.

See also:: VerticalTextAlignment, IToolBarButton::Text, HAlignmentConstants

IToolBarButton HotButton [get, set]

Specifies the control's hot button

Retrieves or sets the control's hot button. The hot button is the button under the mouse cursor. If set to Nothing, the control does not have a hot button.

Remarks:: This property is ignored if the ButtonStyle property is set to bst3D.

See also:: SetHotButton, IToolBarButton::Hot, _IToolBarEvents::HotButtonChanging

LONG HoverTime [get, set]

Controls when the MouseHover event is fired

Retrieves or sets the number of milliseconds the mouse cursor must be located over the control's client area before the MouseHover event is fired. If set to -1, the system hover time is used.

See also:: _IToolBarEvents::MouseHover

OLE_HANDLE hWnd [get]

Retrieves the control's window handle

Retrieves the control's window handle.

Remarks:: This property is read-only.

See also:: _IToolBarEvents::RecreatedControlWindow, _IToolBarEvents::DestroyedControlWindow

OLE_HANDLE hWndChevronToolBar [get]

Retrieves the window handle of the tool bar that is displayed as part of the chevron popup window

The chevron popup that the control may display is a simple popup menu (if the control is in menu mode) or a popup window that contains a tool bar control. This property retrieves the window handle of the tool bar control that is part of the chevron popup.

Remarks:: This property is read-only.

See also:: hChevronMenu, DisplayChevronPopupWindow, hWnd

OLE_HANDLE hWndToolTip [get, set]

Specifies the tooltip control's window handle

Retrieves or sets the tooltip control's window handle.

Remarks:: The previous tooltip window does NOT get auto-destroyed.

See also:: ShowToolTips

OLE_YSIZE_PIXELS IdealHeight [get]

Retrieves the control's ideal height

Retrieves the control's ideal height, i. e. the height at which all buttons would be displayed.

Remarks:: This property is read-only.

See also:: IdealWidth, AutoSize, MaximumHeight

OLE_XSIZE_PIXELS IdealWidth [get]

Retrieves the control's ideal width

Retrieves the control's ideal width, i. e. the width at which all buttons would be displayed.

Remarks:: This property is read-only.

See also:: IdealHeight, AutoSize, MaximumWidth

LONG ImageListCount [get]

Retrieves the number of image lists associated with the control

Remarks:: This property is read-only.

See also:: hImageList

OLE_COLOR InsertMarkColor [get, set]

Specifies the color of the control's insertion mark

Retrieves or sets the color that the control's insertion mark is drawn in.

See also:: SetInsertMarkPosition

VARIANT_BOOL IsRelease [get]

OLE_XSIZE_PIXELS MaximumButtonWidth [get, set]

Controls the buttons' width

Retrieves or sets the maximum width of a button. If this width would be exceeded, the button's text is drawn with ellipsis.

See also:: MinimumButtonWidth, ButtonWidth

OLE_YSIZE_PIXELS MaximumHeight [get]

Retrieves the control's maximum height

Retrieves the control's maximum height, i. e. the calculated total height of all visible buttons and separators together.

Remarks:: This property is read-only.

See also:: MaximumWidth, AutoSize, IdealHeight

LONG MaximumTextRows [get, set]

Controls the drawing of button texts

Retrieves or sets the maximum number of lines used to display button texts.

Remarks:: The button text is wrapped at word breaks only, line breaks are ignored.
This property is ignored if the ButtonTextPosition property is set to btpRightToIcon.

See also:: IToolBarButton::Text, ButtonTextPosition

OLE_XSIZE_PIXELS MaximumWidth [get]

Retrieves the control's maximum width

Retrieves the control's maximum width, i. e. the calculated total width of all visible buttons and separators together.

Remarks:: This property is read-only.

See also:: MaximumHeight, AutoSize, IdealWidth

MenuBarThemeConstants MenuBarTheme [get, set]

Controls the control's appearance in menu mode

Retrieves or sets how the tool bar buttons are drawn if the control is in menu mode. Any of the values defined by the MenuBarThemeConstants enumeration is valid.

See also:: MenuMode, MenuBarThemeConstants

VARIANT_BOOL MenuMode [get, set]

Specifies whether the control is used as a menu bar replacement

Retrieves or sets whether the control emulates a menu bar. If set to True, the control emulates a menu bar; otherwise not.

Remarks:

This property cannot be set at runtime.
Emulating a menu bar activates a couple of restrictions:

The AlwaysDisplayButtonText property has to be set to True.
The ButtonTextPosition property has to be set to btpRightToIcon.
The HorizontalTextAlignment property has to be set to halCenter.
The NormalDropDownButtonStyle property has to be set to nddbsWithoutArrow.
The VerticalTextAlignment property has to be set to valCenter.

See also:: MenuBarTheme, RegisterHotkey

OLE_XSIZE_PIXELS MinimumButtonWidth [get, set]

Controls the buttons' width

Retrieves or sets the minimum width of a button. Auto-sized buttons won't become smaller than this.

See also:: MaximumButtonWidth, ButtonWidth

IPictureDisp MouseIcon [get, set]

Controls the control's mouse cursor

Retrieves or sets a user-defined mouse cursor. It's used if MousePointer is set to mpCustom.

See also:: MousePointer, MousePointerConstants

MousePointerConstants MousePointer [get, set]

Controls the control's mouse cursor

Retrieves or sets the cursor's type that's used if the mouse cursor is placed within the control's client area. Any of the values defined by the MousePointerConstants enumeration is valid.

See also:: MouseIcon, MousePointerConstants

VARIANT_BOOL MultiColumn [get, set]

Specifies whether the buttons are organized in multiple columns if the control's orientation is vertical

Retrieves or sets whether the control displays the buttons in multiple columns. If set to True, the buttons are organized in multiple columns; otherwise not.

Remarks:: This property cannot be set to True, if the Orientation property is set to oHorizontal.

Attention:: Changing this property destroys and recreates the control window.

See also:: Orientation

IUnknown NativeDropTarget [get]

Retrieves the native tool bar control's IDropTarget implementation

Remarks:: This property is read-only.

See also:: RegisterForOLEDragDrop

NormalDropDownButtonStyleConstants NormalDropDownButtonStyle [get, set]

Controls the appearance of drop-down buttons

Retrieves or sets how buttons with the DropDownStyle property being set to ddstNormal are drawn. Any of the values defined by the NormalDropDownButtonStyleConstants enumeration is valid.

Attention:: Changing this property destroys and recreates the control window.

See also:: IToolBarButton::DropDownStyle, NormalDropDownButtonStyleConstants

OLEDragImageStyleConstants OLEDragImageStyle [get, set]

Specifies the appearance of the OLE drag images generated by the control

Retrieves or sets the appearance of the OLE drag images generated by the control. Any of the values defined by the OLEDragImageStyleConstants enumeration is valid.

See also:: SupportOLEDragImages, OLEDrag, OLEDragImageStyleConstants

OrientationConstants Orientation [get, set]

Controls the control's orientation

Retrieves or sets the direction, in which the control displays buttons. Any of the values defined by the OrientationConstants enumeration is valid.

Remarks:: If this property is set to oVertical, the DisplayPartiallyClippedButtons property must be set to True. Additionally the BackStyle property should be set to bksOpaque and the ButtonStyle property should be set to bst3D, if the control is not placed inside a rebar control.

Attention:: Changing this property destroys and recreates the control window.

See also:: DisplayPartiallyClippedButtons, BackStyle, ButtonStyle, MultiColumn, OrientationConstants

VARIANT_BOOL ProcessContextMenuKeys [get, set]

Specifies whether the ContextMenu event can be invoked using the keyboard

Retrieves or sets whether the control fires the ContextMenu event if the user presses [SHIFT]+[F10] or [WINDOWS CONTEXTMENU]. If set to True, the event is fired; otherwise not.

See also:: _IToolBarEvents::ContextMenu

BSTR Programmer [get]

VARIANT_BOOL RaiseCustomDrawEventOnEraseBackground [get, set]

Specifies whether the CustomDraw event is raised when erasing the control's background

Retrieves or sets whether the CustomDraw event is raised when erasing the control's background. If this property is set to True, the event is raised when the control erases its background. Otherwise the event is not raised in this case.

See also:: _IToolBarEvents::CustomDraw, CustomDrawStageConstants

RegisterForOLEDragDropConstants RegisterForOLEDragDrop [get, set]

Controls the control's behavior in drag'n'drop operations

Retrieves or sets whether the control is registered as a target for OLE drag'n'drop. Any of the values defined by the RegisterForOLEDragDropConstants enumeration is valid.

See also:: SupportOLEDragImages, _IToolBarEvents::OLEDragEnter, RegisterForOLEDragDropConstants

RightToLeftConstants RightToLeft [get, set]

Controls the control's right-to-left features

Enables or disables bidirectional features. Any combination of the values defined by the RightToLeftConstants enumeration is valid.

See also:: RightToLeftConstants

OLE_COLOR ShadowColor [get, set]

Specifies the control's 3D shadow color

Retrieves or sets the color used by the control to draw shadowed parts of tool bar buttons. If set to -1, the default color is used.

Remarks:: This property isn't supported for themed tool bars.

See also:: HighlightColor

VARIANT_BOOL ShowDragImage [get, set]

Controls the visibility of the control's drag image

Retrieves or sets whether the drag image is currently visible or hidden. If set to True, it is visible; otherwise it is hidden.

See also:: SupportOLEDragImages

VARIANT_BOOL ShowToolTips [get, set]

Specifies whether the control displays any tooltips

Retrieves or sets whether the control displays any tooltips. If this property is set to True, the buttons' tooltips retrieved through the ButtonGetInfoTipText event are displayed. Otherwise no tooltips are shown.

See also:: hWndToolTip, _IToolBarEvents::ButtonGetInfoTipText

Retrieves which icon size should be used

Retrieves a value specifying which icon size should be used for the tool bar button icons. This suggestion is based upon the system's DPI settings. Any of the values defined by the SuggestedIconSizeConstants enumeration is valid.

Remarks:: This property is read-only.

See also:: hImageList, SuggestedIconSizeConstants

VARIANT_BOOL SupportOLEDragImages [get, set]

Controls the control's behavior in drag'n'drop operations

Retrieves or sets whether the control creates an IDropTargetHelper object, so that a drag image can be displayed during OLE drag'n'drop. If set to True, the control creates the object; otherwise not.

Remarks:: Requires shell32.dll version 5.0 or higher.

See also:: RegisterForOLEDragDrop, hImageList, ShowDragImage, OLEDragImageStyle, IDropTargetHelper

BSTR Tester [get]

VARIANT_BOOL UseMnemonics [get, set]

Specifies how ampersands in button texts are handled

Retrieves or sets whether the control handles ampersands in button texts as accelerator keys. If set to True, ampersands are handled as marking accelerator keys; otherwise they are handled as normal characters.

See also:: IToolBarButton::Text

VARIANT_BOOL UseSystemFont [get, set]

Specifies whether the control uses the system font

Retrieves or sets whether the control uses the MS Shell Dlg font (which is mapped to the system's default GUI font) or the font specified by the Font property. If set to True, the system font; otherwise the specified font is used.

Remarks:: This property isn't supported for themed tool bars (except on Windows XP).

See also:: Font

BSTR Version [get]

Retrieves the control's version

Remarks:: This property is read-only.

OLE_YSIZE_PIXELS VerticalButtonPadding [get, set]

Controls the buttons' inner layout

Retrieves or sets the number of pixels in vertical direction between a button's border and its content. If set to -1, the system's default value is used.

Remarks:: Padding is applied to automatically-sized buttons only.
This property is ignored if the AlwaysDisplayButtonText property is set to False.

See also:: HorizontalButtonPadding, VerticalButtonSpacing, IToolBarButton::AutoSize, AlwaysDisplayButtonText

OLE_YSIZE_PIXELS VerticalButtonSpacing [get, set]

Controls the buttons' alignment

Retrieves or sets the number of pixels between buttons in vertical direction.

Remarks:: Requires comctl32.dll version 6.0 or higher.

See also:: HorizontalButtonSpacing, VerticalButtonPadding

VAlignmentConstants VerticalTextAlignment [get, set]

Controls the vertical alignment of the button texts

Retrieves or sets the vertical alignment of the button texts. Any of the values defined by the VAlignmentConstants enumeration is valid.

See also:: HorizontalTextAlignment, IToolBarButton::Text, VAlignmentConstants

VARIANT_BOOL WrapButtons [get, set]

Specifies whether buttons may be wrapped to multiple lines

Retrieves or sets whether buttons may be displayed on multiple lines, if the tool bar becomes too narrow to include all buttons on the same line. If set to True, buttons may be wrapped; otherwise not.

See also:: DisplayPartiallyClippedButtons, IToolBarButton::FollowedByLineBreak, IToolBarButton::Width, ButtonRowCount, SetButtonRowCount

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation