Share via


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)

Syntax

'Declaration
<GuidAttribute("35299EEC-11EE-4518-9F08-401638D1D3BC")> _
<InterfaceTypeAttribute()> _
Public Interface IVsUIShellOpenDocument
[GuidAttribute("35299EEC-11EE-4518-9F08-401638D1D3BC")]
[InterfaceTypeAttribute()]
public interface IVsUIShellOpenDocument
[GuidAttribute(L"35299EEC-11EE-4518-9F08-401638D1D3BC")]
[InterfaceTypeAttribute()]
public interface class IVsUIShellOpenDocument
[<GuidAttribute("35299EEC-11EE-4518-9F08-401638D1D3BC")>]
[<InterfaceTypeAttribute()>]
type IVsUIShellOpenDocument =  interface end
public interface IVsUIShellOpenDocument

The IVsUIShellOpenDocument type exposes the following members.

Methods

  Name Description
Public method AddStandardPreviewer Adds a Web browser to the list of available previewers.
Public method GetFirstDefaultPreviewer Returns the .exe file path of the first default web browser.
Public method GetStandardEditorFactory Returns the editor factory associated with a specific document (for example, a file type).
Public method InitializeEditorInstance Initializes an instance of the document editor.
Public method IsDocumentInAProject Determines whether a document is part of the project.
Public method IsDocumentOpen Determines whether a document is currently open.
Public method IsSpecificDocumentViewOpen Determines whether a specified document view is open.
Public method MapLogicalView Maps a physical view to a logical view.
Public method OpenCopyOfStandardEditor Used to implement Window.NewWindow functionality.
Public method OpenDocumentViaProject Finds an appropriate project to open the document.
Public method OpenDocumentViaProjectWithSpecific Finds a specified project to open this document.
Public method OpenSpecificEditor Opens a specified editor.
Public method OpenStandardEditor Opens the standard editor.
Public method OpenStandardPreviewer Opens a standard web browser for the specified document.
Public method SearchProjectsForRelativePath Converts a relative path for a document to an absolute path that can be passed to OpenDocumentViaProject.

Top

Remarks

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.

See Also

Reference

Microsoft.VisualStudio.Shell.Interop Namespace