Aztec® Programming Language

Version 1.1 Alpha 2

Copyright © 2010-2017, Aztec Development Group, All Rights Reserved

Download Aztec

Search        Contact Us

ProgressBar Class

After three days in the desert fun...
I was looking at a river bed.
And the story it told of a river that flowed...
Made me sad to think it was dead.

- Dewey Bunnell

 

aztec.ui.ProgressBar

public class ProgressBar from<Control>

Base

Window

Control

ProgressBar

The ProgressBar class provides a simple progress control, which draws a bar with a length based on the percent complete of an operation. The size, position and color of the progress bar can be controlled by the user, as well as the maximum limit for the control (corresponding to 100 percent complete). The user can also specify a solid bar or a broken bar.

 

It provides a simple interface which requires a periodic update of the "percent complete" value, at which time the framework redraws the bar based on the current percent complete versus the maximum limit specified in the constructor. Normally a status bar is increased from 0 to 100 percent with increasing percent complete values, but the ProgressBar control can also handle receiving a percent complete less than the previous value.

ProgressBar Methods

ProgressBar Constants

Derived Classes

None

See Also

Class Hierarchy, Frame, ChildFrame, Dialog

 

---

ProgressBar()

public method ProgressBar(Window Parent, int XPos, int YPos, int Width, int Height, int MaxValue = 100, int BarType = ProgressBar.SolidBar)

Parameters

Parent

Parent window for the progress bar control

XPos

One based X position of control relative to parent

YPos

One based Y position of control relative to parent

Width

Initial width of the control in pixels

Height

Initial height of the control in pixels

MaxValue

Value to correspond to a completely filled bar (default of 100)

BarType

Bar type (SolidBar or BrokenBar)

Return Value

None

Description

Constructor for the ProgressBar class, which specifies the size and position, the max value and the bar type.

 

ProgressBar Class

---

SetValue()

public method SetValue(int CurrentValue)

Parameters

CurrentValue

Specifies current value for the progress bar

Return Value

None

Description

Specifies the current size of the progress bar. The length of the bar drawn within the progress bar control is dictated by this value. The ratio of the bar length to the with of the progress bar control is the same as the ratio of the current value to the max limit for the progress bar. If the current value is less than one, the bar will be empty, and if the current value is greater than the max limit, the bar will fill the entire width of the progress bar control.

 

ProgressBar Class

 

Copyright © 2010-2017

Aztec Development Group

All Rights Reserved

Download Aztec