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

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

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

Public Member Functions

int32_t get_Count ()
 Returns the number of effects in a sequense. Read-only int32_t. More...
 
System::SharedPtr< IShapeget_TriggerShape ()
 Returns shape target for INTERACTIVE sequence. If sequence is not interactive then returns null. Read IShape. More...
 
void set_TriggerShape (System::SharedPtr< IShape > value)
 Sets shape target for INTERACTIVE sequence. If sequence is not interactive then returns null. Write IShape. More...
 
void Remove (System::SharedPtr< IEffect > item)
 Removes specified effect from a collection. More...
 
void RemoveAt (int32_t index)
 Removes an effect from a collection. More...
 
void Clear ()
 Removes all effects from a collection. More...
 
System::SharedPtr< IEffectidx_get (int32_t index)
 Returns an effect at the specified index. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< IEffect > > > GetEnumerator ()
 Returns an enumerator that iterates through the collection. More...
 
void RemoveByShape (System::SharedPtr< IShape > shape)
 Remove effect for the specified shape. More...
 
System::ArrayPtr< System::SharedPtr< IEffect > > GetEffectsByShape (System::SharedPtr< IShape > shape)
 Returns array of effects for the specified shape. More...
 
System::ArrayPtr< System::SharedPtr< IEffect > > GetEffectsByParagraph (System::SharedPtr< IParagraph > paragraph)
 Returns array of effects for the specified paragraph. More...
 
int32_t GetCount (System::SharedPtr< IShape > shape)
 Returns count of effects for the specified shape. More...
 
System::SharedPtr< IEffectAddEffect (System::SharedPtr< IShape > shape, EffectType effectType, EffectSubtype subtype, EffectTriggerType triggerType)
 Add new effect to the end of sequence. More...
 
System::SharedPtr< IEffectAddEffect (System::SharedPtr< IParagraph > paragraph, EffectType effectType, EffectSubtype subtype, EffectTriggerType triggerType)
 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)
 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)
 Adds the new chart animation effect for elements in category or series to the end of sequence. 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 refernce 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 int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_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 (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Protected Member Functions

System::SharedPtr< Aspose::Slides::UnsupportedProps::PPTXUnsupportedProps::TimeLine::SequencePPTXUnsupportedProps > get_PPTXUnsupportedProps ()
 
int32_t get_EffectTimelineId ()
 
 Sequence (System::SharedPtr< AnimationTimeLine > parent)
 
System::ArrayPtr< System::SharedPtr< Effect > > GetEffectsByShapeId (uint32_t shapeId)
 Returns array of effects for the specified shape id. More...
 
System::SharedPtr< EffectAddEffect (System::SharedPtr< IShape > shape, EffectType effectType, EffectSubtype subtype, EffectPresetClassType classType, EffectTriggerType triggerType)
 
System::SharedPtr< ShapeGetShapeFromID (int32_t shapeIndex)
 
int32_t GetNextEffectTimelineId ()
 
virtual ~Sequence ()
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Slides::Animation::IEffect > >
 ~IEnumerable () override
 Destructor. 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...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. 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 ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Detailed Description

Represent sequence (collection of effects).

Constructor & Destructor Documentation

◆ Sequence()

Aspose::Slides::Animation::Sequence::Sequence ( System::SharedPtr< AnimationTimeLine parent)
protected

◆ ~Sequence()

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

Member Function Documentation

◆ AddEffect() [1/5]

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

Add new effect to the end of sequence.

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

◆ AddEffect() [2/5]

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

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

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() [3/5]

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 
)
virtual

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

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

◆ AddEffect() [4/5]

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 
)
virtual

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

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

◆ AddEffect() [5/5]

System::SharedPtr<Effect> Aspose::Slides::Animation::Sequence::AddEffect ( System::SharedPtr< IShape shape,
EffectType  effectType,
EffectSubtype  subtype,
EffectPresetClassType  classType,
EffectTriggerType  triggerType 
)
protected

◆ Clear()

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

Removes all effects from a collection.

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

◆ get_Count()

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

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

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

◆ get_EffectTimelineId()

int32_t Aspose::Slides::Animation::Sequence::get_EffectTimelineId ( )
protected

◆ get_PPTXUnsupportedProps()

System::SharedPtr<Aspose::Slides::UnsupportedProps::PPTXUnsupportedProps::TimeLine::SequencePPTXUnsupportedProps> Aspose::Slides::Animation::Sequence::get_PPTXUnsupportedProps ( )
protected

◆ get_TriggerShape()

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

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)
virtual

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)
virtual

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)
virtual

Returns array of effects for the specified shape.

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

◆ GetEffectsByShapeId()

System::ArrayPtr<System::SharedPtr<Effect> > Aspose::Slides::Animation::Sequence::GetEffectsByShapeId ( uint32_t  shapeId)
protected

Returns array of effects for the specified shape id.

◆ GetEnumerator()

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

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 > >.

◆ GetNextEffectTimelineId()

int32_t Aspose::Slides::Animation::Sequence::GetNextEffectTimelineId ( )
protected

◆ GetShapeFromID()

System::SharedPtr<Shape> Aspose::Slides::Animation::Sequence::GetShapeFromID ( int32_t  shapeIndex)
protected

◆ idx_get()

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

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)
virtual

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)
virtual

Removes an effect from a collection.

Parameters
index

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

◆ RemoveByShape()

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

Remove effect for the specified shape.

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

◆ set_TriggerShape()

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

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

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