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)

public interface IEditorOptions

The IEditorOptions type exposes the following members.

  NameDescription
Public propertyGlobalOptionsGets the global options.
Public propertyParentGets the immediate parent of this set of options.
Public propertySupportedOptionsGets the supported options.
Top

  NameDescription
Public methodClearOptionValue(String)Clear the locally-defined value for the given option.
Public methodClearOptionValue<T>(EditorOptionKey<T>)Clear the locally-defined value for the given option.
Public methodGetOptionValue(String)Gets the value of the option specified by the option ID.
Public methodGetOptionValue<T>(String)Gets the value of the option identified by the specified option ID.
Public methodGetOptionValue<T>(EditorOptionKey<T>)Gets the value of the option identified by the specified key.
Public methodIsOptionDefined(String, Boolean)Determines whether the specified option is defined.
Public methodIsOptionDefined<T>(EditorOptionKey<T>, Boolean)Determines whether the specified editor option is defined.
Public methodSetOptionValue(String, Object)Sets the value of the specified option in the current scope.
Public methodSetOptionValue<T>(EditorOptionKey<T>, T)Sets the value of the specified option in the current scope.
Top

  NameDescription
Public eventOptionChangedOccurs when any option changes.
Top

  NameDescription
Public Extension MethodAppearanceCategorySpecifies the appearance category. (Defined by WpfViewOptionExtensions.)
Public Extension MethodDoesViewProhibitUserInputDetermines whether the view prohibits all user input. (Defined by TextViewOptionExtensions.)
Public Extension MethodGetIndentSizeGets the size of an indentation for the specified IEditorOptions. (Defined by DefaultOptionExtensions.)
Public Extension MethodGetNewLineCharacterGets the newline character or characters for the specified editor options. (Defined by DefaultOptionExtensions.)
Public Extension MethodGetReplicateNewLineCharacterDetermines whether to duplicate the newline character or character sequence if it is already present when inserting a newline. (Defined by DefaultOptionExtensions.)
Public Extension MethodGetTabSizeGets the number of spaces for the tab in the specified IEditorOptions. (Defined by DefaultOptionExtensions.)
Public Extension MethodIsAutoScrollEnabledDetermines whether auto-scroll is enabled with the specified set of editor options. (Defined by TextViewOptionExtensions.)
Public Extension MethodIsChangeTrackingEnabledDetermines whether change tracking is enabled with the specified set of editor options. (Defined by TextViewHostOptionExtensions.)
Public Extension MethodIsConvertTabsToSpacesEnabledDetermines whether the option to convert tabs to spaces is enabled in the specified IEditorOptions. (Defined by DefaultOptionExtensions.)
Public Extension MethodIsDragDropEditingEnabledDetermines whether the option for drag/drop editing is enabled in the specified options. (Defined by TextViewOptionExtensions.)
Public Extension MethodIsGlyphMarginEnabledDetermines whether the glyph margin is enabled with the specified set of editor options. (Defined by TextViewHostOptionExtensions.)
Public Extension MethodIsHighlightCurrentLineEnabledDetermines whether the option to highlight the current line is enabled. (Defined by WpfViewOptionExtensions.)
Public Extension MethodIsHorizontalScrollBarEnabledDetermines whether the horizontal scrollbar is enabled with the specified set of editor options. (Defined by TextViewHostOptionExtensions.)
Public Extension MethodIsLineNumberMarginEnabledDetermines whether the line number margin is enabled with the specified set of editor options. (Defined by TextViewHostOptionExtensions.)
Public Extension MethodIsMouseWheelZoomEnabledDetermines whether to allow mouse wheel zooming. (Defined by WpfViewOptionExtensions.)
Public Extension MethodIsOutliningMarginEnabledDetermines whether the outlining margin is enabled with the specified set of editor options. (Defined by TextViewHostOptionExtensions.)
Public Extension MethodIsOutliningUndoEnabledDetermines whether the option for outlining undo enabled in the specified IEditorOptions. (Defined by TextViewOptionExtensions.)
Public Extension MethodIsOverwriteModeEnabledDetermines whether overwrite mode is enabled with the specified set of editor options. (Defined by TextViewOptionExtensions.)
Public Extension MethodIsSelectionMarginEnabledDetermines whether the selection margin is enabled with the specified set of editor options. (Defined by TextViewHostOptionExtensions.)
Public Extension MethodIsSimpleGraphicsEnabledDetermines whether the option to draw a gradient selection is enabled. (Defined by WpfViewOptionExtensions.)
Public Extension MethodIsVerticalScrollBarEnabledDetermines whether the vertical scrollbar is enabled with the specified set of editor options. (Defined by TextViewHostOptionExtensions.)
Public Extension MethodIsViewportLeftClippedDetermines whether the view's ViewportLeft property is clipped to the text width. (Defined by TextViewOptionExtensions.)
Public Extension MethodIsVirtualSpaceEnabledDetermines whether virtual space is enabled for the specified set of editor options. (Defined by TextViewOptionExtensions.)
Public Extension MethodIsVisibleWhitespaceEnabledDetermines whether visible whitespace is enabled with the specified set of editor options. (Defined by TextViewOptionExtensions.)
Public Extension MethodIsZoomControlEnabledDetermines whether the zoom control is enabled with the specified set of editor options. (Defined by TextViewHostOptionExtensions.)
Public Extension MethodWordWrapStyleGets the set of word wrap styles with the specified set of editor options. (Defined by TextViewOptionExtensions.)
Top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft