Represents effect properties of shape. More...

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

Public Member Functions

bool get_IsNoEffects ()
 Returns true if all effects are disabled (as just created, default EffectFormat object). Read-only bool. More...
 
System::SharedPtr< Effects::IBlurget_BlurEffect ()
 Blur effect. Read IBlur. More...
 
void set_BlurEffect (System::SharedPtr< Effects::IBlur > value)
 Blur effect. Write IBlur. More...
 
System::SharedPtr< Effects::IFillOverlayget_FillOverlayEffect ()
 Fill overlay effect. Read IFillOverlay. More...
 
void set_FillOverlayEffect (System::SharedPtr< Effects::IFillOverlay > value)
 Fill overlay effect. Write IFillOverlay. More...
 
System::SharedPtr< Effects::IGlowget_GlowEffect ()
 Glow effect. Read IGlow. More...
 
void set_GlowEffect (System::SharedPtr< Effects::IGlow > value)
 Glow effect. Write IGlow. More...
 
System::SharedPtr< Effects::IInnerShadowget_InnerShadowEffect ()
 Inner shadow. Read IInnerShadow. More...
 
void set_InnerShadowEffect (System::SharedPtr< Effects::IInnerShadow > value)
 Inner shadow. Write IInnerShadow. More...
 
System::SharedPtr< Effects::IOuterShadowget_OuterShadowEffect ()
 Outer shadow. Read IOuterShadow. More...
 
void set_OuterShadowEffect (System::SharedPtr< Effects::IOuterShadow > value)
 Outer shadow. Write IOuterShadow. More...
 
System::SharedPtr< Effects::IPresetShadowget_PresetShadowEffect ()
 Preset shadow. Read IPresetShadow. More...
 
void set_PresetShadowEffect (System::SharedPtr< Effects::IPresetShadow > value)
 Preset shadow. Write IPresetShadow. More...
 
System::SharedPtr< Effects::IReflectionget_ReflectionEffect ()
 Reflection. Read IReflection. More...
 
void set_ReflectionEffect (System::SharedPtr< Effects::IReflection > value)
 Reflection. Write IReflection. More...
 
System::SharedPtr< Effects::ISoftEdgeget_SoftEdgeEffect ()
 Soft edge. Read ISoftEdge. More...
 
void set_SoftEdgeEffect (System::SharedPtr< Effects::ISoftEdge > value)
 Soft edge. Write ISoftEdge. More...
 
void SetBlurEffect (double radius, bool grow)
 Sets blur effect. More...
 
void EnableFillOverlayEffect ()
 Enables fill overlay effect. More...
 
void EnableGlowEffect ()
 Enables glow effect. More...
 
void EnableInnerShadowEffect ()
 Enables inner shadow effect. More...
 
void EnableOuterShadowEffect ()
 Enables outer shadow effect. More...
 
void EnablePresetShadowEffect ()
 Enables preset shadows effect. More...
 
void EnableReflectionEffect ()
 Enables reflection effect. More...
 
void EnableSoftEdgeEffect ()
 Enables soft edge effect. More...
 
void DisableBlurEffect ()
 Disables blur effect. More...
 
void DisableFillOverlayEffect ()
 Disables fill overlay effect. More...
 
void DisableGlowEffect ()
 Disable glow effect. More...
 
void DisableInnerShadowEffect ()
 Disables inner shadow effect. More...
 
void DisableOuterShadowEffect ()
 Disables outer shadow effect. More...
 
void DisablePresetShadowEffect ()
 Disables preset shadow effect. More...
 
void DisableReflectionEffect ()
 Disables reflection effect. More...
 
void DisableSoftEdgeEffect ()
 Disables soft edge effect. More...
 
System::SharedPtr< IEffectFormatEffectiveDataGetEffective ()
 Gets effective effect formatting 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< EffectFormatImpl > get_RealObject ()
 
bool get_IsExplicitlyDefined ()
 Returns if the format is explicitly defined. True if the format is not empty or explicitly empty (in this case it should override parent's EffectFormat settings with empty value), False otherwise. Read-only bool. More...
 
 EffectFormat (System::SharedPtr< IDOMObject > parentImmediate)
 
virtual void CreateChildObjects ()
 
virtual System::SharedPtr< System::ObjectCreateRealObject ()
 
void CopyDataFrom (System::SharedPtr< IEffectFormat > source)
 
void CopyDataFrom (System::SharedPtr< IEffectFormatEffectiveData > source)
 
void SetExplicitlyEmpty ()
 Clears all effects and marks the format as explicitly defined. More...
 
void SetNotDefined ()
 Clears all effects and marks the format as not defined. More...
 
void Reset ()
 Sets all properties to NotDefined state. More...
 
System::SharedPtr< EffectFormatEffectiveData > 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 ()
 

Protected Attributes

System::Event< void()> EffectFormatChanged
 

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 effect properties of shape.

Constructor & Destructor Documentation

◆ EffectFormat()

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

Member Function Documentation

◆ CopyDataFrom() [1/2]

void Aspose::Slides::EffectFormat::CopyDataFrom ( System::SharedPtr< IEffectFormat source)
protected

◆ CopyDataFrom() [2/2]

void Aspose::Slides::EffectFormat::CopyDataFrom ( System::SharedPtr< IEffectFormatEffectiveData source)
protected

◆ CreateChildObjects()

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

◆ CreateRealObject()

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

◆ DisableBlurEffect()

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

Disables blur effect.

Implements Aspose::Slides::IEffectFormat.

◆ DisableFillOverlayEffect()

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

Disables fill overlay effect.

Implements Aspose::Slides::IEffectFormat.

◆ DisableGlowEffect()

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

Disable glow effect.

Implements Aspose::Slides::IEffectFormat.

◆ DisableInnerShadowEffect()

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

Disables inner shadow effect.

Implements Aspose::Slides::IEffectFormat.

◆ DisableOuterShadowEffect()

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

Disables outer shadow effect.

Implements Aspose::Slides::IEffectFormat.

◆ DisablePresetShadowEffect()

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

Disables preset shadow effect.

Implements Aspose::Slides::IEffectFormat.

◆ DisableReflectionEffect()

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

Disables reflection effect.

Implements Aspose::Slides::IEffectFormat.

◆ DisableSoftEdgeEffect()

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

Disables soft edge effect.

Implements Aspose::Slides::IEffectFormat.

◆ EnableFillOverlayEffect()

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

Enables fill overlay effect.

Implements Aspose::Slides::IEffectFormat.

◆ EnableGlowEffect()

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

Enables glow effect.

Implements Aspose::Slides::IEffectFormat.

◆ EnableInnerShadowEffect()

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

Enables inner shadow effect.

Implements Aspose::Slides::IEffectFormat.

◆ EnableOuterShadowEffect()

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

Enables outer shadow effect.

Implements Aspose::Slides::IEffectFormat.

◆ EnablePresetShadowEffect()

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

Enables preset shadows effect.

Implements Aspose::Slides::IEffectFormat.

◆ EnableReflectionEffect()

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

Enables reflection effect.

Implements Aspose::Slides::IEffectFormat.

◆ EnableSoftEdgeEffect()

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

Enables soft edge effect.

Implements Aspose::Slides::IEffectFormat.

◆ get_BlurEffect()

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

Blur effect. Read IBlur.

Implements Aspose::Slides::IEffectFormat.

◆ get_FillOverlayEffect()

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

Fill overlay effect. Read IFillOverlay.

Implements Aspose::Slides::IEffectFormat.

◆ get_GlowEffect()

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

Glow effect. Read IGlow.

Implements Aspose::Slides::IEffectFormat.

◆ get_InnerShadowEffect()

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

Inner shadow. Read IInnerShadow.

Implements Aspose::Slides::IEffectFormat.

◆ get_IsExplicitlyDefined()

bool Aspose::Slides::EffectFormat::get_IsExplicitlyDefined ( )
protected

Returns if the format is explicitly defined. True if the format is not empty or explicitly empty (in this case it should override parent's EffectFormat settings with empty value), False otherwise. Read-only bool.

◆ get_IsNoEffects()

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

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

Outer shadow. Read IOuterShadow.

Implements Aspose::Slides::IEffectFormat.

◆ get_PresetShadowEffect()

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

Preset shadow. Read IPresetShadow.

Implements Aspose::Slides::IEffectFormat.

◆ get_RealObject()

System::SharedPtr<EffectFormatImpl> Aspose::Slides::EffectFormat::get_RealObject ( )
protected

◆ get_ReflectionEffect()

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

Reflection. Read IReflection.

Implements Aspose::Slides::IEffectFormat.

◆ get_SoftEdgeEffect()

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

Soft edge. Read ISoftEdge.

Implements Aspose::Slides::IEffectFormat.

◆ GetEffective()

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

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.

◆ GetEffectiveInternal()

System::SharedPtr<EffectFormatEffectiveData> Aspose::Slides::EffectFormat::GetEffectiveInternal ( )
protected

◆ Reset()

void Aspose::Slides::EffectFormat::Reset ( )
protected

Sets all properties to NotDefined state.

◆ set_BlurEffect()

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

Blur effect. Write IBlur.

Implements Aspose::Slides::IEffectFormat.

◆ set_FillOverlayEffect()

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

Fill overlay effect. Write IFillOverlay.

Implements Aspose::Slides::IEffectFormat.

◆ set_GlowEffect()

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

Glow effect. Write IGlow.

Implements Aspose::Slides::IEffectFormat.

◆ set_InnerShadowEffect()

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

Inner shadow. Write IInnerShadow.

Implements Aspose::Slides::IEffectFormat.

◆ set_OuterShadowEffect()

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

Outer shadow. Write IOuterShadow.

Implements Aspose::Slides::IEffectFormat.

◆ set_PresetShadowEffect()

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

Preset shadow. Write IPresetShadow.

Implements Aspose::Slides::IEffectFormat.

◆ set_ReflectionEffect()

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

Reflection. Write IReflection.

Implements Aspose::Slides::IEffectFormat.

◆ set_SoftEdgeEffect()

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

Soft edge. Write ISoftEdge.

Implements Aspose::Slides::IEffectFormat.

◆ SetBlurEffect()

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

Sets blur effect.

Parameters
radiusRadius.
growGrow.

Implements Aspose::Slides::IEffectFormat.

◆ SetExplicitlyEmpty()

void Aspose::Slides::EffectFormat::SetExplicitlyEmpty ( )
protected

Clears all effects and marks the format as explicitly defined.

◆ SetNotDefined()

void Aspose::Slides::EffectFormat::SetNotDefined ( )
protected

Clears all effects and marks the format as not defined.

Member Data Documentation

◆ EffectFormatChanged

System::Event<void()> Aspose::Slides::EffectFormat::EffectFormatChanged
protected