Share via

CodeLensDetailsDescriptor.CustomData Property

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Language.CodeLens.Remoting
Assembly:
Microsoft.VisualStudio.Language.dll
Package:
Microsoft.VisualStudio.Language v17.11.260

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). 

public:
 property System::Collections::Generic::IEnumerable<System::Object ^> ^ CustomData { System::Collections::Generic::IEnumerable<System::Object ^> ^ get(); void set(System::Collections::Generic::IEnumerable<System::Object ^> ^ value); };
[Newtonsoft.Json.JsonProperty(ItemTypeNameHandling=Newtonsoft.Json.TypeNameHandling.All)]
public System.Collections.Generic.IEnumerable<object> CustomData { get; set; }
[<Newtonsoft.Json.JsonProperty(ItemTypeNameHandling=Newtonsoft.Json.TypeNameHandling.All)>]
member this.CustomData : seq<obj> with get, set
Public Property CustomData As IEnumerable(Of Object)

Property Value

IEnumerable<Object>
Attributes
Newtonsoft.Json.JsonPropertyAttribute

Applies to