Home > Services > DXCore Services – Options

DXCore Services – Options

February 5th, 2011

This DXCore service provides methods and properties for manipulation of options pages and decoupled storages for persisting plug-in settings.

Methods of this service:

Name Description
CollectFullNames Returns a string array containing the full names of all registered options pages.
CollectFullNames(UserLevel) Returns a string array containing the full names of all registered options pages whose UserLevel is equal to or less than the specified level.
GetCategory Returns the category of an options page.
GetFullName Returns the full name of an options page.
GetLevel Returns the user level for an options page.
GetPage Returns the options page specified by a full name or its type instance.
GetPageName Returns the name of an options page specified by its type instance.
GetRegisteredCategories Returns a list of all registered options page categories. If this method is called when DXCore/CodeRush is not loaded, it uses the last known list of registered categories.
GetStorage Creates and returns an instance of the DecoupleStorage object specified by the page full name or its type instance.
GetStorageFile Returns the file name used by the specified options page for a language-neutral storage.
IsRegistered Determines whether an options page is registered.
Reload Reloads options by triggering the OptionsChanged event.
ReloadAll Reloads all DXCore options by triggering the OptionsChanged event, causing event listeners to read data from decoupled storage. You can set the directory where DXCore reads settings by changing the Paths property.
Show Displays the DXCore options dialog.
Show(String) Displays the DXCore options dialog and selects the specified page full name.
Show(Type) Displays the DXCore options dialog and selects the specified page type instance.

Properties:

Name Description
Item[] Gets an options page by an index or a full name.
PageCount Gets the number of registered options pages.
Paths Provides access to various DXCore/CodeRush paths, for example: setting file storage physical path, cache files path, install directory path, different registry paths, and others. VisualStudioRegistryPath Gets the registry root path for the current Visual Studio IDE.
—–
Products: DXCore
Versions: 12.1 and up
VS IDEs: any
Updated: Jun/09/2012
ID: D060

Similar Posts: