# VProgressBar

**Hereda de:** [Widget](widget).

Esta clase representa al control barra de progreso de formulario.

## Indice de propiedades

Number [alignment](#alignment)

String [format](#format)

Boolean [invertedAppearance](#invertedappearance)

Number [maximum](#maximum)

Numer [minimum](#minimum)

Number [orientation](#orientation)

const String [text](#text)

Number [textDirection](#textdirection)

Boolean [textVisible](#textvisible)

Number [value](#value)

## Indice de funciones

### **Generales**

void [reset](#reset)()

void [setMaximum](#setmaximum)( Number max )

void [setMinimum](#setminimum)( Number min )

void [setOrientation](#setorientation)( Number orienta )

void [setRange](#setrange)( Number min, Number max )

void [setValue](#setvalue)( Number value )

## Enumeraciones

**EchoMode**

* Normal
* NoEcho
* Password
* PasswordEchoOnEdit

**Flags de alineamiento**

* AlignLeft
* AlignRight
* AlignHCenter
* AlignJustify
* AlignTop
* AlignBottom
* AlignVCenter
* AlignBaseline
* AlignCenter
* AlignAbsolute
* AlignLeading
* AlignTrailing
* AlignHorizontal\_Mask
* AlignVertical\_Mask

**Flags de orientación**

* Horizontal
* Vertical

**Text direction (Sólo verticales)**

* TopToBottom
* BottomToTop

## Documentación de propiedades

#### alignment

Permite leer o configurar la alineación del control. Ver enum de flags de alineamiento. Los valores con combinables mediante el uso del operador bitwise or booleano "|".

#### format

Permite leer o configurar la cadena que se utiliza para generar el texto actual. %p - se sustituye por el porcentaje completado. %v - se sustituye por el valor actual. m% - se sustituye por el número total de pasos. El valor por defecto es "%p%".

#### invertedAppearance

Permite leer o configurar si la barra de progreso muestra el progreso invertido. Si esta propiedad es true, la barra de progreso crece en la otra dirección (por ejemplo, de derecha a izquierda). Por defecto, la barra de progreso no se invierte.

#### maximum

Permite leer o configurar el valor máximo de la barra de progreso. Al establecer esta propiedad, el mínimo se ajusta si es necesario para asegurar que el rango sigue siendo válido. Si el valor actual cae fuera de la nueva gama, la barra de progreso se restablece con reset().

#### minimum

Permite leer o configurar el valor mínimo de la barra de progreso. Al establecer esta propiedad, el máximo es ajustado si es necesario para asegurar que el rango sigue siendo válido. Si el valor actual cae fuera de la nueva gama, la barra de progreso se restablece con reset().

#### orientation

Permite leer o configurar la orientación de la barra de progreso. La orientación puede ser Horizontal (por defecto) o Vertical. Ver enum de flags de orientación. Los valores con combinables mediante el uso del operador bitwise or booleano "|".

#### text

Devuelve el texto descriptivo se muestra con la barra de progreso. El texto devuelto es el mismo que el texto que se muestra en el centro (o en algunos estilos, a la izquierda) de la barra de progreso. El progreso se muestra en el texto puede ser menor que el valor mínimo, lo que indica que la barra de progreso está en el "reset" del Estado antes de que cualquier progreso está establecido. En la implementación predeterminada, el texto contiene ya sea un valor porcentual que indica el progreso hasta ahora, o está en blanco debido a que la barra de progreso está en estado de reset.

#### textDirection

Permite leer o configurar la dirección de lectura del texto de las barras de progreso verticales. Esta propiedad no tiene impacto en las barras de progreso horizontales. Por defecto, la dirección de lectura es TopToBottom. Ver enum Text direction.

#### textVisible

Permite leer o configurar si el actual porcentaje completado se debe mostrar. Esta propiedad puede ser ignorada por el estilo (por ejemplo, MacStyle nunca dibuja el texto).

#### value

Permite leer o configurar el valor actual de la barra de progreso. Un intento de cambiar el valor de la corriente a uno fuera del rango mínimo-máximo no tiene efecto en el valor actual.

## Documentación de funciones

### Funciones generales

#### void reset() <a href="#reset" id="reset"></a>

Inicializa el valor del control a su valor mínimo.

#### void setMaximum( Number max ) <a href="#setmaximum" id="setmaximum"></a>

Fija el valor máximo a mostrar en la barra de progreso.

Parámetros:

* max: valor numérico que representa el valor máximo a mostrar en el control.

#### void setMinimum( Number min ) <a href="#setminimum" id="setminimum"></a>

Fija el valor mínimo a mostrar en la barra de progreso.

Parámetros:

* min: valor numérico que representa el valor mínimo a mostrar en el control.

#### void setOrientation( Number orienta ) <a href="#setorientation" id="setorientation"></a>

Fija la orientación de la barra de progreso.

Parámetros:

* orienta: ver enum de flags de orientación. Los valores con combinables mediante el uso del operador bitwise or booleano "|".

#### void setRange( Number min, Number max ) <a href="#setrange" id="setrange"></a>

Fija el rango a mostrar en el control, es decir los valores mínimo y máximo a visualizar en la barra de progreso.

Parámetros:

* min: valor numérico que representa el valor mínimo a mostrar en el control.
* max: valor numérico que representa el valor mínimo a mostrar en el control.

#### void setValue( Number value ) <a href="#setvalue" id="setvalue"></a>

Asigna el valor en curso a mostrar en el control.

Parámetros:

* value: valor numérico a mostrar en el control.

## Ejemplo

### Resetear la barra de progreso en un formulario

Se hará desde un [manejador de evento](../../../../proyectos-objetos-y-editores/proyecto-de-aplicacion/sub-objetos-de-vistas-de-datos/manejador-de-evento) del mismo.

```javascript
//Obtenemos el control
var barra = theRoot.dataView().control("BAR_PRO");
//Lo reseteamos
barra.reset();
```
