IVsUIShellOpenDocument.OpenStandardEditor Method

Opens the standard editor.

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

Syntax

‘선언
Function OpenStandardEditor ( _
    grfOpenStandard As UInteger, _
    pszMkDocument As String, _
    ByRef rguidLogicalView As Guid, _
    pszOwnerCaption As String, _
    pHier As IVsUIHierarchy, _
    itemid As UInteger, _
    punkDocDataExisting As IntPtr, _
    psp As IServiceProvider, _
    <OutAttribute> ByRef ppWindowFrame As IVsWindowFrame _
) As Integer
‘사용 방법
Dim instance As IVsUIShellOpenDocument
Dim grfOpenStandard As UInteger
Dim pszMkDocument As String
Dim rguidLogicalView As Guid
Dim pszOwnerCaption As String
Dim pHier As IVsUIHierarchy
Dim itemid As UInteger
Dim punkDocDataExisting As IntPtr
Dim psp As IServiceProvider
Dim ppWindowFrame As IVsWindowFrame
Dim returnValue As Integer

returnValue = instance.OpenStandardEditor(grfOpenStandard, _
    pszMkDocument, rguidLogicalView, _
    pszOwnerCaption, pHier, itemid, punkDocDataExisting, _
    psp, ppWindowFrame)

int OpenStandardEditor(
    uint grfOpenStandard,
    string pszMkDocument,
    ref Guid rguidLogicalView,
    string pszOwnerCaption,
    IVsUIHierarchy pHier,
    uint itemid,
    IntPtr punkDocDataExisting,
    IServiceProvider psp,
    out IVsWindowFrame ppWindowFrame
)

int OpenStandardEditor(
    [InAttribute] unsigned int grfOpenStandard, 
    [InAttribute] String^ pszMkDocument, 
    [InAttribute] Guid% rguidLogicalView, 
    [InAttribute] String^ pszOwnerCaption, 
    [InAttribute] IVsUIHierarchy^ pHier, 
    [InAttribute] unsigned int itemid, 
    [InAttribute] IntPtr punkDocDataExisting, 
    [InAttribute] IServiceProvider^ psp, 
    [OutAttribute] IVsWindowFrame^% ppWindowFrame
)

function OpenStandardEditor(
    grfOpenStandard : uint, 
    pszMkDocument : String, 
    rguidLogicalView : Guid, 
    pszOwnerCaption : String, 
    pHier : IVsUIHierarchy, 
    itemid : uint, 
    punkDocDataExisting : IntPtr, 
    psp : IServiceProvider, 
    ppWindowFrame : IVsWindowFrame
) : int

Parameters

• grfOpenStandard
  Type: System.UInt32

  [in] Flags whose values are taken from the __VSOSEFLAGS enumeration.

• pszMkDocument
  Type: System.String

  [in] String form of the unique moniker identifier of the document in the project system. If the document is a file, you can simply specify the file extension for this parameter rather than the full path to the file (for example, .bmp or txt). In non-file cases, this identifier is often in the form of a URL.

• rguidLogicalView
  Type: System.Guid%

  [in] GUID identifying the logical view. If the editor implements IVsMultiViewDocumentView on the document view object, then the value passed into the rguidLogicalView parameter determines which view is activated when the editor window is shown. By specifying the logical view GUID, you can request the specific view that matches the reason you are requesting the view. For example, specify LOGVIEWID_Debugging to get the view appropriate for debugging, or LOGVIEWID_TextView to get the view appropriate for the text editor (that is, a view that implements IVsCodeWindow).

• pszOwnerCaption
  Type: System.String

  [in] Initial caption defined by the document owner (that is, the project) for the document window. This is often of the form: "ProjectName – ItemName."

• pHier
  Type: Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy

  [in] Pointer to the IVsUIHierarchy interface.

• itemid
  Type: System.UInt32

  [in] UI hierarchy item identifier of the standard editor. For more information see VSITEMID.

• punkDocDataExisting
  Type: System.IntPtr

  [in] Pointer to the IUnknown interface of the document data object.

• psp
  Type: Microsoft.VisualStudio.OLE.Interop.IServiceProvider

  [in] Pointer to the IServiceProvider interface.

• ppWindowFrame
  Type: Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame%

  [out, retval] Pointer to the IVsWindowFrame interface.

Return Value

Type: System.Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsUIShellOpenDocument::OpenStandardEditor(
   [in] VSOSEFLAGS grfOpenStandard,
   [in] LPCOLESTR pszMkDocument,
   [in] REFGUID rguidLogicalView,
   [in] LPCOLESTR pszOwnerCaption,
   [in] IVsUIHierarchy *pHier,
   [in] VSITEMID itemid,
   [in] IUnknown *punkDocDataExisting,
   [in] IServiceProvider *pSP,
   [out, retval] IVsWindowFrame **ppWindowFrame
);

This method does not call back OpenItem.

Permissions

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

IVsUIShellOpenDocument Interface

IVsUIShellOpenDocument Members

Microsoft.VisualStudio.Shell.Interop Namespace