ITextViewMarginProvider Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Extensibility.Editor

Assembly:: Microsoft.VisualStudio.Extensibility.dll

Package:: Microsoft.VisualStudio.Extensibility v17.12.2051

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Extensibility point for providing text view margins.

[Microsoft.VisualStudio.Extensibility.ExtensionContract(typeof(Microsoft.VisualStudio.RpcContracts.Editor.ITextViewMarginProviderContract), typeof(Microsoft.VisualStudio.Extensibility.Editor.TextViewMarginProvider))]
[Microsoft.VisualStudio.Extensibility.ExtensionPart(typeof(Microsoft.VisualStudio.Extensibility.Editor.ITextViewMarginProvider), new System.String[] { "TextViewMarginProviderConfiguration", "TextViewExtensionConfiguration" })]
public interface ITextViewMarginProvider : Microsoft.VisualStudio.Extensibility.Editor.ITextViewExtension, Microsoft.VisualStudio.Extensibility.Editor.ITextViewMarginProviderBase

[<Microsoft.VisualStudio.Extensibility.ExtensionContract(typeof(Microsoft.VisualStudio.RpcContracts.Editor.ITextViewMarginProviderContract), typeof(Microsoft.VisualStudio.Extensibility.Editor.TextViewMarginProvider))>]
[<Microsoft.VisualStudio.Extensibility.ExtensionPart(typeof(Microsoft.VisualStudio.Extensibility.Editor.ITextViewMarginProvider), new System.String[] { "TextViewMarginProviderConfiguration", "TextViewExtensionConfiguration" })>]
type ITextViewMarginProvider = interface
    interface ITextViewExtension
    interface ITextViewMarginProviderBase

Public Interface ITextViewMarginProvider
Implements ITextViewExtension, ITextViewMarginProviderBase

Attributes: ExtensionContractAttribute ExtensionPartAttribute

Implements: ITextViewExtension ITextViewMarginProviderBase

Remarks

Typical usage (providing a margin and listening to text view and text document changes):

[Export]
internal class MyTextViewMarginProvider : ExtensionPart, ITextViewMarginProvider, ITextViewChangedListener

Properties

TextViewExtensionConfiguration	Gets the configuration for this ITextViewExtension. The value of this property is evaluated at compile time when building the Visual Studio extension. (Inherited from ITextViewExtension)
TextViewMarginProviderConfiguration	Gets the configuration for this ITextViewMarginProvider. The value of this property is evaluated at compile time when building the Visual Studio extension.

Methods

CreateVisualElementAsync(ITextViewSnapshot, CancellationToken)

Creates visual element representing margin's UI content.

Applies to

Share via