Interface IContextInfo

One piece of context information, with a type, purpose and description, as stored in Contexts.

Inherited Members

IMetaDataContainer.MetaDataContainsKey(string)

IMetaDataContainer.GetMetaData(string)

IMetaDataContainer.SetMetaData(string, string)

IMetaDataContainer.RemoveMetaData(string)

IMetaDataContainer.ClearMetaData()

IMetaDataContainer.MetaData

IMetaDataContainer.HasMetaData

IMetaDataContainer.MetaDataCount

ICloneable.Clone()

Namespace: SdlSdl.FileTypeSupportFrameworkNativeApi

Assembly: Sdl.FileTypeSupport.Framework.Core.dll

Syntax

public interface IContextInfo : IMetaDataContainer, ICloneable

Remarks

Custom metadata can be stored and accessed by using the methods in IMetaDataContainer.

Properties

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.

Declaration

string ContextType { get; set; }

Property Value

Type	Description
string

DefaultFormatting

Display formatting associated with this context, or null if none.

Declaration

IFormattingGroup DefaultFormatting { get; set; }

Property Value

Type	Description
IFormattingGroup

Remarks

When specified, this will be the "base formatting" used in paragraph units appearing inside the context, which can be overridden locally inside the paragraph unit for individual tag pairs.

Description

Additional, more descriptive information on the context

Declaration

string Description { get; set; }

Property Value

Type	Description
string

DisplayCode

A very short string (usually one or two letters) to identify the context

Declaration

string DisplayCode { get; set; }

Property Value

Type	Description
string

DisplayColor

The display color associated with the context (background color, etc.)

Declaration

Color DisplayColor { get; set; }

Property Value

Type	Description
Color

DisplayName

A short string to be used as the default display text for the context

Declaration

string DisplayName { get; set; }

Property Value

Type	Description
string

Purpose

A value that indicates how this context is to be used:

Declaration

ContextPurpose Purpose { get; set; }

Property Value

Type	Description
ContextPurpose