IWpfTextView.GetAdornmentLayer(String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text.Editor

Assembly:: Microsoft.VisualStudio.Text.UI.Wpf.dll

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

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.

Gets a named IAdornmentLayer.

public:
 Microsoft::VisualStudio::Text::Editor::IAdornmentLayer ^ GetAdornmentLayer(System::String ^ name);

public:
 Microsoft::VisualStudio::Text::Editor::IAdornmentLayer ^ GetAdornmentLayer(Platform::String ^ name);

Microsoft::VisualStudio::Text::Editor::IAdornmentLayer GetAdornmentLayer(std::wstring const & name);

public Microsoft.VisualStudio.Text.Editor.IAdornmentLayer GetAdornmentLayer (string name);

abstract member GetAdornmentLayer : string -> Microsoft.VisualStudio.Text.Editor.IAdornmentLayer

Public Function GetAdornmentLayer (name As String) As IAdornmentLayer

Parameters

name: String

The name of the layer.

Returns

IAdornmentLayer

An instance of the layer in this view.

Remarks

Layer names must be defined as AdornmentLayerDefinition component parts. The following layer names: "Text", "Caret", "Selection", and "ProvisionalHighlight" are reserved and cannot be requested using this method.

Applies to

Compartilhar via