WBS PowerPointOperations, Dodeca 8.3
Methods
PowerPointOperations
Create and update PowerPoint files.
Overloads
| Overload Name | Description |
|---|---|
Closes PowerPoint. |
|
Closes a specified file or all files depending on whether a file is specified. |
|
Copy a worksheet range to a PowerPoint slide as an image. |
|
Opens a new PowerPoint file for subsequent PowerPoint operations. |
|
Opens an existing PowerPoint file for subsequent PowerPoint operations. |
|
Remove an image from a PowerPoint slide. |
|
Remove an slide from a PowerPoint presentation. |
|
Replace an image on a PowerPoint slide with a worksheet range. |
|
Saves one or all PowerPoint files depending on whether a file is specified. |
CloseFile
Closes a specified file or all files depending on whether a file is specified.
| Argument | Description |
|---|---|
FullFilePath |
The full path to the PowerPoint file. The default is the last file PowerPointOperations interacted with. |
Save |
Whether to save the file. Defaults to TRUE. |
CopyRange
Copy a worksheet range to a PowerPoint slide as an image.
| Argument | Description |
|---|---|
FullFilePath |
The full path to the PowerPoint file. The default is the last file PowerPointOperations interacted with. |
Range |
Specifies the range to copy. Defaults to the sheet's used range. |
ReplacePolicy |
Whether to replace an image that has the same name. If ReplacePolicy is not specified PerSlideName will be used. None - The image will be added to the specified slide, if any. Otherwise the image will be added to a new slide. OnAnySlide - Every image with the same name on any slide (if any) would be replaced. If an image with the same name does not exist then the image would be added. PerSlideName - If an image with the specified name exists on the specified slide it would be replaced, otherwise it would be added. |
SizePolicy |
The size of the new image. The default is NewImage. NewImage - The size of the replacing image will be based on the size of the copied range. ReplacedImage - The size of the replacing image will be based on the size of the replaced image. |
ImageName |
The name of the image. ImageName can be left blank. |
SlideName |
The name of the slide. |
SlideNumber |
The number of the slide. |
Left |
The horizontal position of the image on the slide. Left can be left blank. |
Top |
The vertical position of the image on the slide. Top can be left blank. |
Height |
The height of the image in pixels. If Height is specified it overrides other arguments that impact the height of the image. The height of the image is always limited by the height of the slide. |
Width |
The width of the image in pixels. If Width is specified it overrides other arguments that impact the width of the image. The width of the image is always limited by the width of the slide. |
ScalePercent |
Scale the image with a value between 10 and 400. The default is 100. |
Save |
Whether to save the file. Defaults to TRUE. |
ImageNamePropertyName |
The resolved name of the image. |
SlideNamePropertyName |
The resolved name of the slide. |
NewFile
Opens a new PowerPoint file for subsequent PowerPoint operations.
| Argument | Description |
|---|---|
Visible |
Whether PowerPoint is made visible. Defaults to FALSE. |
Filename |
Specify the name of the PowerPoint file. When UseDialog is TRUE, the file name is used as the default file name presented in the file dialog. When UseDialog is FALSE, the file name is used as the exported PowerPoint file name. |
Folder |
Specify the folder to save the PowerPoint file to. When UseDialog is TRUE, the folder is used as the default folder presented in the file dialog. When UseDialog is FALSE, the folder is used as the location of the exported PowerPoint file. |
IncrementFilename |
Whether to add a subscript, such as (1), to the filename if the specified file already exists. If IncrementFilename is blank an existing file with the same name will be overwritten. |
UseDialog |
Whether to show the file dialog to allow the user to select the folder and filename. |
DialogResultPropertyName |
The name of the script property to hold the FileDialog form result. Possible values are OK, Cancel, and Abort. |
FullFilePathPropertyName |
The full path of the file that is saved. |
OpenFile
Opens an existing PowerPoint file for subsequent PowerPoint operations.
| Argument | Description |
|---|---|
Visible |
Whether PowerPoint is made visible. Defaults to FALSE. |
BinaryArtifactID |
Specifies a BinaryArtifactID of a PowerPoint binary artifact. If a BinaryArtifactID is specified then file related arguments will be ignored. |
Filename |
Specify the name of the PowerPoint file. When UseDialog is TRUE, the file name is used as the default file name presented in the file dialog. When UseDialog is FALSE, the file name is used as the exported PowerPoint file name. |
Folder |
Specify the folder to save the PowerPoint file to. When UseDialog is TRUE, the folder is used as the default folder presented in the file dialog. When UseDialog is FALSE, the folder is used as the location of the exported PowerPoint file. |
UseDialog |
Whether to show the file dialog to allow the user to select the folder and filename. |
DialogResultPropertyName |
The name of the script property to hold the FileDialog form result. Possible values are OK, Cancel, and Abort. |
FullFilePathPropertyName |
The full path of the file that is saved. |
RemoveImage
Remove an image from a PowerPoint slide.
| Argument | Description |
|---|---|
FullFilePath |
The full path to the PowerPoint file. The default is the last file PowerPointOperations interacted with. |
ImageName |
The name of the image. ImageName can be left blank. |
SlideName |
The name of the slide. |
SlideNumber |
The number of the slide. |
Left |
The horizontal position of the image on the slide. Left can be left blank. |
Top |
The vertical position of the image on the slide. Top can be left blank. |
Save |
Whether to save the file. Defaults to TRUE. |
ImageNamePropertyName |
The resolved name of the image. |
SlideNamePropertyName |
The resolved name of the slide. |
RemoveSlide
Remove an slide from a PowerPoint presentation.
| Argument | Description |
|---|---|
FullFilePath |
The full path to the PowerPoint file. The default is the last file PowerPointOperations interacted with. |
SlideName |
The name of the slide. |
SlideNumber |
The number of the slide. |
Save |
Whether to save the file. Defaults to TRUE. |
SlideNamePropertyName |
The resolved name of the slide. |
ReplaceImage
Replace an image on a PowerPoint slide with a worksheet range.
| Argument | Description |
|---|---|
FullFilePath |
The full path to the PowerPoint file. The default is the last file PowerPointOperations interacted with. |
Range |
Specifies the range to copy. Defaults to the sheet's used range. |
ImageName |
The name of the image. ImageName can be left blank. |
SlideName |
The name of the slide. |
SlideNumber |
The number of the slide. |
Left |
The horizontal position of the image on the slide. Left can be left blank. |
Top |
The vertical position of the image on the slide. Top can be left blank. |
Height |
The height of the image in pixels. If Height is specified it overrides other arguments that impact the height of the image. The height of the image is always limited by the height of the slide. |
Width |
The width of the image in pixels. If Width is specified it overrides other arguments that impact the width of the image. The width of the image is always limited by the width of the slide. |
ScalePercent |
Scale the image with a value between 10 and 400. The default is 100. |
SizePolicy |
The size of the new image. The default is NewImage. NewImage - The size of the replacing image will be based on the size of the copied range. ReplacedImage - The size of the replacing image will be based on the size of the replaced image. |
Save |
Whether to save the file. Defaults to TRUE. |
ImageNamePropertyName |
The resolved name of the image. |
SlideNamePropertyName |
The resolved name of the slide. |
SaveFile
Saves one or all PowerPoint files depending on whether a file is specified.
| Argument | Description |
|---|---|
FullFilePath |
The full path to the PowerPoint file. The default is the last file PowerPointOperations interacted with. |
SaveAsFilePath |
Specify the name to save the PowerPoint file as. If a full path is not specified the file will be saved in the original folder. |
IncrementFilename |
Whether to add a subscript, such as (1), to the filename if the specified file already exists. If IncrementFilename is blank an existing file with the same name will be overwritten. |
UseDialog |
Whether to show the file dialog to allow the user to select the folder and filename. |
DialogResultPropertyName |
The name of the script property to hold the FileDialog form result. Possible values are OK, Cancel, and Abort. |
FullFilePathPropertyName |
The full path of the file that is saved. |