# VObjectInfo

Los objetos de esta clase contienen la información de la estructura de un objeto.

Se pueden ver sus propiedades, tanto los datos que contienen como información de su nombre, tipo, tabla asociada (si tiene), tipo de objeto referenciado… Para obtener el valor que contiene una propiedad primero debemos mirar el tipo de dato para usar la función adecuada. Por ejemplo si el tipo de dato es Uint16 usar la función propertyDataToInt(nProp);

También se pueden obtener otros VObjectInfo de sus subobjetos y de los objetos referenciados por sus propiedades.

## Funciones

**Generales  (Act.)**

| Retorno | Función                                         |
| ------- | ----------------------------------------------- |
| String  | [comments](#comments)()                         |
| String  | [iconPath](#iconpath)()                         |
| String  | [id](#id)()                                     |
| String  | [idRef](#idref)()                               |
| Boolean | [isDataView](#isdataview)()                     |
| Boolean | [isNull](#isnull)()                             |
| String  | [name](#name)( Number lenguaje, Number pais=0 ) |
| String  | [name](#string-name)()                          |
| Number  | [type](#type)()                                 |

**De estilos**

| Retorno | Función                                       |
| ------- | --------------------------------------------- |
| Boolean | [isAccessibleFromWeb](#isaccessiblefromweb)() |
| Boolean | [isDelayedEdition](#isdelayededition)()       |
| Boolean | [isDragCopyEnabled](#isdragcopyenabled)()     |
| Boolean | [isDragMoveEnabled](#isdragmoveenabled)()     |
| Boolean | [isHardLock](#ishardlock)()                   |
| Boolean | [isInsertPoint](#isinsertpoint)()             |
| Boolean | [isOnlyOneExpanded](#isonlyoneexpanded)()     |
| Boolean | [isPrivate](#isprivate)()                     |
| Boolean | [isRemoteFunction](#isremotefunction)()       |
| Boolean | [isRunOnSimpleClick](#isrunonsimpleclick)()   |
| Boolean | [isVertical](#isvertical)()                   |
| Number  | [style](#style)()                             |

**De entrada**

| Retorno                  | Función                    |
| ------------------------ | -------------------------- |
| [VTableInfo](vtableinfo) | [inputTable](#inputtype)() |
| Number                   | [inputType](#inputtype)()  |

**De salida**

| Retorno                  | Función                       |
| ------------------------ | ----------------------------- |
| [VTableInfo](vtableinfo) | [outputTable](#outputtable)() |
| Number                   | [outputType](#outputtype)()   |

**De propiedades**

| Retorno     | Función                                                   |
| ----------- | --------------------------------------------------------- |
| Bool        | [equals](#equals)( VObjectInfo objectInfo )               |
| Number      | [propertyCount](#propertycount)()                         |
| Variant     | [propertyData](#propertydata)( Number nProp )             |
| Number      | [propertyDataType](#propertydatatype)( Number nProp )     |
| Number      | [propertyEditType](#propertyedittype)( Number nProp )     |
| String      | [propertyName](#propertyname)( Number nProp )             |
| VObjectInfo | [propertyObjectInfo](#propertyobjectinfo)( Number nProp ) |
| Number      | [propertyObjectType](#propertyobjecttype)( Number nProp ) |

**De subobjetos**

| Retorno     | Función                                                                                                              |
| ----------- | -------------------------------------------------------------------------------------------------------------------- |
| Number      | [subObjectCount](#subobjectcount)( Number nSubType )                                                                 |
| VObjectInfo | [subObjectInfo](#subobjectinfo)( Number nSubType, String szIdSubObject )                                             |
| VObjectInfo | [subObjectInfo](#vobjectinfo-subobjectinfo-number-nsubtype-number-nsubobject-)( Number nSubType, Number nSubObject ) |

## Enumeraciones

**Estilos**

* VMS\_PRIVADO = 0x00000001 // Privado
* VMS\_HEREDABLE = 0x00000002 // Heredable
* VMS\_DRAGABLECOPY = 0x00000004 // Permite drag para copia
* VMS\_DRAGABLEMOVE = 0x00000008 // Permite drag para movimiento
* VMS\_INSERTPOINT = 0x00000010 // Punto de inserción
* VMS\_FUNCION\_REMOTA = 0x00000020 // Indica si es disparable como función remota (funciones only)
* VMS\_WEB = 0x00000040 // Indica si es accesible web
* VMS\_BLOQUEO\_DURO = 0x00000080 // Indica como bloquea el mapobjeto
* VMS\_VERTICAL = 0x00000100 // Vertical(lo usan algunos como el multivista)
* VMS\_CLICK\_DISPARA = 0x00000200 // Un-click hace lo mismo que doble-click (lo usan algunos)
* VMS\_STOP\_DEBUG = 0x00000400 // Stop debug (lo usan instrucciones)
* VMS\_ONLY\_ONE\_EXPANDED = 0x00000800 // Trees: solo una rama abierta
* VMS\_HINT\_NO\_TITLE = 0x00002000 // Ocultar barra de título de la ventana
* VMS\_HINT\_NO\_MINIMIZEBUTTON = 0x00004000 // Ocultar el botón minimizar ventana
* VMS\_HINT\_NO\_MAXIMIZEBUTTON = 0x00008000 // Ocultar el botón maximizar ventana
* VMS\_HINT\_NO\_CLOSEBUTTON = 0x00010000 // Ocultar el botón cerrar ventana
* VMS\_HINT\_ALL = HINT\_NO\_TITLE|HINT\_NO\_SYSTEMMENU|HINT\_NO\_MINIMIZEBUTTON|HINT\_NO\_MAXIMIZEBUTTON|HINT\_NO\_CLOSEBUTTON
* VMS\_RETARDO\_EDICION = 0x00020000 // Retardo con timer en edits (solo controles tipo edit)
* VMS\_OBJETO\_AUTO\_SOFT = 0x80000000 // Marca el objeto como auto-creación (no notifican modified).

**Property Data Types**

* IdentificadorPrimario = 00
* IdentificadorRef = 01
* IdentificadorTotal = 02
* StringIdiomas = 03
* String = 04
* StringList = 05
* Formula = 06
* FormulaList = 07
* Bool = 08
* Double = 09
* Int8 = 10
* Uint8 = 11
* Int16 = 12
* Uint16 = 13
* Int32 = 14
* Uint32 = 15
* Int64 = 16
* Uint64 = 17
* Color = 18
* Font = 19
* Imagen = 20
* Region = 21
* StringVariable = 22
* IdCompuestoControl = 23
* PathFileScript = 24

**Property Edit Types**

* El default para el tipo de dato = 00
* AutoCalculada. No editable = 01
* Combo Enum = 02
* Combo que permite edición = 03
* Combo que muestra todos los campos de su origen + sus maestros = 04
* Combo que muestra los campos de tipo objeto dibujo + sus maestros = 05
* Combo de Strings = 06
* SerialPortWindows: browser puerto serie Windows = 07
* SerialPortPosix: browser puerto serie Posix = 08
*   Browser de plataformas&#x20;

    &

    &#x20;SO = 09
* Browser de ficheros = 10
* Browser de directorios = 11
* Combo de estilos (flags) = 12

**Tipos de controles (Propiedad 0)**

* Dibujo = 0
* Caja de grupo = 1
* Texto estático = 2
* Nombre de campo = 3
* Edición alfabética = 4
* Botón = 5
* Botón de radio = 6
* Botón de check = 7
* Edición numérica = 8
* Calendario = 9
* Barra de progreso = 10
* Deslizador = 11
* Dial = 12
* Separador de formularios = 13
* ComboBox = 14
* ListBox = 15
* Vista de datos = 16
* Caja de formularios = 17
* Caja de texto = 18
* Reservado = 19
* Visor HTML = 20
* Objeto dibujo = 21
* Layout = 22
* Espaciador = 23
* Edición Fecha/Hora = 24
* Edición Fecha = 25
* Edición Hora = 26
* Caja de texto enriquecido = 27
* Pila de formularios = 28
* Reloj = 29
* Manómetro = 30
* Termómetro = 31
* Rueda = 32
* Imagen Svg = 33
* Botón Svg = 34
* Interruptor Svg = 35
* Switch Svg = 36
* Reloj indicador Svg = 37
* Menú arbolado = 38
* Edición fórmula = 39
* Edición senda de fichero = 40
* Edición senda de directorio = 41
* Splitter = 42
* Data Catcher Edit = 43
* Tree Widget = 44
* Área de scroll = 45

**Tipos de entrada/salida**

* IONone = 0
* IORecord = 1
* IOList = 2

**Tipos de objetos**

* TypeTable = 0
* TypeField = 1
* TypeIndex = 2
* TypeIndexPart = 3
* TypePluralBind = 4
* TypeUpdate = 5
* TypeUpdateComponent = 6
* TypeComplexIndex = 7
* TypeComplexIndexPart = 8
* TypeVariable = 9
* TypeStaticTable = 10
* TypeStaticTableItem = 11
* TypeTrigger = 12
* TypePicture = 13
* TypeGrid = 14
* TypeGridCol = 15
* TypeTree = 16
* TypeSlot = 17
* TypeForm = 18
* TypeControl = 19
* TypeSubcontrol = 20
* TypeMultiView = 21
* TypeLogicPrinter = 22
* TypeReport = 23
* TypeReportSection = 24
* TypeReportControl = 25
* TypeReportGrouping = 26
* TypeReportCalcution = 27
* TypeQuery = 28
* TypeQueryComponent = 29
* TypeFilterGlass = 30
* TypeFinder = 31
* TypeFinderIndex = 32
* TypeBasket = 33
* TypeProcess = 34
* TypeFunction = 35
* TypeEventConnection = 37
* TypeEventSlot = 38
* TypeInstruction = 39
* TypeDll = 40
* TypeAction = 41
* TypeMenu = 42
* TypeToolbar = 43
* TypeActionLauncher = 44
* TypeListPipe = 45
* TypeRecordPipe = 46
* TypeTcpProtocol = 47
* TypeConstant = 51
* TypeFrame = 52 - Marco
* TypeDock = 53
* TypeFormBlock = 54 - Bloque de formularios
* TypeDrop = 55
* TypeQueue = 56 - Cola de procesos
* TypeScheme = 57
* TypeSchemeItem = 58
* TypeDllFunction = 60
* TypeInsertion = 61
* TypeSerialPort = 62
* TypeDllFunctionParam = 63
* TypeAttachedFile = 64
* TypeSvgImage = 65
* TypeSvgControl = 66
* TypeSubindexator = 67
* TypeIntercomunicator = 68 - Intercomunicador del TCP
* TypeStyleCondition = 69 - Condición de estilo en rejilla
* TypeViewFlow = 70
* TypeListAlternator = 71
* TypeComboView = 72
* TypeListView = 73
* TypeQmlList = 74
* TypeUserRole = 75
* TypeAuxModel = 76
* TypeAdvancedGrid = 77
* TypeAdvancedGridCol = 78
* TypeAdvancedGridBand = 79
* TypeQmlForm = 80
* TypeFieldMigrator = 81 - Traspaso de campo
* TypeFormExtRecord = 82 - Ficha de extensión de formulario
* TypeChart = 83 - Gráfico
* TypeSeries = 84 - Serie de un gráfico
* TypeAxis = 85 - Eje de un gráfico
* TypeNone = -1

## Documentación de funciones

### Funciones generales

#### String comments() <a href="#comments" id="comments"></a>

Devuelve el valor de la propiedad comentarios del objeto.

#### String iconPath() <a href="#iconpath" id="iconpath"></a>

Se trata de una senda a recursos internos de la plataforma. Devuelve la senda del icono del objeto.

Esta función, si bien es funcional en vClient, está pensada para su uso en las [extensiones de Velneo vDevelop](../../../../extensiones-de-velneo-vdevelop).

#### String id() <a href="#id" id="id"></a>

Devuelve el identificador de un objeto. Por ejemplo, "AUTOEXEC".

#### String idRef() <a href="#idref" id="idref"></a>

Devuelve el identificador con referencia de un objeto. Por ejemplo, "VJS\_APP/AUTOEXEC".

#### Boolean isDataView() <a href="#isdataview" id="isdataview"></a>

Devuelve true si el objeto es una vista de datos.

#### Boolean isNull() <a href="#isnull" id="isnull"></a>

Devuelve true si el objeto VObjectInfo es nulo, false si contiene un objeto.

#### String name( Number lenguaje, Number pais=0 ) <a href="#name" id="name"></a>

Devuelve el nombre o descripción del objeto. Si no le pasamos parámetros devuelvo el nombre del idioma en curso. Si le resolvemos el idioma o el idioma y país nos devuelve del nombre para ese idioma y país.

Parámetros:

* nLenguaje: código Qt del idioma
* nPais: código Qt del país

#### String name()

Devuelve el nombre o descripción del objeto del idioma en curso.

#### Number type() <a href="#type" id="type"></a>

Devuelve el código de tipo de objeto. Ver enum de tipos de objetos.

### Funciones de estilos

#### Boolean isAccessibleFromWeb() <a href="#isaccessiblefromweb" id="isaccessiblefromweb"></a>

Devuelve true si el objeto tiene activado el estilo "Accesible Web" que se aplica en procesos.

Esta función se ha incorporado al API a partir de la versión 7.16.

#### Boolean isDelayedEdition() <a href="#isdelayededition" id="isdelayededition"></a>

Devuelve true si el objeto tiene activado el estilo "Retardo señal valueChanged" que se aplica en controles de edición.

Esta función se ha incorporado al API a partir de la versión 7.16.

#### Boolean isDragCopyEnabled() <a href="#isdragcopyenabled" id="isdragcopyenabled"></a>

Devuelve true si el objeto tiene activado el estilo "Arrastrable para copiar" que se aplica en objetos de tipo árbol visor de tabla, casillero, comboview, listview, lista QML, rejilla, rejilla avanzada y viewflow.

Esta función se ha incorporado al API a partir de la versión 7.16.

#### Boolean isDragMoveEnabled() <a href="#isdragmoveenabled" id="isdragmoveenabled"></a>

Devuelve true si el objeto tiene activado el estilo "Arrastrable para mover" que se aplica en objetos de tipo árbol visor de tabla, casillero, comboview, listview, lista QML, rejilla, rejilla avanzada y viewflow.

Esta función se ha incorporado al API a partir de la versión 7.16.

#### Boolean isHardLock() <a href="#ishardlock" id="ishardlock"></a>

Devuelve true si el objeto tiene activado el estilo "Bloqueo duro" que se aplica en objetos de tipo formulario y formulario QML.

Esta función se ha incorporado al API a partir de la versión 7.16.

#### Boolean isInsertPoint() <a href="#isinsertpoint" id="isinsertpoint"></a>

Devuelve true si el objeto tiene activado el estilo "Punto de inserción" que se aplica en objetos de tipo acción, formulario y formulario QML.

Esta función se ha incorporado al API a partir de la versión 7.16.

#### Boolean isOnlyOneExpanded() <a href="#isonlyoneexpanded" id="isonlyoneexpanded"></a>

Devuelve true si el objeto tiene activado el estilo "Solo una rama abierta" que se aplica en objetos de tipo árbol de tabla.

Esta función se ha incorporado al API a partir de la versión 7.16.

#### Boolean isPrivate() <a href="#isprivate" id="isprivate"></a>

Devuelve true si el objeto tiene activado el estilo "Privado" que se aplica en todos los objetos.

Esta función se ha incorporado al API a partir de la versión 7.16.

#### Boolean isRemoteFunction() <a href="#isremotefunction" id="isremotefunction"></a>

Devuelve true si el objeto tiene activado el estilo "Ejecutable en remoto" que se aplica en funciones.

Esta función se ha incorporado al API a partir de la versión 7.16.

#### Boolean isRunOnSimpleClick() <a href="#isrunonsimpleclick" id="isrunonsimpleclick"></a>

Devuelve true si el objeto tiene activado el estilo "Simple-click dispara" que se aplica en objetos de tipo árbol visor de tablas, casillero, listview, rejilla, rejilla avanzada y viewflow.

Esta función se ha incorporado al API a partir de la versión 7.16.

#### Boolean isVertical() <a href="#isvertical" id="isvertical"></a>

Devuelve true si el objeto tiene activado el estilo "Vertical" que se aplica en objetos de tipo multivista.

Esta función se ha incorporado al API a partir de la versión 7.16.

#### Number style() <a href="#style" id="style"></a>

Devuelve un número de 32 bits en el que cada bit se corresponde con un flag de estilo del enum de estilos de la clase VObjectInfo.

Para determinar si un estilo está activado o no podemos usar los operadores bitwase de JavaScript. Por ejemplo:

(0x00000001 == (objeto.style()

&

0x00000001)) // Devuelve true si es privado

(0x00000010 == (objeto.style()

&

0x00000010)) // Devuelve true si es un punto de inserción

(0x00000020 == (objeto.style()

&

0x00000020)) // Devuelve true si la función es ejecutable en remoto

(0x00000040 == (objeto.style()

&

0x00000040)) // Devuelve true si el proceso es accesible web

Esta función se ha incorporado al API a partir de la versión 7.16.

### Funciones de entrada

#### VTableInfo inputTable() <a href="#inputtable" id="inputtable"></a>

Devuelve el objeto [VTableInfo ](vtableinfo)correspondiente a la tabla de entrada.

#### Number inputType() <a href="#inputtype" id="inputtype"></a>

Devuelve el tipo de entrada. Ver enum de tipos de entrada/salida.

### Funciones de salida

#### VTableInfo outputTable() <a href="#outputtable" id="outputtable"></a>

Devuelve el objeto [VTableInfo ](vtableinfo)correspondiente a la tabla de salida.

#### Number outputType() <a href="#outputtype" id="outputtype"></a>

Devuelve el tipo de salida. Ver enum de tipos de entrada/salida.

### Funciones de propiedades

#### Bool equals( VObjectInfo objectInfo ) <a href="#equals" id="equals"></a>

Devuelve true si el objeto es igual que el que pasamos como parámetro, false si es distinto. Comprueba para ello propiedades y subobjetos.

Parámetros:

* objectInfo: objeto de la clase VObjectInfo con el que queremos comparar el objeto.

#### Number propertyCount() <a href="#propertycount" id="propertycount"></a>

Devuelve el número de propiedades del control.

#### QVariant propertyData( Number nProp ) <a href="#propertydata" id="propertydata"></a>

Devuelve el valor de la propiedad.

Parámetros:

* nProp: valor numérico que se corresponde con la posición ordinal de la propiedad del objeto o control.

#### Number propertyDataType( Number nProp ) <a href="#propertydatatype" id="propertydatatype"></a>

Devuelve el tipo de dato de la propiedad. Ver enum Property Data Types.

Parámetros:

* nProp: valor numérico que se corresponde con la posición ordinal de la propiedad del objeto o control.

#### Number propertyEditType( Number nProp ) <a href="#propertyedittype" id="propertyedittype"></a>

Devuelve el tipo de editor de la propiedad. Ver enum Property Edit Types.

Parámetros:

* nProp: valor numérico que se corresponde con la posición ordinal de la propiedad del objeto o control.

#### String propertyName( Number nProp ) <a href="#propertyname" id="propertyname"></a>

Devuelve el nombre de la propiedad.

Parámetros:

* nProp: valor numérico que se corresponde con la posición ordinal de la propiedad del objeto o control.

#### VObjectInfo propertyObjectInfo( Number nProp ) <a href="#propertyobjectinfo" id="propertyobjectinfo"></a>

Devuelve un objeto de la clase VObjectInfo de la propiedad.

Parámetros:

* nProp: valor numérico que se corresponde con la posición ordinal de la propiedad del objeto o control.

#### Number propertyObjectType( Number nProp ) <a href="#propertyobjecttype" id="propertyobjecttype"></a>

Devuelve un número que identifica el tipo de objeto de la propiedad. Ver enum de tipos de objetos.

Parámetros:

* nProp: valor numérico que se corresponde con la posición ordinal de la propiedad del objeto o control.

### Funciones de subobjetos

#### Number subObjectCount( Number nSubType ) <a href="#subobjectcount" id="subobjectcount"></a>

Devuelve el número de subobjetos de un objeto de un tipo.

Parámetros:

* nSubType: ver enum de tipos de objetos.

#### VObjectInfo subObjectInfo( Number nSubType, String szIdSubObject ) <a href="#subobjectinfo" id="subobjectinfo"></a>

Devuelve un objeto VObjectInfo de un subobjeto de un tipo y un identificador.

Parámetros:

* nSubType: ver enum de tipos de objetos.
* szIdSubObject: identificador del subobjeto.

#### VObjectInfo subObjectInfo( Number nSubType, Number nSubObject )

Devuelve un objeto VObjectInfo de un subobjeto de un tipo y un número de orden del subobjeto.

Parámetros:

* nSubType: ver enum de tipos de objetos.
* szIdSubObject = número de orden del subobjeto en la lista.

## Ejemplos

### 1. Información del objeto de la vista en curso

```javascript
////////////////////////////////////////////////////////////
// Información del objeto de la vista en curso

// Se coge el root (objeto) de la vista en curso
var root = theMainWindow.currentView().root();

// Se crea el objeto VObjectInfo de la vista en curso
obj = root.objectInfo();

// Se muestra la información del objeto
msg = "El objeto en curso tiene la siguiente información:" +  "nn" + 
        "Id: " + obj.id() + "n" + 
        "IdRef: " + obj.idRef() + "n" + 
        "Name: " + obj.name() + "n" + 
        "Tipo: " + obj.type() + "n" + 
        "¿Es vista de datos? " + obj.isDataView() + "n";

// Si tiene tabla asociada se añade al mensaje
if ( obj.inputTable().name() != "" )
    msg += "n" + "Tabla asociada: " + obj.inputTable().name() + "n";

// Si tiene tabla destino se añade al mensaje
if ( obj.outputTable().name() != "" )
    msg += "n" + "Tabla destino: " + obj.outputTable().name() + "n";

// Si es una rejilla se muestra el número de columnas
if ( obj.type() == VObjectInfo.TypeGrid )
    msg += "n" + "Es una rejilla y tiene " + obj.subObjectCount( 15 ) + " columnas";
```
