Funciones API

Conjunto de Funciones de fórmula que hacen de uso del API de Velneo para retornar valores propios de los proyectos y objetos en tiempo de ejecución.
getCurrentObjectId
Devuelve el identificador del objeto en curso.
Sintaxis
getCurrentObjectId()
Parámetros
No tiene.
Devuelve una cadena con el identificador del objeto en curso.
Ejemplo
Para obtener el identificador del formulario en curso desde un manejador de evento del mismo:
getCurrentObjectId() = ENT_M
getCurrentObjectName
Devuelve el nombre del objeto en curso.
Sintaxis
getCurrentObjectName()
Parámetros
No tiene.
Devuelve una cadena con el nombre del objeto en curso.
Ejemplo
Para obtener el nombre del formulario en curso desde un manejador de evento del mismo:
getCurrentObjectNAME() = Contacto
getCurrentObjectTableId
Devuelve el identificador de la tabla asociada al objeto en curso.
Sintaxis
getCurrentObjectTableId()
Parámetros
No tiene.
Devuelve una cadena con el identificador de la tabla asociada al objeto en curso. Si el objeto no tiene tabla asociada, no devolverá nada.
Ejemplo
Para obtener el identificador de la tabla del formulario en curso desde un manejador de evento del mismo:
getCurrentObjectTableId() = ENT_M
getCurrentObjectTableName
Devuelve el nombre plural de la tabla asociada al objeto en curso.
Sintaxis
getCurrentObjectTableName()
Parámetros
No tiene.
Devuelve una cadena con el nombre de la tabla asociada al objeto en curso. Si el objeto no tiene tabla asociada, no devolverá nada.
Ejemplo
Para obtener el nombre de la tabla del formulario en curso desde un manejador de evento del mismo:
getCurrentObjectTableName() = Contactos
getCurrentObjectTableSingleName
Devuelve el nombre singular de la tabla asociada al objeto en curso.
Sintaxis
getCurrentObjectTableSingleName()
Parámetros
No tiene.
Devuelve una cadena con el nombre singular de la tabla asociada al objeto en curso. Si el objeto no tiene tabla asociada, no devolverá nada.
Ejemplo
Para obtener el nombre de la tabla del formulario en curso desde un manejador de evento del mismo:
getCurrentObjectTableSingleName() = Contacto
getCurrentObjectType
Devuelve el tipo de objeto en curso.
Sintaxis
getCurrentObjectType()
Parámetros
No tiene.
Devuelve una cadena con el nombre del tipo de objeto en curso. 
Ejemplo
Para obtener el tipo de objeto del formulario en curso desde un manejador de evento del mismo:
getCurrentObjectType() = Formulario
getMainObjectId
Devuelve el identificador del objeto principal que se está ejecutando.
Sintaxis
getMainObjectId()
Parámetros
No tiene.
Devuelve una cadena con el identificador del objeto principal que se está ejecutando. Por ejemplo, si estamos ejecutando un menejador de evento de una rejilla que está incrustada en un formulario, nos devolverá el identificador del formulario.
Ejemplo
Para obtener el identificador del formulario donde está incrustada una rejilla en curso desde un manejador de evento de la misma:
getMainObjectId() = ENT_M
getMainObjectName
Devuelve el nombre del objeto principal que se está ejecutando.
Sintaxis
getMainObjectName()
Parámetros
No tiene.
Devuelve una cadena con el nombre del objeto principal que se está ejecutando. Por ejemplo, si estamos ejecutando un menejador de evento de una rejilla que está incrustada en un formulario, nos devolverá el nombre del formulario.
Ejemplo
Para obtener el nombre del formulario donde está incrustada una rejilla en curso desde un manejador de evento de la misma:
getMainObjectName() = Contacto
getMainObjectType
Devuelve el tipo del objeto principal que se está ejecutando.
Sintaxis
getMainObjectType()
Parámetros
No tiene.
Devuelve una cadena con el tipo del objeto principal que se está ejecutando. Por ejemplo, si estamos ejecutando un menejador de evento de una rejilla que está incrustada en un formulario, nos devolverá el tipo de objeto del formulario.
Ejemplo
Para obtener el tipo de objeto del formulario donde está incrustada una rejilla en curso desde un manejador de evento de la misma:
getMainObjectType() = Formulario
getParentObjectId
Devuelve el identificador del objeto padre que contiene el objeto en curso.
Sintaxis
getParentObjetctId()
Parámetros
No tiene.
Devuelve el identificador del objeto padre que contiene el objeto en curso.
Ejemplo
Ejecutamos esta función desde un menejador de evento de una rejilla que está incrustada en un formulario:
getParentObjectId() = ENT_M_MEN
getParentObjectName
Devuelve el nombre del objeto padre que contiene el objeto en curso.
Sintaxis
getParentObjectName()
Parámetros
No tiene.
Devuelve el nombre del objeto padre que contiene el objeto en curso.
Ejemplo
Ejecutamos esta función desde un menejador de evento de una rejilla que está incrustada en un formulario:
getParentObjectName() = Contacto.
getParentObjectType
Devuelve el tipo del objeto padre que contiene el objeto en curso.
Sintaxis
getParentObjectType()
Parámetros
No tiene.
Devuelve el tipo del objeto padre que contiene el objeto en curso.
Ejemplo
Ejecutamos esta función desde un menejador de evento de una rejilla que está incrustada en un formulario:
getParentObjectType() = Formulario.
getPathObjectIds
Devuelve una cadena separada por comas con los identificadores de todos los objetos desde el objeto principal hasta el objeto en curso.
Sintaxis
getPathObjectIds()
Parámetros
No tiene.
Devuelve una cadena separada por comas con los identificadores de todos los objetos desde el objeto principal hasta el objeto en curso.
Ejemplo
Ejecutamos esta función desde un menejador de evento de una rejilla de facturas que está incrustada en un subformulario de un formulario de Clientes:
getPathObjectIds() = CLI,CLI_SUB,FAC.
getPathObjectINames
Devuelve una cadena separada por comas con los nombres de todos los objetos desde el objeto principal hasta el objeto en curso.
Sintaxis
getPathObjectNames()
Parámetros
No tiene.
Devuelve una cadena separada por comas con los nombres de todos los objetos desde el objeto principal hasta el objeto en curso.
Ejemplo
Ejecutamos esta función desde un menejador de evento de una rejilla de facturas que está incrustada en un subformulario de un formulario de Clientes:
getPathObjectNames() = Cliente,Facturas,Facturas.
getPathObjectITypes
Devuelve una cadena separada por comas con los tipos de todos los objetos desde el objeto principal hasta el objeto en curso.
Sintaxis
getPathObjectTypes()
Parámetros
No tiene.
Devuelve una cadena separada por comas con los tipos de todos los objetos desde el objeto principal hasta el objeto en curso.
Ejemplo
Ejecutamos esta función desde un menejador de evento de una rejilla de facturas que está incrustada en un subformulario de un formulario de Clientes:
getPathObjectTypes() = Formulario,Formulario,Rejilla.
getProjectName
Devuelve el nombre del proyecto en curso.
Sintaxis
getProjectName()
Parámetros
No tiene.
Devuelve una cadena con el nombre del proyecto en curso.
Ejemplo
getProjectName() = Velneo vSalesDaybook
getProjectVersion
Devuelve la versión del proyecto en curso.
Sintaxis
getProjectVersion()
Parámetros
No tiene.
Devuelve una cadena con la versión del proyecto en curso.
Ejemplo
getProjectVersion() = 0.1 Beta
getTableHandle
Devuelve el manejador o handle de la tabla en curso en formato hexadecimal.
Sintaxis
getTableHandle()
Parámetros
No tiene.
Devuelve el manejador hexadecimal de la tabla en la que nos encontramos. Este manejador se corresponderá con el orden de creación de la tabla dentro del proyecto. El manejador correspondiente a la primera tabla creada en el proyecto será 0.
Ejemplo
getTableHandle() = 1A