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
	GlobalOptions	Gets the global options.
	Parent	Gets the immediate parent of this set of options.
	SupportedOptions	Gets the supported options.

Top

Methods

	Name	Description
	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>(String)	Gets the value of the option identified by the specified option ID.
	GetOptionValue<T>(EditorOptionKey<T>)	Gets the value of the option identified by the specified key.
	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.
	SetOptionValue<T>(EditorOptionKey<T>, T)	Sets the value of the specified option in the current scope.

Top

Events

	Name	Description
	OptionChanged	Occurs when any option changes.

Top

Extension Methods

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