Aspose::Words::Drawing::Charts::ChartDataLabelCollection Class Reference

Represents a collection of Aspose::Words::Drawing::Charts::ChartDataLabel. More...

#include "Aspose.Words.Cpp/Model/Drawing/Charts/ChartDataLabelCollection.h"

Inherits System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Words::Drawing::Charts::ChartDataLabel > >, and INumberFormatProvider.

Public Member Functions

int32_t get_Count ()
 Returns the number of Aspose::Words::Drawing::Charts::ChartDataLabel in this collection. More...
 
bool get_ShowCategoryName ()
 Allows to specify whether category name is to be displayed for the data labels of the entire series. Default value is false. More...
 
void set_ShowCategoryName (bool value)
 Setter for Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowCategoryName. More...
 
bool get_ShowBubbleSize ()
 Allows to specify whether bubble size is to be displayed for the data labels of the entire series. Applies only to Bubble charts. Default value is false. More...
 
void set_ShowBubbleSize (bool value)
 Setter for Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowBubbleSize. More...
 
bool get_ShowLegendKey ()
 Allows to specify whether legend key is to be displayed for the data labels of the entire series. Default value is false. More...
 
void set_ShowLegendKey (bool value)
 Setter for Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowLegendKey. More...
 
bool get_ShowPercentage ()
 Allows to specify whether percentage value is to be displayed for the data labels of the entire series. Default value is false. More...
 
void set_ShowPercentage (bool value)
 Setter for Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowPercentage. More...
 
bool get_ShowSeriesName ()
 Returns or sets a Boolean to indicate the series name display behavior for the data labels of the entire series. True to show the series name. False to hide. By default false. More...
 
void set_ShowSeriesName (bool value)
 Setter for Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowSeriesName. More...
 
bool get_ShowValue ()
 Allows to specify whether values are to be displayed in the data labels of the entire series. Default value is false. More...
 
void set_ShowValue (bool value)
 Setter for Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowValue. More...
 
bool get_ShowLeaderLines ()
 Allows to specify whether data label leader lines need be shown for the data labels of the entire series. Default value is false. More...
 
void set_ShowLeaderLines (bool value)
 Setter for Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowLeaderLines. More...
 
bool get_ShowDataLabelsRange ()
 Allows to specify whether values from data labels range to be displayed in the data labels of the entire series. Default value is false. More...
 
void set_ShowDataLabelsRange (bool value)
 Setter for Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowDataLabelsRange. More...
 
System::String get_Separator ()
 Gets or sets string separator used for the data labels of the entire series. The default is a comma, except for pie charts showing only category name and percentage, when a line break shall be used instead. More...
 
void set_Separator (System::String value)
 Setter for Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_Separator. More...
 
System::SharedPtr< Aspose::Words::Drawing::Charts::ChartNumberFormatget_NumberFormat ()
 Gets an Aspose::Words::Drawing::Charts::ChartNumberFormat instance allowing to set number format for the data labels of the entire series. More...
 
System::SharedPtr< Aspose::Words::Drawing::Charts::Core::ComplexTypes::DmlChartNumFormat > get_NumFmt_INumberFormatProvider ()
 
void set_NumFmt_INumberFormatProvider (System::SharedPtr< Aspose::Words::Drawing::Charts::Core::ComplexTypes::DmlChartNumFormat > value)
 
System::SharedPtr< Aspose::Words::Drawing::Charts::ChartDataLabelidx_get (int32_t index)
 Returns Aspose::Words::Drawing::Charts::ChartDataLabel for the specified index. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< Aspose::Words::Drawing::Charts::ChartDataLabel > > > GetEnumerator ()
 Returns an enumerator object. More...
 
System::SharedPtr< Aspose::Words::Drawing::Charts::ChartDataLabelAdd (int32_t index)
 Adds new Aspose::Words::Drawing::Charts::ChartDataLabel at the specified index. More...
 
void RemoveAt (int32_t index)
 Removes a Aspose::Words::Drawing::Charts::ChartDataLabel at the specified index. More...
 
void Clear ()
 Removes all Aspose::Words::Drawing::Charts::ChartDataLabel from this collection. 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 ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Additional Inherited Members

- Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Words::Drawing::Charts::ChartDataLabel > >
typedef IEnumerator< System::SharedPtr< Aspose::Words::Drawing::Charts::ChartDataLabel > > 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...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 

Detailed Description

Member Function Documentation

◆ Add()

System::SharedPtr<Aspose::Words::Drawing::Charts::ChartDataLabel> Aspose::Words::Drawing::Charts::ChartDataLabelCollection::Add ( int32_t  index)

Adds new Aspose::Words::Drawing::Charts::ChartDataLabel at the specified index.

Parameters
indexTarget data label index.

◆ Clear()

void Aspose::Words::Drawing::Charts::ChartDataLabelCollection::Clear ( )

Removes all Aspose::Words::Drawing::Charts::ChartDataLabel from this collection.

◆ get_Count()

int32_t Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_Count ( )

Returns the number of Aspose::Words::Drawing::Charts::ChartDataLabel in this collection.

◆ get_NumberFormat()

System::SharedPtr<Aspose::Words::Drawing::Charts::ChartNumberFormat> Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_NumberFormat ( )

Gets an Aspose::Words::Drawing::Charts::ChartNumberFormat instance allowing to set number format for the data labels of the entire series.

◆ get_NumFmt_INumberFormatProvider()

System::SharedPtr<Aspose::Words::Drawing::Charts::Core::ComplexTypes::DmlChartNumFormat> Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_NumFmt_INumberFormatProvider ( )

◆ get_Separator()

System::String Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_Separator ( )

Gets or sets string separator used for the data labels of the entire series. The default is a comma, except for pie charts showing only category name and percentage, when a line break shall be used instead.

Value defined for this property can be overridden for an individual data label with using the Aspose::Words::Drawing::Charts::ChartDataLabel::get_Separator property.

◆ get_ShowBubbleSize()

bool Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowBubbleSize ( )

Allows to specify whether bubble size is to be displayed for the data labels of the entire series. Applies only to Bubble charts. Default value is false.

Value defined for this property can be overridden for an individual data label with using the Aspose::Words::Drawing::Charts::ChartDataLabel::get_ShowBubbleSize property.

◆ get_ShowCategoryName()

bool Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowCategoryName ( )

Allows to specify whether category name is to be displayed for the data labels of the entire series. Default value is false.

Value defined for this property can be overridden for an individual data label with using the Aspose::Words::Drawing::Charts::ChartDataLabel::get_ShowCategoryName property.

◆ get_ShowDataLabelsRange()

bool Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowDataLabelsRange ( )

Allows to specify whether values from data labels range to be displayed in the data labels of the entire series. Default value is false.

Value defined for this property can be overridden for an individual data label with using the Aspose::Words::Drawing::Charts::ChartDataLabel::get_ShowDataLabelsRange property.

◆ get_ShowLeaderLines()

bool Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowLeaderLines ( )

Allows to specify whether data label leader lines need be shown for the data labels of the entire series. Default value is false.

Applies to Pie charts only. Leader lines create a visual connection between a data label and its corresponding data point.

Value defined for this property can be overridden for an individual data label with using the Aspose::Words::Drawing::Charts::ChartDataLabel::get_ShowLeaderLines property.

◆ get_ShowLegendKey()

bool Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowLegendKey ( )

Allows to specify whether legend key is to be displayed for the data labels of the entire series. Default value is false.

Value defined for this property can be overridden for an individual data label with using the Aspose::Words::Drawing::Charts::ChartDataLabel::get_ShowLegendKey property.

◆ get_ShowPercentage()

bool Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowPercentage ( )

Allows to specify whether percentage value is to be displayed for the data labels of the entire series. Default value is false.

Value defined for this property can be overridden for an individual data label with using the Aspose::Words::Drawing::Charts::ChartDataLabel::get_ShowPercentage property.

◆ get_ShowSeriesName()

bool Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowSeriesName ( )

Returns or sets a Boolean to indicate the series name display behavior for the data labels of the entire series. True to show the series name. False to hide. By default false.

Value defined for this property can be overridden for an individual data label with using the Aspose::Words::Drawing::Charts::ChartDataLabel::get_ShowSeriesName property.

◆ get_ShowValue()

bool Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowValue ( )

Allows to specify whether values are to be displayed in the data labels of the entire series. Default value is false.

Value defined for this property can be overridden for an individual data label with using the Aspose::Words::Drawing::Charts::ChartDataLabel::get_ShowValue property.

◆ GetEnumerator()

◆ idx_get()

System::SharedPtr<Aspose::Words::Drawing::Charts::ChartDataLabel> Aspose::Words::Drawing::Charts::ChartDataLabelCollection::idx_get ( int32_t  index)

Returns Aspose::Words::Drawing::Charts::ChartDataLabel for the specified index.

◆ RemoveAt()

void Aspose::Words::Drawing::Charts::ChartDataLabelCollection::RemoveAt ( int32_t  index)

Removes a Aspose::Words::Drawing::Charts::ChartDataLabel at the specified index.

Parameters
indexThe zero-based index of the chart data label to remove.

◆ set_NumFmt_INumberFormatProvider()

void Aspose::Words::Drawing::Charts::ChartDataLabelCollection::set_NumFmt_INumberFormatProvider ( System::SharedPtr< Aspose::Words::Drawing::Charts::Core::ComplexTypes::DmlChartNumFormat >  value)

◆ set_Separator()

void Aspose::Words::Drawing::Charts::ChartDataLabelCollection::set_Separator ( System::String  value)

◆ set_ShowBubbleSize()

void Aspose::Words::Drawing::Charts::ChartDataLabelCollection::set_ShowBubbleSize ( bool  value)

◆ set_ShowCategoryName()

void Aspose::Words::Drawing::Charts::ChartDataLabelCollection::set_ShowCategoryName ( bool  value)

◆ set_ShowDataLabelsRange()

void Aspose::Words::Drawing::Charts::ChartDataLabelCollection::set_ShowDataLabelsRange ( bool  value)

◆ set_ShowLeaderLines()

void Aspose::Words::Drawing::Charts::ChartDataLabelCollection::set_ShowLeaderLines ( bool  value)

◆ set_ShowLegendKey()

void Aspose::Words::Drawing::Charts::ChartDataLabelCollection::set_ShowLegendKey ( bool  value)

◆ set_ShowPercentage()

void Aspose::Words::Drawing::Charts::ChartDataLabelCollection::set_ShowPercentage ( bool  value)

◆ set_ShowSeriesName()

void Aspose::Words::Drawing::Charts::ChartDataLabelCollection::set_ShowSeriesName ( bool  value)

◆ set_ShowValue()

void Aspose::Words::Drawing::Charts::ChartDataLabelCollection::set_ShowValue ( bool  value)