Package.AddOptionKey Method

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

Namespace:  Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.10.0 (in Microsoft.VisualStudio.Shell.10.0.dll)


Protected Sub AddOptionKey ( _
    name As String _
protected void AddOptionKey(
    string name
void AddOptionKey(
    String^ name
member AddOptionKey : 
        name:string -> unit 
protected function AddOptionKey(
    name : String


  • name
    Type: System.String
    The name of the option key to add. An option key name must not have any periods in it.


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.

.NET Framework Security

See Also


Package Class

Microsoft.VisualStudio.Shell Namespace