CreateUiDefinition öğeleri

Bu makalede, bir createUiDefinition.json dosyasının desteklenen tüm öğeleri için şema ve özellikler açıklanmaktadır.

Şema

Çoğu öğe için şema aşağıdaki gibidir:

{
  "name": "element1",
  "type": "Microsoft.Common.TextBox",
  "label": "Some text box",
  "defaultValue": "my value",
  "toolTip": "Provide a descriptive name.",
  "constraints": {},
  "options": {},
  "visible": true
}
Özellik Zorunlu Veri Akışı Açıklaması
name Yes Bir öğenin belirli bir örneğine başvurmak için iç tanımlayıcı. Öğe adının en yaygın kullanımı, outputsbelirtilen öğelerin çıkış değerlerinin şablonun parametrelerine eşlendiği içindedir. Bir öğenin çıkış değerini başka bir öğenin çıkış değerine bağlamak için defaultValue de kullanabilirsiniz.
type Yes öğesi için işlenmek üzere kullanıcı arabirimi denetimi. Desteklenen türlerin listesi için bkz . Öğeler.
label Yes öğesinin görüntüleme metni. Bazı öğe türleri birden çok etiket içerdiğinden, değer birden çok dize içeren bir nesne olabilir.
defaultValue Hayır öğesinin varsayılan değeri. Bazı öğe türleri karmaşık varsayılan değerleri desteklediğinden, değer bir nesne olabilir.
toolTip Hayır Öğenin araç ipucunda görüntülenecek metin. benzer şekilde label, bazı öğeler birden çok araç ipucu dizesini destekler. Satır içi bağlantılar Markdown söz dizimi kullanılarak eklenebilir.
constraints Hayır Öğesinin doğrulama davranışını özelleştirmek için kullanılan bir veya daha fazla özellik. Kısıtlamalar için desteklenen özellikler öğe türüne göre değişir. Bazı öğe türleri doğrulama davranışını özelleştirmeyi desteklemez ve bu nedenle kısıtlama özelliği yoktur.
options Hayır öğesinin davranışını özelleştiren diğer özellikler. benzer şekilde constraints, desteklenen özellikler öğe türüne göre değişir.
visible Hayır Öğesinin görüntülenip görüntülenmeyeceğini gösterir. ise true, öğesi ve ilgili alt öğeler görüntülenir. Varsayılan değer şudur: true. Bu özelliğin değerini dinamik olarak denetlemek için mantıksal işlevleri kullanın.

Öğeler

Her öğenin belgeleri bir kullanıcı arabirimi örneği, şema, öğenin davranışıyla ilgili açıklamalar (genellikle doğrulama ve desteklenen özelleştirmeyle ilgili) ve örnek çıktı içerir.

Sonraki adımlar

UI tanımları oluşturmaya giriş için bkz . CreateUiDefinition'ı kullanmaya başlama.