Compartir vía

Elementos CreateUiDefinition

  • Artículo

En este artículo se describen el esquema y las propiedades de todos los elementos admitidos de un archivo createUiDefinition.json .

Schema

El esquema de la mayoría de los elementos es el siguiente:

{
  "name": "element1",
  "type": "Microsoft.Common.TextBox",
  "label": "Some text box",
  "defaultValue": "my value",
  "toolTip": "Provide a descriptive name.",
  "constraints": {},
  "options": {},
  "visible": true
}
Propiedad Obligatorio Descripción
name Sí Un identificador interno para hacer referencia a una instancia específica de un elemento. El uso más común del nombre del elemento es en outputs, donde se asignan los valores de salida de los elementos especificados a los parámetros de la plantilla. También se puede usar para enlazar el valor de salida de un elemento a defaultValue de otro elemento.
type Sí El control de interfaz de usuario que se representa para el elemento. Para ver una lista de los tipos admitidos, consulte Elementos.
label Sí Texto para mostrar del elemento. Algunos tipos de elementos contienen varias etiquetas, por lo que el valor podría ser un objeto que contiene varias cadenas.
defaultValue No Valor predeterminado de la propiedad. Algunos tipos de elemento admiten valores predeterminados complejos, por lo que el valor podría ser un objeto.
toolTip No El texto que se muestra en la información sobre herramientas del elemento. Similar a label, algunos elementos admiten varias cadenas de información sobre herramientas. Se pueden insertar vínculos en línea con la sintaxis de Markdown.
constraints No Una o varias propiedades que se utilizan para personalizar el comportamiento de validación del elemento. Las propiedades que se admiten para las restricciones varían según el tipo de elemento. Algunos tipos de elementos no admiten la personalización del comportamiento de validación y, por tanto, no tienen ninguna propiedad de restricciones.
options No Más propiedades que personalizan el comportamiento del elemento. De forma similar a constraints, las propiedades que se admiten varían según el tipo de elemento.
visible No Indica si se muestra el elemento. Si true, se muestran el elemento y los elementos secundarios aplicables. El valor predeterminado es true. Use funciones lógicas para controlar dinámicamente el valor de esta propiedad.

Elementos

La documentación de cada elemento contiene un ejemplo de interfaz de usuario, un esquema, comentarios sobre el comportamiento del elemento (normalmente sobre la validación y personalización compatibles) y una salida de ejemplo.

Pasos siguientes

Para ver una introducción sobre la creación de definiciones de interfaz de usuario, consulte Introducción a CreateUiDefinition.