C# Class Microsoft.VisualStudio.Project.DocumentManager

Mostra file Open project: tunnelvisionlabs/MPFProj10 Class Usage Examples

Public Methods

Method	Description
Close ( __FRAMECLOSE closeFlag ) : int	Close an open document window
GetDocInfo ( bool &isOpen, bool &isDirty, bool &isOpenedByUs, uint &docCookie, IVsPersistDocData &persistDocData ) : void	Get document properties from RDT
Open ( System.Guid &logicalView, IntPtr docDataExisting, IVsWindowFrame &windowFrame, WindowFrameShowAction windowFrameAction ) : int	Open a document using the standard editor. This method has no implementation since a document is abstract in this context See FileDocumentManager class for an implementation of this method
OpenWithSpecific ( uint editorFlags, System.Guid &editorType, string physicalView, System.Guid &logicalView, IntPtr docDataExisting, IVsWindowFrame &frame, WindowFrameShowAction windowFrameAction ) : int	Open a document using a specific editor. This method has no implementation. See FileDocumentManager for an implementation of this method
RenameDocument ( System.IServiceProvider site, string oldName, string newName, uint newItemId ) : void	Rename document in the running document table from oldName to newName.
Save ( bool saveIfDirty ) : void	Silently saves an open document The call to SaveDocData may return Microsoft.VisualStudio.Shell.Interop.PFF_RESULTS.STG_S_DATALOSS to indicate some characters could not be represented in the current codepage
UpdateCaption ( System.IServiceProvider site, string caption, IntPtr docData ) : void	Updates the caption for all windows associated to the document.

Protected Methods

Method	Description
CloseWindowFrame ( IVsWindowFrame &windowFrame ) : void
DocumentManager ( HierarchyNode node ) : System
GetFullPathForDocument ( ) : string
GetOwnerCaption ( ) : string

Method Details

Close() public method

Close an open document window

public Close ( __FRAMECLOSE closeFlag ) : int
closeFlag	__FRAMECLOSE	Decides how to close the document
return	int

CloseWindowFrame() protected static method

protected static CloseWindowFrame ( IVsWindowFrame &windowFrame ) : void
windowFrame	IVsWindowFrame
return	void

DocumentManager() protected method

protected DocumentManager ( HierarchyNode node ) : System
node	HierarchyNode
return	System

GetDocInfo() public method

Get document properties from RDT

public GetDocInfo ( bool &isOpen, bool &isDirty, bool &isOpenedByUs, uint &docCookie, IVsPersistDocData &persistDocData ) : void
isOpen	bool
isDirty	bool
isOpenedByUs	bool
docCookie	uint
persistDocData	IVsPersistDocData
return	void

GetFullPathForDocument() protected method

protected GetFullPathForDocument ( ) : string
return	string

GetOwnerCaption() protected method

protected GetOwnerCaption ( ) : string
return	string

Open() public method

Open a document using the standard editor. This method has no implementation since a document is abstract in this context

See FileDocumentManager class for an implementation of this method

public Open ( System.Guid &logicalView, IntPtr docDataExisting, IVsWindowFrame &windowFrame, WindowFrameShowAction windowFrameAction ) : int
logicalView	System.Guid	In MultiView case determines view to be activated by IVsMultiViewDocumentView. For a list of logical view GUIDS, see constants starting with LOGVIEWID_ defined in NativeMethods class
docDataExisting	System.IntPtr	IntPtr to the IUnknown interface of the existing document data object
windowFrame	IVsWindowFrame	A reference to the window frame that is mapped to the document
windowFrameAction	WindowFrameShowAction	Determine the UI action on the document window
return	int

OpenWithSpecific() public method

Open a document using a specific editor. This method has no implementation.

See FileDocumentManager for an implementation of this method

public OpenWithSpecific ( uint editorFlags, System.Guid &editorType, string physicalView, System.Guid &logicalView, IntPtr docDataExisting, IVsWindowFrame &frame, WindowFrameShowAction windowFrameAction ) : int
editorFlags	uint	Specifies actions to take when opening a specific editor. Possible editor flags are defined in the enumeration Microsoft.VisualStudio.Shell.Interop.__VSOSPEFLAGS
editorType	System.Guid	Unique identifier of the editor type
physicalView	string	Name of the physical view. If null, the environment calls MapLogicalView on the editor factory to determine the physical view that corresponds to the logical view. In this case, null does not specify the primary view, but rather indicates that you do not know which view corresponds to the logical view
logicalView	System.Guid	In MultiView case determines view to be activated by IVsMultiViewDocumentView. For a list of logical view GUIDS, see constants starting with LOGVIEWID_ defined in NativeMethods class
docDataExisting	System.IntPtr	IntPtr to the IUnknown interface of the existing document data object
frame	IVsWindowFrame	A reference to the window frame that is mapped to the document
windowFrameAction	WindowFrameShowAction	Determine the UI action on the document window
return	int

RenameDocument() public static method

Rename document in the running document table from oldName to newName.

public static RenameDocument ( System.IServiceProvider site, string oldName, string newName, uint newItemId ) : void
site	System.IServiceProvider	The service provider.
oldName	string	Full path to the old name of the document.
newName	string	Full path to the new name of the document.
newItemId	uint	The new item id of the document
return	void

Save() public method

Silently saves an open document

The call to SaveDocData may return Microsoft.VisualStudio.Shell.Interop.PFF_RESULTS.STG_S_DATALOSS to indicate some characters could not be represented in the current codepage

public Save ( bool saveIfDirty ) : void
saveIfDirty	bool	Save the open document only if it is dirty
return	void

UpdateCaption() public static method

Updates the caption for all windows associated to the document.

public static UpdateCaption ( System.IServiceProvider site, string caption, IntPtr docData ) : void
site	System.IServiceProvider	The service provider.
caption	string	The new caption.
docData	System.IntPtr	The IUnknown interface to a document data object associated with a registered document.
return	void