Skip to main content
Las siguientes funciones están disponibles para crear scripts personalizados. Para acceder a las instancias de objeto, use la variable commandArgs. Todas las variables de esta sección son globales y están visibles en todo el programa.

Rutas de campos

Algunas funciones reciben la ruta a un campo como parámetro de entrada. La ruta incluye el nombre del campo y los nombres de los elementos padre (grupo de campos, sección). Para tablas, tablas repetidas y grupos repetidos, debe especificar el número de instancia comenzando por 0 (cero). Por ejemplo, ['Document Section 1', 'Group[10]', 'Field3'], donde [10] es el número de la instancia del grupo repetido.

Funciones para trabajar con fields

getCurrentField

getCurrentField() Devuelve un vínculo al objeto de campo que usa el script personalizado actual.

getFieldByName

getFieldByName(namesPath) Devuelve un enlace al campo para el que se abrió el script personalizado.

getFieldValue

getFieldValue(namesPath) Devuelve el valor del campo: una cadena para un campo TextField, un valor de marca de verificación para un campo Checkmark o un array de cadenas para un campo Checkmark Group.

setCurrentFieldValue

setCurrentFieldValue(value, forced, onSaved) Modifica el valor del campo para el que se abrió el script personalizado.

setFieldValue

setFieldValue(namesPath | field, value, forced, onSaved) Modifica el valor del campo.

save

save() Cierra la ventana en la que se ejecuta el script personalizado y guarda los cambios.

cancel

cancel() Cierra la ventana en la que se ejecuta el script personalizado sin guardar los cambios.

Funciones para trabajar con conjuntos de datos

addEntity

addEntity(entityInfo: {cacheName, columns, values}, onResult(newId)) Agrega una entrada al conjunto de datos.

editEntity

editEntity(entityInfo: {cacheName, columns, values}, onResult()) Edita una entrada de la base de datos.

getDict

getDict({cacheName, filters: [{FieldName, FieldValue}], cursorPos, allowMultipleColumnResults}, onResult(param: {FieldName, FieldValue, BoldMask}[][])) Busca en el conjunto de datos un valor especificado o una parte de él. BoldMask es una cadena de 0 y 1 de la misma longitud que el valor encontrado. 1 marca un símbolo del valor encontrado que coincide con el símbolo correspondiente en el campo de búsqueda y 0 marca uno que no coincide. Por ejemplo, si un conjunto de datos contiene CompanyName: ABBYY y se realiza una búsqueda de los símbolos ABB, se devuelve lo siguiente:
El array devuelto puede contener varios valores, incluidos algunos que inicialmente no se ajustaban a las condiciones de búsqueda. Los resultados se ordenan de forma descendente ըստ el valor de BoldMask, comenzando por las cadenas que mejor coinciden con las condiciones de búsqueda.

getDictAll

getDictAll({cacheName, filters: {FieldName, FieldValue}}, }, onResult(param: {FieldName, FieldValue, BoldMask}[][])) Busca en la base de datos el valor completo especificado. Devuelve los valores de todos los campos encontrados. BoldMask es una cadena de 0 y 1 de la misma longitud que el valor encontrado. Un 1 marca un símbolo del valor encontrado que coincide con el símbolo correspondiente en el campo de búsqueda, mientras que un 0 marca un símbolo que no coincide. Por ejemplo, si un conjunto de datos contiene CompanyName: ABBYY y se buscan los símbolos ABB, se devuelve lo siguiente:
El array devuelto puede contener varios valores, incluidos algunos que inicialmente no cumplían las condiciones de búsqueda. Los resultados se ordenan por el valor de BoldMask de forma descendente, comenzando por las cadenas que mejor coinciden con las condiciones de búsqueda. Para ver un ejemplo completo, consulte el script de ejemplo para buscar en una base de datos.

Funciones para trabajar con el formulario del documento

selectRow

selectRow(tablePath, rowNumber) Marca como seleccionada una fila de la tabla.

deselectRow

deselectRow(tablePath, rowNumber?) Quita la selección de una fila de una tabla.

scrollFormToField

scrollFormToField(namesPath) Desplaza el editor de formularios hasta mostrar el campo.

getDomElementPosition

getDomElementPosition(domId, onResult: (result?: {width, height, top, left, right, bottom})) Obtiene la posición de un elemento en la ventana del editor de formularios y devuelve el resultado de una función de callback.

setStyles

setStyles(styles, callback) Añade estilos CSS a la ventana del marco de la acción personalizada.

objeto commandArgs

Variables

Eventos

Tipos de objeto de campo

Los scripts personalizados pueden acceder a los siguientes tipos de objeto de campo y al objeto Document. Cada objeto de campo expone el objeto Region a través de su propiedad Regions.

Campo de grupo de campos

Campo Section

Campo de tabla

Objeto Row

Campo de entrada de texto

Valores de TextType

Campo de marca de verificación

Campo de grupo de marcas de verificación

Campo de imagen

Campo de grupo repetido de secciones

Objeto Region

La propiedad Regions de cada objeto de campo devuelve un array de regiones con la siguiente estructura.

Objeto Document

El objeto Document está disponible a través de commandArgs.params.document.

Objeto de error de ensamblaje

Objeto Error

Objeto Page