ViewOptionDefinition<T> Class

Defines a ITextView-specific editor option.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Text.Editor.EditorOptionDefinition
    Microsoft.VisualStudio.Text.Editor.EditorOptionDefinition<T>
      Microsoft.VisualStudio.Text.Editor.ViewOptionDefinition<T>
        More...

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

Syntax

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

Type Parameters

  • T
    The type of the option.

The ViewOptionDefinition<T> type exposes the following members.

Constructors

  Name Description
Protected method ViewOptionDefinition<T> Initializes a new instance of ViewOptionDefinition<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 the option is applicable to the specified scope. (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

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Text.Editor.EditorOptionDefinition
    Microsoft.VisualStudio.Text.Editor.EditorOptionDefinition<T>
      Microsoft.VisualStudio.Text.Editor.ViewOptionDefinition<T>
        Microsoft.VisualStudio.Text.Editor.AutoScrollEnabled
        Microsoft.VisualStudio.Text.Editor.ChangeTrackingMarginEnabled
        Microsoft.VisualStudio.Text.Editor.CutOrCopyBlankLineIfNoSelection
        Microsoft.VisualStudio.Text.Editor.DragDropEditing
        Microsoft.VisualStudio.Text.Editor.GlyphMarginEnabled
        Microsoft.VisualStudio.Text.Editor.HorizontalScrollBarEnabled
        Microsoft.VisualStudio.Text.Editor.IsViewportLeftClipped
        Microsoft.VisualStudio.Text.Editor.LineNumberMarginEnabled
        Microsoft.VisualStudio.Text.Editor.OutliningMarginEnabled
        Microsoft.VisualStudio.Text.Editor.OverwriteMode
        Microsoft.VisualStudio.Text.Editor.ProduceScreenReaderFriendlyText
        Microsoft.VisualStudio.Text.Editor.SelectionMarginEnabled
        Microsoft.VisualStudio.Text.Editor.UseVirtualSpace
        Microsoft.VisualStudio.Text.Editor.UseVisibleWhitespace
        Microsoft.VisualStudio.Text.Editor.VerticalScrollBarEnabled
        Microsoft.VisualStudio.Text.Editor.ViewProhibitUserInput
        Microsoft.VisualStudio.Text.Editor.WordWrapStyle
        Microsoft.VisualStudio.Text.Editor.ZoomControlEnabled