logo
logo
  • Interface IPropertyDefinition

    Represents a data schema / domain model for properties on an IEntityDefinition.

    Namespace: Stylelabs.M.Sdk.Contracts.Base
    Assembly: Stylelabs.M.Sdk.dll
    Syntax
    public interface IPropertyDefinition : IMemberDefinition

    Properties

    Boost

    Indicates whether the content of this property is boosted when searched for via index querying (Elasticsearch powered).

    Declaration
    bool Boost { get; set; }
    Property Value
    Type Description
    System.Boolean

    DataType

    DataType of the value for this property.

    Declaration
    Type DataType { get; }
    Property Value
    Type Description
    Type

    IncludedInCompletion

    Indicates whether the property value is included in the collection of words used for auto-complete functionality in Sitecore Content Hub web portal.

    Declaration
    bool IncludedInCompletion { get; set; }
    Property Value
    Type Description
    System.Boolean

    IncludedInContent

    Indicates whether the property value is included in the full text search content of the Elasticsearch document.

    Declaration
    bool IncludedInContent { get; set; }
    Property Value
    Type Description
    System.Boolean

    Indexed

    Indicates whether the property value is indexed and thus searchable via the basic querying API. Search for value with indexed querying will always work. Note that this value should be set only if required and with good understanding of potential consequences.

    Declaration
    bool Indexed { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsMandatory

    Indicates whether the property is required to be set.

    Declaration
    bool IsMandatory { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsMultiLanguage

    Indicates whether the property is culture sensitive or not.

    Declaration
    bool IsMultiLanguage { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsMultiValue

    Indicates whether the value is an array.

    Declaration
    bool IsMultiValue { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsUnique

    Indicates whether the value of the property is unique among all the property values of this property definition and entity definition.

    Declaration
    bool IsUnique { get; set; }
    Property Value
    Type Description
    System.Boolean

    Can we improve this article ? Provide feedback