IVsTextManager Interface
TOC
Collapse the table of content
Expand the table of content

IVsTextManager Interface

 

Provides general services for anyone wanting information about the active text views.

Namespace:   Microsoft.VisualStudio.TextManager.Interop
Assembly:  Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

[InterfaceTypeAttribute(1)]
[GuidAttribute("909F83E3-B3FC-4BBF-8820-64378744B39B")]
public interface class IVsTextManager

NameDescription
System_CAPS_pubmethodAdjustFileChangeIgnoreCount(IVsTextBuffer^, Int32)

Increases or decreases the ignore count for file changes.

System_CAPS_pubmethodAttemptToCheckOutBufferFromScc(IVsUserData^, Int32)

Method information not provided.

System_CAPS_pubmethodAttemptToCheckOutBufferFromScc2(String^, Int32, Int32)

Attempts to check out a file from source code control.

System_CAPS_pubmethodCreateSelectionAction(IVsTextBuffer^, IVsTextSelectionAction^)

Method information is not provided. Do not use this method.

System_CAPS_pubmethodEnumBuffers(IVsEnumTextBuffers^)

Enumerates text buffers. Not yet implemented.

System_CAPS_pubmethodEnumIndependentViews(IVsTextBuffer^, IVsEnumIndependentViews^)

Enumerates the independent views.

System_CAPS_pubmethodEnumLanguageServices(IVsEnumGUID^)

Enumerates the registered language service IDs.

System_CAPS_pubmethodEnumViews(IVsTextBuffer^, IVsEnumTextViews^)

Enumerates views that are provided with the core editor and are associated with a particular text buffer.

System_CAPS_pubmethodGetActiveView(Int32, IVsTextBuffer^, IVsTextView^)

Returns the active or previously active view.

System_CAPS_pubmethodGetBufferSccStatus(IVsUserData^, Int32)

Method information not provided. Do not use this method.

System_CAPS_pubmethodGetBufferSccStatus2(String^, Int32, Int32)

Returns information on whether a buffer is under source code control and, if so, whether the file is checked in.

System_CAPS_pubmethodGetMarkerTypeCount(Int32)

Returns the number of registered marker types within all buffers associated with the core text editor.

System_CAPS_pubmethodGetMarkerTypeInterface(Int32, IVsTextMarkerType^)

Maps a numeric marker type ID to an interface that can be used to probe for specific information.

System_CAPS_pubmethodGetPerLanguagePreferences(array<LANGPREFERENCES>^)

Method information is not provided.

System_CAPS_pubmethodGetRegisteredMarkerTypeID(Guid, Int32)

Returns a registered marker type.

System_CAPS_pubmethodGetShortcutManager(IVsShortcutManager^)

Returns the shortcut manager.

System_CAPS_pubmethodGetUserPreferences(array<VIEWPREFERENCES>^, array<FRAMEPREFERENCES>^, array<LANGPREFERENCES>^, array<FONTCOLORPREFERENCES>^)

Returns the user preferences, such as tab usage, indent size and widget margin presence for the view, frame, and language service.

System_CAPS_pubmethodIgnoreNextFileChange(IVsTextBuffer^)

Notifies that the next file change is to be ignored.

System_CAPS_pubmethodMapFilenameToLanguageSID(String^, Guid)

Given a file name, determines the registered language service, if one exists, that understands it.

System_CAPS_pubmethodNavigateToLineAndColumn(IVsTextBuffer^, Guid, Int32, Int32, Int32, Int32)

Finds or creates an appropriate view on the specified buffer and places the selection at the specified location.

System_CAPS_pubmethodNavigateToPosition(IVsTextBuffer^, Guid, Int32, Int32)

Finds or creates an appropriate view on the specified buffer and puts the selection on the specified linear position.

System_CAPS_pubmethodRegisterBuffer(IVsTextBuffer^)

Registers a text buffer with the text manager.

System_CAPS_pubmethodRegisterIndependentView(Object^, IVsTextBuffer^)

Registers a view from a source other than the core editor.

System_CAPS_pubmethodRegisterView(IVsTextView^, IVsTextBuffer^)

Method information is not provided.

System_CAPS_pubmethodSetFileChangeAdvise(String^, Int32)

Method information is not provided.

System_CAPS_pubmethodSetPerLanguagePreferences(array<LANGPREFERENCES>^)

Method information is not provided.

System_CAPS_pubmethodSetUserPreferences(array<VIEWPREFERENCES>^, array<FRAMEPREFERENCES>^, array<LANGPREFERENCES>^, array<FONTCOLORPREFERENCES>^)

Sets user preferences.

System_CAPS_pubmethodSuspendFileChangeAdvise(String^, Int32)

Suspends file change notifications for a given file.

System_CAPS_pubmethodUnregisterBuffer(IVsTextBuffer^)

Unregisters a buffer.

System_CAPS_pubmethodUnregisterIndependentView(Object^, IVsTextBuffer^)

Unregisters an externally-created view.

System_CAPS_pubmethodUnregisterView(IVsTextView^)

Method information is not provided.

There is one text manager in the environment. The text manager manages all of the text buffers that are active at any given point, all of the user settings for the different languages, and any other global preferences related to the core text editor. When the user specifies preferences for the appearance and/or behavior of components in the text editor, the text manager stores this information and communicates it to all relevant clients. Examples include color preferences, tab versus space preferences, and so on. Preferences that are unique to a given language (that is, that apply to one language but to no other) are not stored here. These settings are managed by the individual language services.

The text manager provides a central location for components to discover common information, such as whether a buffer is under source-code control, registering for file-change notifications, keeping track of which views are associated with which buffers, and so on.

See illustrations of the implementation and/or calling of this interface in the sample .f08872bd-fd9c-4e36-8cf2-a2a2622ef986

System_CAPS_noteNote

For historical reasons, VSPackages using the Managed Package Framework, use VsTextManagerClass (the class implementing IVsTextManager) with System.typeof, instead of IVsTextManager, to obtain the serviceType argument for GetService. The return value of GetService must then be cast to IVsTextManager. For more information see GetService.

An IVsTextManager interface can be obtained with:

IVsTextManager mytext_mgr = myPackage.GetService(System.typeof(VsTextManagerClass)) as IVsTextManager;

Notes to Implementers:

Implemented by the environment.

Notes to Callers:

Called by any component that needs to learn about the current view or other information related to the global preferences. The methods of IVsTextManager are most likely required by tools that interact with the Visual Studio core editor.

Return to top
Show:
© 2016 Microsoft