ISequence

All Implemented Interfaces: com.aspose.ms.System.Collections.Generic.IGenericEnumerable

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

Represents sequence (collection of effects).

Methods

Method	Description
getCount()	Returns the number of effects in a sequense.
remove(IEffect item)	Removes specified effect from a collection.
removeAt(int index)	Removes an effect from a collection.
clear()	Removes all effects from a collection.
get_Item(int index)	Returns an effect at the specified index.
getTriggerShape()	Returns or sets shape target for INTERACTIVE sequence.
setTriggerShape(IShape value)	Returns or sets shape target for INTERACTIVE sequence.
removeByShape(IShape shape)	Remove effect for the specified shape.
getEffectsByShape(IShape shape)	Returns array of effects for the specified shape.
getEffectsByParagraph(IParagraph paragraph)	Returns array of effects for the specified paragraph.
getCount(IShape shape)	Returns count of effects for the specified shape.
addEffect(IShape shape, int effectType, int subtype, int triggerType)	Add new effect to the end of sequence.
addEffect(IParagraph paragraph, int effectType, int subtype, int triggerType)	Add new animation effect for paragraph to the end of sequence.
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.
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.

getCount()

public abstract int getCount()

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

Returns: int

remove(IEffect item)

public abstract void remove(IEffect item)

Removes specified effect from a collection.

Parameters:

Parameter	Type	Description
item	IEffect	Effect to remove.

removeAt(int index)

public abstract void removeAt(int index)

Removes an effect from a collection.

Parameters:

Parameter	Type	Description
index	int	Index of effect to remove int

clear()

public abstract void clear()

Removes all effects from a collection.

get_Item(int index)

public abstract IEffect get_Item(int index)

Returns an effect at the specified index.

Parameters:

Parameter	Type	Description
index	int	Index of element.

Returns: IEffect - The IEffect object.

getTriggerShape()

public abstract IShape getTriggerShape()

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

Returns: IShape

setTriggerShape(IShape value)

public abstract void setTriggerShape(IShape value)

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

Parameters:

Parameter	Type	Description
value	IShape

removeByShape(IShape shape)

public abstract void removeByShape(IShape shape)

Remove effect for the specified shape.

Parameters:

Parameter	Type	Description
shape	IShape	Shape object IShape

getEffectsByShape(IShape shape)

public abstract IEffect[] getEffectsByShape(IShape shape)

Returns array of effects for the specified shape.

Parameters:

Parameter	Type	Description
shape	IShape	Shape object IShape

Returns: com.aspose.slides.IEffect[] - Array of effects IEffect

getEffectsByParagraph(IParagraph paragraph)

public abstract IEffect[] getEffectsByParagraph(IParagraph paragraph)

Returns array of effects for the specified paragraph.

Parameters:

Parameter	Type	Description
paragraph	IParagraph	Paragraph object IParagraph

Returns: com.aspose.slides.IEffect[] - Array of effects IEffect

getCount(IShape shape)

public abstract int getCount(IShape shape)

Returns count of effects for the specified shape.

Parameters:

Parameter	Type	Description
shape	IShape	Shape object IShape

Returns: int - Count of effects int

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

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

Add new effect to the end of sequence.

Parameters:

Parameter	Type	Description
shape	IShape	Shape object IShape for adding an effect
effectType	int	Type of an animation effect EffectType
subtype	int	Subtypes of animation effect EffectSubtype
triggerType	int	Trigger type of effect EffectTriggerType

Returns: IEffect - New effect object IEffect

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

public abstract 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:

Parameter	Type	Description
paragraph	IParagraph	Paragraph object IParagraph
effectType	int	Type of an animation effect EffectType
subtype	int	Subtypes of animation effect EffectSubtype
triggerType	int	Trigger type of effect EffectTriggerType

Returns: IEffect - New effect object IEffect

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

public abstract 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:

Parameter	Type	Description
chart	IChart	Chart object IChart
type	int	Type of an animation effect EffectChartMinorGroupingType
index	int	Index int
effectType	int	Type of an animation effect EffectType
subtype	int	Subtypes of animation effect EffectSubtype
triggerType	int	Trigger type of effect EffectTriggerType

Returns: IEffect - New effect object IEffect

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

public abstract 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:

Parameter	Type	Description
chart	IChart	Chart object IChart
type	int	Type of an animation effect EffectChartMinorGroupingType
seriesIndex	int	Index of chart series int
categoriesIndex	int	Index of category int
effectType	int	Type of an animation effect EffectType
subtype	int	Subtypes of animation effect EffectSubtype
triggerType	int	Trigger type of effect EffectTriggerType

Returns: IEffect - New effect object IEffect