IEditorOptions.IsOptionDefined Method
Definition
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.
Overloads
IsOptionDefined(String, Boolean) |
Determines whether the specified option is defined. |
IsOptionDefined<T>(EditorOptionKey<T>, Boolean) |
Determines whether the specified editor option is defined. |
IsOptionDefined(String, Boolean)
Determines whether the specified option is defined.
public:
bool IsOptionDefined(System::String ^ optionId, bool localScopeOnly);
public:
bool IsOptionDefined(Platform::String ^ optionId, bool localScopeOnly);
bool IsOptionDefined(std::wstring const & optionId, bool localScopeOnly);
public bool IsOptionDefined (string optionId, bool localScopeOnly);
abstract member IsOptionDefined : string * bool -> bool
Public Function IsOptionDefined (optionId As String, localScopeOnly As Boolean) As Boolean
Parameters
- optionId
- String
The ID of the option.
- localScopeOnly
- Boolean
true
to search only in this scope, false
to try parent scopes as well. This setting has no effect if the current scope is global.
Returns
true
if the option is defined, otherwise false
.
Applies to
IsOptionDefined<T>(EditorOptionKey<T>, Boolean)
Determines whether the specified editor option is defined.
public:
generic <typename T>
bool IsOptionDefined(Microsoft::VisualStudio::Text::Editor::EditorOptionKey<T> key, bool localScopeOnly);
template <typename T>
bool IsOptionDefined(Microsoft::VisualStudio::Text::Editor::EditorOptionKey<T> key, bool localScopeOnly);
public bool IsOptionDefined<T> (Microsoft.VisualStudio.Text.Editor.EditorOptionKey<T> key, bool localScopeOnly);
abstract member IsOptionDefined : Microsoft.VisualStudio.Text.Editor.EditorOptionKey<'T> * bool -> bool
Public Function IsOptionDefined(Of T) (key As EditorOptionKey(Of T), localScopeOnly As Boolean) As Boolean
Type Parameters
- T
The type of the key.
Parameters
The key of the option.
- localScopeOnly
- Boolean
true
to search only in this scope, false
to try parent scopes as well. This setting has no effect if the current scope is global.
Returns
true
if the option is defined, otherwise false
.