SiliconStudio.ProjectTemplating.ProjectTemplate Class Reference

Defines a project template that allows automated creation of a project structure with files. More...

Public Member Functions
	ProjectTemplate ()
	Initializes a new instance of the ProjectTemplate class. More...
LoggerResult	Generate (string outputDirectory, string projectName, Guid projectGuid, Dictionary< string, object > options=null)
	Generates this project template to the specified output directory. More...
void	Generate (string outputDirectory, string projectName, Guid projectGuid, ILogger log, Dictionary< string, object > options=null, List< string > generatedOutputFiles=null)
	Generates this project template to the specified output directory. More...
string	GeneratePart (string templatePathPart, ILogger log, Dictionary< string, object > options)

Static Public Member Functions
static ProjectTemplate	Load (string filePath)
	Loads the a ProjectTemplate from the specified file path. More...

Properties
string	FilePath [get, set]
	Gets or sets the template file path. More...
bool	IsDynamicTemplate [get, set]
	Gets a value indicating whether this template description is dynamic (itself requiring T4 parsing before generating content files) More...
List< ProjectTemplateItem >	Files [get, set]
	Gets or sets the files part of the template. More...
List< UFile >	Assemblies [get, set]
	Gets or sets the assemblies. More...

Detailed Description

Defines a project template that allows automated creation of a project structure with files.

Definition at line 22 of file ProjectTemplate.cs.

Constructor & Destructor Documentation

SiliconStudio.ProjectTemplating.ProjectTemplate.ProjectTemplate

(

)

Initializes a new instance of the ProjectTemplate class.

Definition at line 27 of file ProjectTemplate.cs.

Member Function Documentation

LoggerResult SiliconStudio.ProjectTemplating.ProjectTemplate.Generate	(	string	outputDirectory,
		string	projectName,
		Guid	projectGuid,
		Dictionary< string, object >	options = null
	)

Generates this project template to the specified output directory.

Parameters

outputDirectory	The output directory.
projectName	Name of the project.
projectGuid	The project unique identifier.
options	The options arguments that will be made available through the Session property in each template.

Returns

LoggerResult.

Exceptions

System.ArgumentNullException	outputDirectory or projectName
System.InvalidOperationException	FilePath cannot be null on this instance

Definition at line 70 of file ProjectTemplate.cs.

void SiliconStudio.ProjectTemplating.ProjectTemplate.Generate	(	string	outputDirectory,
		string	projectName,
		Guid	projectGuid,
		ILogger	log,
		Dictionary< string, object >	options = null,
		List< string >	generatedOutputFiles = null
	)

Generates this project template to the specified output directory.

Parameters

outputDirectory	The output directory.
projectName	Name of the project.
projectGuid	The project unique identifier.
log	The log to output errors to.
options	The options arguments that will be made available through the Session property in each template.
generatedOutputFiles	The generated files.

Exceptions

System.ArgumentNullException	outputDirectory or projectName
System.InvalidOperationException	FilePath cannot be null on this instance

Definition at line 94 of file ProjectTemplate.cs.

References SiliconStudio.Core.Yaml.YamlSerializer.Deserialize().

string SiliconStudio.ProjectTemplating.ProjectTemplate.GeneratePart	(	string	templatePathPart,
		ILogger	log,
		Dictionary< string, object >	options
	)

Definition at line 219 of file ProjectTemplate.cs.

static ProjectTemplate SiliconStudio.ProjectTemplating.ProjectTemplate.Load ( string  filePath )

static

Loads the a ProjectTemplate from the specified file path.

Parameters

filePath

The project template file.

Returns

An instance of the project template.

Exceptions

System.ArgumentNullException

filePath

Definition at line 271 of file ProjectTemplate.cs.

References SiliconStudio.Core.Yaml.YamlSerializer.Deserialize().

Property Documentation

List<UFile> SiliconStudio.ProjectTemplating.ProjectTemplate.Assemblies

getset

Gets or sets the assemblies.

The assemblies.

Definition at line 56 of file ProjectTemplate.cs.

string SiliconStudio.ProjectTemplating.ProjectTemplate.FilePath

getset

Gets or sets the template file path.

The template path.

Definition at line 37 of file ProjectTemplate.cs.

List<ProjectTemplateItem> SiliconStudio.ProjectTemplating.ProjectTemplate.Files

getset

Gets or sets the files part of the template.

The files.

Definition at line 50 of file ProjectTemplate.cs.

bool SiliconStudio.ProjectTemplating.ProjectTemplate.IsDynamicTemplate

getset

Gets a value indicating whether this template description is dynamic (itself requiring T4 parsing before generating content files)

true if this instance is a dynamic template; otherwise, false.

Definition at line 44 of file ProjectTemplate.cs.

---

The documentation for this class was generated from the following file:

• D:/Projects/Bitbucket Hosting/DoxygenFilesAndSources/Paradox v1.0.0 beta06/sources/tools/SiliconStudio.ProjectTemplating/ProjectTemplate.cs