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 class IEditorOptions

NameDescription
System_CAPS_pubpropertyGlobalOptions

Gets the global options.

System_CAPS_pubpropertyParent

Gets the immediate parent of this set of options.

System_CAPS_pubpropertySupportedOptions

Gets the supported options.

NameDescription
System_CAPS_pubmethodClearOptionValue(String^)

Clear the locally-defined value for the given option.

System_CAPS_pubmethodClearOptionValue<T>(EditorOptionKey<T>)

Clear the locally-defined value for the given option.

System_CAPS_pubmethodGetOptionValue(String^)

Gets the value of the option specified by the option ID.

System_CAPS_pubmethodGetOptionValue<T>(EditorOptionKey<T>)

Gets the value of the option identified by the specified key.

System_CAPS_pubmethodGetOptionValue<T>(String^)

Gets the value of the option identified by the specified option ID.

System_CAPS_pubmethodIsOptionDefined(String^, Boolean)

Determines whether the specified option is defined.

System_CAPS_pubmethodIsOptionDefined<T>(EditorOptionKey<T>, Boolean)

Determines whether the specified editor option is defined.

System_CAPS_pubmethodSetOptionValue(String^, Object^)

Sets the value of the specified option in the current scope.

System_CAPS_pubmethodSetOptionValue<T>(EditorOptionKey<T>, T)

Sets the value of the specified option in the current scope.

NameDescription
System_CAPS_pubeventOptionChanged

Occurs when any option changes.

NameDescription
System_CAPS_pubmethodAppearanceCategory()

Specifies the appearance category.(Defined by WpfViewOptionExtensions.)

System_CAPS_pubmethodDoesViewProhibitUserInput()

Determines whether the view prohibits all user input.(Defined by TextViewOptionExtensions.)

System_CAPS_pubmethodGetIndentSize()

Gets the size of an indentation for the specified IEditorOptions.(Defined by DefaultOptionExtensions.)

System_CAPS_pubmethodGetNewLineCharacter()

Gets the newline character or characters for the specified editor options.(Defined by DefaultOptionExtensions.)

System_CAPS_pubmethodGetReplicateNewLineCharacter()

Determines whether to duplicate the newline character or character sequence if it is already present when inserting a newline.(Defined by DefaultOptionExtensions.)

System_CAPS_pubmethodGetTabSize()

Gets the number of spaces for the tab in the specified IEditorOptions.(Defined by DefaultOptionExtensions.)

System_CAPS_pubmethodIsAutoScrollEnabled()

Determines whether auto-scroll is enabled with the specified set of editor options.(Defined by TextViewOptionExtensions.)

System_CAPS_pubmethodIsChangeTrackingEnabled()

Determines whether change tracking is enabled with the specified set of editor options.(Defined by TextViewHostOptionExtensions.)

System_CAPS_pubmethodIsConvertTabsToSpacesEnabled()

Determines whether the option to convert tabs to spaces is enabled in the specified IEditorOptions.(Defined by DefaultOptionExtensions.)

System_CAPS_pubmethodIsDragDropEditingEnabled()

Determines whether the option for drag/drop editing is enabled in the specified options.(Defined by TextViewOptionExtensions.)

System_CAPS_pubmethodIsGlyphMarginEnabled()

Determines whether the glyph margin is enabled with the specified set of editor options.(Defined by TextViewHostOptionExtensions.)

System_CAPS_pubmethodIsHighlightCurrentLineEnabled()

Determines whether the option to highlight the current line is enabled.(Defined by WpfViewOptionExtensions.)

System_CAPS_pubmethodIsHorizontalScrollBarEnabled()

Determines whether the horizontal scrollbar is enabled with the specified set of editor options.(Defined by TextViewHostOptionExtensions.)

System_CAPS_pubmethodIsLineNumberMarginEnabled()

Determines whether the line number margin is enabled with the specified set of editor options.(Defined by TextViewHostOptionExtensions.)

System_CAPS_pubmethodIsMouseWheelZoomEnabled()

Determines whether to allow mouse wheel zooming.(Defined by WpfViewOptionExtensions.)

System_CAPS_pubmethodIsOutliningMarginEnabled()

Determines whether the outlining margin is enabled with the specified set of editor options.(Defined by TextViewHostOptionExtensions.)

System_CAPS_pubmethodIsOutliningUndoEnabled()

Determines whether the option for outlining undo enabled in the specified IEditorOptions.(Defined by TextViewOptionExtensions.)

System_CAPS_pubmethodIsOverwriteModeEnabled()

Determines whether overwrite mode is enabled with the specified set of editor options.(Defined by TextViewOptionExtensions.)

System_CAPS_pubmethodIsSelectionMarginEnabled()

Determines whether the selection margin is enabled with the specified set of editor options.(Defined by TextViewHostOptionExtensions.)

System_CAPS_pubmethodIsSimpleGraphicsEnabled()

Determines whether the option to draw a gradient selection is enabled.(Defined by WpfViewOptionExtensions.)

System_CAPS_pubmethodIsVerticalScrollBarEnabled()

Determines whether the vertical scrollbar is enabled with the specified set of editor options.(Defined by TextViewHostOptionExtensions.)

System_CAPS_pubmethodIsViewportLeftClipped()

Determines whether the view's ViewportLeft property is clipped to the text width.(Defined by TextViewOptionExtensions.)

System_CAPS_pubmethodIsVirtualSpaceEnabled()

Determines whether virtual space is enabled for the specified set of editor options.(Defined by TextViewOptionExtensions.)

System_CAPS_pubmethodIsVisibleWhitespaceEnabled()

Determines whether visible whitespace is enabled with the specified set of editor options.(Defined by TextViewOptionExtensions.)

System_CAPS_pubmethodIsZoomControlEnabled()

Determines whether the zoom control is enabled with the specified set of editor options.(Defined by TextViewHostOptionExtensions.)

System_CAPS_pubmethodWordWrapStyle()

Gets the set of word wrap styles with the specified set of editor options.(Defined by TextViewOptionExtensions.)

System_CAPS_pubmethodZoomLevel()
Return to top
Show: