The main interface More...

Public Member Functions
HRESULT	About (void)
	Displays the control's credits
HRESULT	BeginDragBand ([in] IReBarBand *bandToDrag,[in, defaultvalue(-1)] LONG xMousePosition,[in, defaultvalue(-1)] LONG yMousePosition)
	Starts dragging a band
HRESULT	DragMoveBand ([in, defaultvalue(-1)] LONG xMousePosition,[in, defaultvalue(-1)] LONG yMousePosition)
	Sets the drag position while dragging a band
HRESULT	EndDragBand (void)
	Ends drag'n'drop mode
HRESULT	GetMargins ([in, out, defaultvalue(0)] OLE_XSIZE_PIXELS leftMargin,[in, out, defaultvalue(0)] OLE_YSIZE_PIXELS topMargin,[in, out, defaultvalue(0)] OLE_XSIZE_PIXELS rightMargin,[in, out, defaultvalue(0)] OLE_YSIZE_PIXELS bottomMargin)
	Retrieves the margins around a band
HRESULT	HitTest ([in] OLE_XPOS_PIXELS x,[in] OLE_YPOS_PIXELS y,[in, out] HitTestConstants hitTestDetails,[out, retval] IReBarBand *ppHitBand)
	Hit-tests the specified point
HRESULT	LoadSettingsFromFile ([in] BSTR file,[out, retval] VARIANT_BOOL *pSucceeded)
	Loads the control's settings from the specified file
HRESULT	Refresh (void)
	Advises the control to redraw itself
HRESULT	SaveSettingsToFile ([in] BSTR file,[out, retval] VARIANT_BOOL *pSucceeded)
	Saves the control's settings to the specified file
HRESULT	SizeToRectangle ([in] OLE_XPOS_PIXELS xLeft,[in] OLE_YPOS_PIXELS yTop,[in] OLE_XPOS_PIXELS xRight,[in] OLE_YPOS_PIXELS yBottom,[out, retval] VARIANT_BOOL *pLayoutChanged)
	Resizes the control and changes its layout to best fit a given rectangle
Properties
VARIANT_BOOL	AllowBandReordering `[get, set]`
	Specifies whether the bands can be reordered by the user
AppearanceConstants	Appearance `[get, set]`
	Controls the style of the control's outer border
SHORT	AppID `[get]`
BSTR	AppName `[get]`
BSTR	AppShortName `[get]`
VARIANT_BOOL	AutoUpdateLayout `[get, set]`
	Controls the band layouting
OLE_COLOR	BackColor `[get, set]`
	Specifies the control's background color
IReBarBands	Bands `[get]`
	Retrieves the control's bands
BorderStyleConstants	BorderStyle `[get, set]`
	Controls the style of the control's inner border
LONG	Build `[get]`
BSTR	CharSet `[get]`
OLE_YSIZE_PIXELS	ControlHeight `[get]`
	Retrieves the control's height in pixels
DisabledEventsConstants	DisabledEvents `[get, set]`
	Controls which events are fired
VARIANT_BOOL	DisplayBandSeparators `[get, set]`
	Specifies whether the bands are visually separated
VARIANT_BOOL	DisplaySplitter `[get, set]`
	Specifies whether the control displays a splitter at its bottom
VARIANT_BOOL	DontRedraw `[get, set]`
	Controls redrawing of the control
VARIANT_BOOL	Enabled `[get, set]`
	Controls whether the control accepts user input
VARIANT_BOOL	FixedBandHeight `[get, set]`
	Specifies whether the bands all have the same height
IFontDisp	Font `[get, set]`
	Specifies the control's font
OLE_COLOR	ForeColor `[get, set]`
	Specifies the control's text color
OLE_COLOR	HighlightColor `[get, set]`
	Specifies the control's 3D highlight color
OLE_HANDLE	hImageList ([in] ImageListConstants imageList) `[get, set]`
	Specifies one of the control's associated imagelist
LONG	HoverTime `[get, set]`
	Controls when the `MouseHover` event is fired
OLE_HANDLE	hPalette `[get, set]`
	Specifies the palette used by the control
OLE_HANDLE	hWnd `[get]`
	Retrieves the control's window handle
OLE_HANDLE	hWndNotificationReceiver `[get, set]`
	Specifies the handle of the window that the control sends notifications to
VARIANT_BOOL	IsRelease `[get]`
IReBarBand	MDIFrameMenuBand `[get, set]`
	Specifies which rebar band replaces the menu bar in MDI windows
IPictureDisp	MouseIcon `[get, set]`
	Controls the control's mouse cursor
MousePointerConstants	MousePointer `[get, set]`
	Controls the control's mouse cursor
IUnknown	NativeDropTarget `[get]`
	Retrieves the native rebar control's `IDropTarget` implementation
LONG	NumberOfRows `[get]`
	Retrieves the number of band rows
OrientationConstants	Orientation `[get, set]`
	Controls the control's orientation
BSTR	Programmer `[get]`
RegisterForOLEDragDropConstants	RegisterForOLEDragDrop `[get, set]`
	Controls the control's behavior in drag'n'drop operations
ReplaceMDIFrameMenuConstants	ReplaceMDIFrameMenu `[get, set]`
	Specifies whether the control replaces the menu bar if it sits inside a MDI frame window
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	SupportOLEDragImages `[get, set]`
	Controls the control's behavior in drag'n'drop operations
BSTR	Tester `[get]`
VARIANT_BOOL	ToggleOnDoubleClick `[get, set]`
	Controls when the control minimizes or maximizes a band
VARIANT_BOOL	UseSystemFont `[get, set]`
	Specifies whether the control uses the system font
BSTR	Version `[get]`
	Retrieves the control's version
VARIANT_BOOL	VerticalSizingGripsOnVerticalOrientation `[get, set]`
	Specifies how the sizing grips are drawn if the control is orientated vertically

Detailed Description

The main interface

This is the date time picker control's main interface. It wraps the control window.

See also:: _IReBarEvents

Member Function Documentation

HRESULT About ( void )

Displays the control's credits

Displays some information about this control and its author.

HRESULT BeginDragBand	(	[in] IReBarBand *	bandToDrag,
		[in, defaultvalue(-1)] LONG	xMousePosition,
		[in, defaultvalue(-1)] LONG	yMousePosition
	)

Starts dragging a band

Puts the control into drag'n'drop mode.

Parameters:

[in]	bandToDrag	The band to drag.
[in]	xMousePosition	The x-coordinate (in pixels) of the mouse cursor's position relative to the control's upper-left corner.
[in]	yMousePosition	The y-coordinate (in pixels) of the mouse cursor's position relative to the control's upper-left corner.

Remarks:: If xMousePosition or yMousePosition is set to -1, the position, that the mouse cursor had on the last processed message, is used. If xMousePosition or yMousePosition is set to -2, the mouse cursor's position on the last MouseDown message is used.
The BandBeginDrag event won't be raised.

See also:: DragMoveBand, EndDragBand, _IReBarEvents::BandBeginDrag

HRESULT DragMoveBand	(	[in, defaultvalue(-1)] LONG	xMousePosition,
		[in, defaultvalue(-1)] LONG	yMousePosition
	)

Sets the drag position while dragging a band

Sets the drag position is the control is in drag'n'drop mode.

Parameters:

[in]	xMousePosition	The x-coordinate (in pixels) of the mouse cursor's position relative to the control's upper-left corner.
[in]	yMousePosition	The y-coordinate (in pixels) of the mouse cursor's position relative to the control's upper-left corner.

Remarks:: If xMousePosition or yMousePosition is set to -1, the position, that the mouse cursor had on the last processed message, is used.

See also:: BeginDragBand, EndDragBand

HRESULT EndDragBand ( void )

Ends drag'n'drop mode

Remarks:: The BandEndDrag event won't be raised.

See also:: BeginDragBand, EndDragBand, _IReBarEvents::BandEndDrag

HRESULT GetMargins	(	[in, out, defaultvalue(0)] OLE_XSIZE_PIXELS *	leftMargin,
		[in, out, defaultvalue(0)] OLE_YSIZE_PIXELS *	topMargin,
		[in, out, defaultvalue(0)] OLE_XSIZE_PIXELS *	rightMargin,
		[in, out, defaultvalue(0)] OLE_YSIZE_PIXELS *	bottomMargin
	)

Retrieves the margins around a band

Retrieves the size (in pixels) of the margins around a band.

Parameters:

[out]	leftMargin	The width (in pixels) of the margin on the left of a band.
[out]	topMargin	The height (in pixels) of the margin on the top of a band.
[out]	rightMargin	The width (in pixels) of the margin on the right of a band.
[out]	bottomMargin	The height (in pixels) of the margin on the bottom of a band.

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

See also:: IReBarBand::AddMarginsAroundChild, IReBarBand::GetBorderSizes, IReBarBand::GetRectangle

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

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 band that the specified point belongs to. Nothing, if no band was "hit".

See also:: HitTestConstants

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

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

HRESULT SizeToRectangle	(	[in] OLE_XPOS_PIXELS	xLeft,
		[in] OLE_YPOS_PIXELS	yTop,
		[in] OLE_XPOS_PIXELS	xRight,
		[in] OLE_YPOS_PIXELS	yBottom,
		[out, retval] VARIANT_BOOL *	pLayoutChanged
	)

Resizes the control and changes its layout to best fit a given rectangle

Resizes the control and reorganizes the bands so that the control's bounding rectangle matches the specified rectangle as good as possible.

Parameters:

[in]	xLeft	The x-coordinate (in pixels) of the rectangle's upper-left corner.
[in]	yTop	The y-coordinate (in pixels) of the rectangle's upper-left corner.
[in]	xRight	The x-coordinate (in pixels) of the rectangle's lower-right corner.
[in]	yBottom	The y-coordinate (in pixels) of the rectangle's lower-right corner.

Returns:: True if the layout has been changed; otherwise False.

See also:: _IReBarEvents::ResizedControlWindow, _IReBarEvents::LayoutChanged

Property Documentation

VARIANT_BOOL AllowBandReordering [get, set]

Specifies whether the bands can be reordered by the user

Retrieves or sets whether the user can bring the bands into a different order using drag'n'drop. If set to True, reordering is possible; otherwise not.

See also:: IReBarBand::SizingGripVisibility

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]

VARIANT_BOOL AutoUpdateLayout [get, set]

Controls the band layouting

Retrieves or sets whether the bands are layouted automatically if the control's size or position changes. If set to True, the layout is changed automatically; otherwise not.

See also:: _IReBarEvents::AutoSized, _IReBarEvents::LayoutChanged

OLE_COLOR BackColor [get, set]

Specifies the control's background color

Retrieves or sets the control's background color. If set to -1, the system's default is used.

Remarks:: This property isn't supported for themed rebars.

See also:: ForeColor, HighlightColor, ShadowColor, IReBarBand::BackColor, IReBarBand::hBackgroundBitmap

IReBarBands Bands [get]

Retrieves the control's bands

Retrieves a collection object wrapping the rebar bands.

Remarks:: This property is read-only.

See also:: IReBarBands

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]

BSTR CharSet [get]

OLE_YSIZE_PIXELS ControlHeight [get]

Retrieves the control's height in pixels

Remarks:: This property is read-only.

See also:: IReBarBand::RowHeight

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 DisplayBandSeparators [get, set]

Specifies whether the bands are visually separated

Retrieves or sets whether adjacent bands are separated by a thin border. If set to True, a border is drawn between adjacent bands; otherwise not.

See also:: DisplaySplitter, HighlightColor, ShadowColor, IReBarBand::AddMarginsAroundChild

VARIANT_BOOL DisplaySplitter [get, set]

Specifies whether the control displays a splitter at its bottom

Retrieves or sets whether a splitter is displayed at the bottom of the control. If the mouse is moved over this splitter, the cursor is changed to a sizing cursor. Dragging the splitter doesn't resize the control, but raises the DraggingSplitter event. If set to True, the splitter is displayed; otherwise not.

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

See also:: DisplayBandSeparators, _IReBarEvents::DraggingSplitter

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.

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.

VARIANT_BOOL FixedBandHeight [get, set]

Specifies whether the bands all have the same height

Retrieves or sets whether the rebar bands are sized using each individual band's minimum height or using the tallest band's height. If set to True, the tallest band's height is used for all bands; otherwise each band is sized individually using its minimum height.

See also:: IReBarBand::CurrentHeight

IFontDisp Font [get, set]

Specifies the control's font

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

Remarks:: This property isn't supported for themed rebars.

See also:: UseSystemFont

OLE_COLOR ForeColor [get, set]

Specifies the control's text color

Retrieves or sets the control's text color. If set to -1, the system's default is used.

Remarks:: This property isn't supported for themed rebars.

See also:: BackColor, HighlightColor, ShadowColor, IReBarBand::ForeColor

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 3D elements like band borders and sizing grips. If set to -1, the default color is used.

Remarks:: This property isn't supported for themed rebars.

See also:: ShadowColor, BackColor, ForeColor, DisplayBandSeparators, IReBarBand::SizingGripVisibility

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. Some of the values defined by the ImageListConstants enumeration is valid.

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

See also:: ImageListConstants

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:: _IReBarEvents::MouseHover

OLE_HANDLE hPalette [get, set]

Specifies the palette used by the control

Retrieves or sets the palette used by the control when drawing itself.

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

See also:: IReBarBand::hBackgroundBitmap

OLE_HANDLE hWnd [get]

Retrieves the control's window handle

Retrieves the control's window handle.

Remarks:: This property is read-only.

See also:: hWndNotificationReceiver, _IReBarEvents::RecreatedControlWindow, _IReBarEvents::DestroyedControlWindow

OLE_HANDLE hWndNotificationReceiver [get, set]

Specifies the handle of the window that the control sends notifications to

Retrieves or sets the handle of the window that the control sends notifications to.

See also:: hWnd

VARIANT_BOOL IsRelease [get]

IReBarBand MDIFrameMenuBand [get, set]

Specifies which rebar band replaces the menu bar in MDI windows

Retrieves or sets the rebar band that replaces the parent window's menu bar if the parent window is a MDI frame window and the ReplaceMDIFrameMenu property is set to rmfmFullReplace.

See also:: ReplaceMDIFrameMenu, Bands, IReBarBand, ReplaceMDIFrameMenuConstants

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

IUnknown NativeDropTarget [get]

Retrieves the native rebar control's IDropTarget implementation

Remarks:: This property is read-only.

See also:: RegisterForOLEDragDrop

LONG NumberOfRows [get]

Retrieves the number of band rows

Remarks:: This property is read-only.

See also:: IReBarBand::RowHeight

OrientationConstants Orientation [get, set]

Controls the control's orientation

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

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

See also:: IReBarBand::HideIfVertical, VerticalSizingGripsOnVerticalOrientation, OrientationConstants

BSTR Programmer [get]

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, _IReBarEvents::OLEDragEnter, RegisterForOLEDragDropConstants

ReplaceMDIFrameMenuConstants ReplaceMDIFrameMenu [get, set]

Specifies whether the control replaces the menu bar if it sits inside a MDI frame window

Retrieves or sets whether the control replaces the parent window's menu bar if the parent window is a MDI frame window. Any of the values defined by the ReplaceMDIFrameMenuConstants enumeration is valid.

Remarks:: This property cannot be set at runtime.

See also:: MDIFrameMenuBand, ReplaceMDIFrameMenuConstants

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 3D elements like band borders and sizing grips. If set to -1, the default color is used.

Remarks:: This property isn't supported for themed rebars.

See also:: HighlightColor, BackColor, ForeColor, DisplayBandSeparators, IReBarBand::SizingGripVisibility

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, IDropTargetHelper

BSTR Tester [get]

VARIANT_BOOL ToggleOnDoubleClick [get, set]

Controls when the control minimizes or maximizes a band

Retrieves or sets whether a double-click is required to toggle a band's minimized or maximized state. If set to True, a band is minimized or maximized if it is double-clicked; otherwise if it is single-clicked.

See also:: IReBarBand::Maximize, IReBarBand::Minimize, _IReBarEvents::DblClick, _IReBarEvents::TogglingBand

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 rebars.

See also:: Font

BSTR Version [get]

Retrieves the control's version

Remarks:: This property is read-only.

VARIANT_BOOL VerticalSizingGripsOnVerticalOrientation [get, set]

Specifies how the sizing grips are drawn if the control is orientated vertically

Retrieves or sets whether sizing grips are drawn vertically if the Orientation property is set to oVertical. If set to True, sizing grips are drawn vertically then; otherwise horizontally.

See also:: Orientation, IReBarBand::SizingGripVisibility

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation