Class Document

The BCM root element.

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

Constructors

Document()

Public constructor.

Declaration
public Document()

Properties

Files

A collection of all the Files in this document.

Declaration
[DataMember(Name = "files")]
public FileCollection Files { get; set; }
Property Value
Type Description
FileCollection

Id

The document ID. Uniquely identifies a BCM document.

Declaration
[DataMember(Name = "id")]
public string Id { get; set; }
Property Value
Type Description
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
[DataMember(Name = "modelVersion")]
public string ModelVersion { get; }
Property Value
Type Description
string

Name

The BCM document name.

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

SourceLanguageCode

The source language code.

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

"en-GB"

SourceLanguageName

Gets or sets the source language display name.

Declaration
[Obsolete("Will be removed in a future version. Use the LanguageRegistry instead for retrieving language information.")]
[DataMember(Name = "sourceLanguageName", EmitDefaultValue = false)]
public string SourceLanguageName { get; set; }
Property Value
Type Description
string

The name of the source language.

TargetLanguageCode

The source language code.

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

"de-DE"

TargetLanguageName

Gets or sets the target language display name.

Declaration
[Obsolete("Will be removed in a future version. Use the LanguageRegistry instead for retrieving language information.")]
[DataMember(Name = "targetLanguageName", EmitDefaultValue = false)]
public string TargetLanguageName { get; set; }
Property Value
Type Description
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
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
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

Implements