Class Document
The BCM root element.
Inherited Members
Namespace: Sdl.Core.Bcm.BcmModel
Assembly: Sdl.Core.Bcm.BcmModel.dll
Syntax
public class Document : MetadataContainer, ICloneable<Document>Constructors
Document()
Public constructor.
Declaration
public Document()Properties
Files
A collection of all the Files in this document.
Declaration
public FileCollection Files { get; set; }Property Value
| Type | Description |
|---|---|
| FileCollection |
Id
The document ID. Uniquely identifies a BCM document.
Declaration
public string Id { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
IdGenerator
Used for managing sequential numeric IDs of different elements.
Declaration
public IdGenerator IdGenerator { get; }Property Value
| Type | Description |
|---|---|
| IdGenerator |
ModelVersion
The semantic version of the BCM used for creating this document.
Declaration
public string ModelVersion { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Name
The BCM document name.
Declaration
public string Name { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
SourceLanguageCode
The source language code.
Declaration
public string SourceLanguageCode { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Examples
"en-GB"
SourceLanguageName
Gets or sets the source language display name.
Declaration
public string SourceLanguageName { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The name of the source language. |
TargetLanguageCode
The source language code.
Declaration
public string TargetLanguageCode { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Examples
"de-DE"
TargetLanguageName
Gets or sets the target language display name.
Declaration
public string TargetLanguageName { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The name of the target language. |
Methods
Clone()
Deep-clones a Document.
Declaration
public Document Clone()Returns
| Type | Description |
|---|---|
| Document |
DeserializeFromString(String)
Declaration
public static Document DeserializeFromString(string json)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | json |
Returns
| Type | Description |
|---|---|
| Document |
Equals(Document)
Performs a deep-equals comparison.
Declaration
public bool Equals(Document other)Parameters
| Type | Name | Description |
|---|---|---|
| Document | 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. |