Table of Contents

Class LisrtScriptProject

Namespace
Loehnert.Lisrt.Scripting.Project
Assembly
Loehnert.Lisrt.Scripting.dll

Class for a script project.

public class LisrtScriptProject : PropertyChangedBase, INotifyPropertyChangedEx, IProject, ICompositeProjectItem, IProjectItem, INotifyPropertyChanged, ICanAddProjectItem, IIsPartOfFileSystem, IHasAdditionalInformations, IByteSerializable, IHasChecksum, IDisposable, ICanBeRenamed
Inheritance
PropertyChangedBase
LisrtScriptProject
Implements
INotifyPropertyChangedEx
Inherited Members
PropertyChangedBase.Refresh()
PropertyChangedBase.IsNotifying
PropertyChangedBase.PropertyChanged
Extension Methods

Constructors

LisrtScriptProject(string)

Initializes a new instance of the LisrtScriptProject class.

public LisrtScriptProject(string name)

Parameters

name string

Name for the project.

Exceptions

ArgumentNullException

Thrown when name is null, empty or whitespace.

Properties

BreakPoints

Gets the BreakPoints for each IProjectItem.

public IDictionary<IProjectItem, BreakPointCollection> BreakPoints { get; }

Property Value

IDictionary<IProjectItem, BreakPointCollection>

Directory

Gets or sets the absolute path to the project.

public string Directory { get; set; }

Property Value

string

Icon

Gets the icon.

public Uri Icon { get; }

Property Value

Uri

Items

Gets the project items.

public IProjectItemCollection Items { get; }

Property Value

IProjectItemCollection

Name

Gets the name of the project with extension.

public string Name { get; }

Property Value

string

Parent

Gets or sets the parent project item.

public ICompositeProjectItem Parent { get; set; }

Property Value

ICompositeProjectItem

Remarks

Usually null, because a LisrtScriptProject is root.

Path

Gets the full path to the project file on the file system.

public string Path { get; }

Property Value

string

References

Gets the references.

public IReferenceCollection References { get; }

Property Value

IReferenceCollection

StartUpProjectItem

Gets or sets the start up project.

public IProjectItem StartUpProjectItem { get; set; }

Property Value

IProjectItem

Versions

Gets the ScriptVersions of the project.

public ObservableCollection<ScriptVersion> Versions { get; }

Property Value

ObservableCollection<ScriptVersion>

Methods

Add(IProjectItem)

Adds an item to the Items.

public void Add(IProjectItem projectItem)

Parameters

projectItem IProjectItem

The new project item.

Exceptions

ArgumentNullException

Thrown when projectItem is null.

AddItemInformationsToNode(XElement)

Adds the additional XML attributes for saving the item.

public void AddItemInformationsToNode(XElement node)

Parameters

node XElement

Node for adding sub nodes.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Remarks

Disposes the internal FileSystemWatcher.

FromBytes(byte[])

Populates an object from a byte[].

public void FromBytes(byte[] data)

Parameters

data byte[]

byte[] representation of the object.

Exceptions

NotImplementedException

Always thrown.

GetChecksum()

Gets the checksum for the object.

public string GetChecksum()

Returns

string

Checksum as number.

IsReleased()

Gets a value indicating whether the project is released.

public bool IsReleased()

Returns

bool

True, if the project is released.

LoadItemInformationsFromNode(XElement)

Loads the additional XML attributes from the node.

public void LoadItemInformationsFromNode(XElement node)

Parameters

node XElement

Node for this item, containing some specific information.

Rename(string)

Renames the object.

public void Rename(string name)

Parameters

name string

The new name.

ToBytes()

Retrieves a byte[] representation of the project.

public byte[] ToBytes()

Returns

byte[]

Bytes representing the instance.

Events

Changed

Occurs when a file in the project has changed, added, removed or renamed.

public event EventHandler<FileSystemEventArgs> Changed

Event Type

EventHandler<FileSystemEventArgs>