WpfViewOptionDefinition<T> Class

Defines an editor option specific to an IWpfTextView.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Text.Editor.EditorOptionDefinition
    Microsoft.VisualStudio.Text.Editor.EditorOptionDefinition<T>
      Microsoft.VisualStudio.Text.Editor.WpfViewOptionDefinition<T>
        Microsoft.VisualStudio.Text.Editor.AppearanceCategoryOption
        Microsoft.VisualStudio.Text.Editor.HighlightCurrentLineOption
        Microsoft.VisualStudio.Text.Editor.MouseWheelZoomEnabled
        Microsoft.VisualStudio.Text.Editor.SimpleGraphicsOption

Namespace:  Microsoft.VisualStudio.Text.Editor
Assembly:  Microsoft.VisualStudio.Text.UI.Wpf (in Microsoft.VisualStudio.Text.UI.Wpf.dll)

Syntax

'Declaration
Public MustInherit Class WpfViewOptionDefinition(Of T) _
    Inherits EditorOptionDefinition(Of T)
public abstract class WpfViewOptionDefinition<T> : EditorOptionDefinition<T>
generic<typename T>
public ref class WpfViewOptionDefinition abstract : public EditorOptionDefinition<T>
[<AbstractClass>]
type WpfViewOptionDefinition<'T> =  
    class
        inherit EditorOptionDefinition<'T>
    end
JScript does not support generic types or methods.

Type Parameters

  • T
    The type of the option.

The WpfViewOptionDefinition<T> type exposes the following members.

Constructors

  Name Description
Protected method WpfViewOptionDefinition<T> Initializes a new instance of WpfViewOptionDefinition<T>.

Top

Properties

  Name Description
Public property Default Gets the default value of this option. (Inherited from EditorOptionDefinition<T>.)
Public property DefaultValue Gets the default value of the option. (Inherited from EditorOptionDefinition<T>.)
Public property Key Gets the key of this option. (Inherited from EditorOptionDefinition<T>.)
Public property Name Gets the name of the option. (Inherited from EditorOptionDefinition<T>.)
Public property ValueType Gets the actual type of the option. (Inherited from EditorOptionDefinition<T>.)

Top

Methods

  Name Description
Public method Equals Determines whether two EditorOptionDefinition objects are the same. (Inherited from EditorOptionDefinition.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Gets the hash code of this type. (Inherited from EditorOptionDefinition.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsApplicableToScope Determines whether this definition is applicable only to text views. (Overrides EditorOptionDefinition.IsApplicableToScope(IPropertyOwner).)
Public method IsValid(Object%) Determines whether the proposed value is valid. (Inherited from EditorOptionDefinition<T>.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

This is a MEF component part, and should be exported with:

[Export(typeof(EditorOptionDefinition))]

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.Text.Editor Namespace