Aspose::Slides::GradientStopCollection Class Referencefinal

Represnts a collection of gradient stops. More...

Inherits Aspose::Slides::PVIObject, and Aspose::Slides::IGradientStopCollection.

Public Member Functions

int32_t get_Count ()
 Returns the number of gradient stops in a collection. Read-only int32_t. More...
 
bool get_IsSynchronized ()
 Returns a value indicating whether access to the collection is synchronized (thread-safe). Read-only bool. More...
 
System::SharedPtr< System::Objectget_SyncRoot ()
 Returns a synchronization root. Read-only object. More...
 
System::SharedPtr< IGradientStopidx_get (int32_t index)
 Returns the gradient stop by index. More...
 
System::SharedPtr< IGradientStopAdd (float position, System::Drawing::Color color)
 Creates the new gradient stop and adds it to the end of collection. More...
 
System::SharedPtr< IGradientStopAdd (float position, PresetColor presetColor)
 Creates the new gradient stop and adds it to the end of collection. More...
 
System::SharedPtr< IGradientStopAdd (float position, SchemeColor schemeColor)
 Creates the new gradient stop and adds it to the end of collection. More...
 
void Insert (int32_t index, float position, System::Drawing::Color color)
 Creates the new gradient stop and inserts it at the specified index to the collection. More...
 
void Insert (int32_t index, float position, PresetColor presetColor)
 Creates the new gradient stop and inserts it at the specified index to the collection. More...
 
void Insert (int32_t index, float position, SchemeColor schemeColor)
 Creates the new gradient stop and inserts it at the specified index to the collection. More...
 
void RemoveAt (int32_t index)
 Removes a gradient stop at the specified index. More...
 
void Clear ()
 Removes all gradient stops from a collection. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< IGradientStop > > > GetEnumerator ()
 Returns an enumerator that iterates through the collection. More...
 
void CopyTo (System::ArrayPtr< System::SharedPtr< IGradientStop >> array, int32_t index)
 
- Public Member Functions inherited from Aspose::Slides::PVIObject
virtual bool Equals (System::SharedPtr< System::Object > obj)
 Compares with specified object. More...
 
virtual int32_t GetHashCode () const
 Returns hash code. 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 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)
 
- Public Member Functions inherited from Aspose::Slides::IGenericCollection< System::SharedPtr< Aspose::Slides::IGradientStop > >
virtual void CopyTo (System::ArrayPtr< System::SharedPtr< Aspose::Slides::IGradientStop > > array, int32_t index)=0
 Copies all elements from the collection into the specified array. More...
 

Protected Member Functions

System::SharedPtr< GradientStopCollectionImpl > get_RealObject ()
 
 GradientStopCollection (System::SharedPtr< IDOMObject > parentImmediate)
 
virtual void CreateChildObjects ()
 
virtual System::SharedPtr< System::ObjectCreateRealObject ()
 
System::SharedPtr< GradientStopCollectionEffectiveDataGetEffective ()
 
System::SharedPtr< IGradientStopAdd ()
 
System::SharedPtr< IGradientStopNoEventAdd ()
 
void NoEventClear ()
 
System::SharedPtr< GradientStopGetByPosition (float position)
 Returns the gradient stop with specified position value or null if there no one. More...
 
void OnGradientStopCollectionChanged ()
 
- Protected Member Functions inherited from Aspose::Slides::PVIObject
System::SharedPtr< ObjectWrapper > get_Wrapper () const
 
System::SharedPtr< IDOMObjectget_Parent_Immediate ()
 Returns Parent_Immediate object. Read-only IDOMObject. More...
 
void set_Parent_Immediate (System::SharedPtr< IDOMObject > value)
 
virtual uint32_t get_Version ()
 Version. Read-only uint32_t. More...
 
System::SharedPtr< IPresentationComponentget_Parent_IPresentationComponent ()
 Returns parent IPresentationComponent. Read-only IPresentationComponent. More...
 
System::SharedPtr< ISlideComponentget_Parent_ISlideComponent ()
 
System::SharedPtr< BaseSlideget_Slide ()
 
System::SharedPtr< Aspose::Slides::Presentationget_Presentation ()
 
 PVIObject (System::SharedPtr< IDOMObject > parentImmediate)
 
void Reset_Parent_IPresentationComponent ()
 

Protected Attributes

System::Event< void()> GradientStopCollectionChanged
 

Additional Inherited Members

- 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...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Slides::IGradientStop > >
typedef IEnumerator< System::SharedPtr< Aspose::Slides::IGradientStop > > IEnumeratorType
 Enumerator 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 ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Detailed Description

Represnts a collection of gradient stops.

Constructor & Destructor Documentation

◆ GradientStopCollection()

Aspose::Slides::GradientStopCollection::GradientStopCollection ( System::SharedPtr< IDOMObject parentImmediate)
protected

Member Function Documentation

◆ Add() [1/4]

System::SharedPtr<IGradientStop> Aspose::Slides::GradientStopCollection::Add ( float  position,
System::Drawing::Color  color 
)
virtual

Creates the new gradient stop and adds it to the end of collection.

Parameters
positionPosition of the new gradient stop.
colorColor of the new radient stop.
Returns
Index of the new gradient stop in the collection.

Implements Aspose::Slides::IGradientStopCollection.

◆ Add() [2/4]

System::SharedPtr<IGradientStop> Aspose::Slides::GradientStopCollection::Add ( float  position,
PresetColor  presetColor 
)
virtual

Creates the new gradient stop and adds it to the end of collection.

Parameters
positionPosition of the new gradient stop.
presetColorColor of the new radient stop.
Returns
Index of the new gradient stop in the collection.

Implements Aspose::Slides::IGradientStopCollection.

◆ Add() [3/4]

System::SharedPtr<IGradientStop> Aspose::Slides::GradientStopCollection::Add ( float  position,
SchemeColor  schemeColor 
)
virtual

Creates the new gradient stop and adds it to the end of collection.

Parameters
positionPosition of the new gradient stop.
schemeColorColor of the new radient stop.
Returns
Index of the new gradient stop in the collection.

Implements Aspose::Slides::IGradientStopCollection.

◆ Add() [4/4]

System::SharedPtr<IGradientStop> Aspose::Slides::GradientStopCollection::Add ( )
protected

◆ Clear()

void Aspose::Slides::GradientStopCollection::Clear ( )
virtual

Removes all gradient stops from a collection.

Implements Aspose::Slides::IGradientStopCollection.

◆ CopyTo()

void Aspose::Slides::GradientStopCollection::CopyTo ( System::ArrayPtr< System::SharedPtr< IGradientStop >>  array,
int32_t  index 
)

◆ CreateChildObjects()

virtual void Aspose::Slides::GradientStopCollection::CreateChildObjects ( )
protectedvirtual

◆ CreateRealObject()

virtual System::SharedPtr<System::Object> Aspose::Slides::GradientStopCollection::CreateRealObject ( )
protectedvirtual

◆ get_Count()

int32_t Aspose::Slides::GradientStopCollection::get_Count ( )
virtual

Returns the number of gradient stops in a collection. Read-only int32_t.

Implements Aspose::Slides::IGenericCollection< System::SharedPtr< Aspose::Slides::IGradientStop > >.

◆ get_IsSynchronized()

bool Aspose::Slides::GradientStopCollection::get_IsSynchronized ( )
virtual

Returns a value indicating whether access to the collection is synchronized (thread-safe). Read-only bool.

Implements Aspose::Slides::IGenericCollection< System::SharedPtr< Aspose::Slides::IGradientStop > >.

◆ get_RealObject()

System::SharedPtr<GradientStopCollectionImpl> Aspose::Slides::GradientStopCollection::get_RealObject ( )
protected

◆ get_SyncRoot()

System::SharedPtr<System::Object> Aspose::Slides::GradientStopCollection::get_SyncRoot ( )
virtual

Returns a synchronization root. Read-only object.

Implements Aspose::Slides::IGenericCollection< System::SharedPtr< Aspose::Slides::IGradientStop > >.

◆ GetByPosition()

System::SharedPtr<GradientStop> Aspose::Slides::GradientStopCollection::GetByPosition ( float  position)
protected

Returns the gradient stop with specified position value or null if there no one.

◆ GetEffective()

System::SharedPtr<GradientStopCollectionEffectiveData> Aspose::Slides::GradientStopCollection::GetEffective ( )
protected

◆ GetEnumerator()

System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<IGradientStop> > > Aspose::Slides::GradientStopCollection::GetEnumerator ( )
virtual

Returns an enumerator that iterates through the collection.

Returns
A T:System::Collections::Generic::IEnumerator`1 that can be used to iterate through the collection.

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

◆ idx_get()

System::SharedPtr<IGradientStop> Aspose::Slides::GradientStopCollection::idx_get ( int32_t  index)
virtual

Returns the gradient stop by index.

Implements Aspose::Slides::IGradientStopCollection.

◆ Insert() [1/3]

void Aspose::Slides::GradientStopCollection::Insert ( int32_t  index,
float  position,
System::Drawing::Color  color 
)
virtual

Creates the new gradient stop and inserts it at the specified index to the collection.

Parameters
indexIndex in the collection where new gradient stop will be inserted.
positionPosition of the new gradient stop.
colorColor of the new radient stop.

Implements Aspose::Slides::IGradientStopCollection.

◆ Insert() [2/3]

void Aspose::Slides::GradientStopCollection::Insert ( int32_t  index,
float  position,
PresetColor  presetColor 
)
virtual

Creates the new gradient stop and inserts it at the specified index to the collection.

Parameters
indexIndex in the collection where new gradient stop will be inserted.
positionPosition of the new gradient stop.
presetColorColor of the new radient stop.

Implements Aspose::Slides::IGradientStopCollection.

◆ Insert() [3/3]

void Aspose::Slides::GradientStopCollection::Insert ( int32_t  index,
float  position,
SchemeColor  schemeColor 
)
virtual

Creates the new gradient stop and inserts it at the specified index to the collection.

Parameters
indexIndex in the collection where new gradient stop will be inserted.
positionPosition of the new gradient stop.
schemeColorColor of the new radient stop.

Implements Aspose::Slides::IGradientStopCollection.

◆ NoEventAdd()

System::SharedPtr<IGradientStop> Aspose::Slides::GradientStopCollection::NoEventAdd ( )
protected

◆ NoEventClear()

void Aspose::Slides::GradientStopCollection::NoEventClear ( )
protected

◆ OnGradientStopCollectionChanged()

void Aspose::Slides::GradientStopCollection::OnGradientStopCollectionChanged ( )
protected

◆ RemoveAt()

void Aspose::Slides::GradientStopCollection::RemoveAt ( int32_t  index)
virtual

Removes a gradient stop at the specified index.

Parameters
indexIndex of a gradient stop that should be deleted.

Implements Aspose::Slides::IGradientStopCollection.

Member Data Documentation

◆ GradientStopCollectionChanged

System::Event<void()> Aspose::Slides::GradientStopCollection::GradientStopCollectionChanged
protected