com.aspose.slides

Interfaces

Classes

Exceptions

Skip navigation links
com.aspose.slides

Interface ISequence

  • All Superinterfaces:
    com.aspose.ms.System.Collections.IEnumerable<IEffect>, com.aspose.ms.System.Collections.Generic.IGenericEnumerable<IEffect>, java.lang.Iterable<IEffect>
    All Known Implementing Classes:
    Sequence

    public interface ISequence
extends com.aspose.ms.System.Collections.Generic.IGenericEnumerable<IEffect>

    Represents sequence (collection of effects).

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      IEffect addEffect(IChart chart, int type, int index, int effectType, int subtype, int triggerType)
      Adds the new chart animation effect for category or series to the end of sequence.
      IEffect addEffect(IChart chart, int type, int seriesIndex, int categoriesIndex, int effectType, int subtype, int triggerType)
      Adds the new chart animation effect for elements in category or series to the end of sequence.
      IEffect addEffect(IParagraph paragraph, int effectType, int subtype, int triggerType)
      Add new animation effect for paragraph to the end of sequence.
      IEffect addEffect(IShape shape, int effectType, int subtype, int triggerType)
      Add new effect to the end of sequence.
      void clear()
      Removes all effects from a collection.
      IEffect get_Item(int index)
      Returns an effect at the specified index.
      int getCount()
      Returns the number of effects in a sequense.
      int getCount(IShape shape)
      Returns count of effects for the specified shape.
      IEffect[] getEffectsByParagraph(IParagraph paragraph)
      Returns array of effects for the specified paragraph.
      IEffect[] getEffectsByShape(IShape shape)
      Returns array of effects for the specified shape.
      IShape getTriggerShape()
      Returns or sets shape target for INTERACTIVE sequence.
      void remove(IEffect item)
      Removes specified effect from a collection.
      void removeAt(int index)
      Removes an effect from a collection.
      void removeByShape(IShape shape)
      Remove effect for the specified shape.
      void setTriggerShape(IShape value)
      Returns or sets shape target for INTERACTIVE sequence.

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

        iterator

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

    • Method Detail

      • getCount

        int getCount()

        Returns the number of effects in a sequense. Read-only int.

      • remove

        void remove(IEffect item)

        Removes specified effect from a collection.

        Parameters:
        item - Effect to remove.

      • removeAt

        void removeAt(int index)

        Removes an effect from a collection.

        Parameters:
        index - Index of effect to remove int

      • clear

        void clear()

        Removes all effects from a collection.

      • get_Item

        IEffect get_Item(int index)

        Returns an effect at the specified index.

        Parameters:
        index - Index of element.
        Returns:
        The IEffect object.

      • getTriggerShape

        IShape getTriggerShape()

        Returns or sets shape target for INTERACTIVE sequence. If sequence is not interactive then returns null. Read/write IShape.

      • setTriggerShape

        void setTriggerShape(IShape value)

        Returns or sets shape target for INTERACTIVE sequence. If sequence is not interactive then returns null. Read/write IShape.

      • removeByShape

        void removeByShape(IShape shape)

        Remove effect for the specified shape.

        Parameters:
        shape - Shape object IShape

      • getEffectsByShape

        IEffect[] getEffectsByShape(IShape shape)

        Returns array of effects for the specified shape.

        Parameters:
        shape - Shape object IShape
        Returns:
        Array of effects IEffect

      • getEffectsByParagraph

        IEffect[] getEffectsByParagraph(IParagraph paragraph)

        Returns array of effects for the specified paragraph.

        Parameters:
        paragraph - Paragraph object IParagraph
        Returns:
        Array of effects IEffect

      • getCount

        int getCount(IShape shape)

        Returns count of effects for the specified shape.

        Parameters:
        shape - Shape object IShape
        Returns:
        Count of effects int

      • addEffect

        IEffect addEffect(IShape shape,
                  int effectType,
                  int subtype,
                  int triggerType)

        Add new effect to the end of sequence.

        Parameters:
        shape - Shape object IShape for adding an effect
        effectType - Type of an animation effect EffectType
        subtype - Subtypes of animation effect EffectSubtype
        triggerType - Trigger type of effect EffectTriggerType
        Returns:
        New effect object IEffect

      • addEffect

        IEffect addEffect(IParagraph paragraph,
                  int effectType,
                  int subtype,
                  int triggerType)

        Add new animation effect for paragraph to the end of sequence. 

         
         Presentation presentation = new Presentation(path + "input.pptx");
 try
 {
    // select paragraph to add effect
    IAutoShape autoShape = (IAutoShape)presentation.getSlides().get_Item(0).getShapes().get_Item(0);
    IParagraph paragraph = autoShape.getTextFrame().getParagraphs().get_Item(0);
    // add Fly animation effect to selected paragraph
    IEffect effect = presentation.getSlides().get_Item(0).getTimeline().getMainSequence().addEffect(
    paragraph, EffectType.Fly, EffectSubtype.Left, EffectTriggerType.OnClick);
 } finally {
    if (presentation != null) presentation.dispose();
 }
        Parameters:
        paragraph - Paragraph object IParagraph
        effectType - Type of an animation effect EffectType
        subtype - Subtypes of animation effect EffectSubtype
        triggerType - Trigger type of effect EffectTriggerType
        Returns:
        New effect object IEffect

      • addEffect

        IEffect addEffect(IChart chart,
                  int type,
                  int index,
                  int effectType,
                  int subtype,
                  int triggerType)

        Adds the new chart animation effect for category or series to the end of sequence.

        Parameters:
        chart - Chart object IChart
        type - Type of an animation effect EffectChartMinorGroupingType
        index - Index int
        effectType - Type of an animation effect EffectType
        subtype - Subtypes of animation effect EffectSubtype
        triggerType - Trigger type of effect EffectTriggerType
        Returns:
        New effect object IEffect

      • addEffect

        IEffect addEffect(IChart chart,
                  int type,
                  int seriesIndex,
                  int categoriesIndex,
                  int effectType,
                  int subtype,
                  int triggerType)

        Adds the new chart animation effect for elements in category or series to the end of sequence.

        Parameters:
        chart - Chart object IChart
        type - Type of an animation effect EffectChartMinorGroupingType
        seriesIndex - Index of chart series int
        categoriesIndex - Index of category int
        effectType - Type of an animation effect EffectType
        subtype - Subtypes of animation effect EffectSubtype
        triggerType - Trigger type of effect EffectTriggerType
        Returns:
        New effect object IEffect