com.aspose.slides

Interfaces

Classes

Exceptions

Skip navigation links
com.aspose.slides

Interface IMasterLayoutSlideCollection

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      ILayoutSlide add(byte layoutType, java.lang.String layoutName)
      Adds a new layout slide to the end of the collection.
      ILayoutSlide addClone(ILayoutSlide sourceLayout)
      Adds a copy of a specified layout slide to the end of the collection.
      ILayoutSlide insert(int index, byte layoutType, java.lang.String layoutName)
      Inserts a new layout slide to specified position of the collection.
      ILayoutSlide insertClone(int index, ILayoutSlide sourceLayout)
      Inserts a copy of a specified layout slide to specified position of the collection.
      void removeAt(int index)
      Removes the element at the specified index of the collection.
      void reorder(int index, ILayoutSlide layoutSlide)
      Moves layout slide from the collection to the specified position.

      • Methods inherited from interface com.aspose.ms.System.Collections.Generic.IGenericEnumerable

        iterator

      • Methods inherited from interface com.aspose.ms.System.Collections.ICollection

        copyTo, getSyncRoot, isSynchronized, size

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

    • Method Detail

      • insertClone

        ILayoutSlide insertClone(int index,
                         ILayoutSlide sourceLayout)

        Inserts a copy of a specified layout slide to specified position of the collection.

        Parameters:
        index - Index of new slide.
        sourceLayout - Slide to clone.

        New layout will be linked with parent master slide for this layout slides collection. So this is analogue of copy/paste with "Use Destination Theme" option in PowerPoint.
        Returns:
        Inserted slide.

      • add

        ILayoutSlide add(byte layoutType,
                 java.lang.String layoutName)

        Adds a new layout slide to the end of the collection.

        Parameters:
        layoutType - Layout type for a new layout. Supported layout types: Title, TitleOnly, Blank, TitleAndObject, VerticalText, VerticalTitleAndText, TwoObjects, SectionHeader, TwoTextAndTwoObjects, TitleObjectAndCaption, PictureAndCaption, Custom. Other layout types are not supported now: Text, TwoColumnText, Table, TextAndChart, ChartAndText, Diagram, Chart, TextAndClipArt, ClipArtAndText, TextAndObject, ObjectAndText, Object, TextAndMedia, MediaAndText, ObjectOverText, TextOverObject, TextAndTwoObjects, TwoObjectsAndText, TwoObjectsOverText, FourObjects, ClipArtAndVerticalText, VerticalTitleAndTextOverChart, ObjectAndTwoObject, TwoObjectsAndObject.
        layoutName - Name for a new layout. If passed name is already in use the ArgumentException will be thrown. If null parameter is passed then name genarated atomatically in regards to passed layout type (for example "Title Slide" or "1_Title Slide", "2_..", etc.).

        1) Added layout for value SlideLayoutType.Custom of layoutType contains no placeholders and no shapes. 2) Analogue of this method is method IGlobalLayoutSlideCollection.add(IMasterSlide,byte,String) accessed with IPresentation.getLayoutSlides() property.
        Returns:
        Added slide.
        Throws:
        com.aspose.ms.System.NotImplementedException - Thrown if unsupported value of parameter layoutType is passed. Layout types that are not supported now: Text, TwoColumnText, Table, TextAndChart, ChartAndText, Diagram, Chart, TextAndClipArt, ClipArtAndText, TextAndObject, ObjectAndText, Object, TextAndMedia, MediaAndText, ObjectOverText, TextOverObject, TextAndTwoObjects, TwoObjectsAndText, TwoObjectsOverText, FourObjects, ClipArtAndVerticalText, VerticalTitleAndTextOverChart, ObjectAndTwoObject, TwoObjectsAndObject.
        com.aspose.ms.System.ArgumentException - Thrown if layout name value layoutName is already in use in this collection of the layouts.

      • insert

        ILayoutSlide insert(int index,
                    byte layoutType,
                    java.lang.String layoutName)

        Inserts a new layout slide to specified position of the collection.

        Parameters:
        index - Index of new slide.
        layoutType - Layout type for a new layout. Supported layout types: Title, TitleOnly, Blank, TitleAndObject, VerticalText, VerticalTitleAndText, TwoObjects, SectionHeader, TwoTextAndTwoObjects, TitleObjectAndCaption, PictureAndCaption, Custom. Other layout types are not supported now: Text, TwoColumnText, Table, TextAndChart, ChartAndText, Diagram, Chart, TextAndClipArt, ClipArtAndText, TextAndObject, ObjectAndText, Object, TextAndMedia, MediaAndText, ObjectOverText, TextOverObject, TextAndTwoObjects, TwoObjectsAndText, TwoObjectsOverText, FourObjects, ClipArtAndVerticalText, VerticalTitleAndTextOverChart, ObjectAndTwoObject, TwoObjectsAndObject.
        layoutName - Name for a new layout. If passed name is already in use the ArgumentException will be thrown. If null parameter is passed then name genarated atomatically in regards to passed layout type (for example "Title Slide" or "1_Title Slide", "2_..", etc.).

        Inserted layout for value SlideLayoutType.Custom of layoutType contains no placeholders and no shapes.
        Returns:
        Inserted slide.
        Throws:
        com.aspose.ms.System.NotImplementedException - Thrown if unsupported value of parameter layoutType is passed. Layout types that are not supported now: Text, TwoColumnText, Table, TextAndChart, ChartAndText, Diagram, Chart, TextAndClipArt, ClipArtAndText, TextAndObject, ObjectAndText, Object, TextAndMedia, MediaAndText, ObjectOverText, TextOverObject, TextAndTwoObjects, TwoObjectsAndText, TwoObjectsOverText, FourObjects, ClipArtAndVerticalText, VerticalTitleAndTextOverChart, ObjectAndTwoObject, TwoObjectsAndObject.
        com.aspose.ms.System.ArgumentException - Thrown if layout name value layoutName is already in use in this collection of the layouts.

      • removeAt

        void removeAt(int index)

        Removes the element at the specified index of the collection.

        Parameters:
        index - The zero-based index of the element to remove.

        1) To avoid throwing of the PptxEditException check layout's HasDependingSlides property before. 2) You can use also ILayoutSlide.remove() method to simplify code.
        Throws:
        PptxEditException - Thrown if layout is used in presentation (its HasDependingSlides property is true).

      • reorder

        void reorder(int index,
             ILayoutSlide layoutSlide)

        Moves layout slide from the collection to the specified position.

        Parameters:
        index - Target index.
        layoutSlide - Slide to move.