ConnectedServiceGrid Class

Visual Studio 2015

A ConnectedServiceProvider service that shows a grid of instances, where a single instance can be chosen to add to the current project.

Namespace: Microsoft.VisualStudio.ConnectedServices
Assembly: Microsoft.VisualStudio.ConnectedServices (in Microsoft.VisualStudio.ConnectedServices.dll)

Inheritance Hierarchy

System::Object
  Microsoft.VisualStudio.ConnectedServices::ConnectedServiceViewModelBase
    Microsoft.VisualStudio.ConnectedServices::ConnectedServiceConfigurator
      Microsoft.VisualStudio.ConnectedServices::ConnectedServiceGrid

Syntax

C++

public ref class ConnectedServiceGrid abstract : ConnectedServiceConfigurator

Constructors

	Name	Description
	ConnectedServiceGrid()	Initializes a new instance of the ConnectedServiceGrid class.

Properties

	Name	Description
	CanConfigureService	Gets or sets a value indicating whether instances of this service can be configured through the connected service provider.
	CanConfigureServiceInstance	Gets or sets a value indicating whether instances of this service can be configured through the connected service provider.
	CanCreateServiceInstance	Gets or sets a value to use as the text of the control for the users to create a new instance.
	ColumnMetadata	Gets the keys and display strings for metadata to show as columns in the service instance list.
	ConfigureServiceInstanceText	Gets or sets a value to use as the text of the control for the users to configure an instance.
	ConfigureServiceText	Gets or sets a value to use as the text of the control for the users to configure the service.
	CreateServiceInstanceText	Gets or sets a value to use as the text of the control for the users to create a new instance.
	Description	Gets or sets a value to display under the title of the dialog.
	DetailMetadata	Gets the keys and display strings for metadata to show in the property pane (to the right) when an instance is selected from the service instance list.
	EnumeratingServiceInstancesText	Gets or sets a value to display while Connected Services is attempting to retrieve the service instances.
	GridHeaderText	Gets or sets a value to display directly above the grid.
	NoServiceInstancesText	Gets or sets a Stringto display when no instances are available because the enumeration returned no instances.
	ServiceInstanceNameLabelText	Gets or sets a value to display as the column header or label for the service instance name.

Methods

	Name	Description
	ConfigureServiceAsync(CancellationToken)	Configure a service either through a dialog or linking to the configure web page.
	ConfigureServiceInstanceAsync(ConnectedServiceInstance^, CancellationToken)	Configures a service instance either through a dialog or linking to the configure web page.
	CreateAuthenticatorAsync()	Creates the ConnectedServiceAuthenticator that allows users to log into the service.
	CreateServiceInstanceAsync(CancellationToken)	Creates a new instance of the service.
	Dispose()	Releases all resources used by the object.(Inherited from ConnectedServiceViewModelBase.)
	Dispose(Boolean)	(Inherited from ConnectedServiceViewModelBase.)
	EnumerateServiceInstancesAsync(CancellationToken)	Get a list of all of the service instances for the currently authenticated user, if any.
	Equals(Object^)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	OnPropertyChanged(String^)	Notifies clients that a property value has changed.(Inherited from ConnectedServiceViewModelBase.)
	ToString()	(Inherited from Object.)

Events

	Name	Description
	PropertyChanged	Occurs when a property value changes.(Inherited from ConnectedServiceViewModelBase.)

Remarks

For any string property you can return null to use the default text. In order to not display text, return Empty.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.