Class LiteDocument

The BCM root element.

Inheritance

Object

LiteDocument

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Sdl.LanguagePlatform.TranslationMemoryApi.LiteBCM

Assembly: Sdl.LanguagePlatform.TranslationMemoryApi.dll

Syntax

public class LiteDocument

Constructors

LiteDocument(String, String, File)

Creates a new instance of LiteDocument.

Declaration

public LiteDocument(string name, string sourceLanguageCode, File file)

Parameters

Type	Name	Description
String	name	The name of the BCM LiteDocument.
String	sourceLanguageCode	The language code for the BCM LiteDocument source.
File	file	The file to be attached to the document.

LiteDocument(String, String, String, File)

Creates a new instance of LiteDocument.

Declaration

public LiteDocument(string name, string sourceLanguageCode, string targetLanguageCode, File file)

Parameters

Type	Name	Description
String	name	The name of the BCM LiteDocument.
String	sourceLanguageCode	The language code for the BCM LiteDocument source.
String	targetLanguageCode	The language code for the BCM LiteDocument target.
File	file	The file to be attached to the document.

LiteDocument(String, String, String, String, File)

Creates a new instance of LiteDocument.

Declaration

public LiteDocument(string id, string name, string sourceLanguageCode, string targetLanguageCode, File file)

Parameters

Type	Name	Description
String	id	The id of the BCM LiteDocument.
String	name	The name of the BCM LiteDocument.
String	sourceLanguageCode	The language code for the BCM LiteDocument source.
String	targetLanguageCode	The language code for the BCM LiteDocument target.
File	file	The file to be attached to the document.

Exceptions

Type	Condition
System.ArgumentNullException	When any of the parameters is not provided.
ArgumentException	When some of the parameters are not provided.

Properties

File

The File in this document.

Declaration

public File File { get; set; }

Property Value

Type	Description
File

Id

The document ID. Uniquely identifies a BCM document. Can not be null.

Declaration

public string Id { get; set; }

Property Value

Type	Description
String	The identifier.

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
String

Name

The BCM document name. Can not be null

Declaration

public string Name { get; set; }

Property Value

Type	Description
String

SourceLanguageCode

The source language code. Can not be null or empty.

Declaration

public string SourceLanguageCode { get; set; }

Property Value

Type	Description
String

Examples

"en-GB"

TargetLanguageCode

The source language code.

Declaration

public string TargetLanguageCode { get; set; }

Property Value

Type	Description
String

Examples

"de-DE"

"en-GB"