Aspose::Slides::Charts::ChartCategoryCollection Class Reference

Represents collection of ChartCategory More...

Inherits Aspose::Slides::Charts::IChartCategoryCollection, and Aspose::Slides::IDOMObject.

Public Member Functions

ASPOSE_SLIDES_SHARED_API bool get_UseCells ()
 If true then worksheet is used for storing categories (this case supports a multi-level categories). If false then worksheet is NOT used for storing values (and this case doesn't support a multi-level categories). Read bool. More...
 
ASPOSE_SLIDES_SHARED_API void set_UseCells (bool value)
 If true then worksheet is used for storing categories (this case supports a multi-level categories). If false then worksheet is NOT used for storing values (and this case doesn't support a multi-level categories). Write bool. More...
 
ASPOSE_SLIDES_SHARED_API int32_t get_GroupingLevelCount ()
 Returns count of category grouping levels used. Is more then one for multilevel categories. Read-only int32_t. More...
 
ASPOSE_SLIDES_SHARED_API int32_t get_Count ()
 Returns a number of elements int the collection. Read-only int32_t. More...
 
ASPOSE_SLIDES_SHARED_API bool get_IsSynchronized ()
 Returns a value indicating whether access to the List is synchronized (thread safe). Read-only bool. More...
 
ASPOSE_SLIDES_SHARED_API System::SharedPtr< System::Objectget_SyncRoot ()
 Returns an object that can be used to synchronize access to the collection. Read-only object. More...
 
ASPOSE_SLIDES_SHARED_API System::SharedPtr< IChartCategoryidx_get (int32_t index)
 Gets the element at the specified index. More...
 
ASPOSE_SLIDES_SHARED_API System::SharedPtr< IChartCategoryAdd (System::SharedPtr< IChartDataCell > chartDataCell)
 If category exists in collection, return it. Else creates new chart category from IChartDataCell and adds it to the collection. More...
 
ASPOSE_SLIDES_SHARED_API System::SharedPtr< IChartCategoryAdd (System::SharedPtr< System::Object > value)
 Creates new ChartCategory from value and adds it to the collection. More...
 
ASPOSE_SLIDES_SHARED_API int32_t IndexOf (System::SharedPtr< IChartCategory > value)
 Searches for the specified ChartCategory and returns the zero-based index of the first occurrence within the entire Collection. More...
 
ASPOSE_SLIDES_SHARED_API void Remove (System::SharedPtr< IChartCategory > value)
 Removes the specified value. More...
 
ASPOSE_SLIDES_SHARED_API void RemoveAt (int32_t index)
 Removes the element at the given index. More...
 
ASPOSE_SLIDES_SHARED_API void Clear ()
 Removes all elements from the collection. More...
 
ASPOSE_SLIDES_SHARED_API System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< IChartCategory > > > GetEnumerator ()
 Returns an enumerator that iterates through the collection. More...
 
ASPOSE_SLIDES_SHARED_API void CopyTo (System::ArrayPtr< System::SharedPtr< IChartCategory >> array, int32_t index)
 Copies all elements of the collection to the specified array. More...
 

Protected Member Functions

System::SharedPtr< Aspose::Slides::UnsupportedProps::PPTXUnsupportedProps::Charts::ChartCategoryCollectionPPTXUnsupportedProps > get_PPTXUnsupportedProps ()
 
 ChartCategoryCollection (System::SharedPtr< ChartData > parentImmediate)
 
void RemoveInternal (System::SharedPtr< ChartCategory > value)
 Removes ChartCategory from m_items list. But doesn't do this: ChartCategory.m_parent = null; More...
 
void Add (System::SharedPtr< IChartCategory > category)
 Adds ChartCategory object to collection More...
 
System::String GetCellsAddress ()
 Returns address of the set of cells in workbook. More...
 

Detailed Description

Represents collection of ChartCategory

Constructor & Destructor Documentation

◆ ChartCategoryCollection()

Aspose::Slides::Charts::ChartCategoryCollection::ChartCategoryCollection ( System::SharedPtr< ChartData parentImmediate)
protected

Member Function Documentation

◆ Add() [1/3]

ASPOSE_SLIDES_SHARED_API System::SharedPtr<IChartCategory> Aspose::Slides::Charts::ChartCategoryCollection::Add ( System::SharedPtr< IChartDataCell chartDataCell)
virtual

If category exists in collection, return it. Else creates new chart category from IChartDataCell and adds it to the collection.

Parameters
chartDataCellCell used to create chart category.
Returns
Added or existing category.

Implements Aspose::Slides::Charts::IChartCategoryCollection.

◆ Add() [2/3]

ASPOSE_SLIDES_SHARED_API System::SharedPtr<IChartCategory> Aspose::Slides::Charts::ChartCategoryCollection::Add ( System::SharedPtr< System::Object value)
virtual

Creates new ChartCategory from value and adds it to the collection.

Parameters
valueThe value.
Returns
Added IChartCategory.

This method adds worksheet with name AUTO_DATA and adds all values there. If you use ChartDataWorkbook to add or edit cell values, be sure that you do not use this worksheet Maximum number of values added using this method must not exceed 16711680

Exceptions
System::InvalidOperationExceptionif limit exceeded

Implements Aspose::Slides::Charts::IChartCategoryCollection.

◆ Add() [3/3]

void Aspose::Slides::Charts::ChartCategoryCollection::Add ( System::SharedPtr< IChartCategory category)
protected

Adds ChartCategory object to collection

Parameters
categoryCategory to add.

◆ Clear()

ASPOSE_SLIDES_SHARED_API void Aspose::Slides::Charts::ChartCategoryCollection::Clear ( )
virtual

Removes all elements from the collection.

Implements Aspose::Slides::Charts::IChartCategoryCollection.

◆ CopyTo()

ASPOSE_SLIDES_SHARED_API void Aspose::Slides::Charts::ChartCategoryCollection::CopyTo ( System::ArrayPtr< System::SharedPtr< IChartCategory >>  array,
int32_t  index 
)

Copies all elements of the collection to the specified array.

Parameters
arrayTarget array.
indexStarting index in the array.

◆ get_Count()

ASPOSE_SLIDES_SHARED_API int32_t Aspose::Slides::Charts::ChartCategoryCollection::get_Count ( )
virtual

Returns a number of elements int the collection. Read-only int32_t.

Implements Aspose::Slides::IGenericCollection< System::SharedPtr< Aspose::Slides::Charts::IChartCategory > >.

◆ get_GroupingLevelCount()

ASPOSE_SLIDES_SHARED_API int32_t Aspose::Slides::Charts::ChartCategoryCollection::get_GroupingLevelCount ( )
virtual

Returns count of category grouping levels used. Is more then one for multilevel categories. Read-only int32_t.

Implements Aspose::Slides::Charts::IChartCategoryCollection.

◆ get_IsSynchronized()

ASPOSE_SLIDES_SHARED_API bool Aspose::Slides::Charts::ChartCategoryCollection::get_IsSynchronized ( )
virtual

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

Implements Aspose::Slides::IGenericCollection< System::SharedPtr< Aspose::Slides::Charts::IChartCategory > >.

◆ get_PPTXUnsupportedProps()

System::SharedPtr<Aspose::Slides::UnsupportedProps::PPTXUnsupportedProps::Charts::ChartCategoryCollectionPPTXUnsupportedProps> Aspose::Slides::Charts::ChartCategoryCollection::get_PPTXUnsupportedProps ( )
protected

◆ get_SyncRoot()

ASPOSE_SLIDES_SHARED_API System::SharedPtr<System::Object> Aspose::Slides::Charts::ChartCategoryCollection::get_SyncRoot ( )
virtual

Returns an object that can be used to synchronize access to the collection. Read-only object.

Returns a synchronization root. Read-only object.

Implements Aspose::Slides::IGenericCollection< System::SharedPtr< Aspose::Slides::Charts::IChartCategory > >.

◆ get_UseCells()

ASPOSE_SLIDES_SHARED_API bool Aspose::Slides::Charts::ChartCategoryCollection::get_UseCells ( )
virtual

If true then worksheet is used for storing categories (this case supports a multi-level categories). If false then worksheet is NOT used for storing values (and this case doesn't support a multi-level categories). Read bool.

Implements Aspose::Slides::Charts::IChartCategoryCollection.

◆ GetCellsAddress()

System::String Aspose::Slides::Charts::ChartCategoryCollection::GetCellsAddress ( )
protected

Returns address of the set of cells in workbook.

◆ GetEnumerator()

ASPOSE_SLIDES_SHARED_API System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<IChartCategory> > > Aspose::Slides::Charts::ChartCategoryCollection::GetEnumerator ( )

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.

◆ idx_get()

ASPOSE_SLIDES_SHARED_API System::SharedPtr<IChartCategory> Aspose::Slides::Charts::ChartCategoryCollection::idx_get ( int32_t  index)
virtual

Gets the element at the specified index.

Returns
The element at the specified index.
Exceptions
System::ArgumentOutOfRangeExceptionindex is not a valid index in the System::Collections::IList.

Implements Aspose::Slides::Charts::IChartCategoryCollection.

◆ IndexOf()

ASPOSE_SLIDES_SHARED_API int32_t Aspose::Slides::Charts::ChartCategoryCollection::IndexOf ( System::SharedPtr< IChartCategory value)
virtual

Searches for the specified ChartCategory and returns the zero-based index of the first occurrence within the entire Collection.

Parameters
valueChart category.
Returns
The zero-based index of the first occurrence of value within the entire CollectionBase, if found; otherwise, -1.

Implements Aspose::Slides::Charts::IChartCategoryCollection.

◆ Remove()

ASPOSE_SLIDES_SHARED_API void Aspose::Slides::Charts::ChartCategoryCollection::Remove ( System::SharedPtr< IChartCategory value)
virtual

Removes the specified value.

Parameters
valueThe value.
Exceptions
System::ArgumentException The value parameter was not found in the collection.

Implements Aspose::Slides::Charts::IChartCategoryCollection.

◆ RemoveAt()

ASPOSE_SLIDES_SHARED_API void Aspose::Slides::Charts::ChartCategoryCollection::RemoveAt ( int32_t  index)
virtual

Removes the element at the given index.

Parameters
indexIndex of a category to remove.

Implements Aspose::Slides::Charts::IChartCategoryCollection.

◆ RemoveInternal()

void Aspose::Slides::Charts::ChartCategoryCollection::RemoveInternal ( System::SharedPtr< ChartCategory value)
protected

Removes ChartCategory from m_items list. But doesn't do this: ChartCategory.m_parent = null;

◆ set_UseCells()

ASPOSE_SLIDES_SHARED_API void Aspose::Slides::Charts::ChartCategoryCollection::set_UseCells ( bool  value)
virtual

If true then worksheet is used for storing categories (this case supports a multi-level categories). If false then worksheet is NOT used for storing values (and this case doesn't support a multi-level categories). Write bool.

Implements Aspose::Slides::Charts::IChartCategoryCollection.