Microsoft.VisualStudio.Text.Editor Namespace

Classes

AdornmentLayerDefinition

Provides information for an IAdornmentLayer export.

AppearanceCategoryOption

Defines the appearance category.

AutoDetectUtf8Option

The option definition that determines whether files, when opened, attempt to detect for a utf-8 encoding.

AutomaticDelimiterHighlightingOption

The option definition that determines whether matching delimiters should be highlighted.

AutoScrollEnabled

Defines the option to enable auto-scroll.

BackgroundBrushChangedEventArgs

Provides information for a BackgroundBrushChanged event in the IWpfTextView.

CaretPositionChangedEventArgs

Provides information for the PositionChanged event.

CaretWidthOption

The option definition that determines how wide the caret should be rendered.

ChangeTrackingMarginEnabled

Defines the option to enable the change-tracking margin.

ClickGotoDefEnabledOption

Determines whether to enable mouse click + modifier keypress for go to definition.

ClickGotoDefModifierKeyOption

Determines what modifier key to use for go to definition by mouse click + modifier keypress.

ClickGotoDefOpensPeekOption

Determines whether to open definition target in Peek view for mouse click + modifier keypress.

CollapseHintAdornmentControl

Highlights an outlining region in the text view when the mouse hovers over this region in the outlining margin.

ConvertTabsToSpaces

The option definition that determines whether to convert tabs to spaces.

CutOrCopyBlankLineIfNoSelection

Defines the option to cut or copy a blank line if the selection is empty.

DefaultOptions

Common general options.

DefaultTextViewHostOptions

Names of common ITextView host-related options.

DefaultTextViewOptions

Defines common ITextView options.

DefaultWpfViewOptions

Represents common IWpfTextView options.

DeferCreationAttribute

Specifies optional deferred creation semantics.

DisplayUrlsAsHyperlinks

The option definition that determines if URLs should be displayed as hyperlinks.

DragDropEditing

Defines the view option for drag/drop editing.

EditingStateMarginEnabledOption

Defines the option to enable all editing state margins

EditorEmulationModeOption

The option definition that determines the editor emulation mode.

EditorOptionChangedEventArgs

Provides information for the OptionChanged event.

EditorOptionDefinition

The definition of an editor option.

EditorOptionDefinition<T>

Represents the definition of an editor option.

EditorStyleNames

The names of various editor components where the component's style can be defined by the program hosting the editor.

FallbackFont

The option definition that determines the fallback font (defined here since the name of the fallback is WPF specific).

FileHealthIndicatorEnabled

Defines the option to enable the File Health Indicator.

FollowCodingConventionsOption

The option definition that determines whether files should follow project coding conventions.

GlyphMarginEnabled

Defines the option to enable the glyph margin.

GridCellLengthAttribute

This class associates a grid cell size with a MEF export.

GridUnitTypeAttribute

This class associates a GridUnitType value with a MEF export.

HighlightCurrentLineOption

Represents the option to highlight the current line.

HorizontalScrollBarEnabled

Defines the option to enable the horizontal scroll bar.

ImeTextComposition

Represents a text composition generated by the IME processing of the ITextView.

IndentationCharacterMarginEnabled

Defines the option to enable the IndentationCharacterMargin

IndentSize

The option definition that determines the size (in number of spaces) of an indent.

InsertFinalNewLine

The option definition that determines whether to insert a final newline.

InsertModeMarginEnabled

Defines the option to enable the InsertModeMargin.

IntraTextAdornment

Support for theming intra-text adornments that are provided via IntraTextAdornmentTags.

IntraTextAdornmentTag

Represents a tag that provides adornments to be displayed as interspersed with text.

IsInContrastModeOption

Determines whether the editor is in either "Extra Contrast" or "High Contrast" modes.

IsInHighContrastThemeOption

Determines whether the editor is in the Windows high contrast theme.

This theme is the specific VS Windows High Contrast theme that is enabled by the user when in Windows OS High Contrast mode. This option is not checking for Blue (Extra Contrast) theme or the Windows OS High Contrast mode.

IsViewportLeftClipped

Defines the Use Virtual Space option.

KeyProcessor

Processes the keyboard input of the editor.

LineEndingMarginEnabled

Defines the option to enable the LineEndingMargin.

LineNumberMarginEnabled

Defines the option to enable the line number margin.

LineSpacingOption

Defines the vertical line spacing option.

LongBufferLineChunk

The option definition that determines the determines the chunking size for long lines.

LongBufferLineThreshold

The option definition that determines the threshold for special handling of long lines.

MarginContainerAttribute

Specifies the type of margin container.

MinimumErrorSeverity

Determines what error severity to use for error squiggles

MouseHoverAttribute

An attribute to be placed on an event handler for MouseHover, specifying the delay between the time when the mouse stops moving and the generation of the hover event.

MouseHoverEventArgs

Provides information for a MouseHover event of ITextView.

MouseProcessorBase

Provides a base implementation for mouse bindings, so that clients can override only the the methods they need.

MouseWheelZoomEnabled

Defines the option to enable the mouse wheel zoom

NewLineCharacter

The option definition that specifies the newline character or characters.

NonBlockingCompletionOption

The option definition that determines whether editor uses non blocking completion mode, where editor does not wait for completion items to arrive when user presses a commit character. This option is not exposed to the users. It is controllable by laguage services.

OutliningCollapsedAdornmentControl

Represents collapsed text in the text view.

OutliningMarginBracketControl

Indicates the vertical extent of an expanded outlining region and allows the user to collapse it.

OutliningMarginControl

Represents the outlining margin.

OutliningMarginEnabled

Defines the option to enable the Outlining margin.

OutliningMarginHeaderControl

Allows collapsing and expanding an outlining region.

OutliningUndoEnabled

The option definition that determines whether outlining is undoable.

OverwriteMode

Defines the view option for overwrite mode.

PredefinedAdornmentLayers

This static class defines the names of the adornment layers predefined by the editor.

PredefinedMarginNames

Specifies the names of the pre-defined margins supplied by Visual Studio.

PredefinedTextViewRoles

Specifies the names of the pre-defined text view roles supplied by Visual Studio.

ProduceScreenReaderFriendlyText

Defines the option to enable providing annotated text in automation controls so that screen readers can properly read contents of code.

ReplacesAttribute

Specifies the name(s) of an asset that will be replaced by this asset.

ReplicateNewLineCharacter

The option definition that determines whether to duplicate a newline character when inserting a line.

ResponsiveCompletionOption

The option definition that determines whether editor uses responsive completion mode, where editor waits short amount of time for completion items when user presses a commit character. If completion items still don't exist after the delay, completion is dismissed. This option is exposed to the users at Tools/Options/Text Editor/Advanced page.

ResponsiveCompletionThresholdOption

The option definition that determines the maximum allowed delay in responsive completion mode, where editor waits specified amount of time for completion items when user presses a commit character. If completion items still don't exist after the delay, completion is dismissed. This option is not exposed to the users. It is controllable by remote setting.

RowColMarginEnabled

Defines the option to enable the RowColMargin.

SelectionMarginEnabled

Defines the option to enable the selection margin.

SelectionStateMarginEnabled

Defines the option to enable the SelectionStateMargin.

ShouldCaretsBeRendered

Defines the Should Carets Be Rendered option.

ShouldSelectionsBeRendered

Defines the Should Selection Be Rendered option.

ShowBlockStructure

Defines the Show Block Structure option.

ShowErrorSquiggles

Defines the Show Error Squiggles.

SimpleGraphicsOption

Represents the option to draw a selection gradient as opposed to a solid color selection.

SpaceReservationAgentChangedEventArgs

Provides information when an ISpaceReservationAgent is changed in an ISpaceReservationManager.

SpaceReservationManagerDefinition

Represents metadata for an ISpaceReservationManager.

SuggestionMarginEnabled

Defines the option to enable the suggestion margin.

TabSize

The option definition that determines the size (in number of spaces) of a tab.

TextFormattingModeOption

Customizes the text Formatting Mode used by the Editor

TextRenderingModeOption

Customizes the text Rendering Mode used by the Editor

TextViewCreatedEventArgs

Provides information for newly created ITextView.

TextViewExtensions

Utility ITextView extension methods.

TextViewLayoutChangedEventArgs

Provides information for a Layout Changed event of ITextView.

TextViewRoleAttribute

Use this attribute to specify the kinds of TextViews to which an extension applies.

TooltipAppearanceCategory

The option definition that determines whether to insert a final newline.

TrimTrailingWhiteSpace

The option definition that determines whether to trim trailing whitespace.

UpdateIndentationCharacterOption

Defines the option to enable updating the standard leading whitespace character based on the contents of the buffer after every edit.

UseReducedOpacityForHighContrastOption
UseVirtualSpace

Defines the Use Virtual Space option.

UseVisibleWhitespace

Defines the Use Visible Whitespace option.

UseVisibleWhitespaceEnabledTypes

Defines the Use Visible Whitespace option.

UseVisibleWhitespaceOnlyForSelection

Defines the Use Visible Whitespace option.

VerticalScrollBarEnabled

Defines the option to enable the vertical scroll bar.

ViewOptionDefinition<T>

Defines a ITextView-specific editor option.

ViewProhibitUserInput

Defines the Prohibit User Input option.

ViewState

View state at a particular point in time.

WordWrapStyle

Defines the word wrap style option.

WpfTextViewKeyboardFilterName

Represents the KeyboardFilter ordering name.

WpfViewOptionDefinition<T>

Defines an editor option specific to an IWpfTextView.

ZoomConstants

Defines the constants used for zoom operations

ZoomControl

Represents zoom control in the text view.

ZoomControlEnabled

Defines the option to enable the Zoom Control.

ZoomLevel

Defines the zoomlevel.

ZoomLevelChangedEventArgs

Provides information for a ZoomLevelChangedEvent event in the IWpfTextView.

ZoomLevelConverter

Value converter that allows convertion between String and Double representations of the zoom level.

Structs

CaretPosition

Represents the position of a caret in an ITextView.

EditorOptionKey<T>

Represents a type-safe key for editor options.

Interfaces

IAdornmentLayer

Represents an adornment layer.

IAdornmentLayerElement

Defines an element in an adornment layer.

IEditorOptions

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

IEditorOptionsFactoryService

Represents a service that gets IEditorOptions for a specified scope or for the global scope.

IGlyphFactory

Provides a visual for a specific glyph type.

IGlyphFactoryProvider

Provides an IGlyphFactory.

IGlyphMouseProcessorProvider

Provides a mouse binding for the glyph margin.

IGlyphTag

Represents a glyph tag, which is consumed by the glyph margin to place glyph visuals.

IIndentationManagerService
IKeyProcessorProvider

Creates a KeyProcessor for a given IWpfTextView.

IMapEditToData

Interface to facilitate mapping between positions in an TextViewModel's EditBuffer and DataBuffer.

IMouseProcessor

Provides extensions for mouse bindings.

IMouseProcessor2

Provides touch related extensions for mouse bindings.

IMouseProcessorProvider

Creates an IMouseProcessor for a IWpfTextView.

IScrollMap

Defines the mapping between character positions and scrollmap coordinates. This is not the same as the coordinate system in which the scrollbar is rendered.

IScrollMapFactoryService

Creates or reuses an IScrollMap for an ITextView.

ISmartIndent

Provides for computing the desired indentation for a line.

ISmartIndentationService

Provides a Visual Studio service that determines automatic indentation when the enter key is pressed or when navigating to an empty line.

ISmartIndentProvider

Gets an ISmartIndent object for a given ITextView. Component exporters must supply at least one content type attribute to specify the applicable content types.

ISpaceReservationAgent

Handles the display of space reservation adornments.

ISpaceReservationManager

Manages space reservation adornments.

ITextCaret

Represents the caret associated with an ITextView.

ITextEditorFactoryService

Creates editor views.

ITextSelection

Represents the selected text in an ITextView

ITextView

Represents a view of text in an ITextBuffer. It is the base class for a platform-specific interface that has methods to allow the formatted text to be rendered.

ITextView2

Extensions to ITextView, augmenting functionality. For every member here there should also be an extension method in TextViewExtensions.

ITextViewConnectionListener

Listens to text buffers of a particular content type to find out when they are opened or closed in the text editor.

ITextViewCreationListener

Listens for when ITextViews are created.

ITextViewLineCollection

Represents a helper class for accessing the view's collection of ITextViewLine objects. The TextViewLines property on the ITextView is used to get an instance of this interface.

ITextViewMargin

Represents margins that are attached to an edge of an ITextView.

ITextViewModel

Represents a set of zero or more ITextBuffer objects that are unique to the presentation of text in a particular ITextView.

ITextViewModelProvider

Provides ITextViewModel objects.

ITextViewRoleSet

Set of text view roles.

IVerticalFractionMap

Maps between character positions and fractions of the total vertical extent of an ITextView.

IVerticalScrollBar

Represents a vertical scroll bar.

IViewScroller

Represents a helper class for the ITextView, and provides basic functionality for scrolling. The ViewScroller property of ITextView is used to get an instance of the this interface.

IWpfTextView

Represents a Visual Studio ITextView for the WPF platform.

IWpfTextViewConnectionListener

Listens to text buffers of a particular content type to find out when they are opened or closed in the text editor.

IWpfTextViewCreationListener

Listens for when IWpfTextViews are created.

IWpfTextViewHost

Contains an IWpfTextView and the margins that surround it, such as a scrollbar or line number gutter.

IWpfTextViewLineCollection

Allows the ITextView to access the view's collection of ITextViewLine objects. The TextViewLines property on the ITextView is used to get an instance of the ITextViewLineCollection interface.

IWpfTextViewMargin

Represents margins that are attached to an edge of an IWpfTextView.

IWpfTextViewMarginProvider

Creates an IWpfTextViewMargin for a given IWpfTextViewHost.

Enums

AdornmentPositioningBehavior

Defines the positioning of adornments.

ConnectionReason

Defines the reasons for connecting or disconnecting a text buffer and a text view.

EditorTextFormattingMode

Specifies the WPF TextFormattingModes available in the Editor. This enumeration adds Automatic to TextFormattingMode.

EnsureSpanVisibleOptions

Options to control the behavior of IViewScroller EnsureSpanVisible.

ScrollDirection

The direction in which to scroll the ITextView.

TextSelectionMode

Specifies the text selection mode.

ViewRelativePosition

Defines the meaning of the verticalOffset parameter in the ITextView.DisplayTextLineContaining(...).

WhitespaceType

Sets a bitwise combination of enumeration values to specify which whitespace symbols are displayed on an ITextView.

WordWrapStyles

Sets a bitwise combination of enumeration values to specify the word wrap style of an ITextView.

Delegates

AdornmentRemovedCallback

Defines the behavior when a UIElement is removed from an IAdornmentLayer.