Class ParagraphUnit

The main element of translatable content. Contains a source and target Paragraph element.

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

Constructors

ParagraphUnit()

Initializes a new instance of the ParagraphUnit class.

Declaration
public ParagraphUnit()

Properties

CommentDefinitionIds

Gets or sets the list of CommentDefinition IDs.

Declaration
[DataMember(Name = "commentDefinitionIds", EmitDefaultValue = false)]
public List<int> CommentDefinitionIds { get; set; }
Property Value
Type Description
List<int>

The list of CommentDefinition IDs.
Remarks

This holds any ParagraphUnit level comments.

ContextList

Gets or sets the list of Context IDs associated with this instance.

Declaration
[DataMember(Name = "contextList", EmitDefaultValue = false)]
public IList<int> ContextList { get; set; }
Property Value
Type Description
IList<int>

The list of Context IDs associated with this instance.

Id

Gets or sets the identifier.

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

The identifier.

Index

Gets or sets the index of this instance in the ParentFile.

Declaration
[DataMember(Name = "index")]
[JsonConverter(typeof(FloatToIntConverter))]
public int Index { get; set; }
Property Value
Type Description
int

The index of this instance in the ParentFile.

IsLocked

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

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

true if this instance is locked; otherwise, false.

IsStructure

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

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

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

A structure ParagraphUnit is not usually used as translatable content.

ParentFile

Gets or sets the parent File.

Declaration
public File ParentFile { get; set; }
Property Value
Type Description
File

The parent File.

ParentFileId

Gets or sets the parent File identifier.

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

The parent File identifier.

SegmentPairs

Gets all the source and target Segment in this instance, paired as SegmentPair elements.

Declaration
public SegmentPairCollection SegmentPairs { get; }
Property Value
Type Description
SegmentPairCollection

The segment pairs.

Source

Gets or sets the source Paragraph.

Declaration
[DataMember(Name = "source")]
public Paragraph Source { get; set; }
Property Value
Type Description
Paragraph

The source Paragraph.

StructureContextId

Gets or sets the id of the structure Context.

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

The id of the structure Context.

Target

Gets or sets the target Paragraph.

Declaration
[DataMember(Name = "target")]
public Paragraph Target { get; set; }
Property Value
Type Description
Paragraph

The target Paragraph.

Methods

Clone()

Clones this instance.

Declaration
public ParagraphUnit Clone()
Returns
Type Description
ParagraphUnit

A deep clone of this instance.

Equals(ParagraphUnit)

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

Declaration
public bool Equals(ParagraphUnit other)
Parameters
Type Name Description
ParagraphUnit 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.

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

Implements