C# Class Microsoft.VisualStudio.Project.SingleFileGenerator

Provides support for single file generator.

Inheritance: ISingleFileGenerator, IVsGeneratorProgress

Mostra file Open project: tunnelvisionlabs/MPFProj10

Public Methods

Method	Description
GeneratorError ( int warning, uint level, string err, uint line, uint col ) : int
InvokeGenerator ( FileNode fileNode ) : void	Invokes the specified generator
Progress ( uint complete, uint total ) : int
RunGenerator ( string document ) : void	Runs the generator on the current project item.
SingleFileGenerator ( ProjectNode projectMgr ) : System	Overloadde ctor.

Protected Methods

Method	Description
CanEditFile ( string documentMoniker ) : bool	This function asks to the QueryEditQuerySave service if it is possible to edit the file.
ComputeNamespace ( string projectItemPath ) : string	Computes the names space based on the folder for the ProjectItem. It just replaces DirectorySeparatorCharacter with "." for the directory in which the file is located.
GetBufferContents ( string fileName, IVsTextStream &srpStream ) : string	Returns the buffer contents for a moniker.
UpdateGeneratedCodeFile ( FileNode fileNode, byte data, int size, string fileName ) : string	This is called after the single file generator has been invoked to create or update the code file.
VerifyFileDirtyInRdt ( string document, IVsHierarchy &pHier, IVsPersistDocData &ppDocData, uint &cookie ) : bool	Returns TRUE if open and dirty. Note that documents can be open without a window frame so be careful. Returns the DocData and doc cookie if requested

Method Details

CanEditFile() protected method

This function asks to the QueryEditQuerySave service if it is possible to edit the file.

protected CanEditFile ( string documentMoniker ) : bool
documentMoniker	string
return	bool

ComputeNamespace() protected method

Computes the names space based on the folder for the ProjectItem. It just replaces DirectorySeparatorCharacter with "." for the directory in which the file is located.

protected ComputeNamespace ( string projectItemPath ) : string
projectItemPath	string
return	string

GeneratorError() public method

public GeneratorError ( int warning, uint level, string err, uint line, uint col ) : int
warning	int
level	uint
err	string
line	uint
col	uint
return	int

GetBufferContents() protected method

Returns the buffer contents for a moniker.

protected GetBufferContents ( string fileName, IVsTextStream &srpStream ) : string
fileName	string
srpStream	IVsTextStream
return	string

InvokeGenerator() public method

Invokes the specified generator

public InvokeGenerator ( FileNode fileNode ) : void
fileNode	FileNode	The node on which to invoke the generator.
return	void

Progress() public method

public Progress ( uint complete, uint total ) : int
complete	uint
total	uint
return	int

RunGenerator() public method

Runs the generator on the current project item.

public RunGenerator ( string document ) : void
document	string
return	void

SingleFileGenerator() public method

Overloadde ctor.

public SingleFileGenerator ( ProjectNode projectMgr ) : System
projectMgr	ProjectNode	The associated project
return	System

UpdateGeneratedCodeFile() protected method

This is called after the single file generator has been invoked to create or update the code file.

protected UpdateGeneratedCodeFile ( FileNode fileNode, byte data, int size, string fileName ) : string
fileNode	FileNode	The node associated to the generator
data	byte	data to update the file with
size	int	size of the data
fileName	string	Name of the file to update or create
return	string

VerifyFileDirtyInRdt() protected method

Returns TRUE if open and dirty. Note that documents can be open without a window frame so be careful. Returns the DocData and doc cookie if requested

protected VerifyFileDirtyInRdt ( string document, IVsHierarchy &pHier, IVsPersistDocData &ppDocData, uint &cookie ) : bool
document	string	document path
pHier	IVsHierarchy	hierarchy
ppDocData	IVsPersistDocData	doc data associated with document
cookie	uint	item cookie
return	bool