ProvideSettingAttribute Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

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

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

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.

Registers settings owned by a package. All registered settings must be persisted via SVsSettingsPersistenceManager. Settings that are persisted using SVsSettingsPersistenceManager but not registered will be private by default.

public ref class ProvideSettingAttribute sealed : Microsoft::VisualStudio::Shell::RegistrationAttribute

public ref class ProvideSettingAttribute sealed : Microsoft::VisualStudio::Shell::RegistrationAttribute

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

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

Public NotInheritable Class ProvideSettingAttribute
Inherits RegistrationAttribute

Inheritance: Attribute

RegistrationAttribute
ProvideSettingAttribute

Attributes: AttributeUsageAttribute

Constructors

ProvideSettingAttribute(String, SettingScope, SettingStorage, String, String, String, String, String)	Declares one or more settings provided by a package.
ProvideSettingAttribute(String, SettingScope, SettingStorage)	Declares one or more settings provided by a package.

Properties

DescriptionResourceId
IsRemotable	Gets or sets a value controlling whether this setting will be applied to the remote instance instead of the local instance when connected.
IsWritableByGuests
JsonSchemaResourceId
Name	Gets the name of the setting.
NameResourceId
PackageGuid
Scope	Gets the scope of the setting.
SearchKeywordsResourceId
Storage	Gets the storage of the setting.
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)

Methods

GetPackageRegKeyPath(Guid)	Gets the registry path (relative to the registry root of the application) of the VSPackage. (Inherited from RegistrationAttribute)
Register(RegistrationAttribute+RegistrationContext)	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.
Unregister(RegistrationAttribute+RegistrationContext)	Unregister this attribute

Applies to

Share via