IProgressBar Interface Reference

The main interface More...

Inherits IDispatch.

Public Member Functions
HRESULT	About (void)
	Displays the control's credits More...
HRESULT	ChangeCurrentValue ([in, defaultvalue(0)] LONG delta,[out, retval] LONG *pPreviousValue)
	Advances the current progress status 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
VARIANT_BOOL	ActivateMarquee [get, set]
	Controls animation of a marquee style progress bar More...
AppearanceConstants	Appearance [get, set]
	Controls the style of the control's outer border More...
OLE_COLOR	BackColor [get, set]
	Specifies the control's background color More...
OLE_COLOR	BarColor [get, set]
	Specifies the control's progress bar color More...
BarStyleConstants	BarStyle [get, set]
	Controls the visualization style of the progress More...
BorderStyleConstants	BorderStyle [get, set]
	Controls the style of the control's inner border More...
LONG	CurrentValue [get, set]
	Specifies the control's current progress status More...
DisabledEventsConstants	DisabledEvents [get, set]
	Controls which events are fired More...
VARIANT_BOOL	DontRedraw [get, set]
	Controls redrawing of the control 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...
LONG	MarqueeStepDuration [get, set]
	Controls animation of a marquee style progress bar More...
LONG	Maximum [get, set]
	Specifies the maximum progress value More...
LONG	Minimum [get, set]
	Specifies the minimum progress value 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...
ProgressStateConstants	ProgressState [get, set]
	Specifies the state of the associated action to visualize More...
VARIANT_BOOL	RegisterForOLEDragDrop [get, set]
	Controls the control's behavior in drag'n'drop operations More...
VARIANT_BOOL	RightToLeftLayout [get, set]
	Controls the control's right-to-left features More...
VARIANT_BOOL	SmoothReverse [get, set]
	Specifies whether decrementing progress is visualized animated More...
LONG	StepWidth [get, set]
	Controls the size of progress status changes More...
VARIANT_BOOL	SupportOLEDragImages [get, set]
	Controls the control's behavior in drag'n'drop operations More...
BSTR	Version [get]
	Retrieves the control's version More...
VARIANT_BOOL	DetectDoubleClicks [get, set]
	Specifies whether the control intercepts double clicks More...
VARIANT_BOOL	DisplayText [get, set]
	Specifies whether the control draws a text over the progress bar More...
IFontDisp	Font [get, set]
	Specifies the control's font More...
OLE_COLOR	ForeColor [get, set]
	Specifies the control's text color More...
HAlignmentConstants	HAlignment [get, set]
	Controls the horizontal alignment of the control's content More...
RightToLeftConstants	RightToLeft [get, set]
	Controls the control's right-to-left features More...
BSTR	Text [get, set]
	Specifies the control's text More...
OLE_COLOR	TextShadowColor [get, set]
	Specifies the control's text shadow color More...
OLE_XSIZE_PIXELS	TextShadowOffsetX [get, set]
	Controls the appearance of the control's text shadow More...
OLE_YSIZE_PIXELS	TextShadowOffsetY [get, set]
	Controls the appearance of the control's text shadow More...
VARIANT_BOOL	UseSystemFont [get, set]
	Specifies whether the control uses the system font More...
VARIANT_BOOL	DisplayProgressInTaskBar [get, set]
	Specifies whether the progress is displayed in the application window's taskbar button More...
OLE_HANDLE	hApplicationWindow [get, set]
	Specifies the application's main window More...

Detailed Description

The main interface

Author

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

See Also

_IProgressBarEvents

Member Function Documentation

HRESULT About

(

void

)

Displays the control's credits

Displays some information about this control and its author.

HRESULT ChangeCurrentValue	(	[in, defaultvalue(0)] LONG	delta,
		[out, retval] LONG *	pPreviousValue
	)

Advances the current progress status

Advances the current progress status by the specified increment.

Parameters

[in]

delta

The amount by which to increment the current progress status. If set to 0, the value of the StepWidth property is used.

Returns

The previous progress status.

See Also

CurrentValue, StepWidth

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

VARIANT_BOOL ActivateMarquee

getset

Controls animation of a marquee style progress bar

Turns the marquee mode on or off. If set to True, the progress bar moves like a marquee; otherwise it doesn't move.

Remarks

Requires comctl32.dll version 6.0 or higher.

See Also

MarqueeStepDuration, BarStyle

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

OLE_COLOR BackColor

getset

Specifies the control's background color

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

Remarks

This property isn't supported for themed progress bars.

See Also

BarColor

OLE_COLOR BarColor

getset

Specifies the control's progress bar color

Retrieves or sets the color of the bar indicating the progress status. If set to -1, the default color is used.

Remarks

This property isn't supported for themed progress bars.

See Also

BackColor

BarStyleConstants BarStyle

getset

Controls the visualization style of the progress

Retrieves or sets how progress status is displayed. Any of the values defined by the BarStyleConstants enumeration is valid.

Attention

Changing this property may destroy and recreate the control.

See Also

Orientation, BarStyleConstants

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

LONG CurrentValue

getset

Specifies the control's current progress status

Retrieves or sets the current progress status.

See Also

Minimum, Maximum, SmoothReverse

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

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

_IProgressBarEvents::RecreatedControlWindow, _IProgressBarEvents::DestroyedControlWindow

LONG MarqueeStepDuration

getset

Controls animation of a marquee style progress bar

Retrieves or sets the time in milliseconds between marquee animation updates.

Remarks

Requires comctl32.dll version 6.0 or higher.

See Also

ActivateMarquee, BarStyle

LONG Maximum

getset

Specifies the maximum progress value

Retrieves or sets the value, that equals a progress status of 100 %.

See Also

Minimum, CurrentValue, StepWidth

LONG Minimum

getset

Specifies the minimum progress value

Retrieves or sets the value, that equals a progress status of 0 %.

See Also

Maximum, CurrentValue, StepWidth

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 direction, in which the control is filled up. Any of the values defined by the OrientationConstants enumeration is valid.

See Also

OrientationConstants

ProgressStateConstants ProgressState

getset

Specifies the state of the associated action to visualize

Retrieves or sets the state of the action associated with this progress bar. Different states are visualized differently. Any of the values defined by the ProgressStateConstants enumeration is valid.

Remarks

Requires comctl32.dll version 6.10 or higher.

See Also

Minimum, Maximum, CurrentValue, ProgressStateConstants

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, _IProgressBarEvents::OLEDragEnter

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 (e. g. the bar fills from right to left); otherwise it is left to right.

Deprecated:

Use the 'RightToLeft' property instead.

See Also

RightToLeft

VARIANT_BOOL SmoothReverse

getset

Specifies whether decrementing progress is visualized animated

Retrieves or sets whether the control switches from a higher progress state to a lower one with an animated smooth transition or simply jumps to the lower progress state. If set to True, an animated smooth transition is displayed; otherwise not.

Remarks

Requires comctl32.dll version 6.10 or higher.

See Also

CurrentValue, BarStyle

LONG StepWidth

getset

Controls the size of progress status changes

Retrieves or sets the amount, by which the current progress status will change if the ChangeCurrentValue method is called with the delta parameter being set to -1.

See Also

ChangeCurrentValue, Maximum, Minimum, CurrentValue

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

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

_IProgressBarEvents::DblClick, _IProgressBarEvents::MDblClick, _IProgressBarEvents::RDblClick

VARIANT_BOOL DisplayText

getset

Specifies whether the control draws a text over the progress bar

Retrieves or sets whether the control draws the text specified by the Text property over the progress bar. If set to True, the text is drawn; otherwise not.

Remarks

Requires comctl32.dll version 6.0 or higher.

See Also

Text, HAlignment, Font

IFontDisp Font

getset

Specifies the control's font

Retrieves or sets the control's font. It's used to optionally draw a text over the progress bar.

Remarks

Requires comctl32.dll version 6.0 or higher.

See Also

UseSystemFont, Text

OLE_COLOR ForeColor

getset

Specifies the control's text color

Retrieves or sets the control's text color.

Remarks

Requires comctl32.dll version 6.0 or higher.

See Also

TextShadowColor, Text

HAlignmentConstants HAlignment

getset

Controls the horizontal alignment of the control's content

Retrieves or sets the horizontal alignment of the control's text. Any of the values defined by the HAlignmentConstants enumeration is valid.

Remarks

Requires comctl32.dll version 6.0 or higher.

See Also

Text, HAlignmentConstants

RightToLeftConstants RightToLeft

getset

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

Text, RightToLeftConstants

BSTR Text

getset

Specifies the control's text

Retrieves or sets the control's text. It may contain the following placeholders:

• %1: Current value in percent.
• %2: Current value as absolute value.

Remarks

Requires comctl32.dll version 6.0 or higher.

See Also

DisplayText, HAlignment, Font, UseSystemFont, ForeColor, TextShadowColor, TextShadowOffsetX, TextShadowOffsetY

OLE_COLOR TextShadowColor

getset

Specifies the control's text shadow color

Retrieves or sets the control's text shadow color.

Remarks

Requires comctl32.dll version 6.0 or higher.

See Also

ForeColor, Text, TextShadowOffsetX, TextShadowOffsetY

OLE_XSIZE_PIXELS TextShadowOffsetX

getset

Controls the appearance of the control's text shadow

Retrieves or sets the horizontal offset of the control's text shadow.

Remarks

Requires comctl32.dll version 6.0 or higher.

See Also

TextShadowOffsetY, Text, TextShadowColor

OLE_YSIZE_PIXELS TextShadowOffsetY

getset

Controls the appearance of the control's text shadow

Retrieves or sets the vertical offset of the control's text shadow.

Remarks

Requires comctl32.dll version 6.0 or higher.

See Also

TextShadowOffsetX, Text, TextShadowColor

VARIANT_BOOL UseSystemFont

getset

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

Requires comctl32.dll version 6.0 or higher.

See Also

Font

VARIANT_BOOL DisplayProgressInTaskBar

getset

Specifies whether the progress is displayed in the application window's taskbar button

Retrieves or sets whether the current progress state and value is displayed in the application main window's taskbar button. If set to True, the progress is displayed in the taskbar button; otherwise not.

Remarks

To display the progress indicator in the taskbar, the hApplicationWindow property has to be set, too.
Requires Windows 7 or higher.

See Also

hApplicationWindow, CurrentValue, ProgressState

OLE_HANDLE hApplicationWindow

getset

Specifies the application's main window

Retrieves or sets the handle of the application's main window. If the DisplayProgressInTaskBar property is set to True, this window's taskbar button will be extended with a progress indicator if the application is running on Windows 7 or newer.

Remarks

The window has to be visible and its taskbar button already has to be created. Otherwise the progress indicator cannot be displayed.

See Also

DisplayProgressInTaskBar, CurrentValue, ProgressState