diff --git a/articles/BCM.NET_client_API.md b/articles/BCM.NET_client_API.md index 1467b0c..b9a1e94 100644 --- a/articles/BCM.NET_client_API.md +++ b/articles/BCM.NET_client_API.md @@ -4,4 +4,15 @@ API reference generated from the code of the BCM .NET Client. ## [BCM .NET Client API Samples](BCM/samples.md) -Samples documenting some usages of the BCM .NET Client. \ No newline at end of file +Samples documenting some usages of the BCM .NET Client. + +## Knowledge Base + +#### DateTime serialization +The official format for DateTime serialization is `yyyy-MM-dd'T'HH:mm:ss.fff'Z'`. The BCM supports both this format and the default .NET DateTime serialization format `MM/dd/yyyy HH:mm:ss` + +#### Unrecognized Token deserialization +Unrecognized Token objects in the serialized BCM are deserialized into a Token of type Word. E.g.: a new type of Token is introduced in the BCM, but an older client, who doesn't recognized this new type of Token, tries to deserialize it. + +### Unrecognized MarkupData deserialization +Unrecognized MarkupData objects in the serialized BCM are deserialized into a MarkupData of type UnknownMarkupData. This is to preserve the data of newly introduced MarkupData objects when deserializing BCM using older clients. Elements of type UnknownMarkupData should be ignored when manipulating BCM in memory. \ No newline at end of file diff --git a/articles/BCM/Assembly/v2.0.0/Sdl.Core.Bcm.BcmModel.dll b/articles/BCM/Assembly/v2.0.0/Sdl.Core.Bcm.BcmModel.dll new file mode 100644 index 0000000..5473f53 Binary files /dev/null and b/articles/BCM/Assembly/v2.0.0/Sdl.Core.Bcm.BcmModel.dll differ diff --git a/articles/BCM/Assembly/v2.0.0/Sdl.Core.Bcm.BcmModel.xml b/articles/BCM/Assembly/v2.0.0/Sdl.Core.Bcm.BcmModel.xml new file mode 100644 index 0000000..a59100c --- /dev/null +++ b/articles/BCM/Assembly/v2.0.0/Sdl.Core.Bcm.BcmModel.xml @@ -0,0 +1,5768 @@ + + + + Sdl.Core.Bcm.BcmModel + + + + + Alignment related information. + + + + + The TranslationUnit identifier. + + + + + Gets or sets the alignment content insert date. + + + + + Gets or sets the alignment model creation date. + + + + + Collection of alignments subject to bilingual compositionality constraints. + + + + + Collection of incompatible alignments. + + + + + + + + A class to represent a continous span of items in an ordered sequence + + + + + The zero-based start index of the span. + + + + + The length of the span (number of items that it covers in the sequence). + + + + + + + + Stores information about an alignment between a pair of objects. + + + + + The source . + + + + + The target . + + + + + A value indicating how reliable this alignment should be considered to be. + A zero value indicates that no reliability-value can be applied. Otherwise, the value should be no greater than 1, which indicates maximum reliability. + + + + + A value recording how the alignment was produced. + + ValueDescription + 1NodeAlignment + 2SeedConfirmation + 3PlaceableAlignment + 4PhraseExtractor + 5Structure + 6TrainedAligner + 7Other + + + + + + + + + Abstract , marking a user annotation on the BCM. + + + + + The annotation ID. + + + + + based equality. + + + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + An representing user comments. + + + + + Gets or sets the comment definition ID. + + + The comment definition ID. + + + + + Gets the type. + + + + + Gets the . + + + + + Accepts a visitor of type . + + The used to visit this item. + + + + Clones this instance. + + The clone. + + + + Clones this instance using a new uniqueu ID. + + The clone. + + + + based equality. + + + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + An representing terminology-related annotations. + + + + + Gets or sets the terminology data identifier. + + + The terminology data identifier. + + + + + Gets the definition. + + + + + Gets the type. + + + + + Accepts a visitor of type . + + The used to visit this item. + + + + based equality. + + + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + A dictionary with support for: + - deep Equals (instead of ref comparison) + - deep GetHashCode (2 refs with the same values will return the same hash code). The default dictionary returns hash code based on reference. + + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class, based on another instance. + + The other instance from which to construct the current instance. + + + + Initializes a new instance of the class. + + The items. + + + + Performs a deep-equals comparison. + + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + A dictionary-based collection of s. + + + + + Initializes a new instance of the class. + + + + + The identifier generator. + + + + + Inserts an element into the at the specified index. + + The zero-based index at which should be inserted. + The object to insert. + + + + Replaces the item at the specified index with the specified item. + + The zero-based index of the item to be replaced. + The new item. + + + + A dictionary which uses hashes generated from the key to store items in a backing dictionary. We may look at generating + long hashes eventually if there are many collisions detected. + + Item from which key will be derived. At the moment, GetHashCode is called on the key to use as actual key in backing Dictionary + value for given key being stored in dictionary + + + + The backing dictionary. + + + + + Initializes a new instance of the class. + + + + + Adds the specified key. + + The key. + The value. + Item with same key already exists in collection + + + + Determines whether the collection contains the specified key. + + The key. + + true if the collection contains the specified key; otherwise, false. + + Multiple matches found in collection + + + + Gets the with the specified key. + + + The . + + The key. + + + Multiple matches found in collection + or + Key not found in collection + + + + + Removes all keys and values from this instance. + + + + + Removes the specified key. + + The key. + + Multiple matches found in collection + + + + Tries to get a value by key. + + The key. + The value. + + + + + Gets the internal hash code used in the backing dictionary. + + The key. + + + + + A implementation with support for deep equality. + + The key. + The value. + + + + The key selector. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The key selector. + + + + Executes an action over each element of the collection. + + The action. + + + + Indicates whether the current object is equal to another object of the same type. + + An object to compare with this object. + + if the current object is equal to the parameter; otherwise, . + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + When implemented in a derived class, extracts the key from the specified element. + + The element from which to extract the key. + + The key for the specified element. + + + + + A of s. + Adds support for setting the parent elements and additonal helper properties. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the parent file. + + + The parent file. + + + + + Inserts an element into the at the specified index. + + The zero-based index at which should be inserted. + The object to insert. + + + + Gets all segment pairs. + + + All segment pairs. + + + + + Gets the segment count. + + + The segment count. + + + + + A collection of s. + Adds support for indexing by segment number. + + + + + Initializes a new instance of the class. + + The enumerable. + + + + Gets the with the specified segment number. + + + The . + + The segment number. + + + + + Returns an enumerator that iterates through the collection. + + + An enumerator that can be used to iterate through the collection. + + + + + Public constants. + + + + + The current BCM model version. + + + + + Metadata key for storing the original tag ID, populated by the SDL Filter Framework. + + + + + Metadata key for storing the original ID, populated by the SDL Filter Framework. + + + + + Metadata used for conversion from BCM back to native format. + If this metadata is True, the same contexts are used. If False, new contexts are created from the BCM contexts. + + + + + DateTime format for serializing and deserializing BCM DateTime properties. + + + + + An abstract class using the Visitor pattern. + Can be implemented for concrete processing of BCM documents. + + + + + Visits a instance. + + The structure tag. + + + + Visits a instance. + + + + + + Visits a instance. + + + + + + Visits a instance. + + + + + + Visits a instance. + + + + + + Visits a instance. + + + + + + Visits a instance. + + + + + Visits a instance. + + + + + + Visits a instance. + + + + + + Visits a instance. + + + + + + Visits a instance. + + + + + + This class holds the constants that represent the suggested + default values to use for the attribute. + + + + + The segment has been manually adapted or translated from scratch. + + + + + Batch translation by applying a Context TM type tool like PerfectMatch(tm) + + + + + Machine translated content + + + + + + Batch pre-translation using a fuzzy or 100% match + + + + + The segment has not yet been translated. This is usually an empty segment. + + + + + The segment has been translated using AutoPropagation from internal matches. + + + + + The segment has been translated by copying the source to the target. + + + + + The translated segment was created by an automated linguistic alignment of previously + translated source and target content. + + + + + The segment was translated by an unknown tool - usually from a third party provider. + + + + + + The segment was updated by ReverseAlignment process. + + + + + Adaptive machine translated content + + + + + Adaptive machine translated content + + + + + Adaptive machine translated content + + + + + Typed ICloneable interface. + + + + + + Clones this instance. + + + + + + Extension methods. + + + + + Performs a deep comparison between two + + The collection element type. + The first collection. + The second collection. + True if the collections are deeply equal. Otherwise false. + + + + Different stages of translation and translation approval for a . + + + + Untranslated content. + + + + Draft (edited) content. + + + + + Translated content. + + + + + Translated content marked as Rejected. + + + + + Translated content marked as Approved. + + + + + Translated content Rejected at Sign-off. + + + + + Translated content Approved at Sign-off. + + + + + Files marked as dependencies for the BCM content. + Used for conversion from and to native formats. + + + + + The Id. + + + + + The id of the given file in the BCM document. + This is used for multi-file sections in the BCM document and for matching the dependency section to the given file section in the BCM document + + + + + Gets or sets the purpose of the dependency file. + + + The purpose of the dependency file. + + + + + Gets or sets the file location. + + + The file location. + + + + + Gets or sets the name of the file. + + + The name of the file. + + + + + Gets or sets the system providing the file. + + + The system providing the file. + + + + + Gets or sets the embedded content. + + + The embedded content. + + In the cases where the dependency file is stored inline, this will contain the B64-encoded ZIP archive of the dependency file + + + + Clones this instance. + + + + + + Performs a deep-equals comparison. + + An object to compare with this object. + + if the current object is equal to the parameter; otherwise, . + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Defines the purpose of a . + + + + + Unknown or not specified. + + + + + Used during the extraction phase. + + + + + Used during the generate phase. + + + + + Used or required for correct operation of the final (localized) file. + + + + + The BCM root element. + + + + + The document ID. Uniquely identifies a BCM document. + + + + + The semantic version of the BCM used for creating this document. + + + + + The BCM document name. + + + + + The source language code. + + "en-GB" + + + + The source language code. + + "de-DE" + + + + Gets or sets the source language display name. + + + The name of the source language. + + + + + Gets or sets the target language display name. + + + The name of the target language. + + + + + A collection of all the s in this document. + + + + + Public constructor. + + + + + Used for managing sequential numeric IDs of different elements. + + + + + Deep-clones a . + + + + + + Performs a deep-equals comparison. + + An object to compare with this object. + + if the current object is equal to the parameter; otherwise, . + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + A object used as base for elements that need to preserve unrecognized data on deserialization. + + + + + Preserves any unrecognized data upon deserialization from JSON. + This data is serialized in its original format. + + + + + Holds feedback information created during the translation and review process. + + Used by the Translation Quality Assessment process(TQA). + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Type of the feedback. + + + + Gets or sets the author. + + + The author. + + + + + Gets or sets the creation date. + + + The creation date. + + + + + Gets or sets the custom category of this feedback. + + + The category. + + + + + Gets or sets the document category. + + + The document category. + + + + + Gets or sets the custom severity. + + + The custom severity. + + + + + OBSOLETE + Gets or sets the comment definition identifier. + + + The comment definition identifier. + + + + + Gets or sets the type of the feedback. + + + The type of the feedback. + + + + + Gets or sets the replacement identifier. + + + The replacement identifier. + + + Id which is used for identifying TQA replacements (replacing an existing piece of markup with new markup). + Both original and new markup (adjacent FeedbackDeleted and FeedbackAdded markers) will contain + an identical ReplacementId GUID in their properties indicating it is a replacement. + + + + + Gets or sets the comment on this review feedback. + + + The comment. + + + + + Gets or sets the feedback origin. + Example values: "auto-filled", "auto-categorized", "interactive" + + + + + Gets or sets the custom feedback type. + + + The feedback type. + + + + + Accepts a visitor of type . + + The used to visit this item. + + + + Clones this instance. + + A deep clone of this instance. + + + + Clones this instance with a new unique ID. + + A deep clone with a new unique ID. + + + + Performs a deep equals comparison. + + The other used for comparison.. + if the current object is equal to the parameter; otherwise, . + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Types of feedback changes created during the translation/review process. + + + + + Added content. + + + + + Deleted content. + + + + + A feedback comment was added. + + + + + BCM data extracted from a native file. + + + + + Gets or sets the identifier. + + + The identifier. + + + + + Gets or sets the original encoding. + + + The original encoding. + + + + + Gets or sets the preferred target encoding. + + + The preferred target encoding. + + + + + The name of the native file from which this was constructed. + + + + + The ID of the filter used for converting the file from native format. + + + + + Dependency files used for converting to and from native format. + + + + + IDs of used as file-level comments. + + + + + The holding all the structure element data referenced in this . + + + + + A collection of all the elements in this . + + + + + Public constructor. + + + + + The parent of this . + + + + + Gets or sets the used for generating sequential IDs./> + + + The identifier generator. + + + + + Clones this instance. + + A deep clone of this instance. + + + + Indicates whether the current object is equal to another object of the same type. + + An object to compare with this object. + + if the current object is equal to the parameter; otherwise, . + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Used by JSON.NET serializer. + + True if the property should be serialized. + + + + Used by JSON.NET serializer. + + True if the property should be serialized. + + + + Constants used for metadata. + + + + + level metadata containing the context file location. + + + + + Class representing an independent fragment (slice) of a BCM . + + + + + Gets or sets the source language code. + + + The source language code. + + + + + Gets or sets the target language code. + + + The target language code. + + + + + Gets or sets the document identifier. + + + The document identifier which uniquely identifies this BCM . + + + + + Gets or sets the skeleton. + + + The file skeleton. + + + + + Gets or sets the source content of the BCM fragment. + + + The source content of the Fragment. + + + + + Gets or sets the target content of the BCM fragment. + + + The target content of the BCM fragment. + + + + + The index in the source from where this fragment was extracted. + + + The index in the source from where this fragment was extracted. + + + + + Gets or sets the structure associated with this fragment. + + + The structure associated with this fragment. + + + + + Gets or sets the list of IDs associated with this fragment. + + + The list of IDs associated with this fragment.. + + + + + Gets or sets the list of IDs associated with this fragment. + + + The list of IDs associated with this fragment. + + + + + Initializes a new instance of the class. + + + + + Used by JSON.NET serialization. + + True if the should be serialized; otherwise False + + + + Used by JSON.NET serialization. + + True if the should be serialized; otherwise False + + + + Used by JSON.NET serialization. + + True if the should be serialized; otherwise False + + + + Clones this instance. + + A deep clone of this instance. + + + + Performs a deep-equals comparison. + + An object to compare with this object. + + if the current object is equal to the parameter; otherwise, . + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Converts to string. + + + A that represents this instance. + + + + + Marks a class as having its definition in the . + + Type parameter. Should be an item from the . + + + + Gets the definition of this item from the . + + + The definition of this item from the . + + + + + Subcontent of a particular BCM content element. + + + + + Gets or sets the offset in the source tag from which the content was extracted. + + + The offset in the source tag from which the content was extracted. + + + + + Gets or sets the content length. + + + The content length. + + + + + Gets or sets the Id holding the content marked by this reference. + + + The Id holding the content marked by this reference. + + + + + Clones this instance. + + A deep clone of this instance. + + + + Performs a deep-equals comparison. + + The other item used for comparison. + True if the items are deeply equal; False otherwise. + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Marks content that is locked for editing. + + + + + Gets the type of . + + + The type. + + + + + Accepts a visitor of type . + + The used to visit this item. + + + + Clones this instance. + + A deep clone of this instance. + + + + Clones this instance, setting a new unique Id. + + A deep clone of this instance, with a new unique Id. + + + + Abstract entity representing an item that can be included inside a . + Examples: , , . + + Inheritors of MarkupData should not implement themselves , but should override equality. + + + + Markup data unique id (GUID). + + + + + Gets or sets the type. Should be implement in derived classes to uniquely identify the type of on deserialization. + + + The type. + + + + + Initializes a new instance of the class. + + The identifier. + + + + Initializes a new instance of the class. + + + + + The parent container. + + + + + The containing this item. + + + + + The containing this item. + + + + + The containing this item. + + + + + This item's ancestors, in ascending order. + + + + + The containing this item. + Null if the item isn't inside of a Segment. + + + + + True if this is a container. Otherwise false. + + + + + The index of this item in the parent . + -1 if it doesn't have a parent. + + + + + Accepts a visitor of type . + + The used to visit this item. + + + + Clones the item to a new . + + + + + + Indicates whether the current object is equal to another object of the same type. + + An object to compare with this object. + + if the current object is equal to the parameter; otherwise, . + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Creates clone of the current object, with a new unique Id. + + A clone with a new unique Id. + + + + A element that can hold other elements. + + + + + + Metadata key, marking thi instance as cloned (duplicated) during conversion from native formats. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The identifier. + + + + The container's direct children. + + + + + All the items in the subtree, in depth-first order. + + + + + Finds all the items in the subtree which satisfy a specific condition, in depth-first order. + + + + + + + Finds all the items in the subtree which satisfy a specific condition, in depth-first order. + + + + + + + Adds a new to the container. + + The item to be added. + The container after the change. + + + + Adds a new to the container. + + The range of items to be added. + The container after the change. + + + + Inserts a new into the container. + + The item to be inserted. + The position where the item should be inserted. + The container after the change. + + + + Removes a item from the container. + + The item to be removed. + The container after the changes. + + + + Removes all the items from this container. + Sets the previous children Parent property to null. + + + + + Gets the number of children of this container. + + + The number of children of this container. + + + + + Gets or sets the at the specified index. + + + The . + + The index. + + + + + Gets an for the container's children. + + An instance enumerating the container's children. + + + + Clones the item to a new . + + A deep clone of this instance. + + + + Indicates whether the current object is equal to another object of the same type. + + An object to compare with this object. + + if the current object is equal to the parameter; otherwise, . + + + + + Moves the children of this container to another instance. + + The target . + Index in the source container, from where to start moving elements. + Index in the target container, where the elements should be inserted. + Number of elements to be moved. + + + + Equalses the specified other. + + The other. + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Converts to string. + + + A that represents this instance. + + + + + Removes a item from the container at a specific index. + + The index of the item to be removed. + The container after the changes. + + + + Creates a new list of children, used by cloning, + + + + + Creates clone of the current object, with a new unique Id. + + + A clone with a new unique Id. + + + + + Creates a clone of this instance, without any children elements. + + A clone of this instance, without any children elements. + + + + An object that contains metadata in the form of a . + + + + + Gets or sets the metadata. + + + The metadata. + + + + + Gets the metadata. + + The metadata key. + The metadata value; or null if the key was not found. + + + + Sets a metadata value. + + The key. + The value. + + + + Indicates whether the current object is equal to another object of the same type. + + An object to compare with this object. + + if the current object is equal to the parameter; otherwise, . + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Needed for JSON serialization. + + True if this instance should be serialized; otherwise False. + + + + A containing the source or target content of a . + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The identifier. + + + + Initializes a new instance of the class with a particular child . + + The to be added as a child to this instance. + + + + The containing this item. + + + + + Gets the type of . + + + The type. + + + + + Accepts a visitor of type . + + The used to visit this item. + + + + Clones this instance. + + A deep clone of this instance. + + + + Clones this instance, assigning a new unique Id. + + A deep clone of this instance, with a new unique Id. + + + + The main element of translatable content. Contains a source and target element. + + + + + Gets or sets the identifier. + + + The identifier. + + + + + Gets or sets the parent identifier. + + + The parent identifier. + + + + + Gets or sets a value indicating whether this instance is a structure . + + + true if this instance is a structure ; otherwise, false. + + A structure is not usually used as translatable content. + + + + Gets or sets a value indicating whether this instance is locked. + + + true if this instance is locked; otherwise, false. + + + + + Gets or sets the id of the structure . + + + The id of the structure . + + + + + Gets or sets the list of IDs associated with this instance. + + + The list of IDs associated with this instance. + + + + + Gets or sets the index of this instance in the . + + + The index of this instance in the . + + + + + Gets or sets the source . + + + The source . + + + + + Gets or sets the target . + + + The target . + + + + + Gets or sets the list of IDs. + + + The list of IDs. + + This holds any level comments. + + + + Initializes a new instance of the class. + + + + + Gets or sets the parent . + + + The parent . + + + + + Gets all the source and target in this instance, paired as elements. + + + The segment pairs. + + + + + Clones this instance. + + A deep clone of this instance. + + + + Converts to string. + + + A that represents this instance. + + + + + Indicates whether the current object is equal to another object of the same type. + + An object to compare with this object. + + if the current object is equal to the parameter; otherwise, . + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Constants with related metadata keys. + + + + + The original paragraph unit identifier used by the SDL Filter Framework. + + + + + Common superclass for the two types of serializer + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Dispose function to override in derived classes + + + + + + + + + + + + + + In-memory partial bcm serializer + + + + + Constructor from file path + + + + + New empty document + + + + + Constructor from Document instance + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns the document packed into a single Document instance + + + + + + + + Bcm serialization interface that allows for not holding the whole bcm document in memory + + + + + Gets document attributes and metadata without the files list. + Updates made to the object returned will be reflected automatically + in the result in case the updated bcm is requested. + + + + + Number of files in this document + + + + + + All file ids in this document + + + + + + Gets serialization wrapper for specific file + + + + + Adds a file, based on the attributes and skeleton in the parameter. + Array of paragraph units must be empty. + + + + + Inserts a file to a specific position, based on the attributes and skeleton + in the parameter. Array of paragraph units must be empty. + + + + + Deletes the file from the document. + + + + + Deletes the file from the document. + + + + + Saves bcm document as single json object + + + + + Saves bcm document as single json object + + + + + Saves bcm document as single json object to TextWriter + + + + + Bcm file serialization interface that allows for not holding the full file in memory + + + + + Gets file attributes and skeleton without any paragraph units in it. + + + + + Updates file attributes and skeleton. Array of paragraph units must be empty. + + + + + Returns the number of paragraph units in this file + + + + + Returns the paragraph unit ids from this file + + + + + Returns a sequence of paragraph units from this file, deserialized one by one + + + + + Deserializes the paragraph unit with specific index in file + + + + + Deserializes the paragraph unit with specific id in file + + + + + Updates paragraph unit in file + + + + + Adds a paragraph unit at the end of the paragraph units list in the file + + + + + Inserts paragraph unit at specific index in file + + + + + Removes paragraph unit with specific index from file + + + + + Removes paragraph unit from file + + + + + Removes multiple paragraph units based on index + + + + + Creates IPartialBcmSerializer instances (either in-memory or temp file based) + + + + + Limit above which we will use a temp file based serializer + instead of and in-memory one + + + + + Creates serializer based on a temp file with the bcm json content. + Does not delete the file. + + + + + Creates serializer from a stream containing bcm json content + + + + + Creates serializer from a Document instance + + + + + Temp file based bcm serializer variant + + + + + Constructor based on file path + + + + + Creates new empty document. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A tag with no translatable content. + + + + + Gets or sets the id. + + + The id. + + + + + Gets or sets the TagNumber for this instance. This is the same as the "frameworkOriginalTagId" + metadata but now exposed on the tag as well (the metadata will become deprecated). + If needed, it will be populated on deserialization from the metadata, the value remains null + iff not present (which should not be the case). + + + + + Gets the definition of this item from the . + + + The definition of this item from the . + + + + + Gets the type of . + + + The type. + + + + + Accepts a visitor of type . + + The used to visit this item. + + + + Indicates whether the current object is equal to another object of the same type. + + An object to compare with this object. + + if the current object is equal to the parameter; otherwise, . + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Clones this instance, setting a new id. + + A deep clone of this instance, with a new unique id. + + + + Marks revisions to the translated content. + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Type of the revision. + + + + Gets or sets the type of the revision. + + + The type of the revision. + + + + + Gets or sets the revision author. + + + The revision author. + + + + + Gets or sets the date when the revision was added. + + + The date when the revision was added. + + + + + Gets the type of . + + + The type. + + + + + Accepts a visitor of type . + + The used to visit this item. + + + + Indicates whether the current object is equal to another object of the same type. + + An object to compare with this object. + + if the current object is equal to the parameter; otherwise, . + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Clones this instance. + + A deep clone of this instance. + + + + Clones this instance, setting a new unique id. + + A deep clone of this instance, with a new unique id. + + + + Types of . + + + + + Content was inserted. + + + + + Content was deleted. + + + + + The content was not changed. + + + + + Basic unit of translatable content. + + + + + + Initializes a new instance of the class. + + The segment number. + + + + Gets or sets the confirmation level (translation status). + + + The confirmation level (translation status). + + + + + Gets or sets a value indicating whether this instance is locked for editing. + + + true if this instance is locked for editing; otherwise, false. + + + + + Gets or sets the word count. + + + The word count. + + + + + Gets or sets the character count. + + + The character count. + + + + + Gets or sets the segment number. + + + The segment number. + + + + + Gets or sets the translation origin (translation source information). + + + The translation origin. + + + + + Gets or sets the tokens. + + + The tokens. + + Used by the tokenization process. + + + + Gets or sets the alignment data. + + + The alignment data. + + Used by the alignment processing. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The segment number. + The confirmation level. + + + + Gets the type of . + + + The type. + + + + + Accepts a visitor of type . + + The used to visit this item. + + + + Clones this instance. + + A deep clone of this instance. + + + + Clones this instance, setting a new unique id. + + A deep clone of this instance, with a new unique id. + + + + Creates a clone of this instance, without any children elements. + + A clone of this instance, without any children elements. + + + + Gets the sibling segment. + + + The sibling segment. + + If this is the source segment, it retrieves the target (and the other way around) + + + + Indicates whether the current object is equal to another object of the same type. + + An object to compare with this object. + + if the current object is equal to the parameter; otherwise, . + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Converts to string. + + + A that represents this instance. + + + + + Information on how specific tags should be segmented. + + + + If possible, the segmentation engine should always include this tag inside a segment. + + + The tag may be left outside of the segment, e.g. if it appears at a segment boundary. + + + + The tag will be included in a segment if the segment also contains text content, + otherwise it will not be included in a segment (in order to prevent segment-only tags). + + + + + The tag will be excluded from a segment, even if this means changing the segmentation. This is used for sub-content processing. + + + + + Constants for metadata. + + + + + metadata key for accesing system fields. + + + + + metadata key for accesing custom fields. + + + + + metadata key for accesing alignment date. + + + + + metadata key for accesing the Translation Unit numerical id. + + + + + metadata key for accesing the Translation Unit GUID id. + + + + + metadata key for accesing the associated contexts. + + + + + Class grouping together the source and equivalent target . + + + + + Initializes a new instance of the class. + + The source. + The target. + + + + Gets or sets the source. + + + The source. + + + + + Gets or sets the target. + + + The target. + + + + + Clones this instance. + + A deep clone of this instance. + + + + Factory providing mapping between string values and concrete implementations of . + + + + + Gets the concrete implementation of . + + The string. + + + + + Class for mapping to different types of . + + + + + Gets the type of based on the string type. + + The type. + + + + + Contains comment data. Can be referenced by multiple instances. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the text. + + + The text. + + + + + Gets or sets the author. + + + The author. + + + + + Gets or sets the comment creation date. + + + The comment creation date. + + + + + Gets or sets the comment severity. + + + The comment severity. + + + + + Clones this instance. + + A dee + + + + Performs a deep-equals comparison. + + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Supported values of comment severity. + + + + + Low comment severity. + + + + + Medium comment severity (default). + + + + + High comment severity. + + + + + Context information, organized as a tree structure. + + + + + Id of the object holding the data for this specific element. + + + + + The id of the parent element. + + + + + Clones this instance. + + A clone of this instance. + + + + Indicates whether the current object is equal to another object of the same type. + + An object to compare with this object. + + if the current object is equal to the parameter; otherwise, . + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Converts to string. + + + A that represents this instance. + + + + + Holds context data. + Can be referenced by multiple elements. + + + + + Gets or sets a value indicating whether this instance is a TM context. + + + true if this instance is TM context; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is a structure context. + + + true if this instance is a structure context; otherwise, false. + + + + + Gets or sets the context type identifier. + + + The context type identifier. + + + + + Gets or sets the context display name. + + + The context display name. + + + + + Gets or sets the context display code. + + + The context display code. + + + + + Gets or sets the context display color. + + + The context display color. + + + + + Gets or sets the description. + + + The description. + + + + + Gets or sets the formatting group identifier. + + + The formatting group identifier. + + + + + Gets a value indicating whether this instance is sID context. + + + true if this instance is sID context; otherwise, false. + + + + + Gets a value indicating whether this instance is a TM structure context. + + + true if this instance is a TM structure context; otherwise, false. + + + + + Clones this instance. + + + + + + Converts to string. + + + A that represents this instance. + + + + + Performs a deep-equals comparison. + + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Holds data for a that is referenced by different elements. + + + A element has a DefinitionId that points to an element in the collection. + + + + + The id. + + + + + Collection of all the elements referenced in a . + + + + + Collection of all the elements referenced in a . + + + + + Collection of all the elements referenced in a . + + + + + Collection of all the elements referenced in a . + + + + + Collection of all the elements referenced in a . + + + + + Collection of all the elements referenced in a . + + + + + Collection of all the elements referenced in a . + + + + + Collection of all the elements referenced in a . + + + + + Collection of all the QuickInsert IDs referenced in a . + + + + + List of all the IDs of s that are sub-content elements. + + + + + The for which this is defined. + + + + + An instance that creates unique numeric IDs for all the elements in different collection. + + + + + Public constructor. + + + + + Clones this instance. + + + + + + Performs a deep-equals comparison. + + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Used by JSON serialization. + + True if should be serialized. + + + + Used by JSON serialization. + + True if should be serialized. + + + + Used by JSON serialization. + + True if should be serialized. + + + + Used by JSON serialization. + + True if should be serialized. + + + + Used by JSON serialization. + + True if should be serialized. + + + + Used by JSON serialization. + + True if should be serialized. + + + + Used by JSON serialization. + + True if should be serialized. + + + + Used by JSON serialization. + + True if should be serialized. + + + + Used by JSON serialization. + + True if should be serialized. + + + + Used by JSON serialization. + + True if should be serialized. + + + + Holds formatting elements that can be applied to different elements of BCM content. + + + + + Collection of formatting elements in this . + + + + + Initializes a new instance of the class. + + + + + Clones this instance. + + + + + + Performs a deep-equals comparison. + + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Used by JSON serialization. + + + + + + Creates unique numeric IDs for all the elements in different collection. + + + + + Gets the next ID. + + + The next ID in the sequence. + + + + Updates the ID sequence with the ID of the specified item. + + + The item. + + + + Updates the ID sequence with the values from the specified . + + The . + + + + Updates the ID sequence with the values from the specified . + + The . + + + + Interface for BCM elements containing terminology attributes. + + + + + Gets or sets the term attributes. + + + The term attributes. + + + + + Definition of a Placeholder. + Can be referenced by multiple elements. + + + + + Gets or sets the display text. + + + The display text. + + + + + Gets or sets the raw Placeholder tag content. + + + The raw Placeholder tag content of the tag. + + + + + Gets or sets the tag text equivalent. + + + The tag text equivalent. + + + + + Gets or sets the segmentation hint. + + + The segmentation hint. + + + + + Gets or sets the of the placeholder tag. + + + The of the tag. + + + + + Gets or sets the QuickInsert ID of the tag. + + + The QuickInsert ID of the tag. + + + + + Initializes a new instance of the class. + + + + + Clones this instance. + + A new clone of this instance. + + + + Indicates whether the current object is equal to another object of the same type. + + An object to compare with this object. + + if the current object is equal to the parameter; otherwise, . + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Base class for collections used in a . + + + + + + Gets the . + + + The . + + + + + Gets or sets the parent . + + + The parent . + + + + + Gets an element by its numerical id. + + The id. + If found, returns the element with the Id ; otherwise returns default() + + + + Gets the element if it already exists in the collection. + Otherwise, it is added to the collection and gives it the next ID in the sequence. + + The element. + The existing element; or the newly added one with an Id set. + + + + Gets the element if it already exists in the collection. + Otherwise, it is added to the collection (preserving its existing ID). + + The element. + The existing element; or the newly added one with an Id set. + + + + Extracts the key from the specified element. + + The element from which to extract the key. + + The key for the specified element. + + + + + Removes all elements from the . + + + + + Inserts an element into the at the specified index. + + The zero-based index at which should be inserted. + The object to insert. + + + + Removes the element at the specified index of the . + + The index of the element to remove. + + + + Replaces the item at the specified index with the specified item. + + The zero-based index of the item to be replaced. + The new item. + + + + Performs a deep-equals comparison. + + + + + + Wrapper used for defining integer keys in the collections. + + + + + Initializes a new instance of the struct. + + The identifier. + + + + Creates a new from an integer. + + The value with which to initialize this instance. + A new instance of the + + + + Gets or sets the identifier. + + + The identifier. + + + + + Performs a deep-equals comparison. + + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Implements the operator ==. + + The left hand item. + The right hand item. + + The result of + + + + + Implements the operator !=. + + The left hand item. + The right hand item. + + The negated result of + + + + + Base class for different types of elements definied in a . + + + + + Gets or sets the identifier. + + + The identifier. + + + + + Indicates whether the current object is equal to another object of the same type. + + An object to compare with this object. + + if the current object is equal to the parameter; otherwise, . + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Definition of a StructureTag. + Can be referenced by multiple elements. + + + + + Gets or sets the display text. + + + The display text. + + + + + Gets or sets the content of the tag. + + + The content of the tag. + + + + + Gets or sets the localizable sub-content. + + + The localizable sub-content. + + + + + Clones this instance. + + A clone of this instance. + + + + Indicates whether the current object is equal to another object of the same type. + + An object to compare with this object. + + if the current object is equal to the parameter; otherwise, . + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Collection of subcontent elements. + Can appear in different elements. + + + + + Initializes a new instance of the class. + + + + + Definition of a TagPair. + Can be referenced by multiple elements. + + + + + Gets or sets the start tag display text. + + + The start tag display text. + + + + + Gets or sets the raw start tag conten. + + + The raw start tag content. + + + + + Gets or sets the end tag display text. + + + The end tag display text. + + + + + Gets or sets the raw end tag content. + + + The raw end tag content. + + + + + Gets or sets a value indicating whether this tag can be hidden when displayed. + + + true if this tag can be hidden when displayed; otherwise, false. + + + + + Gets or sets the segmentation hint. + + + The segmentation hint. + + + + + Gets or sets the formatting group identifier. + + + The formatting group identifier. + + + + + Gets or sets the localizable subcontent. + + + The localizable subcontent. + + + + + Gets or sets the QuickInsert identifier of this tag. + + + The QuickInsert identifier of this tag. + + + + + Initializes a new instance of the class. + + + + + Clones this instance. + + + + + + Indicates whether the current object is equal to another object of the same type. + + An object to compare with this object. + + if the current object is equal to the parameter; otherwise, . + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Terminology element. + + + + + Gets or sets the identifier. + + + The identifier. + + + + + Gets or sets the terminology text. + + + The terminology text. + + + + + Gets or sets the terminology score. + + + The terminology score. + + + + + Gets or sets the term origin. + + + The term origin. + + + + + Gets or sets the term translations. + + + The term translations. + + + + + Gets or sets term level attributes contained at any level within the termbase field structures. + + + The term attributes. + + + + + Initializes a new instance of the class. + + + + + Clones this instance. + + A deep clone of this instance. + + + + Performs a deep-equals comparison. + + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Used by JSON serialization. + + + + + + Used by JSON serialization. + + + + + + Data containing a list of s representing terminology information. + + + + + Gets or sets the origin of the terminology information. + + + The origin. + + + + + Gets or sets the terms. + + + The terms. + + + + + Clones this instance. + + A deep clone of this instance. + + + + Performs a deep-equals comparison. + + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Data on the creation origin of . + + + + + Gets or sets the identifier of the terminology system. + + + The terminology system identifier. + + + + + Gets or sets the terminology system nane. + + + The terminology system name. + + + + + Gets or sets the terminology resource identifier. + + + The terminology resource identifier. + + + + + Gets or sets the name of the terminology resource. + + + The name of the terminology resource. + + + + + Clones this instance. + + + + + + Performs a deep-equals comparison. + + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Translation of a specific . + + + + + Gets or sets the identifier. + + + The identifier. + + + + + Gets or sets the text. + + + The text. + + + + + Gets or sets the term attributes. + + + The term attributes. + + + + + Initializes a new instance of the class. + + + + + Clones this instance. + + + + + + Performs a deep-equals comparison. + + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Used by JSON serialization. + + + + + + A tag that is used for document structure only and has no translatable content. + + + + + Gets or sets the id of this instance. + + + The id of this instance. + + + + + Gets or sets the TagNumber for this instance. This is the same as the "frameworkOriginalTagId" + metadata but now exposed on the tag as well (the metadata will become deprecated). + If needed, it will be populated on deserialization from the metadata, the value remains null + iff not present (which should not be the case). + + + + + Gets the definition of this item from the . + + + The definition of this item from the . + + + + + Gets the type of . + + + The type. + + + + + Accepts a visitor of type . + + The used to visit this item. + + + + Indicates whether the current object is equal to another object of the same type. + + An object to compare with this object. + + if the current object is equal to the parameter; otherwise, . + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Clones this instance. + + A deep clone of this instance. + + + + A tag composed of a start and and end tag. + Can contain other elements. + + + + + Gets or sets the id for this instance. + + + The id for this instance. + + + + + Gets or sets the TagNumber for this instance. This is the same as the "frameworkOriginalTagId" + metadata but now exposed on the tag as well (the metadata will become deprecated). + If needed, it will be populated on deserialization from the metadata, the value remains null + iff not present (which should not be the case). + + + + + Gets the definition of this item from the . + + + The definition of this item from the . + + + + + Gets the type of . + + + The type. + + + + + Accepts a visitor of type . + + The used to visit this item. + + + + Clones this instance. + + A deep clone of this instance. + + + + Clones this instance, setting a new id. + + A deep clone of this instance, with a new unique id. + + + + Indicates whether the current object is equal to another object of the same type. + + An object to compare with this object. + + if the current object is equal to the parameter; otherwise, . + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance. + + + + + Constants used a keys for metadata. + + + + + Metadata key identifying the original id set by the SDL Filter Framework. + + + + + Metadata key identifying the original segmentation hint set by the SDL Filter Framework. + + + + + Metadata key used for prefixing end tag related metadata (used by internal conversion). + + + + + Used with textual context matches to indicate the level of matching. + + + + + The textual context does not match. + + + + + Source content matches with surrounding source content. + + + + + Source and target matches surrounding source and target content. + + + + + A containing plain text. + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The text. + + + + Gets or sets the text. + + + The text. + + + + + Gets the type of . + + + The type. + + + + + Accepts a visitor of type . + + The used to visit this item. + + + + Converts to string. + + + A that represents this instance. + + + + + Indicates whether the current object is equal to another object of the same type. + + An object to compare with this object. + + if the current object is equal to the parameter; otherwise, . + + + + + Performs a deep-equals comparison. + + + + + + Returns a hash code for this instance. + + + A hash code for this instance, + + + + + Clones this instance. + + A deep clone of this instance. + + + + DateTime patterns used by elements. + + + + + The pattern represents a long date pattern + + + + + The pattern represents a short date pattern + + + + + The pattern represents a short time pattern + + + + + The pattern represents a long time pattern + + + + + The numeric separators type which can occur in a number token. + + + + + Indicates that no explicit separator is used. + + + + + Indicates that the culture's primary separator (group or decimal separator) is used. + + + + + Indicates that an alternate separator (group or decimal separator) is used. + + + + + Represents a position within a segment. + + + + + Gets or sets the index of the run (segment element) within the segment. + + + + + Gets or sets the position within the subsegment. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance with the specified arguments. + + The index of the segment element within the segment. + The position within the run. This is only + relevant for elements, and has no effect for other segment + element types. + + + + + + The object to compare with the current object. + true if the specified object is equal to the current object; + otherwise, false. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Compares two segment positions and returns an indication of their sort order. + + The first of the two items to compare. + The second of the two items to compare. + An int value less than zero if a precedes b, zero if a denotes the same position as b, and greater than zero if a follows b. + + + + Creates a new instance that is a deep copy of this instance. + + A new instance that is a deep copy of this instance. + + + + + + A string representation of the object, for display purposes. + + + + A selection of content inside a . + + + + + Gets or sets the start in the segment. + + + The start in the segment. + + + + + Gets or sets the end in the segment. + + + The end in the segment. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance with the provided positions. + + The start position. + The end position. + No checks are performed to verify that the start position precedes the end position. + + + + Initializes a new instance of with the given parameters. + + The segment element index (run) of the range. + The start position in the run. + The end position (inclusive) in the run. + + + + Compares the current range to another segment range. + + The range to compare with. + true if both ranges are identical. + + + + + + The object to compare with the current object. + true if the specified object is equal to the current object; + otherwise, false. + + + + + + + + + + Compares two segment ranges and returns a value indicating their order. + + The first of the two items to compare. + The second of the two items to compare. + An integer value less than zero if a precedes b, zero if a and b are in the same range, + and a value greater than zero if a follows b. Only the start positions are compared. + + + + Creates a new instance that is a deep copy of this instance. + + A new instance that is a deep copy of this instance. + + + + + + A string representation of the object, for display purposes. + + + + The sign of a number + + + + + No explicit sign at the start of the number. + + + + + An explicit plus sign at the start of the number. + + + + + A minus sign at the start of the number. + + + + + Types of tags appearing in tokenization data. + + + + + Represents an undefined tag type. This is also used for "dummy tags" which may + be added to a segment in case a tag was deleted from the original segment. Such + a situation occurs when the translation engine deletes tags, but the number of + tokens must remain constant in the translation proposal as otherwise the token + positions will become invalid. + + + + + Represents a starting tag. + + + + + Represents an ending tag. + + + + + Represents a standalone tag. + + + + + A standalone tag which represents text, not formatting. + + + + + Group of (locked) tag/text content that should be treated as a single placeable. + + + + + For TMX processing only: unmatched start tag (it pos=start) + + + + + For TMX processing only: unmatched end tag (it pos=end) + + + + + A used for abreviations. + + + + + + Gets the type of . + + + The type. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The token text + + + + A representing acronyms. + + + + + + Gets the type of . + + + The type. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The text. + + + + A representing alphanumeric tokens. + + + + + + Gets the type of . + + + The type. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The token text + + + + A representing sequence of characters. + + + This is used in contexts (such as tokenization of some far-east languages) where word boundaries cannot easily be determined. + + + + Gets the type of . + + + The type. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The token text + + + + A represent date/time tokens. + + + + + + Gets the type of . + + + The type. + + + + + position of segment within the segment + + + + + position of segment within the segment + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance with the specified values. + + The text to assign to the token + The object to assign to the + token's value + The type of the date or time token + + + + A representing general punctuation tokens. + + + + + + Gets the type of . + + + The type. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The token text + + + + + Represents a generic placeable token which is not one of the predefined placeable token + classes. Generic placeable tokens can never be auto-localized, but may be auto-substitutable. + + + + + Gets the type of . + + + The type. + + + + + Gets the value of the token class which has been used during construction. + + + + + Used for IP address tokens. + + + + + Gets the type of . + + + The type. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The token text + + + + A representing a measurement. + + + A measurement is defined as a combination of a number followed by a unit. + + + + Gets the type of . + + + The type. + + + + + Gets or sets the unit. + + + + + Gets or sets the unit separator. + + + + + Gets or sets the unit string, in case the unit is unknown. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance with the specified values. This constructor is for internal + purposes only and should not be used directly. + + + + + A representing a numerical value. + + + + + + Gets the type of . + + + The type. + + + + + Gets or sets the sign. + + + + + Gets or sets the "raw" sign, i.e. the textual representation of the sign + + + + + Gets or sets the decimal separator + + + + + Gets or sets the group separator + + + + + Gets or sets an alternate group separator, which is a single char if an alternate + separator is used, or the null character if no alternate separator is used. + + + + + Gets or sets an alternate decimal separator, which is a single char if an alternate + separator is used, or the null character if no alternate separator is used. + + + + + Gets or sets the raw fractional digits, which are a sequence of digits without + separators or signs. + + + + + Gets or sets the raw decimal digits, which are a sequence of digits without + separators or signs. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance with the specified values. + + The text of the token, as it appeared in the input + The type of group separator used + The type of decimal separator used + The character of an alternative group separator, if used + The character of an alternative decimal separator, if used + The type of sign used + The "raw text" of the sign + The "raw decimal digits", without separators, between 0-9 + The "raw fractional digits", without separators, between 0-9 + + + + A representing a tag element. + + + + + + Gets the type of . + + + The type. + + + + + Gets or sets the tag type. + + + + + Gets or sets the tag anchor, which is used to bracket two tags (connect start and end tag). The anchor + is only relevant for start and end tags and has no cross-segment semantics. + + + + + Gets or sets the alignment anchor, which is used to align cross-segment tags. It only needs to be + set for the start tag. + + + + + Gets or sets the tag ID which is a cross-format ID assigned by the filters and which may be + used to represent a cross-format formatting class (such as "bold"). + + + + + Gets or sets the text equivalent string. This will only be valid for text placeholder tags. + + + + + Gets or sets the CanHide flag + + + + + Initializes a new instance with default values (used for XML serialization only). + + + + + Initializes a new instance of the Tag class with the specified type and anchor. + + The tag type. + The tag ID (user-defined) + The tag anchor. + An alignment anchor (cross-segment), if available + A text equivalent string (ignored if the tag type is not TextPlaceholder or LockedContent) + True if the tag represents inline formatting, false otherwise + + + + + + A string representation of the object, for display purposes. + + + + Abstract class for different token implementations. + + + + + Gets or sets the token text. + + + The token text. + + + + + Gets or sets the span of text in the representing the . + + + The text span. + + + + + Initializes a new instance with default values. + + + + + Initializes a new instance with the specified token text. + + The token text + + + + Clones this instance. + + + + + + Converts to string. + + + A that represents this instance. + + + + + Gets the type of . Should be overriden with names that uniquely identify the implementations. + + + The type. + + + + + An URI token that is placeable but is not substitutable. + + + + + Gets the type of . + + + The type. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The token text + + + + A representing a substitutable variable. + + + + + + Gets the type of . + + + The type. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The token text + + + + A representing a a non-empty sequence of whitespace characters. + + + + + + Gets the type of . + + + The type. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The token text + + + + A which represents a non-specific word. + + + + + Gets the type of . + + + The type. + + + + + An optional stem to assign to this token. Stems are used for TM search and scoring. + + + + + Gets or sets whether this token is a stop word. + + + + + Initializes a new instance with default values + + + + + Initializes a new instance with the specified token text + + + + + + Enumerates the units supported by Sdl.LanguagePlatform.Core.Tokenization.Unit + + + + + Metric millimeters + + + + + Metric centimeters + + + + + Metric decimeters + + + + + Metric meters + + + + + Metric kilometers + + + + + Metric square millimeters + + + + + Metric square centimeters + + + + + Metric square meters + + + + + Metric are + + + + + Metric hectare + + + + + Metric square kilometers + + + + + Metric milligrams + + + + + Metric grams + + + + + Metric kilograms + + + + + Metric tons + + + + + Metric milliliters + + + + + Metric cubic centimeters + + + + + Metric centiliters + + + + + Metric deciliters + + + + + Metric liters + + + + + Metric cubic meters + + + + + Mcentigrade + + + + + Mfahrenheit + + + + + Mkelvin + + + + + Mpercent + + + + + Mdegree + + + + + BISin + + + + + BISft + + + + + BISyd + + + + + BISfurlong + + + + + BISmi + + + + + BISin2 + + + + + BISft2 + + + + + BISyd2 + + + + + BISacre + + + + + BISmi2 + + + + + BISoz + + + + + BISlb + + + + + BISstone + + + + + BISshortHW + + + + + BISlongHW + + + + + BISshortTon + + + + + BISlongTon + + + + + BISflozUK + + + + + BISptUK + + + + + BISqtUK + + + + + BISgalUK + + + + + BISbuUK + + + + + BISflozUS + + + + + BISptUS + + + + + BISgalUS + + + + + BISptUSDry + + + + + BISbuUSDry + + + + + The unit represents another, general unit for which no cross-system conversion will + be available. + + + + + The unit represents a currency + + + + + A sentinel, should not be used + + + + + Contains information on the origin of translation. + + + + + + Gets or sets the translation origin type. + + + The translation origin type. + + Seed for default values. + + + + Gets or sets the origin system. + + + The originating system name for a segment translation. + + + + + Gets or sets the match percent. + + + The match value for a translation memory match, or the confidence level for a machine translation. + Should be a percentage value from 0 - 100% + + + + When a match gets adapted by interactive translation, the original match value can be read from + this property on the properties. + + + + + + Gets or sets a value indicating whether this instance is structure context match. + + + true if this instance is structure context match; otherwise, false. + + + If true, indicates that the translation originates from a system that takes + structural context information into account, and that the structure context matches. + + + + + If true, indicates that the translation originates from a system that takes + ID context information into account, and that the ID context matches. + + + true if this instance is sID context match; otherwise, false. + + + + + Indicates whether the match originates from a source where the textual surrounding content + corresponds to the text surrounding this segment. + + + The value. + + + + + A hash value that identifies the entry in the TM that provided the translation. This is used + to update the correct TM entry if a translator provides an updated version of the translation. + + + The original translation hash. + + + + + Gets or sets the before adaptation. + + + The before adaptation. + + Null or the origin information for the originally adapted target content. + + + + Gets or sets the identifier of the user who created the translation. + + + + + Gets or sets the date and time when the translation was created. + + + + + Gets or sets the identifier of the user who modified the translation. + + + + + Gets or sets the date and time when the translation was modified. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Type of the origin. + The origin system. + The match percent. + if set to true the translation is a structure context match. + if set to true the translation is a sID context match. + The text context match level. + The original translation hash. + The before adaptation. + + + + Clones this instance. + + A deep clone of this instance. + + + + Gets or sets the created_on metadata. + Made obsolete by the property. + + + The created_on metadata value. + + + + + Gets or sets the last_modified_by metadata. + Made obsolete by the property. + + + The last_modified_by metadata value. + + + + + Gets or sets the modified_on metadata. + Made obsolete by the property. + + + The modified_on metadata value. + + + + + Gets or sets the used_by metadata. + + + The used_by metadata value. + + + + + Gets or sets the used_on metadata. + + + The used_on metadata value. + + + + + Gets or sets the used_on metadata. + + + The used_on metadata value. + + + + + Gets or sets the created_by_username metadata. + + + The created_by_username metadata value. + + + + + Gets or sets the created_by_username metadata. + + + The created_by_username metadata value. + + + + + Gets or sets the use_by_username metadata. + + + The use_by_username metadata value. + + + + + Indicates whether the current object is equal to another object of the same type. + + An object to compare with this object. + + if the current object is equal to the parameter; otherwise, . + + + + + Performs a deep-equals comparison. + + + + + + Performs a deep-equals comparison. + + + + + + Metadata keys used for metadata. + + + + + The user who created the translation. + + + + + The translation creation date. + + + + + The Id of the last user who updated the translation. + + + + + The translation modified date. + + + + + The Id of the last user who applied the translation. + + + + + The date when the translation was last applied. + + + + + The translation usage count. + + + + + The display name of the user who created the translation. + + + + + The display name of the user who last modified the translation. + + + + + + The display name of the user who last applied the translation. + + + + + A which was not recognized during deserialization. + Used only to preserve its existing data and should not be used directly in BCM processing. + + + + + + + + + + diff --git a/docfx.json b/docfx.json index 768595d..64cf7eb 100644 --- a/docfx.json +++ b/docfx.json @@ -3,7 +3,7 @@ { "src": [ { - "src": "articles/BCM/Assembly/v1.6.0", + "src": "articles/BCM/Assembly/v2.0.0", "files": [ "Sdl.Core.Bcm.BcmModel.dll" ]