Interface IWorkbookServiceClient
Workbook service client.
Namespace: MAT.Atlas.Automation.Client.Services.Interface
Assembly: MAT.Atlas.Automation.Client.dll
Syntax
public interface IWorkbookServiceClient
Methods
AssociateSetToWorkbook(ObjectId)
Associate a set to the workbook.
Declaration
void AssociateSetToWorkbook(ObjectId setId)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | setId | Unique identifier of a set. |
Remarks
Only works if set association is not currently locked for page/display.
CreateDisplay(String, String)
Add a display to the active page of the workbook.
Declaration
Display CreateDisplay(string type, string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | type | Type of display. |
System.String | name | Title of display. |
Returns
Type | Description |
---|---|
Display | Added display properties. |
Remarks
The types of display that can be created is dependent on the installed plugins.
However some common display type are:
CreatePage(String)
Add a page to the workbook.
Declaration
Page CreatePage(string title)
Parameters
Type | Name | Description |
---|---|---|
System.String | title | Title of page. |
Returns
Type | Description |
---|---|
Page | Added page properties. |
CreateSet(String)
Add a set to the workbook.
Declaration
Set CreateSet(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Title of set. |
Returns
Type | Description |
---|---|
Set | Added set properties. |
GetActiveDisplay()
Get the properties of the active display.
Declaration
Display GetActiveDisplay()
Returns
Type | Description |
---|---|
Display | Display properties. |
GetActivePage()
Get the properties of the active page.
Declaration
Page GetActivePage()
Returns
Type | Description |
---|---|
Page | Page properties. |
GetDisplays()
Get the properties of all displays.
Declaration
Display[] GetDisplays()
Returns
Type | Description |
---|---|
Display[] | Collection of display properties. |
GetPages()
Get the properties of all pages.
Declaration
Page[] GetPages()
Returns
Type | Description |
---|---|
Page[] | Collection of page properties. |
GetRecorders()
Get the properties of all recorders.
Declaration
Recorder[] GetRecorders()
Returns
Type | Description |
---|---|
Recorder[] | Collection of recorder properties. |
GetSets()
Get the properties of all sets.
Declaration
Set[] GetSets()
Returns
Type | Description |
---|---|
Set[] | Collection of set properties. |
GetWorkbook()
Get the properties of the workbook.
Declaration
Workbook GetWorkbook()
Returns
Type | Description |
---|---|
Workbook | Workbook properties. |
LoadWorkbook(String)
Loads the workbook (prompts the user to save previous if needed).
Declaration
void LoadWorkbook(string filePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | filePath | The file path. |
NewWorkbook(Boolean)
Creates a new workbook.
Declaration
void NewWorkbook(bool skipPromptToSave)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | skipPromptToSave | Discards current workbook losing edits if prompt is skipped. |
ReplaceWorkbook(String)
Replaces the workbook (discards current workbook losing edits if unsaved).
Declaration
void ReplaceWorkbook(string filePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | filePath | The file path. |
SaveWorkbook(String)
Saves the workbook.
Declaration
void SaveWorkbook(string filePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | filePath | The file path. |