IVsUIShellOpenDocument Interface


Controls the state of open documents within the environment.

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

public interface IVsUIShellOpenDocument

System_CAPS_pubmethodAddStandardPreviewer(String, String, Int32, String, String, String, String, String, UInt32)

Adds a Web browser to the list of available previewers.

System_CAPS_pubmethodGetFirstDefaultPreviewer(String, Int32, Int32)

Returns the .exe file path of the first default web browser.

System_CAPS_pubmethodGetStandardEditorFactory(UInt32, Guid, String, Guid, String, IVsEditorFactory)

Returns the editor factory associated with a specific document (for example, a file type).

System_CAPS_pubmethodInitializeEditorInstance(UInt32, IntPtr, IntPtr, String, Guid, String, Guid, String, String, IVsUIHierarchy, UInt32, IntPtr, IServiceProvider, Guid, IVsWindowFrame)

Initializes an instance of the document editor.

System_CAPS_pubmethodIsDocumentInAProject(String, IVsUIHierarchy, UInt32, IServiceProvider, Int32)

Determines whether a document is part of the project.

System_CAPS_pubmethodIsDocumentOpen(IVsUIHierarchy, UInt32, String, Guid, UInt32, IVsUIHierarchy, UInt32[], IVsWindowFrame, Int32)

Determines whether a document is currently open.

System_CAPS_pubmethodIsSpecificDocumentViewOpen(IVsUIHierarchy, UInt32, String, Guid, String, UInt32, IVsUIHierarchy, UInt32, IVsWindowFrame, Int32)

Determines whether a specified document view is open.

System_CAPS_pubmethodMapLogicalView(Guid, Guid, String)

Maps a physical view to a logical view.

System_CAPS_pubmethodOpenCopyOfStandardEditor(IVsWindowFrame, Guid, IVsWindowFrame)

Used to implement Window.NewWindow functionality.

System_CAPS_pubmethodOpenDocumentViaProject(String, Guid, IServiceProvider, IVsUIHierarchy, UInt32, IVsWindowFrame)

Finds an appropriate project to open the document.

System_CAPS_pubmethodOpenDocumentViaProjectWithSpecific(String, UInt32, Guid, String, Guid, IServiceProvider, IVsUIHierarchy, UInt32, IVsWindowFrame)

Finds a specified project to open this document.

System_CAPS_pubmethodOpenSpecificEditor(UInt32, String, Guid, String, Guid, String, IVsUIHierarchy, UInt32, IntPtr, IServiceProvider, IVsWindowFrame)

Opens a specified editor.

System_CAPS_pubmethodOpenStandardEditor(UInt32, String, Guid, String, IVsUIHierarchy, UInt32, IntPtr, IServiceProvider, IVsWindowFrame)

Opens the standard editor.

System_CAPS_pubmethodOpenStandardPreviewer(UInt32, String, VSPREVIEWRESOLUTION, UInt32)

Opens a standard web browser for the specified document.

System_CAPS_pubmethodSearchProjectsForRelativePath(UInt32, String, String[])

Converts a relative path for a document to an absolute path that can be passed to OpenDocumentViaProject.

See also SVsUIShellOpenDocument service.

To provisionally open a document in the Visual Studio preview tab, use methods on this interface from within a using statement in conjunction with the NewDocumentStateScope class, or use the SetNewDocumentState method.

Notes to Callers:

Call to determine whether a document is open, to open a document using various editors, or to preview a document.

Return to top