Class Segment

Basic unit of translatable content.

Inheritance
object
ExtensionDataContainer
MetadataContainer
MarkupData
MarkupDataContainer
Segment
Implements
Inherited Members
Namespace: Sdl.Core.Bcm.BcmModel
Assembly: Sdl.Core.Bcm.BcmModel.dll
Syntax
[DataContract]
public class Segment : MarkupDataContainer, IEquatable<MetadataContainer>, ICloneable<MarkupData>, IEquatable<MarkupData>

Constructors

Segment()

Initializes a new instance of the Segment class.

Declaration
public Segment()

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.

Properties

AlignmentData

Gets or sets the alignment data.

Declaration
[DataMember(Name = "alignmentData")]
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public AlignmentData AlignmentData { get; set; }
Property Value
Type Description
AlignmentData

The alignment data.
Remarks

Used by the alignment processing.

CharacterCount

Gets or sets the character count.

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

The character count.

ConfirmationLevel

Gets or sets the confirmation level (translation status).

Declaration
[DataMember(Name = "confirmationLevel", EmitDefaultValue = false)]
[JsonProperty(DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate, NullValueHandling = NullValueHandling.Ignore)]
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
[DataMember(Name = "isLocked", EmitDefaultValue = false)]
public bool IsLocked { get; set; }
Property Value
Type Description
bool

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

SegmentNumber

Gets or sets the segment number.

Declaration
[DataMember(Name = "segmentNumber")]
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)

Tokens

Gets or sets the tokens.

Declaration
[DataMember(Name = "tokens")]
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public List<Token> Tokens { get; set; }
Property Value
Type Description
List<Token>

The tokens.
Remarks

Used by the tokenization process.

TranslationOrigin

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

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

The translation origin.

Type

Gets the type of MarkupData.

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

The type.
Overrides

WordCount

Gets or sets the word count.

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

The word count.

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

Clone()

Clones this instance.

Declaration
public Segment Clone()
Returns
Type Description
Segment

A deep clone of this instance.

CloneWithoutChildren()

Creates a clone of this instance, without any children elements.

Declaration
public override MarkupDataContainer CloneWithoutChildren()
Returns
Type Description
MarkupDataContainer

A clone of this instance, without any children elements.
Overrides

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

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

GetHashCode()

Returns a hash code for this instance.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for this instance.
Overrides

ToString()

Converts to string.

Declaration
public override string ToString()
Returns
Type Description
string

A string that represents this instance.
Overrides

UniqueClone()

Clones this instance, setting a new unique id.

Declaration
public Segment UniqueClone()
Returns
Type Description
Segment

A deep clone of this instance, with a new unique id.

Implements

See Also