C# Class RIM.VSNDK_Package.EditorFactory

Inheritance: IVsEditorFactory, IDisposable

Show file Open project: blackberry/VSPlugin

Public Methods

Method	Description
Close ( ) : int	Close the factory
CreateEditorInstance ( uint grfCreateDoc, string pszMkDocument, string pszPhysicalView, IVsHierarchy pvHier, uint itemid, IntPtr punkDocDataExisting, IntPtr &ppunkDocView, IntPtr &ppunkDocData, string &pbstrEditorCaption, System.Guid &pguidCmdUI, int &pgrfCDW ) : int	Create an instance of the custom editor
Dispose ( ) : void	IDisposable Constructor
EditorFactory ( VSNDK_PackagePackage package ) : System	Constructor
GetService ( Type serviceType ) : object	Private function to return the required service.
MapLogicalView ( System.Guid &rguidLogicalView, string &pbstrPhysicalView ) : int	This method is called by the Environment (inside IVsUIShellOpenDocument:: OpenStandardEditor and OpenSpecificEditor) to map a LOGICAL view to a PHYSICAL view.
SetSite ( Microsoft.VisualStudio.OLE.Interop.IServiceProvider psp ) : int	Used for initialization of the editor in the environment

Private Methods

Method	Description
Dispose ( bool disposing ) : void	IDisposable Constructor Override

Method Details

Close() public method

Close the factory

public Close ( ) : int
return	int

CreateEditorInstance() public method

Create an instance of the custom editor

public CreateEditorInstance ( uint grfCreateDoc, string pszMkDocument, string pszPhysicalView, IVsHierarchy pvHier, uint itemid, IntPtr punkDocDataExisting, IntPtr &ppunkDocView, IntPtr &ppunkDocData, string &pbstrEditorCaption, System.Guid &pguidCmdUI, int &pgrfCDW ) : int
grfCreateDoc	uint	Behaviour Flags
pszMkDocument	string	Document to be opened.
pszPhysicalView	string	Name of the view
pvHier	IVsHierarchy	Pointer to the IVSHierarchy
itemid	uint	Item ID for this instance
punkDocDataExisting	System.IntPtr	This parameter is used to determine if a document buffer (DocData object) has already been created
ppunkDocView	System.IntPtr	Pointer to the IUnknown interface for the DocView object
ppunkDocData	System.IntPtr	Pointer to the IUnknown interface for the DocData object
pbstrEditorCaption	string	Caption mentioned by the editor for the doc window
pguidCmdUI	System.Guid	the Command UI Guid. Any UI element that is visible in the editor has to use this GUID. This is specified in the .vsct file
pgrfCDW	int	Flags for CreateDocumentWindow
return	int

Dispose() public method

IDisposable Constructor

public Dispose ( ) : void
return	void

EditorFactory() public method

Constructor

public EditorFactory ( VSNDK_PackagePackage package ) : System
package	VSNDK_PackagePackage
return	System

GetService() public method

Private function to return the required service.

public GetService ( Type serviceType ) : object
serviceType	System.Type
return	object

MapLogicalView() public method

This method is called by the Environment (inside IVsUIShellOpenDocument:: OpenStandardEditor and OpenSpecificEditor) to map a LOGICAL view to a PHYSICAL view.

public MapLogicalView ( System.Guid &rguidLogicalView, string &pbstrPhysicalView ) : int
rguidLogicalView	System.Guid
pbstrPhysicalView	string
return	int

SetSite() public method

Used for initialization of the editor in the environment

public SetSite ( Microsoft.VisualStudio.OLE.Interop.IServiceProvider psp ) : int
psp	Microsoft.VisualStudio.OLE.Interop.IServiceProvider	pointer to the service provider. Can be used to obtain instances of other interfaces
return	int