Aspose::Slides::Charts::Legend Class Reference

Represents chart's legend properties. More...

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

Public Member Functions

ASPOSE_SLIDES_SHARED_API float get_X ()
 Returns the x coordinate of a legend as a fraction of the width of the chart. Read float. More...
 
ASPOSE_SLIDES_SHARED_API void set_X (float value)
 Sets the x coordinate of a legend as a fraction of the width of the chart. Write float. More...
 
ASPOSE_SLIDES_SHARED_API float get_Y ()
 Returns the y coordinate of a legend as a fraction of the height of the chart. Read float. More...
 
ASPOSE_SLIDES_SHARED_API void set_Y (float value)
 Sets the y coordinate of a legend as a fraction of the height of the chart. Write float. More...
 
ASPOSE_SLIDES_SHARED_API float get_Width ()
 Returns the width of a legend as a fraction of the width of the chart. Read float. More...
 
ASPOSE_SLIDES_SHARED_API void set_Width (float value)
 Sets the width of a legend as a fraction of the width of the chart. Write float. More...
 
ASPOSE_SLIDES_SHARED_API float get_Height ()
 Returns the height of a legend as a fraction of the height of the chart. Read float. More...
 
ASPOSE_SLIDES_SHARED_API void set_Height (float value)
 Sets the height of a legend as a fraction of the height of the chart. Write float. More...
 
ASPOSE_SLIDES_SHARED_API float get_Right ()
 Right. Read-only float. More...
 
ASPOSE_SLIDES_SHARED_API float get_Bottom ()
 Bottom. Read-only float. More...
 
ASPOSE_SLIDES_SHARED_API bool get_Overlay ()
 Determines whether other chart elements shall be allowed to overlap legend. Read bool. More...
 
ASPOSE_SLIDES_SHARED_API void set_Overlay (bool value)
 Determines whether other chart elements shall be allowed to overlap legend. Write bool. More...
 
ASPOSE_SLIDES_SHARED_API System::SharedPtr< IChartTextFormatget_TextFormat ()
 Text format. Read-only IChartTextFormat. More...
 
ASPOSE_SLIDES_SHARED_API LegendPositionType get_Position ()
 Specifies the position of the legend on a chart. Non-NaN values of X, Y, Width, Heigt properties override effect of this property. Read LegendPositionType. More...
 
ASPOSE_SLIDES_SHARED_API void set_Position (LegendPositionType value)
 Specifies the position of the legend on a chart. Non-NaN values of X, Y, Width, Heigt properties override effect of this property. Write LegendPositionType. More...
 
ASPOSE_SLIDES_SHARED_API System::SharedPtr< IFormatget_Format ()
 Returns the format of a legend. Read-only IFormat. More...
 
ASPOSE_SLIDES_SHARED_API System::SharedPtr< IChartget_Chart ()
 Returns the chart. Read-only IChart. More...
 
ASPOSE_SLIDES_SHARED_API System::SharedPtr< ILegendEntryCollectionget_Entries ()
 Gets legend entries. Read-only ILegendEntryCollection. 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...
 
void SharedRefRemoved ()
 Decrements shared reference count and deletes object if it hits zero. Shouldn't be called directly; instead, use smart pointers or ThisProtector. 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 FreeOrDetectCycles (int count)
 Reacts on shared reference counter decrement. Shouldn't be called directly, use smart pointers instead. If neccessary, deletes the object. If allowed, initiates loop references lookup. 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...
 
void __FreePointers ()
 Resets all smart pointers stored inside this object directly (in fields) or indirectly (in value type fields). Used by memory management systems, shouldn't be called directly. 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::Charts::LegendPPTXUnsupportedProps > get_PPTXUnsupportedProps ()
 
 Legend (System::SharedPtr< Aspose::Slides::Charts::Chart > parentImmediate)
 
- Protected Member Functions inherited from System::Object
template<class Container , typename Value = typename Container::value_type>
std::enable_if<!System::IsSmartPtr< Value >::value &&!System::detail::is_a< Value, std::pair >::value, void >::type PopulateSharedMembers (Object::shared_members_type &, const char *, Container &)
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if< System::IsSmartPtr< Value >::value, void >::type PopulateSharedMembers (Object::shared_members_type &data, const char *name, Container &container)
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if< System::detail::is_a< Value, std::pair >::value &&!System::IsSmartPtr< typename Value::first_type >::value &&!System::IsSmartPtr< typename Value::second_type >::value, void >::type PopulateSharedMembers (Object::shared_members_type &, const char *, Container &)
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if< System::detail::is_a< Value, std::pair >::value &&System::IsSmartPtr< typename Value::first_type >::value &&!System::IsSmartPtr< typename Value::second_type >::value, void >::type PopulateSharedMembers (Object::shared_members_type &data, const char *name, Container &container)
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if< System::detail::is_a< Value, std::pair >::value &&!System::IsSmartPtr< typename Value::first_type >::value &&System::IsSmartPtr< typename Value::second_type >::value, void >::type PopulateSharedMembers (Object::shared_members_type &data, const char *name, Container &container)
 
template<class Container , typename Value = typename Container::value_type>
std::enable_if< System::detail::is_a< Value, std::pair >::value &&System::IsSmartPtr< typename Value::first_type >::value &&System::IsSmartPtr< typename Value::second_type >::value, void >::type PopulateSharedMembers (Object::shared_members_type &data, const char *name, Container &container)
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer 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...
 
- Protected Types inherited from System::Object
template<class T >
using supports_free_pointers = decltype(__SupportsFreePointers(std::declval< T * >()))
 Checks if T type supports __FreePointers() method. More...
 
- Static Protected Member Functions inherited from System::Object
template<class T , class Check = decltype(std::declval<T*>()->__FreePointers())>
static std::true_type __SupportsFreePointers (T *)
 Formal function for template magic to check if type T supports __FreePointers() method. More...
 
static std::false_type __SupportsFreePointers (...)
 Formal function for template magic to check if type T supports __FreePointers() method. More...
 
template<class T >
static std::enable_if< supports_free_pointers< T >::value, void >::type __DoFreePointers (T &t)
 
template<class T >
static std::enable_if<!supports_free_pointers< T >::value &&!std::is_fundamental< T >::value &&!std::is_enum< T >::value &&!std::is_const< T >::value, void >::type __DoFreePointers (const T &)
 
template<class T >
static std::enable_if<!supports_free_pointers< T >::value &&!std::is_fundamental< T >::value &&!std::is_enum< T >::value &&std::is_const< T >::value, void >::type __DoFreePointers (T &)
 
template<class T >
static std::enable_if< std::is_fundamental< T >::value||std::is_enum< T >::value, void >::type __DoFreePointers (T)
 

Detailed Description

Represents chart's legend properties.

Constructor & Destructor Documentation

◆ Legend()

Aspose::Slides::Charts::Legend::Legend ( System::SharedPtr< Aspose::Slides::Charts::Chart parentImmediate)
protected

Member Function Documentation

◆ get_Bottom()

ASPOSE_SLIDES_SHARED_API float Aspose::Slides::Charts::Legend::get_Bottom ( )
virtual

Bottom. Read-only float.

Implements Aspose::Slides::Charts::ILayoutable.

◆ get_Chart()

ASPOSE_SLIDES_SHARED_API System::SharedPtr<IChart> Aspose::Slides::Charts::Legend::get_Chart ( )
virtual

Returns the chart. Read-only IChart.

Implements Aspose::Slides::Charts::IChartComponent.

◆ get_Entries()

ASPOSE_SLIDES_SHARED_API System::SharedPtr<ILegendEntryCollection> Aspose::Slides::Charts::Legend::get_Entries ( )
virtual

Gets legend entries. Read-only ILegendEntryCollection.

Implements Aspose::Slides::Charts::ILegend.

◆ get_Format()

ASPOSE_SLIDES_SHARED_API System::SharedPtr<IFormat> Aspose::Slides::Charts::Legend::get_Format ( )
virtual

Returns the format of a legend. Read-only IFormat.

Implements Aspose::Slides::Charts::ILegend.

◆ get_Height()

ASPOSE_SLIDES_SHARED_API float Aspose::Slides::Charts::Legend::get_Height ( )
virtual

Returns the height of a legend as a fraction of the height of the chart. Read float.

Implements Aspose::Slides::Charts::ILayoutable.

◆ get_Overlay()

ASPOSE_SLIDES_SHARED_API bool Aspose::Slides::Charts::Legend::get_Overlay ( )
virtual

Determines whether other chart elements shall be allowed to overlap legend. Read bool.

Implements Aspose::Slides::Charts::ILegend.

◆ get_Position()

ASPOSE_SLIDES_SHARED_API LegendPositionType Aspose::Slides::Charts::Legend::get_Position ( )
virtual

Specifies the position of the legend on a chart. Non-NaN values of X, Y, Width, Heigt properties override effect of this property. Read LegendPositionType.

Implements Aspose::Slides::Charts::ILegend.

◆ get_PPTXUnsupportedProps()

System::SharedPtr<Aspose::Slides::UnsupportedProps::PPTXUnsupportedProps::Charts::LegendPPTXUnsupportedProps> Aspose::Slides::Charts::Legend::get_PPTXUnsupportedProps ( )
protected

◆ get_Right()

ASPOSE_SLIDES_SHARED_API float Aspose::Slides::Charts::Legend::get_Right ( )
virtual

Right. Read-only float.

Implements Aspose::Slides::Charts::ILayoutable.

◆ get_TextFormat()

ASPOSE_SLIDES_SHARED_API System::SharedPtr<IChartTextFormat> Aspose::Slides::Charts::Legend::get_TextFormat ( )
virtual

◆ get_Width()

ASPOSE_SLIDES_SHARED_API float Aspose::Slides::Charts::Legend::get_Width ( )
virtual

Returns the width of a legend as a fraction of the width of the chart. Read float.

Implements Aspose::Slides::Charts::ILayoutable.

◆ get_X()

ASPOSE_SLIDES_SHARED_API float Aspose::Slides::Charts::Legend::get_X ( )
virtual

Returns the x coordinate of a legend as a fraction of the width of the chart. Read float.

Implements Aspose::Slides::Charts::ILayoutable.

◆ get_Y()

ASPOSE_SLIDES_SHARED_API float Aspose::Slides::Charts::Legend::get_Y ( )
virtual

Returns the y coordinate of a legend as a fraction of the height of the chart. Read float.

Implements Aspose::Slides::Charts::ILayoutable.

◆ set_Height()

ASPOSE_SLIDES_SHARED_API void Aspose::Slides::Charts::Legend::set_Height ( float  value)
virtual

Sets the height of a legend as a fraction of the height of the chart. Write float.

Implements Aspose::Slides::Charts::ILayoutable.

◆ set_Overlay()

ASPOSE_SLIDES_SHARED_API void Aspose::Slides::Charts::Legend::set_Overlay ( bool  value)
virtual

Determines whether other chart elements shall be allowed to overlap legend. Write bool.

Implements Aspose::Slides::Charts::ILegend.

◆ set_Position()

ASPOSE_SLIDES_SHARED_API void Aspose::Slides::Charts::Legend::set_Position ( LegendPositionType  value)
virtual

Specifies the position of the legend on a chart. Non-NaN values of X, Y, Width, Heigt properties override effect of this property. Write LegendPositionType.

Implements Aspose::Slides::Charts::ILegend.

◆ set_Width()

ASPOSE_SLIDES_SHARED_API void Aspose::Slides::Charts::Legend::set_Width ( float  value)
virtual

Sets the width of a legend as a fraction of the width of the chart. Write float.

Implements Aspose::Slides::Charts::ILayoutable.

◆ set_X()

ASPOSE_SLIDES_SHARED_API void Aspose::Slides::Charts::Legend::set_X ( float  value)
virtual

Sets the x coordinate of a legend as a fraction of the width of the chart. Write float.

Implements Aspose::Slides::Charts::ILayoutable.

◆ set_Y()

ASPOSE_SLIDES_SHARED_API void Aspose::Slides::Charts::Legend::set_Y ( float  value)
virtual

Sets the y coordinate of a legend as a fraction of the height of the chart. Write float.

Implements Aspose::Slides::Charts::ILayoutable.