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 ()
 Returns a type of background fill. Read BackgroundType. More...
 
void set_Type (BackgroundType value)
 Returns a type of background fill. Write BackgroundType. More...
 
System::SharedPtr< IFillFormatget_FillFormat ()
 Returns a FillFormat for BackgroundType.OwnBackground fill. Read-only IFillFormat. More...
 
System::SharedPtr< IEffectFormatget_EffectFormat ()
 Returns a EffectFormat for BackgroundType.OwnBackground fill. Read-only IEffectFormat. More...
 
System::SharedPtr< IColorFormatget_StyleColor ()
 Return a ColorFormat for a BackgroundType.Themed fill. Read-only IColorFormat. More...
 
uint16_t get_StyleIndex ()
 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)
 Returns an index of BackgroundType.Themed fill in background theme collection. 0 means no fill. 1..999 - index. Write uint16_t. More...
 
System::SharedPtr< IDOMObjectget_Parent_Immediate ()
 Returns Parent_Immediate object. Read-only IDOMObject. More...
 
System::SharedPtr< IBaseSlideget_Slide ()
 Returns the parent slide of a shape. Read-only IBaseSlide. More...
 
System::SharedPtr< IPresentationget_Presentation ()
 Returns the parent presentation of a slide. Read-only IPresentation. More...
 
System::SharedPtr< IBackgroundEffectiveDataGetEffective ()
 Gets effective background data with the inheritance applied. More...
 
- Public Member Functions inherited from Aspose::Slides::PVIObject
virtual bool Equals (System::SharedPtr< System::Object > obj)
 Compares with specified object. More...
 
virtual int32_t GetHashCode () const
 Returns hash code. 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 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 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< BackgroundImpl > get_RealObject ()
 
System::SharedPtr< UnsupportedProps::PPTXUnsupportedProps::BackgroundPPTXUnsupportedProps > get_PPTXUnsupportedProps ()
 
System::SharedPtr< UnsupportedProps::PPTUnsupportedProps::BackgroundPPTUnsupportedProps > get_PPTUnsupportedProps ()
 
System::SharedPtr< BaseSlideget_SlideInternal ()
 
 Background (System::SharedPtr< IDOMObject > parentImmediate)
 
virtual void CreateChildObjects ()
 
virtual System::SharedPtr< System::ObjectCreateRealObject ()
 
System::SharedPtr< BackgroundEffectiveData > GetEffectiveInternal ()
 
- Protected Member Functions inherited from Aspose::Slides::PVIObject
System::SharedPtr< ObjectWrapper > get_Wrapper () const
 
System::SharedPtr< IDOMObjectget_Parent_Immediate ()
 Returns Parent_Immediate object. Read-only IDOMObject. More...
 
void set_Parent_Immediate (System::SharedPtr< IDOMObject > value)
 
virtual uint32_t get_Version ()
 Version. Read-only uint32_t. More...
 
System::SharedPtr< IPresentationComponentget_Parent_IPresentationComponent ()
 Returns parent IPresentationComponent. Read-only IPresentationComponent. More...
 
System::SharedPtr< ISlideComponentget_Parent_ISlideComponent ()
 
System::SharedPtr< BaseSlideget_Slide ()
 
System::SharedPtr< Aspose::Slides::Presentationget_Presentation ()
 
 PVIObject (System::SharedPtr< IDOMObject > parentImmediate)
 
void Reset_Parent_IPresentationComponent ()
 

Additional Inherited Members

- 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...
 

Detailed Description

Represents background of a slide.

Constructor & Destructor Documentation

◆ Background()

Aspose::Slides::Background::Background ( System::SharedPtr< IDOMObject parentImmediate)
protected

Member Function Documentation

◆ CreateChildObjects()

virtual void Aspose::Slides::Background::CreateChildObjects ( )
protectedvirtual

◆ CreateRealObject()

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

◆ get_EffectFormat()

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

◆ get_FillFormat()

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

◆ get_Parent_Immediate()

System::SharedPtr<IDOMObject> Aspose::Slides::Background::get_Parent_Immediate ( )
virtual

Returns Parent_Immediate object. Read-only IDOMObject.

Implements Aspose::Slides::IDOMObject.

◆ get_PPTUnsupportedProps()

System::SharedPtr<UnsupportedProps::PPTUnsupportedProps::BackgroundPPTUnsupportedProps> Aspose::Slides::Background::get_PPTUnsupportedProps ( )
protected

◆ get_PPTXUnsupportedProps()

System::SharedPtr<UnsupportedProps::PPTXUnsupportedProps::BackgroundPPTXUnsupportedProps> Aspose::Slides::Background::get_PPTXUnsupportedProps ( )
protected

◆ get_Presentation()

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

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

Implements Aspose::Slides::IPresentationComponent.

◆ get_RealObject()

System::SharedPtr<BackgroundImpl> Aspose::Slides::Background::get_RealObject ( )
protected

◆ get_Slide()

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

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

Implements Aspose::Slides::ISlideComponent.

◆ get_SlideInternal()

System::SharedPtr<BaseSlide> Aspose::Slides::Background::get_SlideInternal ( )
protected

◆ get_StyleColor()

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

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

Implements Aspose::Slides::IBackground.

◆ get_StyleIndex()

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

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

Returns a type of background fill. Read BackgroundType.

Implements Aspose::Slides::IBackground.

◆ GetEffective()

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

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

Implements Aspose::Slides::IBackground.

◆ GetEffectiveInternal()

System::SharedPtr<BackgroundEffectiveData> Aspose::Slides::Background::GetEffectiveInternal ( )
protected

◆ set_StyleIndex()

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

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

Returns a type of background fill. Write BackgroundType.

Implements Aspose::Slides::IBackground.