SlideUtil

SlideUtil class

Offer methods which help to search shapes and text in a presentation.

SlideUtil

Name	Description
SlideUtil()

Returns: SlideUtil

alignShapes

Name	Description
alignShapes (int, boolean, MasterNotesSlide)	Changes the placement of all shapes on the slide. Aligns shapes to the margins or the edge of the slide or align them relative to each other.

Parameters:

Name	Type	Description
alignmentType	int	Determines which type of alignment will be applied.
alignToSlide	boolean	If true, shapes will be aligned relative to the slide edges.
slide	MasterNotesSlide	Parent slide.

alignShapes

Name	Description
alignShapes (int, boolean, MasterSlide)	Changes the placement of all shapes on the slide. Aligns shapes to the margins or the edge of the slide or align them relative to each other.

Parameters:

Name	Type	Description
alignmentType	int	Determines which type of alignment will be applied.
alignToSlide	boolean	If true, shapes will be aligned relative to the slide edges.
slide	MasterSlide	Parent slide.

alignShapes

Name	Description
alignShapes (int, boolean, BaseSlide)	Changes the placement of all shapes on the slide. Aligns shapes to the margins or the edge of the slide or align them relative to each other.

Parameters:

Name	Type	Description
alignmentType	int	Determines which type of alignment will be applied.
alignToSlide	boolean	If true, shapes will be aligned relative to the slide edges.
slide	BaseSlide	Parent slide.

alignShapes

Name	Description
alignShapes (int, boolean, LayoutSlide)	Changes the placement of all shapes on the slide. Aligns shapes to the margins or the edge of the slide or align them relative to each other.

Parameters:

Name	Type	Description
alignmentType	int	Determines which type of alignment will be applied.
alignToSlide	boolean	If true, shapes will be aligned relative to the slide edges.
slide	LayoutSlide	Parent slide.

alignShapes

Name	Description
alignShapes (int, boolean, NotesSlide)	Changes the placement of all shapes on the slide. Aligns shapes to the margins or the edge of the slide or align them relative to each other.

Parameters:

Name	Type	Description
alignmentType	int	Determines which type of alignment will be applied.
alignToSlide	boolean	If true, shapes will be aligned relative to the slide edges.
slide	NotesSlide	Parent slide.

alignShapes

Name	Description
alignShapes (int, boolean, Slide)	Changes the placement of all shapes on the slide. Aligns shapes to the margins or the edge of the slide or align them relative to each other.

Parameters:

Name	Type	Description
alignmentType	int	Determines which type of alignment will be applied.
alignToSlide	boolean	If true, shapes will be aligned relative to the slide edges.
slide	Slide	Parent slide.

alignShapes

Name	Description
alignShapes (int, boolean, MasterHandoutSlide)	Changes the placement of all shapes on the slide. Aligns shapes to the margins or the edge of the slide or align them relative to each other.

Parameters:

Name	Type	Description
alignmentType	int	Determines which type of alignment will be applied.
alignToSlide	boolean	If true, shapes will be aligned relative to the slide edges.
slide	MasterHandoutSlide	Parent slide.

alignShapes

Name	Description
alignShapes (int, boolean, MasterNotesSlide, int[])	Changes the placement of selected shapes on the slide. Aligns shapes to the margins or the edge of the slide or align them relative to each other.

Parameters:

Name	Type	Description
alignmentType	int	Determines which type of alignment will be applied.
alignToSlide	boolean	If true, shapes will be aligned relative to the slide edges.
slide	MasterNotesSlide	Parent slide.
shapeIndexes	int[]	Indexes of shapes to be aligned.

alignShapes

Name	Description
alignShapes (int, boolean, MasterSlide, int[])	Changes the placement of selected shapes on the slide. Aligns shapes to the margins or the edge of the slide or align them relative to each other.

Parameters:

Name	Type	Description
alignmentType	int	Determines which type of alignment will be applied.
alignToSlide	boolean	If true, shapes will be aligned relative to the slide edges.
slide	MasterSlide	Parent slide.
shapeIndexes	int[]	Indexes of shapes to be aligned.

alignShapes

Name	Description
alignShapes (int, boolean, BaseSlide, int[])	Changes the placement of selected shapes on the slide. Aligns shapes to the margins or the edge of the slide or align them relative to each other.

Parameters:

Name	Type	Description
alignmentType	int	Determines which type of alignment will be applied.
alignToSlide	boolean	If true, shapes will be aligned relative to the slide edges.
slide	BaseSlide	Parent slide.
shapeIndexes	int[]	Indexes of shapes to be aligned.

alignShapes

Name	Description
alignShapes (int, boolean, LayoutSlide, int[])	Changes the placement of selected shapes on the slide. Aligns shapes to the margins or the edge of the slide or align them relative to each other.

Parameters:

Name	Type	Description
alignmentType	int	Determines which type of alignment will be applied.
alignToSlide	boolean	If true, shapes will be aligned relative to the slide edges.
slide	LayoutSlide	Parent slide.
shapeIndexes	int[]	Indexes of shapes to be aligned.

alignShapes

Name	Description
alignShapes (int, boolean, NotesSlide, int[])	Changes the placement of selected shapes on the slide. Aligns shapes to the margins or the edge of the slide or align them relative to each other.

Parameters:

Name	Type	Description
alignmentType	int	Determines which type of alignment will be applied.
alignToSlide	boolean	If true, shapes will be aligned relative to the slide edges.
slide	NotesSlide	Parent slide.
shapeIndexes	int[]	Indexes of shapes to be aligned.

alignShapes

Name	Description
alignShapes (int, boolean, Slide, int[])	Changes the placement of selected shapes on the slide. Aligns shapes to the margins or the edge of the slide or align them relative to each other.

Parameters:

Name	Type	Description
alignmentType	int	Determines which type of alignment will be applied.
alignToSlide	boolean	If true, shapes will be aligned relative to the slide edges.
slide	Slide	Parent slide.
shapeIndexes	int[]	Indexes of shapes to be aligned.

alignShapes

Name	Description
alignShapes (int, boolean, MasterHandoutSlide, int[])	Changes the placement of selected shapes on the slide. Aligns shapes to the margins or the edge of the slide or align them relative to each other.

Parameters:

Name	Type	Description
alignmentType	int	Determines which type of alignment will be applied.
alignToSlide	boolean	If true, shapes will be aligned relative to the slide edges.
slide	MasterHandoutSlide	Parent slide.
shapeIndexes	int[]	Indexes of shapes to be aligned.

alignShapes

Name	Description
alignShapes (int, boolean, GroupShape)	Changes the placement of all shapes within group shape. Aligns shapes to the margins or the edge of the slide or align them relative to each other.

Parameters:

Name	Type	Description
alignmentType	int	Determines which type of alignment will be applied.
alignToSlide	boolean	If true, shapes will be aligned relative to the slide edges.
groupShape	GroupShape	Parent group shape.

alignShapes

Name	Description
alignShapes (int, boolean, GroupShape, int[])	Changes the placement of selected shapes within group shape. Aligns shapes to the margins or the edge of the slide or align them relative to each other.

Parameters:

Name	Type	Description
alignmentType	int	Determines which type of alignment will be applied.
alignToSlide	boolean	If true, shapes will be aligned relative to the slide edges.
groupShape	GroupShape	Parent group shape.
shapeIndexes	int[]	Indexes of shapes to be aligned.

findAndReplaceText

Name	Description
findAndReplaceText (Presentation, boolean, String, String)	Finds and replaces text in presentation with given format

Parameters:

Name	Type	Description
presentation	Presentation	Scanned presentation.
withMasters	boolean	Determines whether master slides should be scanned.
find	String	String value to find.
replace	String	String value to replace. character of the found string

findAndReplaceText

Name	Description
findAndReplaceText (Presentation, boolean, String, String, PortionFormat)	Finds and replaces text in presentation with given format

Parameters:

Name	Type	Description
presentation	Presentation	Scanned presentation.
withMasters	boolean	Determines whether master slides should be scanned.
find	String	String value to find.
replace	String	String value to replace.
format	PortionFormat	Format for replacing text portion. If null then will be used format of the first character of the found string

findShape

Name	Description
findShape (Presentation, String)	Find shape by alternative text in a PPTX presentation.

Parameters:

Name	Type	Description
pres	Presentation	Scanned presentation.
altText	String	Alternative text of a shape.

Returns: AutoShape, Table, SummaryZoomFrame, LegacyDiagram, SmartArt, SmartArtShape, SummaryZoomSection, GeometryShape, InkActions, Shape, OleObjectFrame, Chart, AudioFrame, Connector, GraphicalObject, PictureFrame, ZoomObject, VideoFrame, ZoomFrame, SectionZoomFrame, GroupShape, Ink

findShape

Name	Description
findShape (MasterNotesSlide, String)	Find shape by alternative text on a slide in a PPTX presentation.

Parameters:

Name	Type	Description
slide	MasterNotesSlide	Scanned slide.
altText	String	Alternative text of a shape.

findShape

Name	Description
findShape (MasterSlide, String)	Find shape by alternative text on a slide in a PPTX presentation.

Parameters:

Name	Type	Description
slide	MasterSlide	Scanned slide.
altText	String	Alternative text of a shape.

findShape

Name	Description
findShape (BaseSlide, String)	Find shape by alternative text on a slide in a PPTX presentation.

Parameters:

Name	Type	Description
slide	BaseSlide	Scanned slide.
altText	String	Alternative text of a shape.

findShape

Name	Description
findShape (LayoutSlide, String)	Find shape by alternative text on a slide in a PPTX presentation.

Parameters:

Name	Type	Description
slide	LayoutSlide	Scanned slide.
altText	String	Alternative text of a shape.

findShape

Name	Description
findShape (NotesSlide, String)	Find shape by alternative text on a slide in a PPTX presentation.

Parameters:

Name	Type	Description
slide	NotesSlide	Scanned slide.
altText	String	Alternative text of a shape.

findShape

Name	Description
findShape (Slide, String)	Find shape by alternative text on a slide in a PPTX presentation.

Parameters:

Name	Type	Description
slide	Slide	Scanned slide.
altText	String	Alternative text of a shape.

findShape

Name	Description
findShape (MasterHandoutSlide, String)	Find shape by alternative text on a slide in a PPTX presentation.

Parameters:

Name	Type	Description
slide	MasterHandoutSlide	Scanned slide.
altText	String	Alternative text of a shape.

findShapesByPlaceholderType

Name	Description
findShapesByPlaceholderType (MasterNotesSlide, byte)	Searches for all shapes on the specified slide that match the given placeholder type.

Parameters:

Name	Type	Description
slide	MasterNotesSlide	The slide to search for shapes.
placeholderType	byte	The type of placeholder to filter shapes by.

findShapesByPlaceholderType

Name	Description
findShapesByPlaceholderType (MasterSlide, byte)	Searches for all shapes on the specified slide that match the given placeholder type.

Parameters:

Name	Type	Description
slide	MasterSlide	The slide to search for shapes.
placeholderType	byte	The type of placeholder to filter shapes by.

findShapesByPlaceholderType

Name	Description
findShapesByPlaceholderType (BaseSlide, byte)	Searches for all shapes on the specified slide that match the given placeholder type.

Parameters:

Name	Type	Description
slide	BaseSlide	The slide to search for shapes.
placeholderType	byte	The type of placeholder to filter shapes by.

findShapesByPlaceholderType

Name	Description
findShapesByPlaceholderType (LayoutSlide, byte)	Searches for all shapes on the specified slide that match the given placeholder type.

Parameters:

Name	Type	Description
slide	LayoutSlide	The slide to search for shapes.
placeholderType	byte	The type of placeholder to filter shapes by.

findShapesByPlaceholderType

Name	Description
findShapesByPlaceholderType (NotesSlide, byte)	Searches for all shapes on the specified slide that match the given placeholder type.

Parameters:

Name	Type	Description
slide	NotesSlide	The slide to search for shapes.
placeholderType	byte	The type of placeholder to filter shapes by.

findShapesByPlaceholderType

Name	Description
findShapesByPlaceholderType (Slide, byte)	Searches for all shapes on the specified slide that match the given placeholder type.

Parameters:

Name	Type	Description
slide	Slide	The slide to search for shapes.
placeholderType	byte	The type of placeholder to filter shapes by.

findShapesByPlaceholderType

Name	Description
findShapesByPlaceholderType (MasterHandoutSlide, byte)	Searches for all shapes on the specified slide that match the given placeholder type.

Parameters:

Name	Type	Description
slide	MasterHandoutSlide	The slide to search for shapes.
placeholderType	byte	The type of placeholder to filter shapes by.

getAllTextBoxes

Name	Description
getAllTextBoxes (MasterNotesSlide)	Returns all text frames on a slide in a PPTX presentation.

Parameters:

Name	Type	Description
slide	MasterNotesSlide	Scanned slide.

Returns: TextFrame

getAllTextBoxes

Name	Description
getAllTextBoxes (MasterSlide)	Returns all text frames on a slide in a PPTX presentation.

Parameters:

Name	Type	Description
slide	MasterSlide	Scanned slide.

Returns: TextFrame

getAllTextBoxes

Name	Description
getAllTextBoxes (BaseSlide)	Returns all text frames on a slide in a PPTX presentation.

Parameters:

Name	Type	Description
slide	BaseSlide	Scanned slide.

Returns: TextFrame

getAllTextBoxes

Name	Description
getAllTextBoxes (LayoutSlide)	Returns all text frames on a slide in a PPTX presentation.

Parameters:

Name	Type	Description
slide	LayoutSlide	Scanned slide.

Returns: TextFrame

getAllTextBoxes

Name	Description
getAllTextBoxes (NotesSlide)	Returns all text frames on a slide in a PPTX presentation.

Parameters:

Name	Type	Description
slide	NotesSlide	Scanned slide.

Returns: TextFrame

getAllTextBoxes

Name	Description
getAllTextBoxes (Slide)	Returns all text frames on a slide in a PPTX presentation.

Parameters:

Name	Type	Description
slide	Slide	Scanned slide.

Returns: TextFrame

getAllTextBoxes

Name	Description
getAllTextBoxes (MasterHandoutSlide)	Returns all text frames on a slide in a PPTX presentation.

Parameters:

Name	Type	Description
slide	MasterHandoutSlide	Scanned slide.

Returns: TextFrame

getAllTextFrames

Name	Description
getAllTextFrames (Presentation, boolean)	Returns all text frames in a PPTX presentation.

Parameters:

Name	Type	Description
pres	Presentation	Scanned presentation.
withMasters	boolean	Determines whether master slides should be scanned.

Returns: TextFrame

getTextBoxesContainsText

Name	Description
getTextBoxesContainsText (MasterNotesSlide, String, boolean)	Returns all text frames on the specified slide that contain the given text.

Parameters:

Name	Type	Description
slide	MasterNotesSlide	The slide to search.
text	String	The text to search for within text frames.
checkPlaceholderText	boolean	Indicates whether to include text frames that are empty, but whose placeholder text contains the search text.

Returns: TextFrame

getTextBoxesContainsText

Name	Description
getTextBoxesContainsText (MasterSlide, String, boolean)	Returns all text frames on the specified slide that contain the given text.

Parameters:

Name	Type	Description
slide	MasterSlide	The slide to search.
text	String	The text to search for within text frames.
checkPlaceholderText	boolean	Indicates whether to include text frames that are empty, but whose placeholder text contains the search text.

Returns: TextFrame

getTextBoxesContainsText

Name	Description
getTextBoxesContainsText (BaseSlide, String, boolean)	Returns all text frames on the specified slide that contain the given text.

Parameters:

Name	Type	Description
slide	BaseSlide	The slide to search.
text	String	The text to search for within text frames.
checkPlaceholderText	boolean	Indicates whether to include text frames that are empty, but whose placeholder text contains the search text.

Returns: TextFrame

getTextBoxesContainsText

Name	Description
getTextBoxesContainsText (LayoutSlide, String, boolean)	Returns all text frames on the specified slide that contain the given text.

Parameters:

Name	Type	Description
slide	LayoutSlide	The slide to search.
text	String	The text to search for within text frames.
checkPlaceholderText	boolean	Indicates whether to include text frames that are empty, but whose placeholder text contains the search text.

Returns: TextFrame

getTextBoxesContainsText

Name	Description
getTextBoxesContainsText (NotesSlide, String, boolean)	Returns all text frames on the specified slide that contain the given text.

Parameters:

Name	Type	Description
slide	NotesSlide	The slide to search.
text	String	The text to search for within text frames.
checkPlaceholderText	boolean	Indicates whether to include text frames that are empty, but whose placeholder text contains the search text.

Returns: TextFrame

getTextBoxesContainsText

Name	Description
getTextBoxesContainsText (Slide, String, boolean)	Returns all text frames on the specified slide that contain the given text.

Parameters:

Name	Type	Description
slide	Slide	The slide to search.
text	String	The text to search for within text frames.
checkPlaceholderText	boolean	Indicates whether to include text frames that are empty, but whose placeholder text contains the search text.

Returns: TextFrame

getTextBoxesContainsText

Name	Description
getTextBoxesContainsText (MasterHandoutSlide, String, boolean)	Returns all text frames on the specified slide that contain the given text.

Parameters:

Name	Type	Description
slide	MasterHandoutSlide	The slide to search.
text	String	The text to search for within text frames.
checkPlaceholderText	boolean	Indicates whether to include text frames that are empty, but whose placeholder text contains the search text.

Returns: TextFrame