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 () override
 Returns the number of gradient stops in a collection. Read-only int32_t. More...
 
bool get_IsSynchronized () override
 Returns a value indicating whether access to the collection is synchronized (thread-safe). Read-only bool. More...
 
System::SharedPtr< System::Objectget_SyncRoot () override
 Returns a synchronization root. Read-only System::Object. More...
 
System::SharedPtr< IGradientStopidx_get (int32_t index) override
 Returns the gradient stop by index. More...
 
System::SharedPtr< IGradientStopAdd (float position, System::Drawing::Color color) override
 Creates the new gradient stop and adds it to the end of collection. More...
 
System::SharedPtr< IGradientStopAdd (float position, PresetColor presetColor) override
 Creates the new gradient stop and adds it to the end of collection. More...
 
System::SharedPtr< IGradientStopAdd (float position, SchemeColor schemeColor) override
 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) override
 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) override
 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) override
 Creates the new gradient stop and inserts it at the specified index to the collection. More...
 
void RemoveAt (int32_t index) override
 Removes a gradient stop at the specified index. More...
 
void Clear () override
 Removes all gradient stops from a collection. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< IGradientStop > > > GetEnumerator () override
 Returns an enumerator that iterates through the collection. More...
 
void CopyTo (System::ArrayPtr< System::SharedPtr< IGradientStop >> array, int32_t index) override
 Copies all elements from the collection to the specified array. More...
 
- Public Member Functions inherited from Aspose::Slides::PVIObject
bool Equals (System::SharedPtr< System::Object > obj) override
 Compares with specified object. More...
 
int32_t GetHashCode () const override
 Returns hash code. More...
 
System::String ToString () const override
 Returns string representation. More...
 
- Public Member Functions inherited from Aspose::Slides::IPVIObject
virtual System::SharedPtr< IPresentationComponentget_Parent_IPresentationComponent ()=0
 Returns parent IPresentationComponent. Read-only IPresentationComponent. More...
 
virtual uint32_t get_Version ()=0
 Version. Read-only uint32_t. More...
 
- Public Member Functions inherited from Aspose::Slides::IDOMObject
virtual System::SharedPtr< IDOMObjectget_Parent_Immediate ()=0
 Returns Parent_Immediate object. Read-only IDOMObject. More...
 
virtual System::String get_DOMPath ()=0
 Returns DOM path. Read-only System::String. 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 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...
 
- 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...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< T >
LINQ_ElementAt (int index)
 Returns the element at a specified index in a sequence. More...
 
LINQ_First ()
 Returns the first element of a sequence. More...
 
LINQ_First (const Func< T, bool > &predicate)
 Returns the first element of a sequence that satisfy the specified condition. More...
 
LINQ_FirstOrDefault ()
 Returns the first element of a sequence, or a default value if the sequence is empty. More...
 
LINQ_FirstOrDefault (std::function< bool(T)> predicate)
 Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. More...
 
LINQ_Last ()
 Returns the last element of a sequence. More...
 
LINQ_LastOrDefault ()
 Returns the last element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< List< T > > 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< T, bool > &predicate)
 Returns the number of elements in the sequence that satisfy the specified condition. More...
 
System::ArrayPtr< T > LINQ_ToArray ()
 Creates an array from a sequence. More...
 
bool LINQ_All (std::function< bool(T)> 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(T)> predicate)
 Determines whether any element of a sequence exists or satisfies a condition. More...
 
SharedPtr< IEnumerable< T > > LINQ_Where (std::function< bool(T)> predicate)
 Filters a sequence based on the specified predicate. More...
 
bool LINQ_Contains (T value)
 Determines if a sequence contains a specified value. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 Casts the elements to the specified type. More...
 
template<typename Key >
SharedPtr< IEnumerable< T > > LINQ_OrderBy (const Func< T, Key > &keySelector)
 Sorts the elements of a sequence in ascending order according to the key values selected by keySelector. More...
 
template<typename Key >
SharedPtr< IEnumerable< T > > LINQ_OrderByDescending (const Func< T, Key > &keySelector)
 Sorts the elements of a sequence in descending order according to the key values selected by keySelector. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 Filters the elements of the sequence based on the specified type. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< T, ResultType > &selector)
 Transforms elements of a sequence. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< T, int32_t, ResultType > &selector)
 Transforms each element of a sequence into a new form by incorporating the element's index. More...
 
SharedPtr< IEnumerable< T > > LINQ_Concat (SharedPtr< IEnumerable< T >> sequence)
 Concatenates two sequences. More...
 
template<typename Key >
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, T > > > > LINQ_GroupBy (System::Func< T, Key > keyPredicate)
 Groups the elements of a sequence. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_SelectMany (const Func< T, SharedPtr< IEnumerable< ResultType >>> &selector)
 Projects each element of a sequence and combines the resulting sequences into one sequence. More...
 
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...
 
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 begin () const noexcept
 Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. 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...
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, int32_t, Result > &selector)
 
template<typename Key >
SharedPtr< IEnumerable< Source > > LINQ_OrderBy (const Func< Source, Key > &keySelector)
 
template<typename Key >
SharedPtr< IEnumerable< Source > > LINQ_OrderByDescending (const Func< Source, Key > &keySelector)
 
template<typename Key >
SharedPtr< IEnumerable< SharedPtr< System::Linq::IGrouping< Key, Source > > > > LINQ_GroupBy (System::Func< Source, Key > keyPredicate)
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_SelectMany (const Func< Source, SharedPtr< IEnumerable< Result >>> &selector)
 

Protected Member Functions

void CreateChildObjects () override
 
System::SharedPtr< System::ObjectCreateRealObject () override
 
virtual ~GradientStopCollection ()
 
- Protected Member Functions inherited from Aspose::Slides::PVIObject
virtual ~PVIObject ()
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< T >
 ~IEnumerable () override
 Destructor. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< T >
typedef IEnumerator< T > IEnumeratorType
 Enumerator type. More...
 
using ValueType = T
 
using iterator = EnumeratorBasedIterator< T, IEnumerator< T > >
 
using const_iterator = iterator
 
- 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

Represnts a collection of gradient stops.

Constructor & Destructor Documentation

◆ ~GradientStopCollection()

virtual Aspose::Slides::GradientStopCollection::~GradientStopCollection ( )
protectedvirtual

Member Function Documentation

◆ Add() [1/3]

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

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

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

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

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

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.

◆ Clear()

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

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

Copies all elements from the collection to the specified array.

Parameters
arrayTarget array.
indexStarting index in the target array.

◆ CreateChildObjects()

void Aspose::Slides::GradientStopCollection::CreateChildObjects ( )
overrideprotected

◆ CreateRealObject()

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

◆ get_Count()

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

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 ( )
overridevirtual

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_SyncRoot()

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

◆ GetEnumerator()

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

Returns an enumerator that iterates through the collection.

Returns
A IEnumerator that can be used to iterate through the collection.

Implements System::Collections::Generic::IEnumerable< T >.

◆ idx_get()

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

Returns the gradient stop by index.

Implements Aspose::Slides::IGradientStopCollection.

◆ Insert() [1/3]

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

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

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

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.

◆ Insert() [3/3]

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

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.

◆ RemoveAt()

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

Removes a gradient stop at the specified index.

Parameters
indexIndex of a gradient stop that should be deleted.

Implements Aspose::Slides::IGradientStopCollection.