Condividi tramite

Package.AddOptionKey(String) Method

  • 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

Adds a user option key name into the list of option keys.

protected:
 void AddOptionKey(System::String ^ name);
protected:
 void AddOptionKey(Platform::String ^ name);
void AddOptionKey(std::wstring const & name);
protected void AddOptionKey (string name);
member this.AddOptionKey : string -> unit
Protected Sub AddOptionKey (name As String)

Parameters

name
String

The name of the option key to add. An option key name must not have any periods in it.

Remarks

The AddOptionKey method adds a user option key name into the list of option keys that the package stores in the solution file. To save package data in a solution file, perform the following tasks:

  1. Call AddOptionKey in your package constructor for each option key you want to store.

  2. Override OnLoadOptions and OnSaveOptions and implement your save and load logic for each key. OnSaveOptions is called for each key you have added. OnLoadOptions is called for each key in the solution file.

Applies to