EditorOptionValue<T> Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Extensibility.Editor

Assembly:: Microsoft.VisualStudio.Extensibility.Editor.Contracts.dll

Package:: Microsoft.VisualStudio.Extensibility.Editor.Contracts v17.10.166

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.

The value of an editor option.

public sealed class EditorOptionValue<T> : Microsoft.VisualStudio.Extensibility.Editor.IEditorOptionValue

type EditorOptionValue<'T> = class
    interface IEditorOptionValue

Public NotInheritable Class EditorOptionValue(Of T)
Implements IEditorOptionValue

Type Parameters

T

The type of the editor option's value.

Inheritance: Object
EditorOptionValue<T>

Implements: IEditorOptionValue

Constructors

EditorOptionValue<T>(Exception)	Initializes a new instance of the EditorOptionValue<T> class.
EditorOptionValue<T>(Object)	Initializes a new instance of the EditorOptionValue<T> class.

Properties

Error	The error that occurred during the retrieval of the editor option value. Error is `null` if the retrieval of the value was successful.
Succeeded	Gets a value indicating whether Error is `null`, meaning that the retrieval of the editor option's value was successful.
Value	Gets the value of the editor option.

Methods

ValueOrDefault(T)

Gets the value, if the retrieval was successful. Returns defaultValue otherwise.

Explicit Interface Implementations

IEditorOptionValue.Value<TInterface>()	Gets the value converted to the type `T`.
IEditorOptionValue.ValueOrDefault<TInterface>(TInterface)	Gets the value converted to the type `T`, if the retrieval and the conversion to `T` are successful. Returns `defaultValue` otherwise.

Applies to

Share via