IEditorOptions Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text.Editor

Assembly:: Microsoft.VisualStudio.Text.Logic.dll

Package:: Microsoft.VisualStudio.Text.Logic v17.12.215

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public interface class IEditorOptions

public interface class IEditorOptions

__interface IEditorOptions

public interface IEditorOptions

type IEditorOptions = interface

Public Interface IEditorOptions

Properties

GlobalOptions	Gets the global options.
Parent	Gets or sets the immediate parent of this set of options. If this set of options has no parent scope (because it is the global scope), this property is null and cannot be set.
SupportedOptions	Gets the supported options. Note that this method will load all assemblies exporting editor definitions and should not be called on in performance critical scenarios.

Methods

ClearOptionValue(String)	Clear the locally-defined value for the given option.
ClearOptionValue<T>(EditorOptionKey<T>)	Clear the locally-defined value for the given option.
GetOptionValue(String)	Gets the value of the option specified by the option ID.
GetOptionValue<T>(EditorOptionKey<T>)	Gets the value of the option identified by the specified key.
GetOptionValue<T>(String)	Gets the value of the option identified by the specified option ID.
IsOptionDefined(String, Boolean)	Determines whether the specified option is defined.
IsOptionDefined<T>(EditorOptionKey<T>, Boolean)	Determines whether the specified editor option is defined.
SetOptionValue(String, Object)	Sets the value of the specified option in the current scope. If the given option is not applicable in the current scope, it attempts to set the option in the global scope.
SetOptionValue<T>(EditorOptionKey<T>, T)	Sets the value of the specified option in the current scope. If the given option is not applicable in the current scope, it attempts to set the option in the global scope.

Events

OptionChanged

Occurs when any option changes. Options that change in the global scope cause this event to be raised if they are also applicable to this scope.

Extension Methods

GetIndentSize(IEditorOptions)	Gets the size of an indent for the specified IEditorOptions.
GetIndentStyle(IEditorOptions)	Gets the indentation style for the specified IEditorOptions.
GetInsertFinalNewLine(IEditorOptions)	Determines whether to insert final newline.
GetNewLineCharacter(IEditorOptions)	Gets the new line character for the specified editor options.
GetReplicateNewLineCharacter(IEditorOptions)	Determines whether to duplicate the new line character if it is already present when inserting a new line.
GetTabSize(IEditorOptions)	Gets the size of the tab for the specified IEditorOptions.
GetTooltipAppearanceCategory(IEditorOptions)	Determines appearance category for tooltips originating in this view
GetTrimTrailingWhieSpace(IEditorOptions)	Determines whether to trim trailing whitespace.
IsConvertTabsToSpacesEnabled(IEditorOptions)	Determines whether the option to convert tabs to spaces is enabled in the specified IEditorOptions.
IsChangeTrackingEnabled(IEditorOptions)	Determines whether change tracking is enabled with the specified set of editor options.
IsGlyphMarginEnabled(IEditorOptions)	Determines whether the glyph margin is enabled with the specified set of editor options.
IsHorizontalScrollBarEnabled(IEditorOptions)	Determines whether the horizontal scrollbar is enabled with the specified set of editor options.
IsInContrastMode(IEditorOptions)	Determines whether the editor is in either "Extra Contrast" or "High Contrast" modes.
IsLineNumberMarginEnabled(IEditorOptions)	Determines whether the line number margin is enabled with the specified set of editor options.
IsOutliningMarginEnabled(IEditorOptions)	Determines whether the Outlining margin is enabled with the specified set of editor options.
IsSelectionMarginEnabled(IEditorOptions)	Determines whether the selection margin is enabled with the specified set of editor options.
IsVerticalScrollBarEnabled(IEditorOptions)	Determines whether the vertical scrollbar is enabled with the specified set of editor options.
IsZoomControlEnabled(IEditorOptions)	Determines whether the zoom control is enabled with the specified set of editor options.
DoesViewProhibitUserInput(IEditorOptions)	Determines whether the view prohibits all user input.
IsAutoScrollEnabled(IEditorOptions)	Determines whether auto-scroll is enabled with the specified set of editor options.
IsDragDropEditingEnabled(IEditorOptions)	Determines whether the option for drag/drop editing is enabled in the specified IEditorOptions.
IsOutliningUndoEnabled(IEditorOptions)	Determines whether the option for outlining undo enabled in the specified IEditorOptions.
IsOverwriteModeEnabled(IEditorOptions)	Determines whether overwrite mode is enabled with the specified set of editor options.
IsViewportLeftClipped(IEditorOptions)	Determines whether the view's ViewportLeft property is clipped to the text width.
IsVirtualSpaceEnabled(IEditorOptions)	Determines whether virtual space is enabled for the specified set of editor options.
IsVisibleWhitespaceEnabled(IEditorOptions)	Determines whether visible whitespace is enabled with the specified set of editor options.
IsVisibleWhitespaceEnabledOnlyForSelection(IEditorOptions)
ShouldMoveCaretToEndOnSelectAll(IEditorOptions)	Determines if the caret should be moved to the end of the selection after performing the "select all" operation.
VisibleWhitespaceTypes(IEditorOptions)
WordWrapStyle(IEditorOptions)	Gets the set of word wrap styles with the specified set of editor options.
AppearanceCategory(IEditorOptions)	Specifies the appearance category.
IsHighlightCurrentLineEnabled(IEditorOptions)	Determines whether the option to highlight the current line is enabled.
IsMouseWheelZoomEnabled(IEditorOptions)	Determines whether to allow mouse wheel zooming
IsSimpleGraphicsEnabled(IEditorOptions)	Determines whether the option to draw a gradient selection is enabled.
ZoomLevel(IEditorOptions)	Specifies the persisted zoomlevel.

Applies to

Partilhar via