IVsUIShellOpenDocument.GetStandardEditorFactory Method

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

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in microsoft.visualstudio.shell.interop.dll)

int GetStandardEditorFactory (
	[InAttribute] uint dwReserved,
	[InAttribute] out Guid pguidEditorType,
	[InAttribute] string pszMkDocument,
	[InAttribute] ref Guid rguidLogicalView,
	out string pbstrPhysicalView,
	out IVsEditorFactory ppEF
)
int GetStandardEditorFactory (
	/** @attribute InAttribute() */ UInt32 dwReserved, 
	/** @attribute InAttribute() */ /** @attribute OutAttribute() */ /** @ref */ Guid pguidEditorType, 
	/** @attribute InAttribute() */ String pszMkDocument, 
	/** @attribute InAttribute() */ /** @ref */ Guid rguidLogicalView, 
	/** @attribute OutAttribute() */ /** @ref */ String pbstrPhysicalView, 
	/** @attribute OutAttribute() */ /** @ref */ IVsEditorFactory ppEF
)
JScript does not support passing value-type arguments by reference.

Parameters

dwReserved

[in] Reserved for future use.

pguidEditorType

[in, out] GUID of the editor factory you want returned. To indicate which editor factory should be returned, specify a value for pguidEditorType or pszMkDocument. Do not provide values for both parameters.

pszMkDocument

[in] String form of the 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). To indicate which editor factory should be returned, specify a value for pszMkDocument or pguidEditorType. Do not provide values for both parameters.

rguidLogicalView

[in] GUID identifying the logical view. For a list of logical view GUIDS, see Interaction Between Logical Views and Physical Views.

pbstrPhysicalView

[out] Physical view string corresponding to the view that is associated with the logical view GUID passed in rguidLogicalView.

ppEF

[out, retval] Pointer to the IVsEditorFactory implementation for the requested editor.

Return Value

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

COM Signature

From vsshell.idl:

HRESULT IVsUIShellOpenDocument::GetStandardEditorFactory(
   [in] DWORD dwReserved,
   [in, out] GUID *pguidEditorType,
   [in] LPCOLESTR pszMkDocument,
   [in] REFGUID rguidLogicalView,
   [out] BSTR *pbstrPhysicalView,
   [out, retval] IVsEditorFactory **ppEF
);

Call IVsUIShellOpenDocument.GetStandardEditor if you need to programmatically access the underlying document data of an editor, but you do not need the full editor window instantiated. To do this, you first need to call IVsUIShellOpenDocument.GetStandardEditor to get a pointer to the editor factory (IVsEditorFactory). Once you have this, you can call CreateEditorInstance.

If you do not own the editor factory and thus do not know the editor GUID (pguidEditorType parameter), you can get the editor GUID in one of the following ways:

  • If you have instantiated the editor before, you can use the editor GUID value attached to the window frame, which you might have cached after determining it by calling GetProperty and specifying a value of VSFPROPID_guidEditorType for the propid parameter.

  • If you have a pointer to the document data object, you can call GetGuidEditorType to access the editor GUID.

If it is not possible for you to specify the editor GUID, then specify the path to the document (pszMkDocument parameter) and the environment determines the appropriate standard editor based on the file extension. If the document is a file, you can just provide the file extension for the pszMkDocument parameter instead of the full document path.

Community Additions

ADD
Show: