Aspose::Slides::Animation::Sequence Class Referencefinal

Represents sequence (collection of effects). More...

Inherits Aspose::Slides::Animation::ISequence.

Public Member Functions

int32_t get_Count () override
 Returns the number of effects in a sequense. Read-only int32_t. More...
 
System::SharedPtr< IShapeget_TriggerShape () override
 Returns shape target for INTERACTIVE sequence. If sequence is not interactive then returns null. Read IShape. More...
 
void set_TriggerShape (System::SharedPtr< IShape > value) override
 Sets shape target for INTERACTIVE sequence. If sequence is not interactive then returns null. Write IShape. More...
 
void Remove (System::SharedPtr< IEffect > item) override
 Removes specified effect from a collection. More...
 
void RemoveAt (int32_t index) override
 Removes an effect from a collection. More...
 
void Clear () override
 Removes all effects from a collection. More...
 
System::SharedPtr< IEffectidx_get (int32_t index) override
 Returns an effect at the specified index. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< IEffect > > > GetEnumerator () override
 Returns an enumerator that iterates through the collection. More...
 
void RemoveByShape (System::SharedPtr< IShape > shape) override
 Remove effect for the specified shape. More...
 
System::ArrayPtr< System::SharedPtr< IEffect > > GetEffectsByShape (System::SharedPtr< IShape > shape) override
 Returns array of effects for the specified shape. More...
 
System::ArrayPtr< System::SharedPtr< IEffect > > GetEffectsByParagraph (System::SharedPtr< IParagraph > paragraph) override
 Returns array of effects for the specified paragraph. More...
 
int32_t GetCount (System::SharedPtr< IShape > shape) override
 Returns count of effects for the specified shape. More...
 
System::SharedPtr< IEffectAddEffect (System::SharedPtr< IShape > shape, EffectType effectType, EffectSubtype subtype, EffectTriggerType triggerType) override
 Add new effect to the end of sequence. More...
 
System::SharedPtr< IEffectAddEffect (System::SharedPtr< IParagraph > paragraph, EffectType effectType, EffectSubtype subtype, EffectTriggerType triggerType) override
 Add new animation effect for paragraph to the end of sequence. More...
 
System::SharedPtr< IEffectAddEffect (System::SharedPtr< Aspose::Slides::Charts::IChart > chart, EffectChartMajorGroupingType type, int32_t index, EffectType effectType, EffectSubtype subtype, EffectTriggerType triggerType) override
 Adds the new chart animation effect for category or series to the end of sequence. More...
 
System::SharedPtr< IEffectAddEffect (System::SharedPtr< Aspose::Slides::Charts::IChart > chart, EffectChartMinorGroupingType type, int32_t seriesIndex, int32_t categoriesIndex, EffectType effectType, EffectSubtype subtype, EffectTriggerType triggerType) override
 Adds the new chart animation effect for elements in category or series to the end of sequence. More...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Slides::Animation::IEffect > >
System::SharedPtr< Aspose::Slides::Animation::IEffectLINQ_ElementAt (int index)
 Returns the element at a specified index in a sequence. More...
 
System::SharedPtr< Aspose::Slides::Animation::IEffectLINQ_First ()
 Returns the first element of a sequence. More...
 
System::SharedPtr< Aspose::Slides::Animation::IEffectLINQ_First (const Func< System::SharedPtr< Aspose::Slides::Animation::IEffect >, bool > &predicate)
 Returns the first element of a sequence that satisfy the specified condition. More...
 
System::SharedPtr< Aspose::Slides::Animation::IEffectLINQ_FirstOrDefault ()
 Returns the first element of a sequence, or a default value if the sequence is empty. More...
 
System::SharedPtr< Aspose::Slides::Animation::IEffectLINQ_FirstOrDefault (std::function< bool(System::SharedPtr< Aspose::Slides::Animation::IEffect >)> predicate)
 Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. More...
 
System::SharedPtr< Aspose::Slides::Animation::IEffectLINQ_Last ()
 Returns the last element of a sequence. More...
 
System::SharedPtr< Aspose::Slides::Animation::IEffectLINQ_LastOrDefault ()
 Returns the last element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< List< System::SharedPtr< Aspose::Slides::Animation::IEffect > > > LINQ_ToList ()
 Creates a List<T> from a sequence. More...
 
int LINQ_Count ()
 Returns the number of elements in the sequence (calculated via direct counting). More...
 
int LINQ_Count (const Func< System::SharedPtr< Aspose::Slides::Animation::IEffect >, bool > &predicate)
 Returns the number of elements in the sequence that satisfy the specified condition. More...
 
System::ArrayPtr< System::SharedPtr< Aspose::Slides::Animation::IEffect > > LINQ_ToArray ()
 Creates an array from a sequence. More...
 
bool LINQ_All (std::function< bool(System::SharedPtr< Aspose::Slides::Animation::IEffect >)> predicate)
 Determines whether all elements of a sequence satisfy a condition. More...
 
bool LINQ_Any ()
 Determines whether a sequence contains any elements. More...
 
bool LINQ_Any (std::function< bool(System::SharedPtr< Aspose::Slides::Animation::IEffect >)> predicate)
 Determines whether any element of a sequence exists or satisfies a condition. More...
 
SharedPtr< IEnumerable< System::SharedPtr< Aspose::Slides::Animation::IEffect > > > LINQ_Where (std::function< bool(System::SharedPtr< Aspose::Slides::Animation::IEffect >)> predicate)
 Filters a sequence based on the specified predicate. More...
 
bool LINQ_Contains (System::SharedPtr< Aspose::Slides::Animation::IEffect > value)
 Determines if a sequence contains a specified value. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 Casts the elements to the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
SharedPtr< IEnumerable< System::SharedPtr< Aspose::Slides::Animation::IEffect > > > LINQ_OrderBy (const Func< System::SharedPtr< Aspose::Slides::Animation::IEffect >, Key > &keySelector)
 Sorts the elements of a sequence in ascending order according to the key values selected by keySelector. More...
 
SharedPtr< IEnumerable< Source > > LINQ_OrderBy (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< System::SharedPtr< Aspose::Slides::Animation::IEffect > > > LINQ_OrderByDescending (const Func< System::SharedPtr< Aspose::Slides::Animation::IEffect >, Key > &keySelector)
 Sorts the elements of a sequence in descending order according to the key values selected by keySelector. More...
 
SharedPtr< IEnumerable< Source > > LINQ_OrderByDescending (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 Filters the elements of the sequence based on the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< System::SharedPtr< Aspose::Slides::Animation::IEffect >, ResultType > &selector)
 Transforms elements of a sequence. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< System::SharedPtr< Aspose::Slides::Animation::IEffect >, int32_t, ResultType > &selector)
 Transforms each element of a sequence into a new form by incorporating the element's index. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, int32_t, Result > &selector)
 
SharedPtr< IEnumerable< System::SharedPtr< Aspose::Slides::Animation::IEffect > > > LINQ_Concat (SharedPtr< IEnumerable< System::SharedPtr< Aspose::Slides::Animation::IEffect > >> sequence)
 Concatenates two sequences. More...
 
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, System::SharedPtr< Aspose::Slides::Animation::IEffect > > > > > LINQ_GroupBy (System::Func< System::SharedPtr< Aspose::Slides::Animation::IEffect >, Key > keyPredicate)
 Groups the elements of a sequence. More...
 
SharedPtr< IEnumerable< SharedPtr< System::Linq::IGrouping< Key, Source > > > > LINQ_GroupBy (System::Func< Source, Key > keyPredicate)
 
SharedPtr< IEnumerable< ResultType > > LINQ_SelectMany (const Func< System::SharedPtr< Aspose::Slides::Animation::IEffect >, SharedPtr< IEnumerable< ResultType >>> &selector)
 Projects each element of a sequence and combines the resulting sequences into one sequence. More...
 
SharedPtr< IEnumerable< Result > > LINQ_SelectMany (const Func< Source, SharedPtr< IEnumerable< Result >>> &selector)
 
iterator begin () noexcept
 Gets iterator pointing to the first element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator begin () const noexcept
 Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. More...
 
iterator end () noexcept
 Gets iterator pointing right after the last element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator end () const noexcept
 Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection. More...
 
const_iterator cbegin () const noexcept
 Gets iterator pointing to the first const-qualified element (if any) of the collection. More...
 
const_iterator cend () const noexcept
 Gets iterator pointing right after the last const-qualified element (if any) of the collection. More...
 
virtual virtualized_iteratorvirtualizeBeginIterator ()
 Gets the implementation of begin iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndIterator ()
 Gets the implementation of end iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeBeginConstIterator () const
 Gets the implementation of begin const iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndConstIterator () const
 Gets the implementation of end const iterator for the current container. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Protected Member Functions

virtual ~Sequence ()
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Slides::Animation::IEffect > >
 ~IEnumerable () override
 Destructor. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator ()
 Gets enumerator instance and prepares it to be used as iterator kernel. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator () const
 Gets enumerator instance and prepares it to be used as iterator kernel. More...
 

Additional Inherited Members

- Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Slides::Animation::IEffect > >
typedef IEnumerator< System::SharedPtr< Aspose::Slides::Animation::IEffect > > IEnumeratorType
 Enumerator type. More...
 
using ValueType = System::SharedPtr< Aspose::Slides::Animation::IEffect >
 
using iterator = System::Details::VirtualizedIterator< System::SharedPtr< Aspose::Slides::Animation::IEffect > >
 Iterator type. More...
 
using const_iterator = System::Details::VirtualizedConstIterator< System::SharedPtr< Aspose::Slides::Animation::IEffect > >
 Const iterator type. More...
 
using virtualized_iterator = System::Details::VirtualizedIteratorBase< System::SharedPtr< Aspose::Slides::Animation::IEffect > >
 Inner iterator base type. More...
 
using virtualized_iterator_element = System::SharedPtr< Aspose::Slides::Animation::IEffect >
 Inner iterator element type. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 

Detailed Description

Represents sequence (collection of effects).

Constructor & Destructor Documentation

◆ ~Sequence()

virtual Aspose::Slides::Animation::Sequence::~Sequence ( )
protectedvirtual

Member Function Documentation

◆ AddEffect() [1/4]

System::SharedPtr<IEffect> Aspose::Slides::Animation::Sequence::AddEffect ( System::SharedPtr< Aspose::Slides::Charts::IChart chart,
EffectChartMajorGroupingType  type,
int32_t  index,
EffectType  effectType,
EffectSubtype  subtype,
EffectTriggerType  triggerType 
)
overridevirtual

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

Parameters
chartChart object Aspose::Slides::Charts::IChart
typeType of an animation effect EffectChartMinorGroupingType
indexIndex int32_t
effectTypeType of an animation effect EffectType
subtypeSubtypes of animation effect EffectSubtype
triggerTypeTrigger type of effect EffectTriggerType
Returns
New effect object IEffect

Implements Aspose::Slides::Animation::ISequence.

◆ AddEffect() [2/4]

System::SharedPtr<IEffect> Aspose::Slides::Animation::Sequence::AddEffect ( System::SharedPtr< Aspose::Slides::Charts::IChart chart,
EffectChartMinorGroupingType  type,
int32_t  seriesIndex,
int32_t  categoriesIndex,
EffectType  effectType,
EffectSubtype  subtype,
EffectTriggerType  triggerType 
)
overridevirtual

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

Parameters
chartChart object Aspose::Slides::Charts::IChart
typeType of an animation effect EffectChartMinorGroupingType
seriesIndexIndex of chart series int32_t
categoriesIndexIndex of category int32_t
effectTypeType of an animation effect EffectType
subtypeSubtypes of animation effect EffectSubtype
triggerTypeTrigger type of effect EffectTriggerType
Returns
New effect object IEffect

Implements Aspose::Slides::Animation::ISequence.

◆ AddEffect() [3/4]

System::SharedPtr<IEffect> Aspose::Slides::Animation::Sequence::AddEffect ( System::SharedPtr< IParagraph paragraph,
EffectType  effectType,
EffectSubtype  subtype,
EffectTriggerType  triggerType 
)
overridevirtual

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

Parameters
paragraphParagraph object IParagraph
effectTypeType of an animation effect EffectType
subtypeSubtypes of animation effect EffectSubtype
triggerTypeTrigger type of effect EffectTriggerType
Returns
New effect object IEffect
auto presentation = System::MakeObject<Presentation>(path + u"input.pptx");
// select paragraph to add effect
auto autoShape = System::DynamicCast<Aspose::Slides::IAutoShape>(presentation->get_Slides()->idx_get(0)->get_Shapes()->idx_get(0));
auto paragraph = autoShape->get_TextFrame()->get_Paragraphs()->idx_get(0);
// add Fly animation effect to selected paragraph
auto effect = presentation->get_Slides()->idx_get(0)->get_Timeline()->get_MainSequence()->AddEffect(
paragraph,

Implements Aspose::Slides::Animation::ISequence.

◆ AddEffect() [4/4]

System::SharedPtr<IEffect> Aspose::Slides::Animation::Sequence::AddEffect ( System::SharedPtr< IShape shape,
EffectType  effectType,
EffectSubtype  subtype,
EffectTriggerType  triggerType 
)
overridevirtual

Add new effect to the end of sequence.

Parameters
shapeShape object IShape for adding an effect
effectTypeType of an animation effect EffectType
subtypeSubtypes of animation effect EffectSubtype
triggerTypeTrigger type of effect EffectTriggerType
Returns
New effect object IEffect

Implements Aspose::Slides::Animation::ISequence.

◆ Clear()

void Aspose::Slides::Animation::Sequence::Clear ( )
overridevirtual

Removes all effects from a collection.

Implements Aspose::Slides::Animation::ISequence.

◆ get_Count()

int32_t Aspose::Slides::Animation::Sequence::get_Count ( )
overridevirtual

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

Implements Aspose::Slides::Animation::ISequence.

◆ get_TriggerShape()

System::SharedPtr<IShape> Aspose::Slides::Animation::Sequence::get_TriggerShape ( )
overridevirtual

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

Implements Aspose::Slides::Animation::ISequence.

◆ GetCount()

int32_t Aspose::Slides::Animation::Sequence::GetCount ( System::SharedPtr< IShape shape)
overridevirtual

Returns count of effects for the specified shape.

Implements Aspose::Slides::Animation::ISequence.

◆ GetEffectsByParagraph()

System::ArrayPtr<System::SharedPtr<IEffect> > Aspose::Slides::Animation::Sequence::GetEffectsByParagraph ( System::SharedPtr< IParagraph paragraph)
overridevirtual

Returns array of effects for the specified paragraph.

Implements Aspose::Slides::Animation::ISequence.

◆ GetEffectsByShape()

System::ArrayPtr<System::SharedPtr<IEffect> > Aspose::Slides::Animation::Sequence::GetEffectsByShape ( System::SharedPtr< IShape shape)
overridevirtual

Returns array of effects for the specified shape.

Implements Aspose::Slides::Animation::ISequence.

◆ GetEnumerator()

System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<IEffect> > > Aspose::Slides::Animation::Sequence::GetEnumerator ( )
overridevirtual

Returns an enumerator that iterates through the collection.

Returns
A System::Collections::Generic::IEnumerator<IEffect> that can be used to iterate through the collection.

Implements System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Slides::Animation::IEffect > >.

◆ idx_get()

System::SharedPtr<IEffect> Aspose::Slides::Animation::Sequence::idx_get ( int32_t  index)
overridevirtual

Returns an effect at the specified index.

Parameters
index
Returns

Implements Aspose::Slides::Animation::ISequence.

◆ Remove()

void Aspose::Slides::Animation::Sequence::Remove ( System::SharedPtr< IEffect item)
overridevirtual

Removes specified effect from a collection.

Parameters
itemEffect to remove.

Implements Aspose::Slides::Animation::ISequence.

◆ RemoveAt()

void Aspose::Slides::Animation::Sequence::RemoveAt ( int32_t  index)
overridevirtual

Removes an effect from a collection.

Parameters
index

Implements Aspose::Slides::Animation::ISequence.

◆ RemoveByShape()

void Aspose::Slides::Animation::Sequence::RemoveByShape ( System::SharedPtr< IShape shape)
overridevirtual

Remove effect for the specified shape.

Implements Aspose::Slides::Animation::ISequence.

◆ set_TriggerShape()

void Aspose::Slides::Animation::Sequence::set_TriggerShape ( System::SharedPtr< IShape value)
overridevirtual

Sets shape target for INTERACTIVE sequence. If sequence is not interactive then returns null. Write IShape.

Implements Aspose::Slides::Animation::ISequence.