Search Results for

    Show / Hide Table of Contents

    Class StructureTag

    A tag that is used for document structure only and has no translatable content.

    Inheritance
    object
    ExtensionDataContainer
    MetadataContainer
    MarkupData
    StructureTag
    Implements
    IEquatable<MetadataContainer>
    ICloneable<MarkupData>
    IEquatable<MarkupData>
    ISkeletonItemReference<StructureTagDefinition>
    Inherited Members
    MarkupData.UniqueClone()
    MarkupData.Id
    MarkupData.Parent
    MarkupData.ParentFragment
    MarkupData.ParentParagraph
    MarkupData.ParentParagraphUnit
    MarkupData.Ancestors
    MarkupData.ParentSegment
    MarkupData.IsContainer
    MarkupData.IndexInParent
    MetadataContainer.GetMetadata(string)
    MetadataContainer.SetMetadata(string, string)
    MetadataContainer.Equals(MetadataContainer)
    MetadataContainer.ShouldSerialize_metadata()
    MetadataContainer.Metadata
    ExtensionDataContainer.ExtensionData
    object.GetType()
    object.MemberwiseClone()
    object.ToString()
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    Namespace: Sdl.Core.Bcm.BcmModel
    Assembly: Sdl.Core.Bcm.BcmModel.dll
    Syntax
    [DataContract]
    public class StructureTag : MarkupData, IEquatable<MetadataContainer>, ICloneable<MarkupData>, IEquatable<MarkupData>, ISkeletonItemReference<StructureTagDefinition>

    Constructors

    StructureTag()

    Declaration
    public StructureTag()

    Properties

    Definition

    Gets the definition of this item from the FileSkeleton.

    Declaration
    public StructureTagDefinition Definition { get; }
    Property Value
    Type Description
    StructureTagDefinition

    The definition of this item from the FileSkeleton.

    StructureTagDefinitionId

    Gets or sets the StructureTagDefinition id of this instance.

    Declaration
    [DataMember(Name = "structureTagDefinitionId")]
    public int StructureTagDefinitionId { get; set; }
    Property Value
    Type Description
    int

    The StructureTagDefinition id of this instance.

    TagNumber

    Gets or sets the TagNumber for this instance. This is the same as the "frameworkOriginalTagId" metadata but now exposed on the tag as well (the metadata will become deprecated). If needed, it will be populated on deserialization from the metadata, the value remains null iff not present (which should not be the case).

    Declaration
    [DataMember(Name = "tagNumber")]
    public string TagNumber { get; set; }
    Property Value
    Type Description
    string

    Type

    Gets the type of MarkupData.

    Declaration
    [JsonProperty("type")]
    protected override string Type { get; set; }
    Property Value
    Type Description
    string

    The type.

    Overrides
    MarkupData.Type

    Methods

    AcceptVisitor(BcmVisitor)

    Accepts a visitor of type BcmVisitor.

    Declaration
    public override void AcceptVisitor(BcmVisitor visitor)
    Parameters
    Type Name Description
    BcmVisitor visitor

    The BcmVisitor used to visit this item.

    Overrides
    MarkupData.AcceptVisitor(BcmVisitor)

    Clone()

    Clones this instance.

    Declaration
    public StructureTag Clone()
    Returns
    Type Description
    StructureTag

    A deep clone of this instance.

    Equals(MarkupData)

    Indicates whether the current object is equal to another object of the same type.

    Declaration
    public override bool Equals(MarkupData other)
    Parameters
    Type Name Description
    MarkupData other

    An object to compare with this object.

    Returns
    Type Description
    bool

    true if the current object is equal to the other parameter; otherwise, false.

    Overrides
    MarkupData.Equals(MarkupData)

    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
    MarkupData.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
    MarkupData.GetHashCode()

    Implements

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