# VToolBox

**Hereda de:** [Widget](https://doc.velneo.com/velneo-vdevelop/scripts/lenguajes/javascript/clases/widget).

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

## Indice de propiedades

const Number [count](#count)

Number [currentIndex](#currentindex)

## Indice de funciones

### **Generales**

VFormDataView [addForm](#addform)( String szIdRefForm, String szText, \[VImage imagen] )

Number [findForm](#findform)( String szIdRefForm )

Number [findForm](#number-findform-widget-form-)( Widget form )

VFormDataView [form](#form)( Number index )

VFormDataView [form](#vformdataview-form-string-szidrefform-)( String szIdRefForm )

VFormDataView [insertForm](#insertform)( Number index, String szIdRefForm, String szText, \[VImage imagen] )

Boolean [isFormEnabled](#isformenabled)( Number index )

void [removeForm](#removeform)( Number index )

void [setCurrentIndex](#setcurrentindex)( Number index )

void [setCurrentWidgetWidget](#setcurrentwidget)(  form )

void [setFormEnabled](#setformenabled)( Number index, Boolean enabled )

### **De ítems bars**

String  [labelText](#labeltext)( Number index )

void [setIcon](#seticon)( Number index, VImage imagen)

void [setLabelText](#setlabeltext)( Number index, String szLabel )

void [setToolTip](#settooltip)( Number index, String szTip )

String [toolTip](#tooltip)( Number index )

## Señales

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](https://doc.velneo.com/velneo-vdevelop/scripts/lenguajes/javascript/clases/vimage) 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](https://doc.velneo.com/velneo-vdevelop/scripts/lenguajes/javascript/clases/widget) 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](https://doc.velneo.com/velneo-vdevelop/scripts/lenguajes/javascript/clases/vimage) 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](https://doc.velneo.com/velneo-vdevelop/scripts/lenguajes/javascript/clases/widget) en curso el objeto formulario especificado.

Parámetros:

* form: objeto de la clase [Widget](https://doc.velneo.com/velneo-vdevelop/scripts/lenguajes/javascript/clases/widget) 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](https://doc.velneo.com/velneo-vdevelop/scripts/lenguajes/javascript/clases/vimage) 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.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.velneo.com/velneo-vdevelop/scripts/lenguajes/javascript/clases/vtoolbox.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.