Working with Text Portions

Introduction

Aspose.Slides Cloud API allows you to read, add, modify and delete text portions on special slides (Master, Layout, Notes) in a PowerPoint presentation. To do this, you can use the following set of methods, identical to those that work with regular slides.

API Information

API Type Description Resource
/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/portions GET Reads information about text portions in a paragraph in a shape on a special slide. GetSpecialSlidePortions
/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/portions/{portionIndex} GET Reads information about a text portion in a paragraph in a shape on a special slide. GetSpecialSlidePortion
/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/portions POST Adds a new text portion to a paragraph in a shape on a special slide. CreateSpecialSlidePortion
/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/portions/{portionIndex} PUT Updates a text portion in a paragraph in a shape on a special slide. UpdateSpecialSlidePortion
/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/portions DELETE Deletes text portions from a paragraph in a shape on a special slide. DeleteSpecialSlidePortions
/slides/{name}/slides/{slideIndex}/{slideType}/shapes/{shapeIndex}/paragraphs/{paragraphIndex}/portions/{portionIndex} DELETE Deletes a text portion from a paragraph in a shape on a special slide. DeleteSpecialSlidePortion
GetSpecialSlidePortions Request Parameters
Name Type Location Required Description
name string path true The name of a presentation file saved in a storage.
slideIndex integer path true The 1-based index of a regular slide.
slideType MasterSlide or LayoutSlide or NotesSlide path true The type of a special slide.
shapeIndex integer path true The 1-based index of a shape.
paragraphIndex integer path true The 1-based index of a paragraph.
password string header false The password to open the presentation.
folder string query false The path to a folder containing the presentation.
storage string query false The name of the storage contaning the folder.
subShape string query false The path to a child shape (e.g. “3”, “3/shapes/2”).
GetSpecialSlidePortion Request Parameters
Name Type Location Required Description
name string path true The name of a presentation file saved in a storage.
slideIndex integer path true The 1-based index of a regular slide.
slideType MasterSlide or LayoutSlide or NotesSlide path true The type of a special slide.
shapeIndex integer path true The 1-based index of a shape.
paragraphIndex integer path true The 1-based index of a paragraph.
portionIndex integer path true The 1-based index of a text portion.
password string header false The password to open the presentation.
folder string query false The path to a folder containing the presentation.
storage string query false The name of the storage contaning the folder.
subShape string query false The path to a child shape (e.g. “3”, “3/shapes/2”).
CreateSpecialSlidePortion Request Parameters
Name Type Location Required Description
name string path true The name of a presentation file saved in a storage.
slideIndex integer path true The 1-based index of a regular slide.
slideType MasterSlide or LayoutSlide or NotesSlide path true The type of a special slide.
shapeIndex integer path true The 1-based index of a shape.
paragraphIndex integer path true The 1-based index of a paragraph.
dto Portion body true The data transfer object with parameters for a new text portion.
position integer query false The position of the new text portion in the list. By default, the text portion is added to the end of the list.
password string header false The password to open the presentation.
folder string query false The path to a folder containing the presentation.
storage string query false The name of the storage contaning the folder.
subShape string query false The path to a child shape (e.g. “3”, “3/shapes/2”).
UpdateSpecialSlidePortion Request Parameters
Name Type Location Required Description
name string path true The name of a presentation file saved in a storage.
slideIndex integer path true The 1-based index of a regular slide.
slideType MasterSlide or LayoutSlide or NotesSlide path true The type of a special slide.
shapeIndex integer path true The 1-based index of a shape.
paragraphIndex integer path true The 1-based index of a paragraph.
portionIndex integer path true The 1-based index of a text portion.
dto Portion body true The data transfer object with parameters for the text portion.
password string header false The password to open the presentation.
folder string query false The path to a folder containing the presentation.
storage string query false The name of the storage contaning the folder.
subShape string query false The path to a child shape (e.g. “3”, “3/shapes/2”).
DeleteSpecialSlidePortions Request Parameters
Name Type Location Required Description
name string path true The name of a presentation file saved in a storage.
slideIndex integer path true The 1-based index of a regular slide.
slideType MasterSlide or LayoutSlide or NotesSlide path true The type of a special slide.
shapeIndex integer path true The 1-based index of a shape.
paragraphIndex integer path true The 1-based index of a paragraph.
portions string query false The indices of the text portions to be deleted. Delete all by default.
password string header false The password to open the presentation.
folder string query false The path to a folder containing the presentation.
storage string query false The name of the storage contaning the folder.
subShape string query false The path to a child shape (e.g. “3”, “3/shapes/2”).
DeleteSpecialSlidePortion Request Parameters
Name Type Location Required Description
name string path true The name of a presentation file saved in a storage.
slideIndex integer path true The 1-based index of a regular slide.
slideType MasterSlide or LayoutSlide or NotesSlide path true The type of a special slide.
shapeIndex integer path true The 1-based index of a shape.
paragraphIndex integer path true The 1-based index of a paragraph.
portionIndex integer path true The 1-based index of a text portion.
password string header false The password to open the presentation.
folder string query false The path to a folder containing the presentation.
storage string query false The name of the storage contaning the folder.
subShape string query false The path to a child shape (e.g. “3”, “3/shapes/2”).

Examples

The following examples demonstrate manipulating text portions on a Master slide. You can access text portions on a Layout or Notes slide the same way, just change the value of the slideType parameter accordingly.

cURL Examples

SDK Examples

SDKs

Check Available SDKs to learn how to add an SDK to your project.