Module - Presentation
Collection of activities related MS PowerPoint presentation such as open, save, save as...
Activities
Create a new PowerPoint presentation.
| Technical Name |
Type |
Minimal Agent Version |
| createNewPresentation |
synchronous
|
WIN-2.0.0
|
Sample Code:
irpa_powerpoint.presentation.createNewPresentation();
Errors:
| Error Class |
Package |
Description |
| SequenceError |
irpa_core |
The PowerPoint Application cannot be null |
Apply a PowerPoint template.
| Technical Name |
Type |
Minimal Agent Version |
| applyTemplate |
synchronous
|
WIN-2.0.0
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| path |
string |
mandatory
|
|
Path of the template. |
Sample Code:
irpa_powerpoint.presentation.applyTemplate();
Errors:
| Error Class |
Package |
Description |
| SequenceError |
irpa_core |
The PowerPoint Application cannot be null |
| Open Existing Presentation |
Open a specified PowerPoint presentation.
| Technical Name |
Type |
Minimal Agent Version |
| openExistingPresentation |
synchronous
|
WIN-2.0.0
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| path |
string |
mandatory
|
|
The presentation path. |
Sample Code:
irpa_powerpoint.presentation.openExistingPresentation(path);
Errors:
| Error Class |
Package |
Description |
| SequenceError |
irpa_core |
The PowerPoint Application cannot be null |
| NotFound |
irpa_core |
Presentation not found |
Save a PowerPoint presentation with a specified file name, or save a previously saved PowerPoint presentation under a different name.
| Technical Name |
Type |
Minimal Agent Version |
| saveAs |
synchronous
|
WIN-2.0.0
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| filePath |
string |
mandatory
|
|
Path of the file to save as. |
| fileFormat |
irpa_powerpoint.enums.format |
optional
|
ppSaveAsDefault |
Use 'sdk.powerpoint.enums.format' to choose a format. |
Sample Code:
irpa_powerpoint.presentation.saveAs(filePath, fileFormat);
Errors:
| Error Class |
Package |
Description |
| SequenceError |
irpa_core |
The PowerPoint Application cannot be null |
Save an active PowerPoint presentation with the latest changes.
| Technical Name |
Type |
Minimal Agent Version |
| save |
synchronous
|
WIN-2.0.0
|
Sample Code:
irpa_powerpoint.presentation.save();
Errors:
| Error Class |
Package |
Description |
| SequenceError |
irpa_core |
The PowerPoint Application cannot be null |
Closes a specified PowerPoint presentation after saving all the latest changes.
| Technical Name |
Type |
Minimal Agent Version |
| close |
synchronous
|
WIN-2.0.0
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| hasToBeSaved |
boolean |
mandatory
|
|
True if the PowerPoint document has to be saved, false otherwise. |
Sample Code:
irpa_powerpoint.presentation.close(hasToBeSaved);
Errors:
| Error Class |
Package |
Description |
| SequenceError |
irpa_core |
The PowerPoint Application cannot be null |