IProgressBar Interface Reference

The main interface More...

List of all members.

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

---

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

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

OLE_COLOR BackColor [get, set]

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

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

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

Specifies the control's current progress status

Retrieves or sets the current progress status.

See also:

Minimum, Maximum, SmoothReverse

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

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:

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

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

Specifies the maximum progress value

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

See also:

Minimum, CurrentValue, StepWidth

LONG Minimum [get, set]

Specifies the minimum progress value

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

See also:

Maximum, CurrentValue, StepWidth

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

OrientationConstants Orientation [get, set]

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

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

See also:

SupportOLEDragImages, _IProgressBarEvents::OLEDragEnter

VARIANT_BOOL RightToLeftLayout [get, set]

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

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

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 [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 Version [get]

Retrieves the control's version

Remarks:

This property is read-only.

VARIANT_BOOL DetectDoubleClicks [get, set]

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

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

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

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

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

Text, RightToLeftConstants

BSTR Text [get, set]

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

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

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

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

Requires comctl32.dll version 6.0 or higher.

See also:

Font