CreateUiDefinition, elementy

Ten artykuł jest referencją do elementu pliku createUiDefinition.json, który jest używany przez Azure Managed Applications. Użyj tego artykułu, aby określić, które elementy są obsługiwane w CreateUiDefinition.

Widok formularza dla specyfikacji szablonu używa formatu uiFormDefinition.json . Posiada własną listę obsługiwanych elementów. Wiele elementów widoku formularzy korzysta z tego samego schematu co elementy CreateUiDefinition i linkuje do tych stron referencyjnych, aby uniknąć powielania treści, ale oba formaty nie obsługują dokładnie tych samych elementów.

Schemat

Schemat dla większości elementów jest następujący:

{
  "name": "element1",
  "type": "Microsoft.Common.TextBox",
  "label": "Some text box",
  "defaultValue": "my value",
  "toolTip": "Provide a descriptive name.",
  "constraints": {},
  "options": {},
  "visible": true
}
Właściwości Wymagania opis
name Tak Wewnętrzny identyfikator odwołujące się do określonego wystąpienia elementu. Najczęstszym użyciem nazwy elementu jest w outputspliku , gdzie wartości wyjściowe określonych elementów są mapowane na parametry szablonu. Można go również użyć do powiązania wartości wyjściowej elementu z innym elementem defaultValue .
type Tak Kontrolka interfejsu użytkownika do renderowania elementu. Aby uzyskać listę obsługiwanych typów, zobacz Elementy.
label Tak Tekst wyświetlany elementu. Niektóre typy elementów zawierają wiele etykiet, więc wartość może być obiektem zawierającym wiele ciągów.
defaultValue Nie. Wartość domyślna elementu. Niektóre typy elementów obsługują złożone wartości domyślne, więc wartość może być obiektem.
toolTip Nie. Tekst do wyświetlenia w poradzie narzędzia elementu. Podobnie jak labelw systemie niektóre elementy obsługują wiele ciągów porad narzędzia. Linki wbudowane można osadzać przy użyciu składni języka Markdown.
constraints Nie. Co najmniej jedna właściwości, która służy do dostosowywania zachowania walidacji elementu. Obsługiwane właściwości ograniczeń różnią się w zależności od typu elementu. Niektóre typy elementów nie obsługują dostosowywania zachowania walidacji i w związku z tym nie mają właściwości ograniczeń.
options Nie. Więcej właściwości, które dostosują zachowanie elementu. Podobnie jak w przypadku , obsługiwane właściwości różnią się w zależności od constraintstypu elementu.
visible Nie. Wskazuje, czy element jest wyświetlany. Jeśli truezostanie wyświetlony element i odpowiednie elementy podrzędne. Domyślna wartość to true. Użyj funkcji logicznych, aby dynamicznie kontrolować wartość tej właściwości.

Elementy

Następujące elementy są wspierane w createUiDefinition.json. Dokumentacja każdego elementu zawiera przykładowy interfejs użytkownika, schemat, uwagi dotyczące zachowania elementu (zwykle dotyczące walidacji i obsługiwanego dostosowywania) oraz przykładowe dane wyjściowe.

Aby uzyskać elementy obsługiwane w uiFormDefinition.json, w tym selektory zakresu specyficzne dla widoku formularza, zobacz elementy widoku formularza.

Następne kroki

Aby zapoznać się z wprowadzeniem do tworzenia definicji interfejsu użytkownika, zobacz Wprowadzenie do metody CreateUiDefinition.

  • Last updated on