Class Fragment

Class representing an independent fragment (slice) of a BCM Document.

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

Constructors

Fragment()

Initializes a new instance of the Fragment class.

Declaration
public Fragment()

Properties

CommentDefinitionIds

Gets or sets the list of CommentDefinition IDs associated with this fragment.

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

The list of CommentDefinition IDs associated with this fragment.

ContextList

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

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 fragment..

DocumentId

Gets or sets the document identifier.

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

The document identifier which uniquely identifies this BCM Fragment.

Index

The index in the source Document from where this fragment was extracted.

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

The index in the source Document from where this fragment was extracted.

Skeleton

Gets or sets the File skeleton.

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

The file skeleton.

SourceContent

Gets or sets the source content of the BCM fragment.

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

The source content of the Fragment.

SourceLanguageCode

Gets or sets the source language code.

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

The source language code.

StructureContextId

Gets or sets the structure Context associated with this fragment.

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

The structure Context associated with this fragment.

TargetContent

Gets or sets the target content of the BCM fragment.

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

The target content of the BCM fragment.

TargetLanguageCode

Gets or sets the target language code.

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

The target language code.

Methods

Clone()

Clones this instance.

Declaration
public Fragment Clone()
Returns
Type Description
Fragment

A deep clone of this instance.

Equals(Fragment)

Performs a deep-equals comparison.

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

ShouldSerializeCommentDefinitionIds()

Used by JSON.NET serialization.

Declaration
public bool ShouldSerializeCommentDefinitionIds()
Returns
Type Description
bool

True if the CommentDefinitionIds should be serialized; otherwise False

ShouldSerializeContextList()

Used by JSON.NET serialization.

Declaration
public bool ShouldSerializeContextList()
Returns
Type Description
bool

True if the ContextList should be serialized; otherwise False

ShouldSerializeSkeleton()

Used by JSON.NET serialization.

Declaration
public bool ShouldSerializeSkeleton()
Returns
Type Description
bool

True if the Skeleton should be serialized; otherwise False

ToString()

Converts to string.

Declaration
public override string ToString()
Returns
Type Description
string

A string that represents this instance.
Overrides

Implements