Search Results for

    Show / Hide Table of Contents

    Class Segment

    Basic unit of translatable content.

    Inheritance
    Object
    MarkupData
    MarkupDataContainer
    Segment
    Inherited Members
    MarkupDataContainer.GetAllChildren(Func<MarkupData, Boolean>)
    MarkupDataContainer.GetAllChildren<T>(Func<T, Boolean>)
    MarkupDataContainer.Add(MarkupData)
    MarkupDataContainer.Add(IEnumerable<MarkupData>)
    MarkupDataContainer.Insert(Int32, MarkupData)
    MarkupDataContainer.Remove(MarkupData)
    MarkupDataContainer.Clear()
    MarkupDataContainer.IndexOf(MarkupData)
    MarkupDataContainer.GetEnumerator()
    MarkupDataContainer.MoveToContainer(MarkupDataContainer, Int32, Int32, Int32)
    MarkupDataContainer.Children
    MarkupDataContainer.AllSubItems
    MarkupDataContainer.Count
    MarkupDataContainer.Item[Int32]
    MarkupData.Id
    MarkupData.Parent
    MarkupData.ParentFragment
    MarkupData.ParentParagraph
    MarkupData.ParentParagraphUnit
    MarkupData.Ancestors
    MarkupData.ParentSegment
    MarkupData.IsContainer
    MarkupData.IndexInParent
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Sdl.LanguagePlatform.TranslationMemoryApi.LiteBCM
    Assembly: Sdl.LanguagePlatform.TranslationMemoryApi.dll
    Syntax
    public class Segment : MarkupDataContainer

    Constructors

    Segment(String)

    Initializes a new instance of the Segment class.

    Declaration
    public Segment(string segmentNumber)
    Parameters
    Type Name Description
    String segmentNumber

    The segment number.

    Segment(String, ConfirmationLevel)

    Initializes a new instance of the Segment class.

    Declaration
    public Segment(string segmentNumber, ConfirmationLevel confirmationLevel)
    Parameters
    Type Name Description
    String segmentNumber

    The segment number.

    ConfirmationLevel confirmationLevel

    The confirmation level.

    Segment(String, String)

    Initializes a new instance of the Segment class.

    Declaration
    public Segment(string id, string segmentNumber)
    Parameters
    Type Name Description
    String id
    String segmentNumber

    The segment number.

    Properties

    ConfirmationLevel

    Gets or sets the confirmation level (translation status).

    Declaration
    public ConfirmationLevel ConfirmationLevel { get; set; }
    Property Value
    Type Description
    ConfirmationLevel

    The confirmation level (translation status).

    IsLocked

    Gets or sets a value indicating whether this instance is locked for editing.

    Declaration
    public bool IsLocked { get; set; }
    Property Value
    Type Description
    Boolean

    true if this instance is locked for editing; otherwise, false.

    SegmentNumber

    Gets or sets the segment number. Can not be null or empty.

    Declaration
    public string SegmentNumber { get; set; }
    Property Value
    Type Description
    String

    The segment number.

    SiblingSegment

    Gets the sibling segment.

    Declaration
    public Segment SiblingSegment { get; }
    Property Value
    Type Description
    Segment

    The sibling segment.

    Remarks

    If this is the source segment, it retrieves the target (and the other way around)

    TranslationOrigin

    Gets or sets the translation origin (translation source information).

    Declaration
    public TranslationOrigin TranslationOrigin { get; set; }
    Property Value
    Type Description
    TranslationOrigin

    The translation origin.

    Type

    Gets the type of MarkupData.

    Declaration
    protected override string Type { get; set; }
    Property Value
    Type Description
    String

    The type.

    Overrides
    MarkupData.Type

    Methods

    AcceptVisitor(LiteBcmVisitor)

    Accepts a visitor of type LiteBcmVisitor.

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

    The LiteBcmVisitor used to visit this item.

    Overrides
    MarkupData.AcceptVisitor(LiteBcmVisitor)

    ToString()

    Converts to string.

    Declaration
    public override string ToString()
    Returns
    Type Description
    String

    A System.String that represents this instance.

    Overrides
    MarkupDataContainer.ToString()

    See Also

    MarkupDataContainer
    In this article
    Back to top Generated by DocFX