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

A workspace control. More...

Inherits UserControl.

Public Member Functions

void Accept ()
 Change accept flag on list More...
 
void AddFile (string fileName)
 Adds file to workspace from file name More...
 
void AddFiles ()
 Adds files. More...
 
void AddGroup ()
 Add new group More...
 
void AddToGroup ()
 Add selected items to group More...
 
void DeleteGroup ()
 Delete group More...
 
void EditGroup ()
 Edit group of selected item More...
 
void EndSession ()
 Ends session More...
 
void ExportFrequencyList ()
 Exports frequency list More...
 
void ExportFrequencyListGroupByFiles ()
 Exports frequency list group by files More...
 
void ExportToOneBigCSV ()
 Exports data to one big CSV More...
 
void ExportToSeparateCSV ()
 Exports to separate CSV files More...
 
bool New ()
 Creates new workspace and try saves current if modified More...
 
bool Open (string fileName)
 Opens an annotation from file More...
 
void Open ()
 Opens annotation. More...
 
void OpenSelectedAnnotation ()
 Opens annotation selected on list More...
 
void PromptUserInfo ()
 Prompts for user info in session More...
 
void RemoveFiles ()
 Removes the files. More...
 
void RemoveFromGroup ()
 Removes from group More...
 
void ResetSession ()
 Reset session More...
 
void ResetStatistics ()
 Resets the statistics. More...
 
void Save ()
 Saves this object. More...
 
void SaveAs ()
 Saves as. More...
 
void SelectItem (WorkspaceItemObject workspaceItem)
 Selects item on list More...
 
void SessionManagement ()
 Open session management form More...
 
void StartSession ()
 Starts session More...
 
void UpdateItem (WorkspaceItemObject workspaceItem)
 Updates the item described by workspaceItem. More...
 

Protected Member Functions

override void Dispose (bool disposing)
 Clean up any resources being used. More...
 

Properties

AnnotationEditor AnnotationEditor [get, set]
 Gets or sets the annotation editor. More...
 
bool IsModified [get, set]
 Gets a value indicating whether this object is modified. More...
 
WorkspaceItemObject SelectedWorkspaceItem [get]
 Gets the selected workspace item. More...
 
string WorkspaceFilePath [get]
 Gets the full pathname of the workspace file. More...
 
WorkspaceItemCollection WorkspaceItems [get, set]
 Workspace items collection More...
 

Detailed Description

A workspace control.

Member Function Documentation

◆ Accept()

void Accept ( )
inline

Change accept flag on list

◆ AddFile()

void AddFile ( string  fileName)
inline

Adds file to workspace from file name

Parameters
fileNameName of file

◆ AddFiles()

void AddFiles ( )
inline

Adds files.

◆ AddGroup()

void AddGroup ( )
inline

Add new group

◆ AddToGroup()

void AddToGroup ( )
inline

Add selected items to group

◆ DeleteGroup()

void DeleteGroup ( )
inline

Delete group

◆ Dispose()

override void Dispose ( bool  disposing)
inlineprotected

Clean up any resources being used.

Parameters
disposingtrue if managed resources should be disposed; otherwise, false.

◆ EditGroup()

void EditGroup ( )
inline

Edit group of selected item

◆ EndSession()

void EndSession ( )
inline

Ends session

◆ ExportFrequencyList()

void ExportFrequencyList ( )
inline

Exports frequency list

◆ ExportFrequencyListGroupByFiles()

void ExportFrequencyListGroupByFiles ( )
inline

Exports frequency list group by files

◆ ExportToOneBigCSV()

void ExportToOneBigCSV ( )
inline

Exports data to one big CSV

◆ ExportToSeparateCSV()

void ExportToSeparateCSV ( )
inline

Exports to separate CSV files

◆ New()

bool New ( )
inline

Creates new workspace and try saves current if modified

Returns
True if success

◆ Open() [1/2]

bool Open ( string  fileName)
inline

Opens an annotation from file

Parameters
fileNameFile with annotation
Returns
True if successfuly open

◆ Open() [2/2]

void Open ( )
inline

Opens annotation.

◆ OpenSelectedAnnotation()

void OpenSelectedAnnotation ( )
inline

Opens annotation selected on list

◆ PromptUserInfo()

void PromptUserInfo ( )
inline

Prompts for user info in session

◆ RemoveFiles()

void RemoveFiles ( )
inline

Removes the files.

◆ RemoveFromGroup()

void RemoveFromGroup ( )
inline

Removes from group

◆ ResetSession()

void ResetSession ( )
inline

Reset session

◆ ResetStatistics()

void ResetStatistics ( )
inline

Resets the statistics.

◆ Save()

void Save ( )
inline

Saves this object.

◆ SaveAs()

void SaveAs ( )
inline

Saves as.

◆ SelectItem()

void SelectItem ( WorkspaceItemObject  workspaceItem)
inline

Selects item on list

Parameters
workspaceItemItem to select

◆ SessionManagement()

void SessionManagement ( )
inline

Open session management form

◆ StartSession()

void StartSession ( )
inline

Starts session

◆ UpdateItem()

void UpdateItem ( WorkspaceItemObject  workspaceItem)
inline

Updates the item described by workspaceItem.

Parameters
workspaceItemThe workspace item.

Property Documentation

◆ AnnotationEditor

Gets or sets the annotation editor.

The annotation editor.

◆ IsModified

bool IsModified
getset

Gets a value indicating whether this object is modified.

true if this object is modified, false if not.

◆ SelectedWorkspaceItem

WorkspaceItemObject SelectedWorkspaceItem
get

Gets the selected workspace item.

The selected workspace item.

◆ WorkspaceFilePath

string WorkspaceFilePath
get

Gets the full pathname of the workspace file.

The full pathname of the workspace file.

◆ WorkspaceItems

WorkspaceItemCollection WorkspaceItems
getset

Workspace items collection


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