Home »
Todas las entradas
methods
Es opcional y permite especificar los métodos "client-executed" que proporciona el control. Cada miembro del grupo identifica un método. El nombre de cada uno es el también el nombre del método, incluyendo su prefijo "$". Los elementos válidos para la definición de un método son:
Es obligatorio, será el número (entero positivo) del método. Debe ser único dentro del contexto del control. Es utilizado internamente por Omnis.
Es obligatorio, y deberá consistir en un texto descriptivo del método.
Es obligatorio e indica el tipo de dato que retorna el método. ("integer", "boolean", "character" o "list")
Es opcional. Consiste en una matriz que describe los parámetros del método. Cada miembro de la matriz es un parámetro con los siguientes atributos:
Es obligatorio y es el nombre del parámetro. Omnis insertará el carácter "p" al comienzo de este nombre.
Es obligatorio y deberá consistir en un texto descriptivo del parámetro.
Es obligatorio e indica el tipo de datos que admitirá el parámetro. ("integer", "character", "boolean" o "list").
Opcional. Deberá ser booleano. (por defecto "false") Si es "true", el parámetro se marcará como no-alterable.
Opcional. Deberá ser booleano. (por defecto "false"). Si es "true", el parámetro se marcará como opcional.
Ejemplo:
"methods": {
"$mymethod1": {
"id": 1,
"desc": "This is my method",
"type": "integer", "parameters": [
{
"name": "p1",
"type": "character",
"altered": true,
"desc": "The parameter p1"
},
{
"name": "p2",
"type": "integer",
"desc": "The parameter p2",
"optional":true
}
]
}
}
events
Es opcional y permite especificar los eventos que generará el control (además de los indicados en el grupo "flags"). Cada miembro del objeto events identifica un evento. El nombre de cada uno es también el nombre del evento, incluyendo su prefijo "ev". Se pueden incluir ciertos eventos estándar, tales como: "evClick", "evDoubleClick", "evTabSelected", "evCellChanges", "evHeaderClick" y "evHeadedListDisplayOrderChanged". Los elementos válidos de cada objeto-evento son:
No debe especificarse para eventos estándar, pero, para el resto es obligatorio y debe ser un número entero positivo. Este identificador deberá coincidir con el identificador de evento, usado en la construcción del control JavaScript y ser único dentro del contexto del mismo.
No debe especificarse para eventos estándar, pero, para el resto es obligatorio y deberá consistir en un texto descriptivo del evento.
Define los parámetros del evento. Consiste es una lista, donde cada línea de la misma, identifica a cada uno de los parámetros, conformando por los siguientes elementos:
Es obligatorio y da nombre al parámetro. No deberá incluirse el prefijo "p". (ya que será agregado por Omnis) Tenga en cuenta que si se usara de nuevo el mismo nombre para definir otro parámetro, se tomará sólo su primera definición, ignorándose el resto, incluyendo su tipo y descripción.
Es obligatorio e indica el tipo de datos que admitirá el parámetro. ("integer", "character", "boolean" o "list").
Es obligatorio y deberá consistir en un texto descriptivo del parámetro.
Ejemplo:
"events": {
"evNetOmnisControlOpened": {
"id": 1,
"desc": "The event sent when the control opens",
"parameters": [
{
"name": "name",
"type": "character",
"desc": "The name event parameter"
},
{
"name": "name2",
"type": "integer",
"desc": "The second event parameter"
}
]
},
"evClick": {
"parameters": [
{
"name": "zname1",
"type": "character",
"desc": "The zname1 event parameter"
},
{
"name": "zname2",
"type": "integer",
"desc": "The zname2 event parameter"
},
{
"name": "horzcell",
"type": "character",
"desc": "the horz cell event parameter"
}
]
}
multivalueproperties
El grupo de propiedades multivalor es opcional y permite configurar propiedades que pueden contener múltiples valores. A continuación describimos cada uno de sus miembros:
Es obligatorio. Cuando un control admite propiedades con varios valores, éstas son guardadas en una lista. Cada fila de la lista contendrá el conjunto de propiedades de la pestaña o columna en particular. Llamaremos a la pestaña o columna "elemento". Esto significa que éstas propiedades mostrarán una lista de tipos, que se ocultará automáticamente sobre el "Property manager".
Es obligatorio y debe ser el nombre de una propiedad "integer" definida en el grupo de propiedades, de modo que se podrá especificar el número de elementos en la lista. Se podrá especificar un valor máximo para esta propiedad, a fin de restringir el número de elementos, de lo contrario se limitará a no más de 256.
Es obligatorio y debe ser el nombre de una propiedad "integer" definida en el grupo de propiedades. Identifica al elemento actual seleccionado en el "Property Manager", los cambios aplican sólo a propiedades multi-valor.
Es obligatorio y debe ser el nombre de una propiedad "integer" definida en el grupo de propiedades. Es utilizado para mover el elemento actual a una nueva posición en la lista de elementos.
Es obligatorio. Permite conformar su lista de valores. Cada miembro ("Property Name") deberá corresponder con el nombre de una propiedad de entre el grupo de propiedades principal; El valor para cada miembro conforma la lista de valores para la propiedad. Es importante no cambiar el orden de las columnas una vez se haya comenzado a utilizar el control.
Ejemplo:
"multivalueproperties": {
"currentitemproperty": "curitem",
"itemlistproperty": "itemlist",
"moveitemproperty": "move",
"itemcountproperty": "itemcount",
"properties": {
"mvprop1": 1,
"mvprop2": 2
}
}
}
constants
Es obligatorio y permite definir las constantes del control. Cada miembro del objeto constantes es en sí mismo un objeto que contiene los miembros que describen cada constante. Su nombre será también el nombre de la constante. Los elementos válidos para definir cada objeto constante son:
Es el valor de tipo "integer" de la constante y es obligatorio.
Descripción de la constante. Un texto obligatorio, utilizado por el IDE como información adicional para la herramienta "catalog".
Identifica al grupo en el "catalog" al que pertenece la constante y es opcional. De forma predeterminada, todas las constantes pertenecerán al grupo "RF:jsControls-≤control name≥". Todas las constantes que figuren a continuación de la que contenga un nombre del grupo, se entenderá como pertenecientes a ese grupo, hasta que se especifique un nuevo nombre de grupo (si procede).
Ejemplo:
"constants": {
"kNetOmnisControlHeaderColor": {
"value": 123,
"desc": "The description of this constant"
},
"kNetOmnisControl1Range1": {
"value": 3,
"desc": "Range constant 1”,
“group": “Ranges"
},
"kNetOmnisControl1Range2": {
"value": 5,
"desc": "Range constant 2"
}
}