Class Fragment
Class representing an independent fragment (slice) of a BCM Document.
Inherited Members
Namespace: Sdl.Core.Bcm.BcmModel
Assembly: Sdl.Core.Bcm.BcmModel.dll
Syntax
public class Fragment : MetadataContainer, 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
public List<int> CommentDefinitionIds { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.Int32> | The list of CommentDefinition IDs associated with this fragment. |
ContextList
Gets or sets the list of Context IDs associated with this fragment.
Declaration
public IList<int> ContextList { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IList<System.Int32> | The list of Context IDs associated with this fragment.. |
DocumentId
Gets or sets the document identifier.
Declaration
public string DocumentId { get; set; }
Property Value
Type | Description |
---|---|
System.String | The document identifier which uniquely identifies this BCM Fragment. |
Index
The index in the source Document from where this fragment was extracted.
Declaration
public Nullable<int> Index { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int32> | The index in the source Document from where this fragment was extracted. |
Skeleton
Gets or sets the File skeleton.
Declaration
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
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
public string SourceLanguageCode { get; set; }
Property Value
Type | Description |
---|---|
System.String | The source language code. |
StructureContextId
Gets or sets the structure Context associated with this fragment.
Declaration
public int StructureContextId { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | The structure Context associated with this fragment. |
TargetContent
Gets or sets the target content of the BCM fragment.
Declaration
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
public string TargetLanguageCode { get; set; }
Property Value
Type | Description |
---|---|
System.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 |
---|---|
System.Boolean | true if the current object is equal to the |
Equals(Object)
Performs a deep-equals comparison.
System.Object.Equals(object)
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
System.Object | obj |
Returns
Type | Description |
---|---|
System.Boolean |
Overrides
GetHashCode()
Returns a hash code for this instance.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
System.Int32 | A hash code for this instance. |
Overrides
ShouldSerializeCommentDefinitionIds()
Used by JSON.NET serialization.
Declaration
public bool ShouldSerializeCommentDefinitionIds()
Returns
Type | Description |
---|---|
System.Boolean |
|
ShouldSerializeContextList()
Used by JSON.NET serialization.
Declaration
public bool ShouldSerializeContextList()
Returns
Type | Description |
---|---|
System.Boolean |
|
ShouldSerializeSkeleton()
Used by JSON.NET serialization.
Declaration
public bool ShouldSerializeSkeleton()
Returns
Type | Description |
---|---|
System.Boolean |
|
ToString()
Converts to string.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
System.String | A System.String that represents this instance. |