CodeLensDetailsDescriptor Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Language.CodeLens.Remoting

Assembly:: Microsoft.VisualStudio.Language.dll

Package:: Microsoft.VisualStudio.Language 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.

Represents a descriptor for the detail of a data point.

public ref class CodeLensDetailsDescriptor sealed

public sealed class CodeLensDetailsDescriptor

type CodeLensDetailsDescriptor = class

Public NotInheritable Class CodeLensDetailsDescriptor

Inheritance: Object
CodeLensDetailsDescriptor

Remarks

When GetDetailsAsync(CodeLensDescriptorContext, CancellationToken) is called, the data point returns a CodeLensDetailsDescriptor object providing the data point details that will be presented in the details popup.

Constructors

CodeLensDetailsDescriptor()

Properties

AdditionalCustomData	Defines additional custom details data to be visualized after the detail list. See CustomData for more information.
CustomData	Defines custom details data to be visualized before the detail list. This property allows remote data point to send a list of arbitrary structured data objects back to the host process to be visualized in the details popup along with (or instead of) the detail list. For each object in this list, IViewElementFactoryService will be used to create a host specific visualization (FrameworkElement in Visual Studio). These visual elements will be stacked vertically. Using this property to create a custom details visualization requires the following provisions: 1. The type represnting a custom data has to be loadable in-proc in the host. In Visual Studio this means it has to be deployed in a package with [ProvideBindingPath] attribute. 2. An IViewElementFactory MEF component needs to be exported in-proc, with a TypeConversionAttribute indicating it can convert the custom data type to a host specific visual element (FrameworkElement in Visual Studio).
Entries	Defines rows (entries) of the detail list.
Headers	Defines the headers of the detail list.
PaneNavigationCommands	Defines the additional navigation commands in the details pane
SelectionMode	Defines selection mode for the deatails entry table.

Applies to

通过