com.aspose.slides

Class ForEach

java.lang.Object

com.aspose.slides.ForEach

public class ForEach
extends java.lang.Object

Represents a group of methods intended to iterate over different Presentation model objects. These methods can be useful if you need to iterate and change some Presentation' elements formatting or content, e.g. change each portion formatting.

 
 Presentation pres = new Presentation("pres.pptx");
 try {
     ForEach.portion(pres, (portion, para, slide, index) ->
         portion.getPortionFormat().setLatinFont(new FontData("Times New Roman")));
     pres.save("pres-out.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ForEach.ForEachLayoutSlideCallback
static interface	ForEach.ForEachMasterSlideCallback
static interface	ForEach.ForEachParagraphCallback
static interface	ForEach.ForEachPortionCallback
static interface	ForEach.ForEachShapeCallback
static interface	ForEach.ForEachSlideCallback

Constructor Summary

Constructors

Constructor and Description
ForEach()

Method Summary

Modifier and Type	Method and Description
static void	layoutSlide(Presentation pres, ForEach.ForEachLayoutSlideCallback forEachLayoutSlide) Iterate each layoutSlide(Presentation,ForEachLayoutSlideCallback) in the Presentation.
static void	masterSlide(Presentation pres, ForEach.ForEachMasterSlideCallback forEachMasterSlide) Iterate each masterSlide(Presentation,ForEachMasterSlideCallback) in the Presentation.
static void	paragraph(Presentation pres, boolean includeNotes, ForEach.ForEachParagraphCallback forEachParagraph) Iterate each Paragraph in the Presentation.
static void	paragraph(Presentation pres, ForEach.ForEachParagraphCallback forEachParagraph) Iterate each Paragraph in the Presentation.
static void	portion(Presentation pres, boolean includeNotes, ForEach.ForEachPortionCallback forEachPortion) Iterate each Portion in the Presentation.
static void	portion(Presentation pres, ForEach.ForEachPortionCallback forEachPortion) Iterate each Portion in the Presentation.
static void	shape(BaseSlide baseSlide, ForEach.ForEachShapeCallback forEachShape) Iterate each Shape in the BaseSlide.
static void	shape(Presentation pres, boolean includeNotes, ForEach.ForEachShapeCallback forEachShape) Iterate each Shape in the Presentation.
static void	shape(Presentation pres, ForEach.ForEachShapeCallback forEachShape) Iterate each Shape in the Presentation.
static void	slide(Presentation pres, ForEach.ForEachSlideCallback forEachSlide) Iterate each slide(Presentation,ForEachSlideCallback) in the Presentation.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ForEach

public ForEach()

Method Detail

slide

public static void slide(Presentation pres,
                         ForEach.ForEachSlideCallback forEachSlide)

Iterate each slide(Presentation,ForEachSlideCallback) in the Presentation.

 
 Presentation pres = new Presentation("pres.pptx");
 try {
     ForEach.slide(pres, (slide, index) ->
         slide.setName(String.format("Slide #%d", index)));
 } finally {
     if (pres != null) pres.dispose();
 } 
 
 

Parameters:

pres - Presentation to iterate slides

forEachSlide - Callback that will be invoked for each slide

masterSlide

public static void masterSlide(Presentation pres,
                               ForEach.ForEachMasterSlideCallback forEachMasterSlide)

Iterate each masterSlide(Presentation,ForEachMasterSlideCallback) in the Presentation.

 
 Presentation pres = new Presentation("pres.pptx");
 try {
     ForEach.masterSlide(pres, (slide, index) ->
         slide.setName(String.format("Master Slide #%d", index)));
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Parameters:

pres - Presentation to iterate master slides

forEachMasterSlide - Callback that will be invoked for each master slide

layoutSlide

public static void layoutSlide(Presentation pres,
                               ForEach.ForEachLayoutSlideCallback forEachLayoutSlide)

Iterate each layoutSlide(Presentation,ForEachLayoutSlideCallback) in the Presentation.

 
 Presentation pres = new Presentation("pres.pptx");
 try {
     ForEach.layoutSlide(pres, (layoutSlide, index) ->
         layoutSlide.setName(String.format("Layout Slide #%d", index)));
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Parameters:

pres - Presentation to iterate layout slides

forEachLayoutSlide - Callback that will be invoked for each layout slide

shape

public static void shape(Presentation pres,
                         ForEach.ForEachShapeCallback forEachShape)

Iterate each Shape in the Presentation.

 
 Presentation pres = new Presentation("pres.pptx");
 try {
     ForEach.shape(pres, (shape, slide, index) ->
         System.out.println(String.format("%s, index: %d", shape.getName(), index)));
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Parameters:

pres - Presentation to iterate layout shapes

forEachShape - Callback that will be invoked for each shape

Shapes will be iterated in all type of slides - slide(Presentation,ForEachSlideCallback), masterSlide(Presentation,ForEachMasterSlideCallback) and layoutSlide(Presentation,ForEachLayoutSlideCallback)

shape

public static void shape(Presentation pres,
                         boolean includeNotes,
                         ForEach.ForEachShapeCallback forEachShape)

Iterate each Shape in the Presentation.

 
 Presentation pres = new Presentation("pres.pptx");
 try {
     ForEach.shape(pres, true, (shape, slide, index) ->
         System.out.println(String.format("%s, index: %d", shape.getName(), index)));
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Parameters:

pres - Presentation to iterate layout shapes

includeNotes - Flag that indicates whether NotesSlides should be included in processing.

forEachShape - Callback that will be invoked for each shape

Shapes will be iterated in all type of slides - slide(Presentation,ForEachSlideCallback), masterSlide(Presentation,ForEachMasterSlideCallback), layoutSlide(Presentation,ForEachLayoutSlideCallback) and NotesSlide if needed.

shape

public static void shape(BaseSlide baseSlide,
                         ForEach.ForEachShapeCallback forEachShape)

Iterate each Shape in the BaseSlide.

 
 Presentation pres = new Presentation("pres.pptx");
 try {
     ForEach.slide(pres, (slide, index) ->
         ForEach.shape(slide, (shape, baseSlide, shapeIndex) ->
                 System.out.println(String.format("%s, index: %d", shape.getName(), shapeIndex))));
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Parameters:

baseSlide - Slide to iterate layout shapes

forEachShape - Callback that will be invoked for each shape

BaseSlide is the base type for slide(Presentation,ForEachSlideCallback), masterSlide(Presentation,ForEachMasterSlideCallback) and layoutSlide(Presentation,ForEachLayoutSlideCallback)

paragraph

public static void paragraph(Presentation pres,
                             ForEach.ForEachParagraphCallback forEachParagraph)

Iterate each Paragraph in the Presentation.

 
 Presentation pres = new Presentation("pres.pptx");
 try {
     ForEach.paragraph(pres, (para, slide, index) ->
         System.out.println(String.format("%s, index: %d", para.getText(), index)));
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Parameters:

pres - Presentation to iterate paragraphs

forEachParagraph - Callback that will be invoked for each paragraph

Shapes will be iterated in all type of slides - slide(Presentation,ForEachSlideCallback), masterSlide(Presentation,ForEachMasterSlideCallback) and layoutSlide(Presentation,ForEachLayoutSlideCallback)

paragraph

public static void paragraph(Presentation pres,
                             boolean includeNotes,
                             ForEach.ForEachParagraphCallback forEachParagraph)

Iterate each Paragraph in the Presentation.

 
 Presentation pres = new Presentation("pres.pptx");
 try {
     ForEach.paragraph(pres, true, (para, slide, index) ->
         System.out.println(String.format("%s, index: %d", para.getText(), index)));
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Parameters:

pres - Presentation to iterate paragraphs

includeNotes - Flag that indicates whether NotesSlides should be included in processing.

forEachParagraph - Callback that will be invoked for each paragraph

Shapes will be iterated in all type of slides - slide(Presentation,ForEachSlideCallback), masterSlide(Presentation,ForEachMasterSlideCallback), layoutSlide(Presentation,ForEachLayoutSlideCallback) and NotesSlide

portion

public static void portion(Presentation pres,
                           ForEach.ForEachPortionCallback forEachPortion)

Iterate each Portion in the Presentation.

 
 Presentation pres = new Presentation("pres.pptx");
 try {
     ForEach.portion(pres, (portion, para, slide, index) ->
         System.out.println(String.format("%s, index: %d", portion.getText(), index)));
 } finally {
     if (pres != null) pres.dispose();
 } 
 
 

Parameters:

pres - Presentation to iterate portions

forEachPortion - Callback that will be invoked for each portion

Portions will be iterated in all type of slides - slide(Presentation,ForEachSlideCallback), masterSlide(Presentation,ForEachMasterSlideCallback) and layoutSlide(Presentation,ForEachLayoutSlideCallback)

portion

public static void portion(Presentation pres,
                           boolean includeNotes,
                           ForEach.ForEachPortionCallback forEachPortion)

Iterate each Portion in the Presentation.

 
 Presentation pres = new Presentation("pres.pptx");
 try {
     ForEach.portion(pres, true, (portion, para, slide, index) ->
         System.out.println(String.format("%s, index: %d", portion.getText(), index)));
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Parameters:

pres - Presentation to iterate portions

includeNotes - Flag that indicates whether NotesSlides should be included in processing.

forEachPortion - Callback that will be invoked for each portion

Portions will be iterated in all type of slides - slide(Presentation,ForEachSlideCallback), masterSlide(Presentation,ForEachMasterSlideCallback), layoutSlide(Presentation,ForEachLayoutSlideCallback) and NotesSlide