Module - Slide
Collection of activities related MS PowerPoint slides such as Add Slide, Delete Slide, Duplicate Slide...
Activities
Add a slide to the current presentation. You also specify the index and layout of the new slide.
| Technical Name |
Type |
Minimal Agent Version |
| addSlide |
synchronous
|
WIN-2.0.0
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| slideIndex |
number |
mandatory
|
|
Slide index (starting at 1). |
| layout |
irpa_powerpoint.enums.layout |
optional
|
ppLayoutBlank |
Use 'sdk.powerpoint.enums.layout' to choose a layout. |
Sample Code:
irpa_powerpoint.slide.addSlide(index, layout);
Errors:
| Error Class |
Package |
Description |
| SequenceError |
irpa_core |
The PowerPoint Application cannot be null |
Delete a slide from the current presentation. Use the slide index to specify which slide you want to delete.
| Technical Name |
Type |
Minimal Agent Version |
| deleteSlide |
synchronous
|
WIN-2.0.0
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| slideIndex |
number |
mandatory
|
|
Slide index (starting at 1). |
Sample Code:
irpa_powerpoint.slide.deleteSlide(index);
Errors:
| Error Class |
Package |
Description |
| SequenceError |
irpa_core |
The PowerPoint Application cannot be null |
Duplicate a slide in the current presentation. Use the slide index to specify which slide you want to duplicate.
| Technical Name |
Type |
Minimal Agent Version |
| duplicateSlide |
synchronous
|
WIN-2.0.0
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| slideIndex |
number |
mandatory
|
|
Slide index (starting at 1). |
Sample Code:
irpa_powerpoint.slide.duplicateSlide(index);
Errors:
| Error Class |
Package |
Description |
| SequenceError |
irpa_core |
The PowerPoint Application cannot be null |
Select a slide in the current presentation. Use the slide index to specify which slide you want to select.
| Technical Name |
Type |
Minimal Agent Version |
| selectSlide |
synchronous
|
WIN-2.0.0
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| slideIndex |
number |
mandatory
|
|
Slide index (starting at 1). |
Sample Code:
irpa_powerpoint.slide.selectSlide(index);
Errors:
| Error Class |
Package |
Description |
| SequenceError |
irpa_core |
The PowerPoint Application cannot be null |
Retrieve the layout of a slide in the current presentation. Use the slide index to specify which slide layout you want to retrieve.
| Technical Name |
Type |
Minimal Agent Version |
| getLayout |
synchronous
|
WIN-2.0.0
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| slideIndex |
number |
mandatory
|
|
Slide index (starting at 1). |
Output Parameters:
| Name |
Type |
Description |
| layout |
number |
Layout of the slide in the current presentation. |
Sample Code:
irpa_powerpoint.slide.getLayout(index);
Errors:
| Error Class |
Package |
Description |
| SequenceError |
irpa_core |
The PowerPoint Application cannot be null |
Set the layout of a slide in the current presentation. Use the slide index to specify which slide layout you want to set.
| Technical Name |
Type |
Minimal Agent Version |
| setLayout |
synchronous
|
WIN-2.0.0
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| slideIndex |
number |
mandatory
|
|
Slide index (starting at 1). |
| layout |
irpa_powerpoint.enums.layout |
optional
|
ppLayoutBlank |
Use 'sdk.powerpoint.enums.layout' to choose a layout. |
Sample Code:
irpa_powerpoint.slide.setLayout(index, layout);
Errors:
| Error Class |
Package |
Description |
| SequenceError |
irpa_core |
The PowerPoint Application cannot be null |
Set the text of a slide in the current presentation. Use the slide index to specify in which slide you want to set text.
| Technical Name |
Type |
Minimal Agent Version |
| setText |
synchronous
|
WIN-2.0.0
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| text |
string |
mandatory
|
|
Text to set. |
| slideIndex |
number |
mandatory
|
|
Slide index (starting at 1). |
| shapeIndex |
number |
mandatory
|
|
Shape index (starting at 1). |
Sample Code:
irpa_powerpoint.slide.setText(text, slideIndex, shapeIndex);
Errors:
| Error Class |
Package |
Description |
| SequenceError |
irpa_core |
The PowerPoint Application cannot be null |
Append text to a slide in the current presentation. Use the slide index to specify in which slide you want to append text.
| Technical Name |
Type |
Minimal Agent Version |
| appendText |
synchronous
|
WIN-2.0.0
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| text |
string |
mandatory
|
|
Text to append. |
| slideIndex |
number |
mandatory
|
|
Slide index (starting at 1). |
| shapeIndex |
number |
mandatory
|
|
Shape index (starting at 1). |
Sample Code:
irpa_powerpoint.slide.appendText(text, slideIndex, shapeIndex);
Errors:
| Error Class |
Package |
Description |
| SequenceError |
irpa_core |
The PowerPoint Application cannot be null |
Set text size to a slide in the current presentation. Use the slide index to specify in which slide you want to set text size. Use the shape index to specify in which shape you want to set text size.
| Technical Name |
Type |
Minimal Agent Version |
| formatting.setTextSize |
synchronous
|
WIN-2.0.0
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| size |
number |
mandatory
|
|
Size to set. |
| slideIndex |
number |
mandatory
|
|
Slide index (starting at 1). |
| shapeIndex |
number |
mandatory
|
|
Shape index (starting at 1). |
Sample Code:
irpa_powerpoint.slide.formatting.setTextSize(size, slideIndex, shapeIndex);
Errors:
| Error Class |
Package |
Description |
| SequenceError |
irpa_core |
The PowerPoint Application cannot be null |
Set alignment to a slide in the current presentation. Use the slide index to specify in which slide you want to set alignment. Use the shape index to specify in which shape you want to set alignment.
| Technical Name |
Type |
Minimal Agent Version |
| formatting.setAlignement |
synchronous
|
WIN-2.0.0
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| alignement |
irpa_powerpoint.enums.alignement |
mandatory
|
|
Use 'sdk.powerpoint.enums.alignment' to choose an alignment. |
| slideIndex |
number |
mandatory
|
|
Slide index (starting at 1). |
| shapeIndex |
number |
mandatory
|
|
Shape index (starting at 1). |
Sample Code:
irpa_powerpoint.slide.formatting.setAlignement(alignement, slideIndex, shapeIndex);
Errors:
| Error Class |
Package |
Description |
| SequenceError |
irpa_core |
The PowerPoint Application cannot be null |