Aspose::Slides::EffectFormat Class Reference

Represents effect properties of shape. More...

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

Public Member Functions

bool get_IsNoEffects () override
 Returns true if all effects are disabled (as just created, default EffectFormat object). Read-only bool. More...
 
System::SharedPtr< Effects::IBlurget_BlurEffect () override
 Blur effect. Read Effects::IBlur. More...
 
void set_BlurEffect (System::SharedPtr< Effects::IBlur > value) override
 Blur effect. Write Effects::IBlur. More...
 
System::SharedPtr< Effects::IFillOverlayget_FillOverlayEffect () override
 Fill overlay effect. Read Effects::IFillOverlay. More...
 
void set_FillOverlayEffect (System::SharedPtr< Effects::IFillOverlay > value) override
 Fill overlay effect. Write Effects::IFillOverlay. More...
 
System::SharedPtr< Effects::IGlowget_GlowEffect () override
 Glow effect. Read Effects::IGlow. More...
 
void set_GlowEffect (System::SharedPtr< Effects::IGlow > value) override
 Glow effect. Write Effects::IGlow. More...
 
System::SharedPtr< Effects::IInnerShadowget_InnerShadowEffect () override
 Inner shadow. Read Effects::IInnerShadow. More...
 
void set_InnerShadowEffect (System::SharedPtr< Effects::IInnerShadow > value) override
 Inner shadow. Write Effects::IInnerShadow. More...
 
System::SharedPtr< Effects::IOuterShadowget_OuterShadowEffect () override
 Outer shadow. Read Effects::IOuterShadow. More...
 
void set_OuterShadowEffect (System::SharedPtr< Effects::IOuterShadow > value) override
 Outer shadow. Write Effects::IOuterShadow. More...
 
System::SharedPtr< Effects::IPresetShadowget_PresetShadowEffect () override
 Preset shadow. Read Effects::IPresetShadow. More...
 
void set_PresetShadowEffect (System::SharedPtr< Effects::IPresetShadow > value) override
 Preset shadow. Write Effects::IPresetShadow. More...
 
System::SharedPtr< Effects::IReflectionget_ReflectionEffect () override
 Reflection. Read Effects::IReflection. More...
 
void set_ReflectionEffect (System::SharedPtr< Effects::IReflection > value) override
 Reflection. Write Effects::IReflection. More...
 
System::SharedPtr< Effects::ISoftEdgeget_SoftEdgeEffect () override
 Soft edge. Read Effects::ISoftEdge. More...
 
void set_SoftEdgeEffect (System::SharedPtr< Effects::ISoftEdge > value) override
 Soft edge. Write Effects::ISoftEdge. More...
 
void SetBlurEffect (double radius, bool grow) override
 Sets blur effect. More...
 
void EnableFillOverlayEffect () override
 Enables fill overlay effect. More...
 
void EnableGlowEffect () override
 Enables glow effect. More...
 
void EnableInnerShadowEffect () override
 Enables inner shadow effect. More...
 
void EnableOuterShadowEffect () override
 Enables outer shadow effect. More...
 
void EnablePresetShadowEffect () override
 Enables preset shadows effect. More...
 
void EnableReflectionEffect () override
 Enables reflection effect. More...
 
void EnableSoftEdgeEffect () override
 Enables soft edge effect. More...
 
void DisableBlurEffect () override
 Disables blur effect. More...
 
void DisableFillOverlayEffect () override
 Disables fill overlay effect. More...
 
void DisableGlowEffect () override
 Disable glow effect. More...
 
void DisableInnerShadowEffect () override
 Disables inner shadow effect. More...
 
void DisableOuterShadowEffect () override
 Disables outer shadow effect. More...
 
void DisablePresetShadowEffect () override
 Disables preset shadow effect. More...
 
void DisableReflectionEffect () override
 Disables reflection effect. More...
 
void DisableSoftEdgeEffect () override
 Disables soft edge effect. More...
 
System::SharedPtr< IEffectFormatEffectiveDataGetEffective () override
 Gets effective effect formatting 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...
 
- 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 Aspose::Slides::IDOMObject
virtual System::SharedPtr< IDOMObjectget_Parent_Immediate ()=0
 Returns Parent_Immediate object. Read-only IDOMObject. 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 String ToString () 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 (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 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...
 
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 ~EffectFormat ()
 
- 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...
 

Detailed Description

Represents effect properties of shape.

Constructor & Destructor Documentation

◆ ~EffectFormat()

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

Member Function Documentation

◆ CreateChildObjects()

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

◆ CreateRealObject()

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

◆ DisableBlurEffect()

void Aspose::Slides::EffectFormat::DisableBlurEffect ( )
overridevirtual

Disables blur effect.

Implements Aspose::Slides::IEffectFormat.

◆ DisableFillOverlayEffect()

void Aspose::Slides::EffectFormat::DisableFillOverlayEffect ( )
overridevirtual

Disables fill overlay effect.

Implements Aspose::Slides::IEffectFormat.

◆ DisableGlowEffect()

void Aspose::Slides::EffectFormat::DisableGlowEffect ( )
overridevirtual

Disable glow effect.

Implements Aspose::Slides::IEffectFormat.

◆ DisableInnerShadowEffect()

void Aspose::Slides::EffectFormat::DisableInnerShadowEffect ( )
overridevirtual

Disables inner shadow effect.

Implements Aspose::Slides::IEffectFormat.

◆ DisableOuterShadowEffect()

void Aspose::Slides::EffectFormat::DisableOuterShadowEffect ( )
overridevirtual

Disables outer shadow effect.

Implements Aspose::Slides::IEffectFormat.

◆ DisablePresetShadowEffect()

void Aspose::Slides::EffectFormat::DisablePresetShadowEffect ( )
overridevirtual

Disables preset shadow effect.

Implements Aspose::Slides::IEffectFormat.

◆ DisableReflectionEffect()

void Aspose::Slides::EffectFormat::DisableReflectionEffect ( )
overridevirtual

Disables reflection effect.

Implements Aspose::Slides::IEffectFormat.

◆ DisableSoftEdgeEffect()

void Aspose::Slides::EffectFormat::DisableSoftEdgeEffect ( )
overridevirtual

Disables soft edge effect.

Implements Aspose::Slides::IEffectFormat.

◆ EnableFillOverlayEffect()

void Aspose::Slides::EffectFormat::EnableFillOverlayEffect ( )
overridevirtual

Enables fill overlay effect.

Implements Aspose::Slides::IEffectFormat.

◆ EnableGlowEffect()

void Aspose::Slides::EffectFormat::EnableGlowEffect ( )
overridevirtual

Enables glow effect.

Implements Aspose::Slides::IEffectFormat.

◆ EnableInnerShadowEffect()

void Aspose::Slides::EffectFormat::EnableInnerShadowEffect ( )
overridevirtual

Enables inner shadow effect.

Implements Aspose::Slides::IEffectFormat.

◆ EnableOuterShadowEffect()

void Aspose::Slides::EffectFormat::EnableOuterShadowEffect ( )
overridevirtual

Enables outer shadow effect.

Implements Aspose::Slides::IEffectFormat.

◆ EnablePresetShadowEffect()

void Aspose::Slides::EffectFormat::EnablePresetShadowEffect ( )
overridevirtual

Enables preset shadows effect.

Implements Aspose::Slides::IEffectFormat.

◆ EnableReflectionEffect()

void Aspose::Slides::EffectFormat::EnableReflectionEffect ( )
overridevirtual

Enables reflection effect.

Implements Aspose::Slides::IEffectFormat.

◆ EnableSoftEdgeEffect()

void Aspose::Slides::EffectFormat::EnableSoftEdgeEffect ( )
overridevirtual

Enables soft edge effect.

Implements Aspose::Slides::IEffectFormat.

◆ get_BlurEffect()

System::SharedPtr<Effects::IBlur> Aspose::Slides::EffectFormat::get_BlurEffect ( )
overridevirtual

Blur effect. Read Effects::IBlur.

Implements Aspose::Slides::IEffectFormat.

◆ get_FillOverlayEffect()

System::SharedPtr<Effects::IFillOverlay> Aspose::Slides::EffectFormat::get_FillOverlayEffect ( )
overridevirtual

Fill overlay effect. Read Effects::IFillOverlay.

Implements Aspose::Slides::IEffectFormat.

◆ get_GlowEffect()

System::SharedPtr<Effects::IGlow> Aspose::Slides::EffectFormat::get_GlowEffect ( )
overridevirtual

Glow effect. Read Effects::IGlow.

Implements Aspose::Slides::IEffectFormat.

◆ get_InnerShadowEffect()

System::SharedPtr<Effects::IInnerShadow> Aspose::Slides::EffectFormat::get_InnerShadowEffect ( )
overridevirtual

Inner shadow. Read Effects::IInnerShadow.

Implements Aspose::Slides::IEffectFormat.

◆ get_IsNoEffects()

bool Aspose::Slides::EffectFormat::get_IsNoEffects ( )
overridevirtual

Returns true if all effects are disabled (as just created, default EffectFormat object). Read-only bool.

Implements Aspose::Slides::IEffectFormat.

◆ get_OuterShadowEffect()

System::SharedPtr<Effects::IOuterShadow> Aspose::Slides::EffectFormat::get_OuterShadowEffect ( )
overridevirtual

Outer shadow. Read Effects::IOuterShadow.

Implements Aspose::Slides::IEffectFormat.

◆ get_PresetShadowEffect()

System::SharedPtr<Effects::IPresetShadow> Aspose::Slides::EffectFormat::get_PresetShadowEffect ( )
overridevirtual

Preset shadow. Read Effects::IPresetShadow.

Implements Aspose::Slides::IEffectFormat.

◆ get_ReflectionEffect()

System::SharedPtr<Effects::IReflection> Aspose::Slides::EffectFormat::get_ReflectionEffect ( )
overridevirtual

Reflection. Read Effects::IReflection.

Implements Aspose::Slides::IEffectFormat.

◆ get_SoftEdgeEffect()

System::SharedPtr<Effects::ISoftEdge> Aspose::Slides::EffectFormat::get_SoftEdgeEffect ( )
overridevirtual

Soft edge. Read Effects::ISoftEdge.

Implements Aspose::Slides::IEffectFormat.

◆ GetEffective()

System::SharedPtr<IEffectFormatEffectiveData> Aspose::Slides::EffectFormat::GetEffective ( )
overridevirtual

Gets effective effect formatting data with the inheritance applied.

Returns
A IEffectFormatEffectiveData.

This example demonstrates getting some of shape's effective effect properties.

auto pres = MakeObject<Presentation>(u"MyPresentation.pptx");
auto effectiveEffectFormat = pres->get_Slides()->idx_get(0)->get_Shapes()->idx_get(0)->get_EffectFormat()->GetEffective();
if (effectiveEffectFormat->get_IsNoEffects())
{
Console::WriteLine(u"The shape has not effects applied.");
}
else
{
if (effectiveEffectFormat->get_BlurEffect() != nullptr)
{
Console::WriteLine(String(u"Blur effect radius: ") + effectiveEffectFormat->get_BlurEffect()->get_Radius());
}
if (effectiveEffectFormat->get_FillOverlayEffect() != nullptr)
{
Console::WriteLine(String(u"Fill overlay effect fill type: ") + ObjectExt::ToString(effectiveEffectFormat->get_FillOverlayEffect()->get_FillFormat()->get_FillType()));
}
if (effectiveEffectFormat->get_GlowEffect() != nullptr)
{
Console::WriteLine(String(u"Glow effect color: ") + effectiveEffectFormat->get_GlowEffect()->get_Color());
}
if (effectiveEffectFormat->get_InnerShadowEffect() != nullptr)
{
Console::WriteLine(String(u"Inner shadow effect shadow color: ") + effectiveEffectFormat->get_InnerShadowEffect()->get_ShadowColor());
}
if (effectiveEffectFormat->get_OuterShadowEffect() != nullptr)
{
Console::WriteLine(String(u"Outer shadow effect shadow color: ") + effectiveEffectFormat->get_OuterShadowEffect()->get_ShadowColor());
}
if (effectiveEffectFormat->get_PresetShadowEffect() != nullptr)
{
Console::WriteLine(String(u"Preset shadow effect shadow color: ") + effectiveEffectFormat->get_PresetShadowEffect()->get_ShadowColor());
}
if (effectiveEffectFormat->get_ReflectionEffect() != nullptr)
{
Console::WriteLine(String(u"Reflection effect distance: ") + effectiveEffectFormat->get_ReflectionEffect()->get_Distance());
}
if (effectiveEffectFormat->get_SoftEdgeEffect() != nullptr)
{
Console::WriteLine(String(u"Soft edge effect radius: ") + effectiveEffectFormat->get_SoftEdgeEffect()->get_Radius());
}
}

Implements Aspose::Slides::IEffectFormat.

◆ set_BlurEffect()

void Aspose::Slides::EffectFormat::set_BlurEffect ( System::SharedPtr< Effects::IBlur value)
overridevirtual

Blur effect. Write Effects::IBlur.

Implements Aspose::Slides::IEffectFormat.

◆ set_FillOverlayEffect()

void Aspose::Slides::EffectFormat::set_FillOverlayEffect ( System::SharedPtr< Effects::IFillOverlay value)
overridevirtual

Fill overlay effect. Write Effects::IFillOverlay.

Implements Aspose::Slides::IEffectFormat.

◆ set_GlowEffect()

void Aspose::Slides::EffectFormat::set_GlowEffect ( System::SharedPtr< Effects::IGlow value)
overridevirtual

Glow effect. Write Effects::IGlow.

Implements Aspose::Slides::IEffectFormat.

◆ set_InnerShadowEffect()

void Aspose::Slides::EffectFormat::set_InnerShadowEffect ( System::SharedPtr< Effects::IInnerShadow value)
overridevirtual

Inner shadow. Write Effects::IInnerShadow.

Implements Aspose::Slides::IEffectFormat.

◆ set_OuterShadowEffect()

void Aspose::Slides::EffectFormat::set_OuterShadowEffect ( System::SharedPtr< Effects::IOuterShadow value)
overridevirtual

Outer shadow. Write Effects::IOuterShadow.

Implements Aspose::Slides::IEffectFormat.

◆ set_PresetShadowEffect()

void Aspose::Slides::EffectFormat::set_PresetShadowEffect ( System::SharedPtr< Effects::IPresetShadow value)
overridevirtual

Preset shadow. Write Effects::IPresetShadow.

Implements Aspose::Slides::IEffectFormat.

◆ set_ReflectionEffect()

void Aspose::Slides::EffectFormat::set_ReflectionEffect ( System::SharedPtr< Effects::IReflection value)
overridevirtual

Reflection. Write Effects::IReflection.

Implements Aspose::Slides::IEffectFormat.

◆ set_SoftEdgeEffect()

void Aspose::Slides::EffectFormat::set_SoftEdgeEffect ( System::SharedPtr< Effects::ISoftEdge value)
overridevirtual

Soft edge. Write Effects::ISoftEdge.

Implements Aspose::Slides::IEffectFormat.

◆ SetBlurEffect()

void Aspose::Slides::EffectFormat::SetBlurEffect ( double  radius,
bool  grow 
)
overridevirtual

Sets blur effect.

Parameters
radiusRadius.
growGrow.

Implements Aspose::Slides::IEffectFormat.