EffectFormat

Inheritance: java.lang.Object, com.aspose.slides.PVIObject

All Implemented Interfaces: com.aspose.slides.IEffectFormat

public final class EffectFormat extends PVIObject implements IEffectFormat

Represents effect properties of shape.

Methods

Method	Description
getVersion()
isNoEffects()	Returns true if all effects are disabled (as just created, default EffectFormat object).
getBlurEffect()	Blur effect.
setBlurEffect(IBlur value)	Blur effect.
getFillOverlayEffect()	Fill overlay effect.
setFillOverlayEffect(IFillOverlay value)	Fill overlay effect.
getGlowEffect()	Glow effect.
setGlowEffect(IGlow value)	Glow effect.
getInnerShadowEffect()	Inner shadow.
setInnerShadowEffect(IInnerShadow value)	Inner shadow.
getOuterShadowEffect()	Outer shadow.
setOuterShadowEffect(IOuterShadow value)	Outer shadow.
getPresetShadowEffect()	Preset shadow.
setPresetShadowEffect(IPresetShadow value)	Preset shadow.
getReflectionEffect()	Reflection.
setReflectionEffect(IReflection value)	Reflection.
getSoftEdgeEffect()	Soft edge.
setSoftEdgeEffect(ISoftEdge value)	Soft edge.
setBlurEffect(double radius, boolean grow)	Sets blur effect.
enableFillOverlayEffect()	Enables fill overlay effect.
enableGlowEffect()	Enables glow effect.
enableInnerShadowEffect()	Enables inner shadow effect.
enableOuterShadowEffect()	Enables outer shadow effect.
enablePresetShadowEffect()	Enables preset shadows effect.
enableReflectionEffect()	Enables reflection effect.
enableSoftEdgeEffect()	Enables soft edge effect.
disableBlurEffect()	Disables blur effect.
disableFillOverlayEffect()	Disables fill overlay effect.
disableGlowEffect()	Disable glow effect.
disableInnerShadowEffect()	Disables inner shadow effect.
disableOuterShadowEffect()	Disables outer shadow effect.
disablePresetShadowEffect()	Disables preset shadow effect.
disableReflectionEffect()	Disables reflection effect.
disableSoftEdgeEffect()	Disables soft edge effect.
getEffective()	Gets effective effect formatting data with the inheritance applied.

getVersion()

public long getVersion()

Version. Read-only long.

Returns: long

isNoEffects()

public final boolean isNoEffects()

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

Returns: boolean

getBlurEffect()

public final IBlur getBlurEffect()

Blur effect. Read/write IBlur.

Returns: IBlur

setBlurEffect(IBlur value)

public final void setBlurEffect(IBlur value)

Blur effect. Read/write IBlur.

Parameters:

Parameter	Type	Description
value	IBlur

getFillOverlayEffect()

public final IFillOverlay getFillOverlayEffect()

Fill overlay effect. Read/write IFillOverlay.

Returns: IFillOverlay

setFillOverlayEffect(IFillOverlay value)

public final void setFillOverlayEffect(IFillOverlay value)

Fill overlay effect. Read/write IFillOverlay.

Parameters:

Parameter	Type	Description
value	IFillOverlay

getGlowEffect()

public final IGlow getGlowEffect()

Glow effect. Read/write IGlow.

Returns: IGlow

setGlowEffect(IGlow value)

public final void setGlowEffect(IGlow value)

Glow effect. Read/write IGlow.

Parameters:

Parameter	Type	Description
value	IGlow

getInnerShadowEffect()

public final IInnerShadow getInnerShadowEffect()

Inner shadow. Read/write IInnerShadow.

Returns: IInnerShadow

setInnerShadowEffect(IInnerShadow value)

public final void setInnerShadowEffect(IInnerShadow value)

Inner shadow. Read/write IInnerShadow.

Parameters:

Parameter	Type	Description
value	IInnerShadow

getOuterShadowEffect()

public final IOuterShadow getOuterShadowEffect()

Outer shadow. Read/write IOuterShadow.

Returns: IOuterShadow

setOuterShadowEffect(IOuterShadow value)

public final void setOuterShadowEffect(IOuterShadow value)

Outer shadow. Read/write IOuterShadow.

Parameters:

Parameter	Type	Description
value	IOuterShadow

getPresetShadowEffect()

public final IPresetShadow getPresetShadowEffect()

Preset shadow. Read/write IPresetShadow.

Returns: IPresetShadow

setPresetShadowEffect(IPresetShadow value)

public final void setPresetShadowEffect(IPresetShadow value)

Preset shadow. Read/write IPresetShadow.

Parameters:

Parameter	Type	Description
value	IPresetShadow

getReflectionEffect()

public final IReflection getReflectionEffect()

Reflection. Read/write IReflection.

Returns: IReflection

setReflectionEffect(IReflection value)

public final void setReflectionEffect(IReflection value)

Reflection. Read/write IReflection.

Parameters:

Parameter	Type	Description
value	IReflection

getSoftEdgeEffect()

public final ISoftEdge getSoftEdgeEffect()

Soft edge. Read/write ISoftEdge.

Returns: ISoftEdge

setSoftEdgeEffect(ISoftEdge value)

public final void setSoftEdgeEffect(ISoftEdge value)

Soft edge. Read/write ISoftEdge.

Parameters:

Parameter	Type	Description
value	ISoftEdge

setBlurEffect(double radius, boolean grow)

public final void setBlurEffect(double radius, boolean grow)

Sets blur effect.

Parameters:

Parameter	Type	Description
radius	double	Radius.
grow	boolean	Grow.

enableFillOverlayEffect()

public final void enableFillOverlayEffect()

Enables fill overlay effect.

enableGlowEffect()

public final void enableGlowEffect()

Enables glow effect.

enableInnerShadowEffect()

public final void enableInnerShadowEffect()

Enables inner shadow effect.

enableOuterShadowEffect()

public final void enableOuterShadowEffect()

Enables outer shadow effect.

enablePresetShadowEffect()

public final void enablePresetShadowEffect()

Enables preset shadows effect.

enableReflectionEffect()

public final void enableReflectionEffect()

Enables reflection effect.

enableSoftEdgeEffect()

public final void enableSoftEdgeEffect()

Enables soft edge effect.

disableBlurEffect()

public final void disableBlurEffect()

Disables blur effect.

disableFillOverlayEffect()

public final void disableFillOverlayEffect()

Disables fill overlay effect.

disableGlowEffect()

public final void disableGlowEffect()

Disable glow effect.

disableInnerShadowEffect()

public final void disableInnerShadowEffect()

Disables inner shadow effect.

disableOuterShadowEffect()

public final void disableOuterShadowEffect()

Disables outer shadow effect.

disablePresetShadowEffect()

public final void disablePresetShadowEffect()

Disables preset shadow effect.

disableReflectionEffect()

public final void disableReflectionEffect()

Disables reflection effect.

disableSoftEdgeEffect()

public final void disableSoftEdgeEffect()

Disables soft edge effect.

getEffective()

public final IEffectFormatEffectiveData getEffective()

Gets effective effect formatting data with the inheritance applied.

---

This example demonstrates getting some of shape's effective effect properties.
 
 Presentation pres = new Presentation("MyPresentation.pptx");
 try
 {
 	IEffectFormatEffectiveData effectiveEffectFormat = pres.getSlides().get_Item(0).Shapes().get_Item(0).getEffectFormat().getEffective();
 	if (effectiveEffectFormat.isNoEffects())
 	{
 		System.out.println("The shape has not effects applied.");
 	}
 	else
 	{
 		if (effectiveEffectFormat.getBlurEffect() != null)
 			System.out.println("Blur effect radius: " + effectiveEffectFormat.getBlurEffect().getRadius());
 		if (effectiveEffectFormat.getFillOverlayEffect() != null)
 			System.out.println("Fill overlay effect fill type: " + effectiveEffectFormat.getFillOverlayEffect().getFillFormat().getFillType());
 		if (effectiveEffectFormat.getGlowEffect() != null)
 			System.out.println("Glow effect color: " + effectiveEffectFormat.getGlowEffect().getColor());
 		if (effectiveEffectFormat.getInnerShadowEffect() != null)
 			System.out.println("Inner shadow effect shadow color: " + effectiveEffectFormat.getInnerShadowEffect().getShadowColor());
 		if (effectiveEffectFormat.getOuterShadowEffect() != null)
 			System.out.println("Outer shadow effect shadow color: " + effectiveEffectFormat.getOuterShadowEffect().getShadowColor());
 		if (effectiveEffectFormat.getPresetShadowEffect() != null)
 			System.out.println("Preset shadow effect shadow color: " + effectiveEffectFormat.getPresetShadowEffect().getShadowColor());
 		if (effectiveEffectFormat.getReflectionEffect() != null)
 			System.out.println("Reflection effect distance: " + effectiveEffectFormat.getReflectionEffect().getDistance());
 		if (effectiveEffectFormat.getSoftEdgeEffect() != null)
 			System.out.println("Soft edge effect radius: " + effectiveEffectFormat.getSoftEdgeEffect().getRadius());
 	}
 } finally {
     if (pres != null) pres.dispose();
 }

Returns: IEffectFormatEffectiveData - A IEffectFormatEffectiveData.