ProvideEditorUIContextAttribute Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Package:: Microsoft.VisualStudio.Shell.15.0 v17.9.37000

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.

Associates a UIContext with a given editor factory. The editor can only be created when the UIContext is active.

public ref class ProvideEditorUIContextAttribute : Microsoft::VisualStudio::Shell::ProvideEditorAttributeBase

[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true, Inherited=true)]
public class ProvideEditorUIContextAttribute : Microsoft.VisualStudio.Shell.ProvideEditorAttributeBase

[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true, Inherited=true)>]
type ProvideEditorUIContextAttribute = class
    inherit ProvideEditorAttributeBase

Public Class ProvideEditorUIContextAttribute
Inherits ProvideEditorAttributeBase

Inheritance: Attribute

RegistrationAttribute

ProvideEditorAttributeBase
ProvideEditorUIContextAttribute

Attributes: AttributeUsageAttribute

Constructors

ProvideEditorUIContextAttribute(Object, Object)

Initializes an instance of ProvideEditorUIContextAttribute

Properties

Factory	The editor factory guid. (Inherited from ProvideEditorAttributeBase)
TypeId	Override the TypeID property in order to let the RegistrationAttribute derived classes to work with System.ComponentModel.TypeDescriptor.GetAttributes(...). An attribute derived from this one will have to override this property only if it needs a better control on the instances that can be applied to a class. (Inherited from RegistrationAttribute)
UIContext	The UIContext to associate with the editor

Methods

GetPackageRegKeyPath(Guid)

Gets the registry path (relative to the registry root of the application) of the VSPackage.

(Inherited from RegistrationAttribute)

Called to register this attribute with the given context. The context contains the location where the registration information should be placed. it also contains such as the type being registered, and path information.

This method is called both for registration and unregistration. The difference is that unregistering just uses a hive that reverses the changes applied to it.

Unregister(RegistrationAttribute+RegistrationContext)

Unregister this editor.

Applies to