SlideUtil

Inheritance: java.lang.Object

public class SlideUtil

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

Constructors

Constructor	Description
SlideUtil()

Methods

Method	Description
findShape(IPresentation pres, String altText)	Find shape by alternative text in a PPTX presentation.
findShape(IBaseSlide slide, String altText)	Find shape by alternative text on a slide in a PPTX presentation.
findShapesByPlaceholderType(IBaseSlide slide, byte placeholderType)	Searches for all shapes on the specified slide that match the given placeholder type.
alignShapes(int alignmentType, boolean alignToSlide, IBaseSlide slide)	Changes the placement of all shapes on the slide.
alignShapes(int alignmentType, boolean alignToSlide, IBaseSlide slide, int[] shapeIndexes)	Changes the placement of selected shapes on the slide.
alignShapes(int alignmentType, boolean alignToSlide, IGroupShape groupShape)	Changes the placement of all shapes within group shape.
alignShapes(int alignmentType, boolean alignToSlide, IGroupShape groupShape, int[] shapeIndexes)	Changes the placement of selected shapes within group shape.
findAndReplaceText(IPresentation presentation, boolean withMasters, String find, String replace)	Finds and replaces text in presentation with given format
findAndReplaceText(IPresentation presentation, boolean withMasters, String find, String replace, PortionFormat format)	Finds and replaces text in presentation with given format
getAllTextBoxes(IBaseSlide slide)	Returns all text frames on a slide in a PPTX presentation.
getTextBoxesContainsText(IBaseSlide slide, String text, boolean checkPlaceholderText)	Returns all text frames on the specified slide that contain the given text.
getAllTextFrames(IPresentation pres, boolean withMasters)	Returns all text frames in a PPTX presentation.

SlideUtil()

public SlideUtil()

findShape(IPresentation pres, String altText)

public static IShape findShape(IPresentation pres, String altText)

Find shape by alternative text in a PPTX presentation.

Parameters:

Parameter	Type	Description
pres	IPresentation	Scanned presentation.
altText	java.lang.String	Alternative text of a shape.

Returns: IShape - Shape or null.

findShape(IBaseSlide slide, String altText)

public static IShape findShape(IBaseSlide slide, String altText)

Find shape by alternative text on a slide in a PPTX presentation.

Parameters:

Parameter	Type	Description
slide	IBaseSlide	Scanned slide.
altText	java.lang.String	Alternative text of a shape.

Returns: IShape - Shape or null.

findShapesByPlaceholderType(IBaseSlide slide, byte placeholderType)

public static IShape[] findShapesByPlaceholderType(IBaseSlide slide, byte placeholderType)

Searches for all shapes on the specified slide that match the given placeholder type.

Parameters:

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

Returns: com.aspose.slides.IShape[] - An array of IShape objects that match the specified placeholder type.

alignShapes(int alignmentType, boolean alignToSlide, IBaseSlide slide)

public static void alignShapes(int alignmentType, boolean alignToSlide, IBaseSlide 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.

Example:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
     SlideUtil.alignShapes(ShapesAlignmentType.AlignBottom, true, pres.getSlides().get_Item(0));
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

Parameter	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	IBaseSlide	Parent slide.

alignShapes(int alignmentType, boolean alignToSlide, IBaseSlide slide, int[] shapeIndexes)

public static void alignShapes(int alignmentType, boolean alignToSlide, IBaseSlide slide, int[] shapeIndexes)

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.

Example:
  
  Presentation pres = new Presentation("pres.pptx");
  try {
     ISlide slide = pres.getSlides().get_Item(0);
     IShape shape1 = slide.getShapes().get_Item(0);
     IShape shape2 = slide.getShapes().get_Item(1);
     SlideUtil.alignShapes(ShapesAlignmentType.AlignBottom, false, pres.getSlides().get_Item(0), new int[]
     {
         slide.getShapes().indexOf(shape1),
         slide.getShapes().indexOf(shape2)
     });
  } finally {
     if (pres != null) pres.dispose();
  }

Parameters:

Parameter	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	IBaseSlide	Parent slide.
shapeIndexes	int[]	Indexes of shapes to be aligned.

alignShapes(int alignmentType, boolean alignToSlide, IGroupShape groupShape)

public static void alignShapes(int alignmentType, boolean alignToSlide, IGroupShape 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.

Example:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
     ISlide slide = pres.getSlides().get_Item(0);
     SlideUtil.alignShapes(ShapesAlignmentType.AlignLeft, false, (GroupShape) slide.getShapes().get_Item(0));
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

Parameter	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	IGroupShape	Parent group shape.

alignShapes(int alignmentType, boolean alignToSlide, IGroupShape groupShape, int[] shapeIndexes)

public static void alignShapes(int alignmentType, boolean alignToSlide, IGroupShape groupShape, int[] shapeIndexes)

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.

Example:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
     ISlide slide = pres.getSlides().get_Item(0);
     SlideUtil.alignShapes(ShapesAlignmentType.AlignLeft, false, (GroupShape)slide.getShapes().get_Item(0), new int[] { 0, 2 });
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

Parameter	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	IGroupShape	Parent group shape.
shapeIndexes	int[]	Indexes of shapes to be aligned.

findAndReplaceText(IPresentation presentation, boolean withMasters, String find, String replace)

public static void findAndReplaceText(IPresentation presentation, boolean withMasters, String find, String replace)

Finds and replaces text in presentation with given format

Presentation pres = new Presentation("pres.pptx");
 try {
     PortionFormat format = new PortionFormat();
     format.setFontHeight(24f);
     format.setFontItalic(NullableBool.True);
     format.getFillFormat().setFillType(FillType.Solid);
     format.getFillFormat().getSolidFillColor().setColor(Color.RED);

     SlideUtil.findAndReplaceText(pres, true, "[this block] ", "my text ", format);
     pres.save("replaced.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

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

findAndReplaceText(IPresentation presentation, boolean withMasters, String find, String replace, PortionFormat format)

public static void findAndReplaceText(IPresentation presentation, boolean withMasters, String find, String replace, PortionFormat format)

Finds and replaces text in presentation with given format

Presentation pres = new Presentation("pres.pptx");
 try {
     PortionFormat format = new PortionFormat();
     format.setFontHeight(24f);
     format.setFontItalic(NullableBool.True);
     format.getFillFormat().setFillType(FillType.Solid);
     format.getFillFormat().getSolidFillColor().setColor(Color.RED);

     SlideUtil.findAndReplaceText(pres, true, "[this block] ", "my text ", format);
     pres.save("replaced.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

Parameter	Type	Description
presentation	IPresentation	Scanned presentation.
withMasters	boolean	Determines whether master slides should be scanned.
find	java.lang.String	String value to find.
replace	java.lang.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

getAllTextBoxes(IBaseSlide slide)

public static ITextFrame[] getAllTextBoxes(IBaseSlide slide)

Returns all text frames on a slide in a PPTX presentation.

Parameters:

Parameter	Type	Description
slide	IBaseSlide	Scanned slide.

Returns: com.aspose.slides.ITextFrame[] - Array of TextFrame objects.

getTextBoxesContainsText(IBaseSlide slide, String text, boolean checkPlaceholderText)

public static ITextFrame[] getTextBoxesContainsText(IBaseSlide slide, String text, boolean checkPlaceholderText)

Returns all text frames on the specified slide that contain the given text.

Parameters:

Parameter	Type	Description
slide	IBaseSlide	The slide to search.
text	java.lang.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: com.aspose.slides.ITextFrame[] - An array of ITextFrame objects that contain the specified text.

getAllTextFrames(IPresentation pres, boolean withMasters)

public static ITextFrame[] getAllTextFrames(IPresentation pres, boolean withMasters)

Returns all text frames in a PPTX presentation.

Parameters:

Parameter	Type	Description
pres	IPresentation	Scanned presentation.
withMasters	boolean	Determines whether master slides should be scanned.

Returns: com.aspose.slides.ITextFrame[] - Array of TextFrame objects.