Search Results for

    Show / Hide Table of Contents

    Class ContextDefinition

    Holds context data. Can be referenced by multiple Context elements.

    Inheritance
    object
    ExtensionDataContainer
    MetadataContainer
    SkeletonItem
    ContextDefinition
    Implements
    IEquatable<MetadataContainer>
    IEquatable<SkeletonItem>
    ICloneable<ContextDefinition>
    IEquatable<ContextDefinition>
    Inherited Members
    SkeletonItem.Equals(SkeletonItem)
    SkeletonItem.Id
    MetadataContainer.GetMetadata(string)
    MetadataContainer.SetMetadata(string, string)
    MetadataContainer.Equals(MetadataContainer)
    MetadataContainer.ShouldSerialize_metadata()
    MetadataContainer.Metadata
    ExtensionDataContainer.ExtensionData
    object.GetType()
    object.MemberwiseClone()
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    Namespace: Sdl.Core.Bcm.BcmModel.Skeleton
    Assembly: Sdl.Core.Bcm.BcmModel.dll
    Syntax
    [DataContract]
    public class ContextDefinition : SkeletonItem, IEquatable<MetadataContainer>, IEquatable<SkeletonItem>, ICloneable<ContextDefinition>, IEquatable<ContextDefinition>

    Constructors

    ContextDefinition()

    Declaration
    public ContextDefinition()

    Properties

    Description

    Gets or sets the description.

    Declaration
    [DataMember(Name = "description", EmitDefaultValue = false)]
    public string Description { get; set; }
    Property Value
    Type Description
    string

    The description.

    DisplayCode

    Gets or sets the context display code.

    Declaration
    [DataMember(Name = "displayCode", EmitDefaultValue = false)]
    public string DisplayCode { get; set; }
    Property Value
    Type Description
    string

    The context display code.

    DisplayColor

    Gets or sets the context display color.

    Declaration
    [DataMember(Name = "displayColor", EmitDefaultValue = false)]
    public string DisplayColor { get; set; }
    Property Value
    Type Description
    string

    The context display color.

    DisplayName

    Gets or sets the context display name.

    Declaration
    [DataMember(Name = "displayName", EmitDefaultValue = false)]
    public string DisplayName { get; set; }
    Property Value
    Type Description
    string

    The context display name.

    FormattingGroupId

    Gets or sets the formatting group identifier.

    Declaration
    [DataMember(Name = "formattingGroupId", EmitDefaultValue = false)]
    public int FormattingGroupId { get; set; }
    Property Value
    Type Description
    int

    The formatting group identifier.

    IsSidContext

    Gets a value indicating whether this instance is sID context.

    Declaration
    public bool IsSidContext { get; }
    Property Value
    Type Description
    bool

    true if this instance is sID context; otherwise, false.

    IsStructureContext

    Gets or sets a value indicating whether this instance is a structure context.

    Declaration
    [DataMember(Name = "isStructureContext", EmitDefaultValue = false)]
    public bool IsStructureContext { get; set; }
    Property Value
    Type Description
    bool

    true if this instance is a structure context; otherwise, false.

    IsTmContext

    Gets or sets a value indicating whether this instance is a TM context.

    Declaration
    [DataMember(Name = "isTmContext", EmitDefaultValue = false)]
    public bool IsTmContext { get; set; }
    Property Value
    Type Description
    bool

    true if this instance is TM context; otherwise, false.

    IsTmStructureContext

    Gets a value indicating whether this instance is a TM structure context.

    Declaration
    public bool IsTmStructureContext { get; }
    Property Value
    Type Description
    bool

    true if this instance is a TM structure context; otherwise, false.

    TypeId

    Gets or sets the context type identifier.

    Declaration
    [DataMember(Name = "typeId", EmitDefaultValue = false)]
    public string TypeId { get; set; }
    Property Value
    Type Description
    string

    The context type identifier.

    Methods

    Clone()

    Clones this instance.

    Declaration
    public ContextDefinition Clone()
    Returns
    Type Description
    ContextDefinition

    Equals(ContextDefinition)

    Performs a deep-equals comparison.
    System.Object.Equals(object)

    Declaration
    public bool Equals(ContextDefinition other)
    Parameters
    Type Name Description
    ContextDefinition other
    Returns
    Type Description
    bool

    Equals(object)

    Performs a deep-equals comparison.
    System.Object.Equals(object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    object obj
    Returns
    Type Description
    bool
    Overrides
    SkeletonItem.Equals(object)

    GetHashCode()

    Returns a hash code for this instance.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int

    A hash code for this instance.

    Overrides
    SkeletonItem.GetHashCode()

    ToString()

    Converts to string.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    A string that represents this instance.

    Overrides
    object.ToString()

    Implements

    IEquatable<T>
    IEquatable<T>
    ICloneable<T>
    IEquatable<T>
    In this article
    Back to top Generated by DocFX