IEditorOptions Interface

Represents common editor options and an extensible mechanism for modifying values and adding new options.

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

Syntax

声明
Public Interface IEditorOptions
public interface IEditorOptions
public interface class IEditorOptions
type IEditorOptions =  interface end
public interface IEditorOptions

The IEditorOptions type exposes the following members.

Properties

  Name Description
Public property GlobalOptions Gets the global options.
Public property Parent Gets the immediate parent of this set of options.
Public property SupportedOptions Gets the supported options.

Top

Methods

  Name Description
Public method ClearOptionValue(String) Clear the locally-defined value for the given option.
Public method ClearOptionValue<T>(EditorOptionKey<T>) Clear the locally-defined value for the given option.
Public method GetOptionValue(String) Gets the value of the option specified by the option ID.
Public method GetOptionValue<T>(String) Gets the value of the option identified by the specified option ID.
Public method GetOptionValue<T>(EditorOptionKey<T>) Gets the value of the option identified by the specified key.
Public method IsOptionDefined(String, Boolean) Determines whether the specified option is defined.
Public method IsOptionDefined<T>(EditorOptionKey<T>, Boolean) Determines whether the specified editor option is defined.
Public method SetOptionValue(String, Object) Sets the value of the specified option in the current scope.
Public method SetOptionValue<T>(EditorOptionKey<T>, T) Sets the value of the specified option in the current scope.

Top

Events

  Name Description
Public event OptionChanged Occurs when any option changes.

Top

Extension Methods

  Name Description
Public Extension Method AppearanceCategory Specifies the appearance category. (Defined by WpfViewOptionExtensions.)
Public Extension Method DoesViewProhibitUserInput Determines whether the view prohibits all user input. (Defined by TextViewOptionExtensions.)
Public Extension Method GetIndentSize Gets the size of an indentation for the specified IEditorOptions. (Defined by DefaultOptionExtensions.)
Public Extension Method GetNewLineCharacter Gets the newline character or characters for the specified editor options. (Defined by DefaultOptionExtensions.)
Public Extension Method GetReplicateNewLineCharacter Determines whether to duplicate the newline character or character sequence if it is already present when inserting a newline. (Defined by DefaultOptionExtensions.)
Public Extension Method GetTabSize Gets the number of spaces for the tab in the specified IEditorOptions. (Defined by DefaultOptionExtensions.)
Public Extension Method IsAutoScrollEnabled Determines whether auto-scroll is enabled with the specified set of editor options. (Defined by TextViewOptionExtensions.)
Public Extension Method IsChangeTrackingEnabled Determines whether change tracking is enabled with the specified set of editor options. (Defined by TextViewHostOptionExtensions.)
Public Extension Method IsConvertTabsToSpacesEnabled Determines whether the option to convert tabs to spaces is enabled in the specified IEditorOptions. (Defined by DefaultOptionExtensions.)
Public Extension Method IsDragDropEditingEnabled Determines whether the option for drag/drop editing is enabled in the specified options. (Defined by TextViewOptionExtensions.)
Public Extension Method IsGlyphMarginEnabled Determines whether the glyph margin is enabled with the specified set of editor options. (Defined by TextViewHostOptionExtensions.)
Public Extension Method IsHighlightCurrentLineEnabled Determines whether the option to highlight the current line is enabled. (Defined by WpfViewOptionExtensions.)
Public Extension Method IsHorizontalScrollBarEnabled Determines whether the horizontal scrollbar is enabled with the specified set of editor options. (Defined by TextViewHostOptionExtensions.)
Public Extension Method IsLineNumberMarginEnabled Determines whether the line number margin is enabled with the specified set of editor options. (Defined by TextViewHostOptionExtensions.)
Public Extension Method IsMouseWheelZoomEnabled Determines whether to allow mouse wheel zooming. (Defined by WpfViewOptionExtensions.)
Public Extension Method IsOutliningMarginEnabled Determines whether the outlining margin is enabled with the specified set of editor options. (Defined by TextViewHostOptionExtensions.)
Public Extension Method IsOutliningUndoEnabled Determines whether the option for outlining undo enabled in the specified IEditorOptions. (Defined by TextViewOptionExtensions.)
Public Extension Method IsOverwriteModeEnabled Determines whether overwrite mode is enabled with the specified set of editor options. (Defined by TextViewOptionExtensions.)
Public Extension Method IsSelectionMarginEnabled Determines whether the selection margin is enabled with the specified set of editor options. (Defined by TextViewHostOptionExtensions.)
Public Extension Method IsSimpleGraphicsEnabled Determines whether the option to draw a gradient selection is enabled. (Defined by WpfViewOptionExtensions.)
Public Extension Method IsVerticalScrollBarEnabled Determines whether the vertical scrollbar is enabled with the specified set of editor options. (Defined by TextViewHostOptionExtensions.)
Public Extension Method IsViewportLeftClipped Determines whether the view's ViewportLeft property is clipped to the text width. (Defined by TextViewOptionExtensions.)
Public Extension Method IsVirtualSpaceEnabled Determines whether virtual space is enabled for the specified set of editor options. (Defined by TextViewOptionExtensions.)
Public Extension Method IsVisibleWhitespaceEnabled Determines whether visible whitespace is enabled with the specified set of editor options. (Defined by TextViewOptionExtensions.)
Public Extension Method IsZoomControlEnabled Determines whether the zoom control is enabled with the specified set of editor options. (Defined by TextViewHostOptionExtensions.)
Public Extension Method WordWrapStyle Gets the set of word wrap styles with the specified set of editor options. (Defined by TextViewOptionExtensions.)

Top

See Also

Reference

Microsoft.VisualStudio.Text.Editor Namespace