ITrackBar Interface Reference

The main interface More...

Inherits IDispatch.

Public Member Functions
HRESULT	About (void)
	Displays the control's credits More...
HRESULT	LoadSettingsFromFile ([in] BSTR file,[out, retval] VARIANT_BOOL *pSucceeded)
	Loads the control's settings from the specified file More...
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 More...

Properties
AppearanceConstants	Appearance [get, set]
	Controls the style of the control's outer border More...
SHORT	AutoTickFrequency [get, set]
	Controls the distance between automatically inserted tick marks More...
VARIANT_BOOL	AutoTickMarks [get, set]
	Specifies whether the control automatically displays tick marks More...
OLE_COLOR	BackColor [get, set]
	Specifies the control's background color More...
BackgroundDrawModeConstants	BackgroundDrawMode [get, set]
	Controls how the control's background is drawn More...
BorderStyleConstants	BorderStyle [get, set]
	Controls the style of the control's inner border More...
OLE_YSIZE_PIXELS	ChannelHeight [get]
	Retrieves the trackbar channel's height More...
OLE_XPOS_PIXELS	ChannelLeft [get]
	Retrieves the x-coordinate of the trackbar channel's position More...
OLE_YPOS_PIXELS	ChannelTop [get]
	Retrieves the y-coordinate of the trackbar channel's position More...
OLE_XSIZE_PIXELS	ChannelWidth [get]
	Retrieves the trackbar channel's width More...
LONG	CurrentPosition [get, set]
	Controls the slider's current position More...
DisabledEventsConstants	DisabledEvents [get, set]
	Controls which events are fired More...
VARIANT_BOOL	DontRedraw [get, set]
	Controls redrawing of the control More...
VARIANT_BOOL	DownIsLeft [get, set]
	Controls the control's behavior in response to pressing the down arrow key More...
VARIANT_BOOL	Enabled [get, set]
	Controls whether the control accepts user input More...
LONG	HoverTime [get, set]
	Controls when the MouseHover event is fired More...
OLE_HANDLE	hWnd [get]
	Retrieves the control's window handle More...
OLE_HANDLE	hWndBottomOrRightBuddy [get, set]
	Specifies the bottom/right buddy window More...
OLE_HANDLE	hWndToolTip [get, set]
	Specifies the associated tooltip control More...
OLE_HANDLE	hWndTopOrLeftBuddy [get, set]
	Specifies the top/left buddy window More...
LONG	LargeStepWidth [get, set]
	Specifies the distance that the slider moves in one large step More...
LONG	Maximum [get, set]
	Specifies the slider's maximum position More...
LONG	Minimum [get, set]
	Specifies the slider's minimum position More...
IPictureDisp	MouseIcon [get, set]
	Controls the control's mouse cursor More...
MousePointerConstants	MousePointer [get, set]
	Controls the control's mouse cursor More...
OrientationConstants	Orientation [get, set]
	Controls the control's orientation More...
VARIANT_BOOL	ProcessContextMenuKeys [get, set]
	Specifies whether the ContextMenu event can be invoked using the keyboard More...
LONG	RangeSelectionEnd [get, set]
	Specifies the selection range's end More...
LONG	RangeSelectionStart [get, set]
	Specifies the selection range's start More...
VARIANT_BOOL	RegisterForOLEDragDrop [get, set]
	Controls the control's behavior in drag'n'drop operations More...
VARIANT_BOOL	Reversed [get, set]
	Flags the control as using inversed logic More...
VARIANT_BOOL	RightToLeftLayout [get, set]
	Controls the control's right-to-left features More...
SelectionTypeConstants	SelectionType [get, set]
	Controls how the user may select a value More...
VARIANT_BOOL	ShowSlider [get, set]
	Specifies whether the control displays a slider More...
OLE_YSIZE_PIXELS	SliderHeight [get]
	Retrieves the slider's height More...
OLE_XPOS_PIXELS	SliderLeft [get]
	Retrieves the x-coordinate of the slider's position More...
LONG	SliderLength [get, set]
	Controls the slider's size More...
OLE_YPOS_PIXELS	SliderTop [get]
	Retrieves the y-coordinate of the slider's position More...
OLE_XSIZE_PIXELS	SliderWidth [get]
	Retrieves the slider's width More...
LONG	SmallStepWidth [get, set]
	Specifies the distance that the slider moves in one small step More...
VARIANT_BOOL	SupportOLEDragImages [get, set]
	Controls the control's behavior in drag'n'drop operations More...
LONG	TickMarkPhysicalPosition ([in] LONG tickMark) [get]
	Retrieves a tick mark's physical position More...
VARIANT	TickMarks [get, set]
	Controls the position of each tick mark More...
TickMarksPositionConstants	TickMarksPosition [get, set]
	Controls the position of the control's tick marks More...
ToolTipPositionConstants	ToolTipPosition [get, set]
	Controls the position of the control's tooltip More...
BSTR	Version [get]
	Retrieves the control's version More...
VARIANT_BOOL	DetectDoubleClicks [get, set]
	Specifies whether the control intercepts double clicks More...

Detailed Description

The main interface

Author

Timo "TimoSoft" Kunze This is the control's main interface. It wraps the control window.

See Also

_ITrackBarEvents

Member Function Documentation

HRESULT About

(

void

)

Displays the control's credits

Displays some information about this control and its author.

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

Property Documentation

AppearanceConstants Appearance

getset

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 AutoTickFrequency

getset

Controls the distance between automatically inserted tick marks

Retrieves or sets the interval frequency for tick marks in a trackbar, that has the AutoTickMarks property set to True.

See Also

AutoTickMarks, TickMarks, CurrentPosition

VARIANT_BOOL AutoTickMarks

getset

Specifies whether the control automatically displays tick marks

Retrieves or sets whether the control automatically displays tick marks. If set to True, tick marks are inserted automatically; otherwise not.

Attention

Changing this property destroys and recreates the control.

See Also

AutoTickFrequency, TickMarks

OLE_COLOR BackColor

getset

Specifies the control's background color

Retrieves or sets the control's background color.

Remarks

This property isn't supported for themed trackbars.

See Also

BackgroundDrawMode

BackgroundDrawModeConstants BackgroundDrawMode

getset

Controls how the control's background is drawn

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

Remarks

Requires comctl32.dll version 6.10 or higher.

See Also

BackColor, BackgroundDrawModeConstants

BorderStyleConstants BorderStyle

getset

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

OLE_YSIZE_PIXELS ChannelHeight

get

Retrieves the trackbar channel's height

Retrieves the trackbar channel's height in pixels.

Remarks

This property is read-only.

See Also

ChannelLeft, ChannelTop, ChannelWidth, SliderHeight

OLE_XPOS_PIXELS ChannelLeft

get

Retrieves the x-coordinate of the trackbar channel's position

Retrieves the distance between the trackbar channel's left border and the left border of the control's client area in pixels.

Remarks

This property is read-only.

See Also

ChannelHeight, ChannelTop, ChannelWidth, SliderLeft

OLE_YPOS_PIXELS ChannelTop

get

Retrieves the y-coordinate of the trackbar channel's position

Retrieves the distance between the trackbar channel's upper border and the upper border of the control's client area in pixels.

Remarks

This property is read-only.

See Also

ChannelHeight, ChannelLeft, ChannelWidth, SliderTop

OLE_XSIZE_PIXELS ChannelWidth

get

Retrieves the trackbar channel's width

Retrieves the trackbar channel's width in pixels.

Remarks

This property is read-only.

See Also

ChannelHeight, ChannelLeft, ChannelTop, SliderWidth

LONG CurrentPosition

getset

Controls the slider's current position

Retrieves or sets the slider's current logical position.

See Also

Minimum, Maximum, ShowSlider, AutoTickMarks, TickMarks, _ITrackBarEvents::PositionChanging, _ITrackBarEvents::PositionChanged

DisabledEventsConstants DisabledEvents

getset

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 DontRedraw

getset

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 DownIsLeft

getset

Controls the control's behavior in response to pressing the down arrow key

Retrieves or sets how the control reacts to the down arrow key. If set to True, pressing the down arrow key is handled like pressing the left arrow key and pressing the up arrow key is handled like pressing the right arrow key. If set to False, pressing the down arrow key is handled like pressing the right arrow key and pressing the up arrow key is handled like pressing the left arrow key.

Remarks

Requires comctl32.dll version 5.81 or higher.

See Also

Orientation, _ITrackBarEvents::KeyDown

VARIANT_BOOL Enabled

getset

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.

LONG HoverTime

getset

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

_ITrackBarEvents::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

_ITrackBarEvents::RecreatedControlWindow, _ITrackBarEvents::DestroyedControlWindow

OLE_HANDLE hWndBottomOrRightBuddy

getset

Specifies the bottom/right buddy window

Retrieves or sets the window handle of the control's bottom or right buddy window (depending on the control's orientation). Buddy windows are automatically displayed in a location relative to the control's orientation (horizontal or vertical).

See Also

hWndTopOrLeftBuddy

OLE_HANDLE hWndToolTip

getset

Specifies the associated tooltip control

Retrieves or sets the tooltip control's window handle.

Remarks

The previously set tooltip window does NOT get destroyed automatically.

See Also

ToolTipPosition, _ITrackBarEvents::GetInfoTipText

OLE_HANDLE hWndTopOrLeftBuddy

getset

Specifies the top/left buddy window

Retrieves or sets the window handle of the control's top or left buddy window (depending on the control's orientation). Buddy windows are automatically displayed in a location relative to the control's orientation (horizontal or vertical).

See Also

hWndBottomOrRightBuddy

LONG LargeStepWidth

getset

Specifies the distance that the slider moves in one large step

Retrieves or sets the number of logical positions, that the trackbar's slider moves in response to keyboard input from keys like [PageUp] and [PageDown] and mouse input, such as clicks in the trackbar's channel. If set to -1, the system's default setting is used.

See Also

SmallStepWidth, CurrentPosition

LONG Maximum

getset

Specifies the slider's maximum position

Retrieves or sets the slider's maximum logical position.

See Also

Minimum, CurrentPosition, ShowSlider

LONG Minimum

getset

Specifies the slider's minimum position

Retrieves or sets the slider's minimum logical position.

See Also

Maximum, CurrentPosition, ShowSlider

IPictureDisp MouseIcon

getset

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

getset

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

OrientationConstants Orientation

getset

Controls the control's orientation

Retrieves or sets the control's orientation. Any of the values defined by the OrientationConstants enumeration is valid.

See Also

OrientationConstants

VARIANT_BOOL ProcessContextMenuKeys

getset

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 events get fired; otherwise not.

See Also

_ITrackBarEvents::ContextMenu

LONG RangeSelectionEnd

getset

Specifies the selection range's end

Retrieves or sets the ending logical position of the current selection range, if the SelectionType property is set to stRangeSelection. Setting RangeSelectionEnd and RangeSelectionStart to -1 clears the selection range.

See Also

RangeSelectionStart, SelectionType, Maximum

LONG RangeSelectionStart

getset

Specifies the selection range's start

Retrieves or sets the starting logical position of the current selection range, if the SelectionType property is set to stRangeSelection. Setting RangeSelectionEnd and RangeSelectionStart to -1 clears the selection range.

See Also

RangeSelectionEnd, SelectionType, Minimum

VARIANT_BOOL RegisterForOLEDragDrop

getset

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. If set to True, the control accepts OLE drag'n'drop actions; otherwise not.

See Also

SupportOLEDragImages, _ITrackBarEvents::OLEDragEnter

VARIANT_BOOL Reversed

getset

Flags the control as using inversed logic

Retrieves or sets whether the control is a "reversed" trackbar, where a smaller number indicates "higher" and a larger number indicates "lower".

Remarks

This property has no effect on the control. It's simply a flag that can be checked to determine whether the control is normal or reversed.
Requires comctl32.dll version 5.80 or higher.

See Also

Minimum, Maximum

VARIANT_BOOL RightToLeftLayout

getset

Controls the control's right-to-left features

Retrieves or sets the control's general layout. If set to True, the layout direction is right to left; otherwise it is left to right.

Attention

Changing this property destroys and recreates the control.

SelectionTypeConstants SelectionType

getset

Controls how the user may select a value

Retrieves or sets which kind of value selection the control allows. Any of the values defined by the SelectionTypeConstants enumeration is valid.

See Also

SelectionTypeConstants

VARIANT_BOOL ShowSlider

getset

Specifies whether the control displays a slider

Retrieves or sets whether the control displays a slider. If set to True, the slider is displayed; otherwise not.

See Also

SliderLength, CurrentPosition

OLE_YSIZE_PIXELS SliderHeight

get

Retrieves the slider's height

Retrieves the slider's height in pixels.

Remarks

This property is read-only.

See Also

SliderLength, SliderLeft, SliderTop, SliderWidth, ChannelHeight

OLE_XPOS_PIXELS SliderLeft

get

Retrieves the x-coordinate of the slider's position

Retrieves the distance between the slider's left border and the left border of the control's client area in pixels.

Remarks

This property is read-only.

See Also

TickMarkPhysicalPosition, SliderHeight, SliderTop, SliderWidth, ChannelLeft

LONG SliderLength

getset

Controls the slider's size

Retrieves or sets the slider's length in pixels. If set to -1, the default length is used.

See Also

SliderHeight, SliderLeft, SliderTop, SliderWidth, ShowSlider

OLE_YPOS_PIXELS SliderTop

get

Retrieves the y-coordinate of the slider's position

Retrieves the distance between the slider's upper border and the upper border of the control's client area in pixels.

Remarks

This property is read-only.

See Also

TickMarkPhysicalPosition, SliderHeight, SliderLeft, SliderWidth, ChannelTop

OLE_XSIZE_PIXELS SliderWidth

get

Retrieves the slider's width

Retrieves the slider's width in pixels.

Remarks

This property is read-only.

See Also

SliderLength, SliderHeight, SliderLeft, SliderTop, ChannelWidth

LONG SmallStepWidth

getset

Specifies the distance that the slider moves in one small step

Retrieves or sets the number of logical positions, that the trackbar's slider moves in response to keyboard input from the arrow keys.

See Also

LargeStepWidth, CurrentPosition

VARIANT_BOOL SupportOLEDragImages

getset

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

LONG TickMarkPhysicalPosition([in] LONG tickMark)

get

Retrieves a tick mark's physical position

Retrieves the specified tick mark's physical position (in pixels) relative to the control's left or top border (depending on the setting of the Orientation property).

Parameters

[in]

tickMark

The zero-based index of the tick mark for which to retrieve the position.

Remarks

This property is read-only.

See Also

TickMarks, TickMarksPosition, Orientation

VARIANT TickMarks

getset

Controls the position of each tick mark

Retrieves or sets the control's tick marks. The property expects a Variant containing an array of integer values, each specifying a tick mark's position.

Remarks

The tick marks for the slider's minimum and maximum logical positions are always displayed and don't need to be included in the array.

See Also

AutoTickMarks, TickMarksPosition

TickMarksPositionConstants TickMarksPosition

getset

Controls the position of the control's tick marks

Retrieves or sets the position at which to display tick marks. Any of the values defined by the TickMarksPositionConstants enumeration is valid.

See Also

TickMarks, TickMarkPhysicalPosition, ToolTipPosition, TickMarksPositionConstants

ToolTipPositionConstants ToolTipPosition

getset

Controls the position of the control's tooltip

Retrieves or sets the position at which to display tooltips. Any of the values defined by the ToolTipPositionConstants enumeration is valid.

See Also

hWndToolTip, TickMarksPosition, _ITrackBarEvents::GetInfoTipText, ToolTipPositionConstants

BSTR Version

get

Retrieves the control's version

Remarks

This property is read-only.

VARIANT_BOOL DetectDoubleClicks

getset

Specifies whether the control intercepts double clicks

Enables or disables double clicks. If set to True, double clicks are accepted; otherwise all clicks are handled as single clicks.

See Also

_ITrackBarEvents::DblClick, _ITrackBarEvents::MDblClick, _ITrackBarEvents::RDblClick