Search Results for

    Show / Hide Table of Contents

    Class FieldBase

    The field base class

    Inheritance
    object
    FieldBase
    FieldBoolean
    FieldDate
    FieldDateTime
    FieldDecimal
    FieldDictionary
    FieldDynamicView
    FieldGeoPoint
    FieldLong
    FieldMultiFieldset
    FieldMultiRelation
    FieldMultiTagbox
    FieldSingleFieldset
    FieldSingleRelation
    FieldSingleTagbox
    FieldString
    FieldTranslatedString
    FieldTreeView
    FieldTrigger
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: System.Dynamic.ExpandoObject
    Syntax
    [JsonConverter(typeof(JsonInheritanceConverter), new object[] { "kind" })]
    [GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
    public abstract class FieldBase

    Properties

    Descriptions

    Language specific field descriptions.

    Declaration
    [JsonProperty("descriptions", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public TranslatedStringDictionary Descriptions { get; set; }
    Property Value
    TranslatedStringDictionary

    FieldNamespace

    The field namespace is auto generated by the system: it carries the hierarchy information.

    Declaration
    [JsonProperty("fieldNamespace", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public string FieldNamespace { get; set; }
    Property Value
    string

    Id

    The field ID. It can be a slug; it must be unique within the schema hierarchy (ancestors / descendants); it must be begin with lower case.

    Declaration
    [JsonProperty("id", Required = Required.Always)]
    [Required]
    public string Id { get; set; }
    Property Value
    string

    Index

    Field is stored for filtering.

    Declaration
    [JsonProperty("index", Required = Required.Always)]
    public bool Index { get; set; }
    Property Value
    bool

    IndexId

    The index ID is auto generated by the system.

    Declaration
    [JsonProperty("indexId", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public string IndexId { get; set; }
    Property Value
    string

    Names

    Language specific field names.

    Declaration
    [JsonProperty("names", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public TranslatedStringDictionary Names { get; set; }
    Property Value
    TranslatedStringDictionary

    Required

    Defines if a field value is mandatory or not.

    Declaration
    [JsonProperty("required", Required = Required.Always)]
    public bool Required { get; set; }
    Property Value
    bool

    SimpleSearch

    Field is stored for simple search.

    Declaration
    [JsonProperty("simpleSearch", Required = Required.Always)]
    public bool SimpleSearch { get; set; }
    Property Value
    bool

    Sortable

    Field is stored for sorting.

    Declaration
    [JsonProperty("sortable", Required = Required.Always)]
    public bool Sortable { get; set; }
    Property Value
    bool

    UiBehavior

    Defines additional only UI-specific behavior

    Declaration
    [JsonProperty("uiBehavior", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public UiFieldBehavior UiBehavior { get; set; }
    Property Value
    UiFieldBehavior

    Methods

    FromJson(string)

    Declaration
    public static FieldBase FromJson(string data)
    Parameters
    string data

    Returns
    FieldBase

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX