IClassificationFormatMap Interface

Definition

Namespace:

Microsoft.VisualStudio.Text.Classification

Assembly:

Microsoft.VisualStudio.Text.UI.Wpf.dll

Package:

Microsoft.VisualStudio.Text.UI.Wpf v17.12.215

Maps from a IClassificationType to an TextFormattingRunProperties object.

public interface class IClassificationFormatMap

public interface class IClassificationFormatMap

__interface IClassificationFormatMap

public interface IClassificationFormatMap

type IClassificationFormatMap = interface

Public Interface IClassificationFormatMap

Properties

CurrentPriorityOrder	Gets a read-only list of the IClassificationType objects supported by this format map, sorted by priority.
DefaultTextProperties	Gets or sets the default properties that are applied to all classification types. The default properties contain the set of minimal properties required to render text properly.
IsInBatchUpdate	Determines whether this IClassificationFormatMap is in the middle of a batch update.

Methods

AddExplicitTextProperties(IClassificationType, TextFormattingRunProperties, IClassificationType)	Adds a TextFormattingRunProperties to a new IClassificationType.
AddExplicitTextProperties(IClassificationType, TextFormattingRunProperties)	Adds a TextFormattingRunProperties to a new IClassificationType.
BeginBatchUpdate()	Begins a batch update on this IClassificationFormatMap. Events will not be raised until EndBatchUpdate() is called.
EndBatchUpdate()	Ends a batch update on this IClassificationFormatMap and raises an event if any changes were made during the batch update.
GetEditorFormatMapKey(IClassificationType)	Gets the key used to store the associated properties of classificationType in the underlying IEditorFormatMap.
GetExplicitTextProperties(IClassificationType)	Gets the explicit TextFormattingRunProperties for classificationType.
GetTextProperties(IClassificationType)	Gets the effective TextFormattingRunProperties for a given text classification type including the properties of classificationType and any properties that it might inherit.
SetExplicitTextProperties(IClassificationType, TextFormattingRunProperties)	Sets the explicit TextFormattingRunProperties of an IClassificationType.
SetTextProperties(IClassificationType, TextFormattingRunProperties)	Sets the merged TextFormattingRunProperties of an IClassificationType.
SwapPriorities(IClassificationType, IClassificationType)	Switches the priorities of two IClassificationType objects.

Events

ClassificationFormatMappingChanged

Occurs when this IClassificationFormatMap changes.