public class EffectFormat extends PVIObject implements IEffectFormat
Represents effect properties of shape.
Modifier and Type | Method and Description |
---|---|
void |
disableBlurEffect()
Disables blur effect.
|
void |
disableFillOverlayEffect()
Disables fill overlay effect.
|
void |
disableGlowEffect()
Disable glow effect.
|
void |
disableInnerShadowEffect()
Disables inner shadow effect.
|
void |
disableOuterShadowEffect()
Disables outer shadow effect.
|
void |
disablePresetShadowEffect()
Disables preset shadow effect.
|
void |
disableReflectionEffect()
Disables reflection effect.
|
void |
disableSoftEdgeEffect()
Disables soft edge effect.
|
void |
enableFillOverlayEffect()
Enables fill overlay effect.
|
void |
enableGlowEffect()
Enables glow effect.
|
void |
enableInnerShadowEffect()
Enables inner shadow effect.
|
void |
enableOuterShadowEffect()
Enables outer shadow effect.
|
void |
enablePresetShadowEffect()
Enables preset shadows effect.
|
void |
enableReflectionEffect()
Enables reflection effect.
|
void |
enableSoftEdgeEffect()
Enables soft edge effect.
|
IBlur |
getBlurEffect()
Blur effect.
|
IEffectFormatEffectiveData |
getEffective()
Gets effective effect formatting data with the inheritance applied.
|
IFillOverlay |
getFillOverlayEffect()
Fill overlay effect.
|
IGlow |
getGlowEffect()
Glow effect.
|
IInnerShadow |
getInnerShadowEffect()
Inner shadow.
|
IOuterShadow |
getOuterShadowEffect()
Outer shadow.
|
IPresetShadow |
getPresetShadowEffect()
Preset shadow.
|
IReflection |
getReflectionEffect()
Reflection.
|
ISoftEdge |
getSoftEdgeEffect()
Soft edge.
|
boolean |
isNoEffects()
Returns true if all effects are disabled (as just created, default EffectFormat object).
|
void |
setBlurEffect(double radius,
boolean grow)
Sets blur effect.
|
void |
setBlurEffect(IBlur value)
Blur effect.
|
void |
setFillOverlayEffect(IFillOverlay value)
Fill overlay effect.
|
void |
setGlowEffect(IGlow value)
Glow effect.
|
void |
setInnerShadowEffect(IInnerShadow value)
Inner shadow.
|
void |
setOuterShadowEffect(IOuterShadow value)
Outer shadow.
|
void |
setPresetShadowEffect(IPresetShadow value)
Preset shadow.
|
void |
setReflectionEffect(IReflection value)
Reflection.
|
void |
setSoftEdgeEffect(ISoftEdge value)
Soft edge.
|
equals, getParent_Immediate, getParent_IPresentationComponent, getParent_ISlideComponent, getPresentation, getSlide, getVersion, hashCode, reset_Parent_IPresentationComponent
public final boolean isNoEffects()
Returns true if all effects are disabled (as just created, default EffectFormat object).
Read-only boolean
.
isNoEffects
in interface IEffectFormat
public final IBlur getBlurEffect()
Blur effect.
Read/write IBlur
.
getBlurEffect
in interface IEffectFormat
public final void setBlurEffect(IBlur value)
Blur effect.
Read/write IBlur
.
setBlurEffect
in interface IEffectFormat
public final IFillOverlay getFillOverlayEffect()
Fill overlay effect.
Read/write IFillOverlay
.
getFillOverlayEffect
in interface IEffectFormat
public final void setFillOverlayEffect(IFillOverlay value)
Fill overlay effect.
Read/write IFillOverlay
.
setFillOverlayEffect
in interface IEffectFormat
public final IGlow getGlowEffect()
Glow effect.
Read/write IGlow
.
getGlowEffect
in interface IEffectFormat
public final void setGlowEffect(IGlow value)
Glow effect.
Read/write IGlow
.
setGlowEffect
in interface IEffectFormat
public final IInnerShadow getInnerShadowEffect()
Inner shadow.
Read/write IInnerShadow
.
getInnerShadowEffect
in interface IEffectFormat
public final void setInnerShadowEffect(IInnerShadow value)
Inner shadow.
Read/write IInnerShadow
.
setInnerShadowEffect
in interface IEffectFormat
public final IOuterShadow getOuterShadowEffect()
Outer shadow.
Read/write IOuterShadow
.
getOuterShadowEffect
in interface IEffectFormat
public final void setOuterShadowEffect(IOuterShadow value)
Outer shadow.
Read/write IOuterShadow
.
setOuterShadowEffect
in interface IEffectFormat
public final IPresetShadow getPresetShadowEffect()
Preset shadow.
Read/write IPresetShadow
.
getPresetShadowEffect
in interface IEffectFormat
public final void setPresetShadowEffect(IPresetShadow value)
Preset shadow.
Read/write IPresetShadow
.
setPresetShadowEffect
in interface IEffectFormat
public final IReflection getReflectionEffect()
Reflection.
Read/write IReflection
.
getReflectionEffect
in interface IEffectFormat
public final void setReflectionEffect(IReflection value)
Reflection.
Read/write IReflection
.
setReflectionEffect
in interface IEffectFormat
public final ISoftEdge getSoftEdgeEffect()
Soft edge.
Read/write ISoftEdge
.
getSoftEdgeEffect
in interface IEffectFormat
public final void setSoftEdgeEffect(ISoftEdge value)
Soft edge.
Read/write ISoftEdge
.
setSoftEdgeEffect
in interface IEffectFormat
public final void setBlurEffect(double radius, boolean grow)
Sets blur effect.
setBlurEffect
in interface IEffectFormat
radius
- Radius.grow
- Grow.public final void enableFillOverlayEffect()
Enables fill overlay effect.
enableFillOverlayEffect
in interface IEffectFormat
public final void enableGlowEffect()
Enables glow effect.
enableGlowEffect
in interface IEffectFormat
public final void enableInnerShadowEffect()
Enables inner shadow effect.
enableInnerShadowEffect
in interface IEffectFormat
public final void enableOuterShadowEffect()
Enables outer shadow effect.
enableOuterShadowEffect
in interface IEffectFormat
public final void enablePresetShadowEffect()
Enables preset shadows effect.
enablePresetShadowEffect
in interface IEffectFormat
public final void enableReflectionEffect()
Enables reflection effect.
enableReflectionEffect
in interface IEffectFormat
public final void enableSoftEdgeEffect()
Enables soft edge effect.
enableSoftEdgeEffect
in interface IEffectFormat
public final void disableBlurEffect()
Disables blur effect.
disableBlurEffect
in interface IEffectFormat
public final void disableFillOverlayEffect()
Disables fill overlay effect.
disableFillOverlayEffect
in interface IEffectFormat
public final void disableGlowEffect()
Disable glow effect.
disableGlowEffect
in interface IEffectFormat
public final void disableInnerShadowEffect()
Disables inner shadow effect.
disableInnerShadowEffect
in interface IEffectFormat
public final void disableOuterShadowEffect()
Disables outer shadow effect.
disableOuterShadowEffect
in interface IEffectFormat
public final void disablePresetShadowEffect()
Disables preset shadow effect.
disablePresetShadowEffect
in interface IEffectFormat
public final void disableReflectionEffect()
Disables reflection effect.
disableReflectionEffect
in interface IEffectFormat
public final void disableSoftEdgeEffect()
Disables soft edge effect.
disableSoftEdgeEffect
in interface IEffectFormat
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(); }
getEffective
in interface IEffectFormat
IEffectFormatEffectiveData
.