| IContextInfo Interface |
One piece of context information, with a type, purpose and description, as
stored in Contexts.
Namespace: Sdl.FileTypeSupport.Framework.NativeApi
Assembly: Sdl.FileTypeSupport.Framework.Core (in Sdl.FileTypeSupport.Framework.Core.dll) Version: 1.0.0.0 (1.0.2343.0)
SyntaxThe IContextInfo type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | ClearMetaData |
Removes all key/value pairs from the meta data collection.
(Inherited from IMetaDataContainer.) |
| Clone | Creates a new object that is a copy of the current instance. (Inherited from ICloneable.) |
| GetMetaData |
Returns the metadata value associated with the specified key,
or null if no such key exists in the collection.
(Inherited from IMetaDataContainer.) |
| MetaDataContainsKey | True if a metadata value with the specified key exists
(Inherited from IMetaDataContainer.) |
| RemoveMetaData |
Removes the metadata key/value pair with the specified key
from the collection. No changes are made if the collection
does not contain such a key.
(Inherited from IMetaDataContainer.) |
| SetMetaData | Sets the value of the specified metadata key. If the key already exists in the collection, its value gets overwritten. |
Properties| Name | Description | |
|---|---|---|
 | ContextType |
A short string that identifies the type of context.
Use pre-defined constants defined in Sdl.FileTypeSupport.Framework.Core.Utilities.NativeApi.TMMatchContextTypes
for TM match contexts, and constants defined in
Sdl.FileTypeSupport.Framework.Core.Utilities.NativeApi.StandardContextTypes for other context types, as far as possible.
|
| DefaultFormatting |
Display formatting associated with this context, or null if none.
|
| Description |
Additional, more descriptive information on the context
|
| DisplayCode |
A very short string (usually one or two letters) to identify the context
|
| DisplayColor |
The display color associated with the context (background color, etc.)
|
| DisplayName |
A short string to be used as the default display text for the context
|
| HasMetaData | True if there is any metadata in the container
(Inherited from IMetaDataContainer.) |
| MetaData |
Enumerator for the metadata key/value pairs.
(Inherited from IMetaDataContainer.) |
| MetaDataCount |
The number of meta data key/value pairs in the container
(Inherited from IMetaDataContainer.) |
| Purpose |
A value that indicates how this context is to be used:
Match: for contexts that are used when looking up in a TMInformational: for contexts that provide translators with informationLocation: for contexts that are used to mark a document location |
RemarksCustom metadata can be stored and accessed by using the methods in IMetaDataContainer.
See AlsoCommunityComments