PATH |
WOCompletionBar
Component Description
The WOCompletionBar component displays a progress bar on a page. You might use WOCompletionBar in the status page of your long-running action (see the WOLongResponsePage Class).
Synopsis
WOCompletionBar { valueMin=aNumber; valueMax=aNumber; [value=aNumber;] [numberformat=numberFormatString;] [progressColor=hexString;] [backgroundColor=hexString;] [width=aNumber;] [border=aString;] [align=aString;] };Bindings
- valueMin
- Minimum value for the bar or value at which the bar begins.
- valueMax
- Maximum value for the bar or value at which the bar ends.
- value
- The current amount completed. The bar sizes to this
number and displays the number inside itself. The value must be
between
valueMin
andvalueMax
.
- numberformat
- A format string that specifies how
value
should be formatted as a number. If a number format is used,value
must be assigned an NSNumber object. If the value can't be interpreted according to the format you specify, the value is set tonil
. See the NSNumberFormatter class specification for a description of the number format syntax.
- progressColor
- Color for showing the value. That is, this color shows the amount completed.
- backgroundColor
- Color for the uncompleted portion.
- width
- Width of the bar. This attribute is passed directly
to the HTML
TABLE
that makes up the bar.
- border
- Thickness of the bar's border in pixels. This attribute
is passed directly to the HTML
TABLE
that makes up the bar.
- align
- Alignment of the displayed number within the completed
portion of the bar. This attribute is passed directly to the HTML
FONT
specification for the number.