WorkspaceItemCollection Class Reference

Collection of workspace items. More...

Inherits List< WorkspaceItemObject >.

Public Member Functions
	WorkspaceItemCollection ()
	Default constructor. More...
WorkspaceItemObject	AddFile ()
	Adds file. More...
WorkspaceItemObject	AddFile (string fileName)
	Creates WorkspaceItemObject and adds it to the WorkspaceItemCollection in WorkspaceControl More...
WorkspaceItemObject	GetByFilePath (string filePath)
	Gets by file path. More...
WorkspaceItemObject	GetById (Guid id)
	Gets by identifier. More...
bool	New ()
	News this object. More...
bool	Open ()
	Opens this object. More...
bool	Save ()
	Saves this object. More...
bool	SaveAs ()
	Saves as. More...
void	SaveData (WorkspaceDataSet dataSet)
	Saves a data. More...

Properties
string	FilePath [get, set]
	Gets or sets the full pathname of the file. More...
WorkspaceGroupCollection	Groups [get, set]
	Gets or sets the groups. More...

Detailed Description

Collection of workspace items.

Constructor & Destructor Documentation

WorkspaceItemCollection()

WorkspaceItemCollection ( )

inline

Default constructor.

Member Function Documentation

AddFile() [1/2]

WorkspaceItemObject AddFile ( )

inline

Adds file.

Returns

A WorkspaceItemObject i doesn't exists in collection otherwise returns null.

AddFile() [2/2]

WorkspaceItemObject AddFile ( string  fileName )

inline

Creates WorkspaceItemObject and adds it to the WorkspaceItemCollection in WorkspaceControl

Parameters

fileName

Path of the file

Returns

WorkspaceItemObject created from file if file exists in collection return null

GetByFilePath()

WorkspaceItemObject GetByFilePath ( string  filePath )

inline

Gets by file path.

Parameters

filePath

The full pathname of the file.

Returns

The by file path.

GetById()

WorkspaceItemObject GetById ( Guid  id )

inline

Gets by identifier.

Parameters

id	The identifier.

Returns

The by identifier.

New()

bool New ( )

inline

News this object.

Returns

true if it succeeds, false if it fails.

Open()

bool Open ( )

inline

Opens this object.

Save()

bool Save ( )

inline

Saves this object.

Returns

true if it succeeds, false if it fails.

SaveAs()

bool SaveAs ( )

inline

Saves as.

Returns

true if it succeeds, false if it fails.

SaveData()

void SaveData ( WorkspaceDataSet  dataSet )

inline

Saves a data.

Parameters

dataSet

Set the data belongs to.

Property Documentation

FilePath

string FilePath

getset

Gets or sets the full pathname of the file.

The full pathname of the file.

Groups

WorkspaceGroupCollection Groups

getset

Gets or sets the groups.

The groups.

---

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

• AnnotationPro.Logic/WorkspaceItemCollection.cs