Interface IProjectTemplate

Namespace

Loehnert.Lisrt.Scripting.Project.Interfaces

Assembly

Loehnert.Lisrt.Scripting.dll

Interface for a IProject template.

public interface IProjectTemplate

Properties

Description

Gets a translated description.

string Description { get; }

Property Value

string

FileExtension

Gets the file extension without dot.

string FileExtension { get; }

Property Value

string

Methods

CanLoadProjectFromPath(string)

Checks if a new project can be loaded from the path.

bool CanLoadProjectFromPath(string filePath)

Parameters

filePath string

Path to the project file.

Returns

bool

A value indicating whether a new project can be loaded from the path.

CreateNewProject(string, string)

Creates and saves a new IProject.

IProject CreateNewProject(string directory, string name)

Parameters

directory string

Directory where the project should be saved.

name string

Name of the new project without extension.

Returns

IProject

A new IProject.

LoadProject(string)

Loads the project from a file.

IProject LoadProject(string filePath)

Parameters

filePath string

Path to the project file.

Returns

IProject

IProject loaded from project file.

ValidateNewFileName(string, string)

Gets the validation results of the new name of the item.

IEnumerable<ValidationResult> ValidateNewFileName(string newName, string newPath)

Parameters

newName string

The name of the file, without extension.

newPath string

The path to the file, without the file name.

Returns

IEnumerable<ValidationResult>

An enumeration of validation results.