Aspose::Slides::Background Class Reference

Represents background of a slide. More...

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

Public Member Functions

BackgroundType get_Type () override
 Returns a type of background fill. Read BackgroundType. More...
 
void set_Type (BackgroundType value) override
 Returns a type of background fill. Write BackgroundType. More...
 
System::SharedPtr< IFillFormatget_FillFormat () override
 Returns a FillFormat for BackgroundType::OwnBackground fill. Read-only IFillFormat. More...
 
System::SharedPtr< IEffectFormatget_EffectFormat () override
 Returns a EffectFormat for BackgroundType::OwnBackground fill. Read-only IEffectFormat. More...
 
System::SharedPtr< IColorFormatget_StyleColor () override
 Return a ColorFormat for a BackgroundType::Themed fill. Read-only IColorFormat. More...
 
uint16_t get_StyleIndex () override
 Returns an index of BackgroundType::Themed fill in background theme collection. 0 means no fill. 1..999 - index. Read uint16_t. More...
 
void set_StyleIndex (uint16_t value) override
 Returns an index of BackgroundType::Themed fill in background theme collection. 0 means no fill. 1..999 - index. Write uint16_t. More...
 
System::SharedPtr< IBaseSlideget_Slide () override
 Returns the parent slide of a shape. Read-only IBaseSlide. More...
 
System::SharedPtr< IPresentationget_Presentation () override
 Returns the parent presentation of a slide. Read-only IPresentation. More...
 
System::SharedPtr< IBackgroundEffectiveDataGetEffective () override
 Gets effective background data with the inheritance applied. 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 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...
 

Protected Member Functions

void CreateChildObjects () override
 
System::SharedPtr< System::ObjectCreateRealObject () override
 
virtual ~Background ()
 
- Protected Member Functions inherited from Aspose::Slides::PVIObject
virtual ~PVIObject ()
 

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

Represents background of a slide.

Constructor & Destructor Documentation

◆ ~Background()

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

Member Function Documentation

◆ CreateChildObjects()

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

◆ CreateRealObject()

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

◆ get_EffectFormat()

System::SharedPtr<IEffectFormat> Aspose::Slides::Background::get_EffectFormat ( )
overridevirtual

◆ get_FillFormat()

System::SharedPtr<IFillFormat> Aspose::Slides::Background::get_FillFormat ( )
overridevirtual

◆ get_Presentation()

System::SharedPtr<IPresentation> Aspose::Slides::Background::get_Presentation ( )
overridevirtual

Returns the parent presentation of a slide. Read-only IPresentation.

Implements Aspose::Slides::IPresentationComponent.

◆ get_Slide()

System::SharedPtr<IBaseSlide> Aspose::Slides::Background::get_Slide ( )
overridevirtual

Returns the parent slide of a shape. Read-only IBaseSlide.

Implements Aspose::Slides::ISlideComponent.

◆ get_StyleColor()

System::SharedPtr<IColorFormat> Aspose::Slides::Background::get_StyleColor ( )
overridevirtual

Return a ColorFormat for a BackgroundType::Themed fill. Read-only IColorFormat.

Implements Aspose::Slides::IBackground.

◆ get_StyleIndex()

uint16_t Aspose::Slides::Background::get_StyleIndex ( )
overridevirtual

Returns an index of BackgroundType::Themed fill in background theme collection. 0 means no fill. 1..999 - index. Read uint16_t.

Implements Aspose::Slides::IBackground.

◆ get_Type()

BackgroundType Aspose::Slides::Background::get_Type ( )
overridevirtual

Returns a type of background fill. Read BackgroundType.

Implements Aspose::Slides::IBackground.

◆ GetEffective()

System::SharedPtr<IBackgroundEffectiveData> Aspose::Slides::Background::GetEffective ( )
overridevirtual

Gets effective background data with the inheritance applied.

Returns
A IBackgroundEffectiveData.

This example demonstrates getting effective background properties.

auto pres = MakeObject<Presentation>(u"MyPresentation.pptx");
auto effectiveBackground = pres->get_Slides()->idx_get(0)->get_Background()->GetEffective();
Console::WriteLine(String(u"Background fill type: ") + ObjectExt::ToString(effectiveBackground->get_FillFormat()->get_FillType()));
Console::WriteLine(String(u"Any effects applied: ") + !effectiveBackground->get_EffectFormat()->get_IsNoEffects());
@ String
A string.
Definition: xpath_result_type.h:13

Implements Aspose::Slides::IBackground.

◆ set_StyleIndex()

void Aspose::Slides::Background::set_StyleIndex ( uint16_t  value)
overridevirtual

Returns an index of BackgroundType::Themed fill in background theme collection. 0 means no fill. 1..999 - index. Write uint16_t.

Implements Aspose::Slides::IBackground.

◆ set_Type()

void Aspose::Slides::Background::set_Type ( BackgroundType  value)
overridevirtual

Returns a type of background fill. Write BackgroundType.

Implements Aspose::Slides::IBackground.