Interface IPageService
Page service.
Namespace: MAT.Atlas.Automation.Api
Assembly: MAT.Atlas.Automation.Api.dll
Syntax
[AutomationService("Page")]
public interface IPageService : IAutomationService
Methods
ActivatePage(ObjectId)
Make page active (switch tab).
Declaration
void ActivatePage(ObjectId pageId)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | pageId | Unique identifier of a page. |
AssociateSetToPage(ObjectId, ObjectId)
Associate a set to a page.
Declaration
void AssociateSetToPage(ObjectId pageId, ObjectId setId)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | pageId | Unique identifier of a page. |
ObjectId | setId | Unique identifier of a set. |
Remarks
Only works if set association is not currently locked for page/display.
DuplicatePage(ObjectId)
Duplicate a page.
Declaration
Page DuplicatePage(ObjectId pageId)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | pageId | Unique identifier of a page. |
Returns
Type | Description |
---|---|
Page | Page properties of duplicate. |
GetDisplaysOfPage(ObjectId)
Get the properties of all displays associated with a page.
Declaration
Display[] GetDisplaysOfPage(ObjectId pageId)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | pageId | Unique identifier of a page. |
Returns
Type | Description |
---|---|
Display[] | Collection of display properties. |
GetPage(ObjectId)
Get the properties of a page.
Declaration
Page GetPage(ObjectId pageId)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | pageId | Unique identifier of a page. |
Returns
Type | Description |
---|---|
Page | Page properties. |
RemovePage(ObjectId)
Remove a page.
Declaration
void RemovePage(ObjectId pageId)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | pageId | Unique identifier of a page. |
RenamePage(ObjectId, String)
Change the title of a page.
Declaration
void RenamePage(ObjectId pageId, string title)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | pageId | Unique identifier of a page. |
System.String | title | New title for the page. |
SetPageLockedToCurrentAssociation(ObjectId, Boolean)
Lock/Unlock the associated set of a page.
Declaration
void SetPageLockedToCurrentAssociation(ObjectId pageId, bool isLockedToCurrentAssociation)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | pageId | Unique identifier of a page. |
System.Boolean | isLockedToCurrentAssociation | Whether to lock or unlock set association. |
SetPageTabColor(ObjectId, Color)
Change the tab color of a page.
Declaration
void SetPageTabColor(ObjectId pageId, Color color)
Parameters
Type | Name | Description |
---|---|---|
ObjectId | pageId | Unique identifier of a page. |
Color | color | New tab color for the page. |