Annotation Pro API
Public Member Functions | Properties | List of all members
SessionEventCollection Class Reference

Collection of session events. More...

Inherits List< SessionEventObject >.

Public Member Functions

SessionEventObject GetById (Guid id)
 Gets by identifier. More...
 
SessionEventObject GetByName (string name)
 Gets by name. More...
 
void Open (string fileName)
 Opens the given file. More...
 
void Open ()
 Opens the given file. More...
 
bool Save ()
 Saves this object. More...
 
bool Save (string fileName)
 Saves this object. More...
 
void SaveData (SessionDataSet dataSet)
 Saves a data. More...
 

Properties

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

Detailed Description

Collection of session events.

Member Function Documentation

◆ GetById()

SessionEventObject GetById ( Guid  id)
inline

Gets by identifier.

Parameters
idThe identifier.
Returns
The by identifier.

◆ GetByName()

SessionEventObject GetByName ( string  name)
inline

Gets by name.

Parameters
nameThe name.
Returns
The by name.

◆ Open() [1/2]

void Open ( string  fileName)
inline

Opens the given file.

Parameters
fileNameFilename of the file.

◆ Open() [2/2]

void Open ( )
inline

Opens the given file.

◆ Save() [1/2]

bool Save ( )
inline

Saves this object.

Returns
true if it succeeds, false if it fails.

◆ Save() [2/2]

bool Save ( string  fileName)
inline

Saves this object.

Parameters
fileNameFilename of the file.
Returns
true if it succeeds, false if it fails.

◆ SaveData()

void SaveData ( SessionDataSet  dataSet)
inline

Saves a data.

Parameters
dataSetSet 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.


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