> For the complete documentation index, see [llms.txt](https://doc.velneo.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.velneo.com/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vtoolbox.md).

# VToolBox

**Hereda de:** [Widget](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/widget.md).

Esta clase representa al control [caja de subformularios](/24/velneo-vdevelop/proyectos-objetos-y-editores/proyecto-de-aplicacion/formulario/contenedores/caja-de-formularios.md).

## [Propiedades](https://doc.velneo.com/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/pages/-M7D7mmSZt0s7e6lUC-j#documentación-de-propiedades)

| Tipo         | Propiedad                                                                                        |
| ------------ | ------------------------------------------------------------------------------------------------ |
| const Number | [count](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vtoolbox.md#count)               |
| Number       | [currentIndex](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vtoolbox.md#currentindex) |

## Funciones

**Generales**

| Retorno                                                                                   | Función                                                                                                                                                           |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [VFormDataView](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vformdataview.md) | [addForm](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vtoolbox.md#addform)( String szIdRefForm, String szText, \[VImage imagen] )                     |
| Number                                                                                    | [findForm](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vtoolbox.md#findform)( String szIdRefForm )                                                    |
| Number                                                                                    | [findForm](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vtoolbox.md#number-findform-widget-form-)( Widget form )                                       |
| [VFormDataView](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vformdataview.md) | [form](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vtoolbox.md#form)( Number index )                                                                  |
| [VFormDataView](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vformdataview.md) | [form](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vtoolbox.md#vformdataview-form-string-szidrefform-)( String szIdRefForm )                          |
| [VFormDataView](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vformdataview.md) | [insertForm](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vtoolbox.md#insertform)( Number index, String szIdRefForm, String szText, \[VImage imagen] ) |
| Boolean                                                                                   | [isFormEnabled](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vtoolbox.md#isformenabled)( Number index )                                                |
| void                                                                                      | [removeForm](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vtoolbox.md#removeform)( Number index )                                                      |
| void                                                                                      | [setCurrentIndex](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vtoolbox.md#setcurrentindex)( Number index )                                            |
| void                                                                                      | [setCurrentWidgetWidget](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vtoolbox.md#setcurrentwidget)(  form )                                           |
| void                                                                                      | [setFormEnabled](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vtoolbox.md#setformenabled)( Number index, Boolean enabled )                             |

**De ítems bars**

| Retorno | Función                                                                                                                          |
| ------- | -------------------------------------------------------------------------------------------------------------------------------- |
| String  | [labelText](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vtoolbox.md#labeltext)( Number index )                       |
| void    | [setIcon](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vtoolbox.md#seticon)( Number index, VImage imagen)             |
| void    | [setLabelText](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vtoolbox.md#setlabeltext)( Number index, String szLabel ) |
| void    | [setToolTip](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vtoolbox.md#settooltip)( Number index, String szTip )       |
| String  | [toolTip](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vtoolbox.md#tooltip)( Number index )                           |

## Señales

| Señal                        |
| ---------------------------- |
| Item: cambio de seleccionado |

## Documentación de propiedades

#### count

Devuelve el número de subformularios.

#### currentIndex

Devuelve el índice del subformulario en curso.

## Documentación de funciones

### Funciones generales

#### VFormDataView addForm( String szIdRefForm, String szText, \[VImage imagen] ) <a href="#addform" id="addform"></a>

Añade una nueva pestaña con un subformulario.

Parámetros:

* szIdRefForm: identificador de referencia, alias\_proyecto/identificador\_formulario, del formulario.
* szText: texto que se mostrará en la pestaña.
* imagen: opcional. Objeto de la clase [VImage](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vimage.md) que contiene el icono a mostrar en la pestaña.

#### Number findForm( String szIdRefForm ) <a href="#findform" id="findform"></a>

Devuelve el índice correspondiente a la posición ocupada por el formulario con el idRef especificado.

Parámetros:

* szIdRefForm: identificador de referencia, alias\_proyecto/identificador\_formulario, del formulario.

#### Number findForm( Widget form )

Devuelve el índice correspondiente a la posición ocupada por el formulario del widget especificado.

Parámetros:

* form: objeto de la clase [Widget](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/widget.md) que se corresponde con el subformulario.

#### VFormDataView form( Number index ) <a href="#form" id="form"></a>

Devuelve el subformulario correspondiente al índice.

Parámetros:

* index: número correspondiente a la posición que ocupa el subformulario que se desea obtener.

#### VFormDataView form( String szIdRefForm )

Devuelve el subformulario correspondiente al formulario con el idRef especificado.

Parámetros:

* szIdRefForm: identificador de referencia, alias\_proyecto/identificador\_formulario, del formulario.

#### VFormDataView insertForm( Number index, String szIdRefForm, String szText, \[VImage imagen] ) <a href="#insertform" id="insertform"></a>

Inserta un subformulario correspondiente al formulario con el IdRef especificado en la posición del índice.

Parámetros:

* index: número correspondiente a la posición en la que se desea insertar el subformulario.
* szIdRefForm: identificador de referencia, alias\_proyecto/identificador\_formulario, del formulario.
* szText: texto que se mostrará en la pestaña.
* imagen: opcional. Objeto de la clase [VImage](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vimage.md) que contiene el icono a mostrar en la pestaña.

#### Boolean isFormEnabled( Number index ) <a href="#isformenabled" id="isformenabled"></a>

Devuelve true si la pestaña está activa.

Parámetros:

* index: número correspondiente a la posición que ocupa la pestaña.

#### void removeForm( Number index ) <a href="#removeform" id="removeform"></a>

Elimina el subformulario correspondiente al índice.

Parámetros:

* index: número correspondiente a la posición que ocupa el subformulario que se desea eliminar.

#### void setCurrentIndex( Number index ) <a href="#setcurrentindex" id="setcurrentindex"></a>

Convierte a subformulario en curso al especificado en el índice.

Parámetros:

* index: número correspondiente a la posición que ocupa el subformulario que se desea asignar como subformulario en curso.

#### void setCurrentWidget( Widget form ) <a href="#setcurrentwidget" id="setcurrentwidget"></a>

Convierte a [Widget](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/widget.md) en curso el objeto formulario especificado.

Parámetros:

* form: objeto de la clase [Widget](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/widget.md) que se corresponde con el subformulario.

#### void setFormEnabled( Number index, Boolean enabled ) <a href="#setformenabled" id="setformenabled"></a>

Fija si la pestaña estará activada o desactivada.

Parámetros:

* index: número correspondiente a la posición que ocupa la pestaña.
* enable: valor booleano. True=La pestaña se activa. False=La pestaña se desactiva.

### Funciones de ítems bars

#### String labelText( Number index ) <a href="#labeltext" id="labeltext"></a>

Devuelve el texto de la pestaña.

Parámetros:

* index: número correspondiente a la posición que ocupa la pestaña.

#### void setIcon( Number index, VImage imagen) <a href="#seticon" id="seticon"></a>

Asigna el icono a mostrar en una pestaña.

Parámetros:

* index: número correspondiente a la posición que ocupa la pestaña.
* imagen: opcional. Objeto de la clase [VImage](/24/velneo-vdevelop/scripts/lenguajes/javascript/clases/vimage.md) que contiene el icono a mostrar en la pestaña.

#### void setLabelText( Number index, String szLabel ) <a href="#setlabeltext" id="setlabeltext"></a>

Asigna el texto a mostrar en una pestaña.

Parámetros:

* index: número correspondiente a la posición que ocupa la pestaña.
* szLabel: texto a mostrar en la pestaña.

#### void setToolTip( Number index, String szTip ) <a href="#settooltip" id="settooltip"></a>

Asigna el texto a mostrar en el tooltip de una pestaña.

Parámetros:

* index: número correspondiente a la posición que ocupa la pestaña.
* szTip: texto a mostrar en el tooltip de la pestaña.

#### String toolTip( Number index ) <a href="#tooltip" id="tooltip"></a>

Devuelve el texto a mostrar en el tooltip de la pestaña.

Parámetros:

* index: número correspondiente a la posición que ocupa la pestaña.