ModernUI_ProgressBar

../../_images/ModernUI_ProgressBar48x48.png

The ModernUI_ProgressBar is a progress bar control like the standard win32 progress bar control, except it provides ease of use and more customizable features, like color of the progress fill, the progress unfilled area and border.

ModernUI_ProgressBar Functions

FunctionDescription
MUIProgressBarCreateCreates a new ModernUI_ProgressBar control
MUIProgressBarGetPercentGets the current percent value of the progressbar
MUIProgressBarGetPropertyGets the value of a property
MUIProgressBarRegisterRegisters a window class for the ModernUI_ProgressBar
MUIProgressBarSetMinMaxSets the minimum and maximum range of progressbar
MUIProgressBarSetPercentSets the current percent value of the progressbar
MUIProgressBarSetPropertySets the value for a property
MUIProgressBarStepIncrementally moves the progressbar

ModernUI_ProgressBar Messages

MessageDescription
MUIPBM_SETPERCENTSets the percentage of the progressbar
MUIPBM_STEPIncrementally moves the progressbar one step

ModernUI_ProgressBar Properties

PropertyType
@ProgressBarTextColorMUICOLORRGB
@ProgressBarTextFontHFONT
@ProgressBarBackColorMUICOLORRGB
@ProgressBarProgressColorMUICOLORRGB
@ProgressBarBorderColorMUICOLORRGB
@ProgressBarPercentMUIVALUE
@ProgressBarMinMUIVALUE
@ProgressBarMaxMUIVALUE
@ProgressBarStepMUIVALUE
@ProgressBarPulseBOOL
@ProgressBarPulseTimeMUIVALUE
@ProgressBarTextTypeMUIVALUE
@ProgressBarSetTextPosMUIVALUE

ModernUI_ProgressBar Property Descriptions

ProgressBarTextColor

Color of percentage text (MUICOLORRGB) of the ModernUI_ProgressBar control.

ProgressBarTextFont

Font (HFONT) used for the progress bar text

ProgressBarBackColor

Background color (MUICOLORRGB) of the ModernUI_ProgressBar control.

ProgressBarProgressColor

Progress bar percent filled color (MUICOLORRGB) of the ModernUI_ProgressBar control.

ProgressBarBorderColor

Border color (MUICOLORRGB) of the ModernUI_ProgressBar control.

ProgressBarPercent

Current progress bar percentage value

ProgressBarMin

Minimum range value -currently not implemented

ProgressBarMax

Maximum range value -currently not implemented

ProgressBarStep

Value to increment the progress bar when callingMUIProgressBarStep orMUIPBM_STEP. Defaults to1 -currently not implemented

ProgressBarPulse

Enable pulse glow effect to show progress bar is still active.TRUE to enable,FALSE to disable. Default isTRUE

ProgressBarPulseTime

Time in milliseconds between pulse effect is shown. Defaults to 5 seconds (5000ms)

ProgressBarTextType

Type of percentage text to display, can be one of the following values:

  • MUIPBTT_NONE- no percentage text in progress bar (default)
  • MUIPBTT_CENTRE - percentage text in center of progress bar
  • MUIPBTT_FOLLOW - percentage text follows progress as it draws

ProgressBarSetTextPos

Position of other text, can be one of the following values:0 = preppend WM_SETTEXT text,1 = append WM_SETTEXT textcurrently not implemented