Namespace EasyXLS.Drawings.Formatting

Class ShadowFormat

System.Object
EasyXLS.Drawings.Formatting.ShadowFormat
public class ShadowFormat extends System.Object
This class stores the shadow options for images, shapes and other drawing objects. It allows to set a predefined shadow or to create a new one. There are 4 types of base shadows: none, outer, inner or perspective shadow.

  • Constant Summary

    Fields
    Modifier and Type
    Field
    Description
    const System.String
    ALIGNMENT_BOTTOM
    A constant indicating the bottom alignment.
    const System.String
    ALIGNMENT_BOTTOM_LEFT
    A constant indicating the bottom left alignment.
    const System.String
    ALIGNMENT_BOTTOM_RIGHT
    A constant indicating the bottom right alignment.
    const System.String
    ALIGNMENT_CENTER
    A constant indicating the center alignment.
    const System.String
    ALIGNMENT_LEFT
    A constant indicating the left alignment.
    const System.String
    ALIGNMENT_RIGHT
    A constant indicating the right alignment.
    const System.String
    ALIGNMENT_TOP
    A constant indicating the top alignment.
    const System.String
    ALIGNMENT_TOP_LEFT
    A constant indicating the top left alignment.
    const System.String
    ALIGNMENT_TOP_RIGHT
    A constant indicating the top right alignment.
    const short
    INSIDE_BOTTOM
    A constant indicating the inside bottom shadow.
    const short
    INSIDE_CENTER
    A constant indicating the inside center shadow.
    const short
    INSIDE_DIAGONAL_BOTTOM_LEFT
    A constant indicating the inside diagonal bottom left shadow.
    const short
    INSIDE_DIAGONAL_BOTTOM_RIGHT
    A constant indicating the inside diagonal bottom right shadow.
    const short
    INSIDE_DIAGONAL_TOP_LEFT
    A constant indicating the inside diagonal top left shadow.
    const short
    INSIDE_DIAGONAL_TOP_RIGHT
    A constant indicating the inside diagonal top right shadow.
    const short
    INSIDE_LEFT
    A constant indicating the inside left shadow.
    const short
    INSIDE_RIGHT
    A constant indicating the inside right shadow.
    const short
    INSIDE_TOP
    A constant indicating the inside top shadow.
    const short
    NO_SHADOW
    A constant indicating that no shadow is set.
    const short
    OFFSET_BOTTOM
    A constant indicating the offset bottom shadow.
    const short
    OFFSET_CENTER
    A constant indicating the offset center shadow.
    const short
    OFFSET_DIAGONAL_BOTTOM_LEFT
    A constant indicating the offset diagonal bottom left shadow.
    const short
    OFFSET_DIAGONAL_BOTTOM_RIGHT
    A constant indicating the offset diagonal bottom right shadow.
    const short
    OFFSET_DIAGONAL_TOP_LEFT
    A constant indicating the offset diagonal top left shadow.
    const short
    OFFSET_DIAGONAL_TOP_RIGHT
    A constant indicating the offset diagonal top right shadow.
    const short
    OFFSET_LEFT
    A constant indicating the offset left shadow.
    const short
    OFFSET_RIGHT
    A constant indicating the offset right shadow.
    const short
    OFFSET_TOP
    A constant indicating the offset top shadow.
    const short
    PERSPECTIVE_BELOW
    A constant indicating the perspective below shadow.
    const short
    PERSPECTIVE_DIAGONAL_LOWER_LEFT
    A constant indicating the perspective diagonal lower left shadow.
    const short
    PERSPECTIVE_DIAGONAL_LOWER_RIGHT
    A constant indicating the perspective diagonal lower right shadow.
    const short
    PERSPECTIVE_DIAGONAL_UPPER_LEFT
    A constant indicating the perspective diagonal upper left shadow.
    const short
    PERSPECTIVE_DIAGONAL_UPPER_RIGHT
    A constant indicating the perspective diagonal upper right shadow.
    const short
    TYPE_INNER
    A constant indicating the inner shadow type.
    const short
    TYPE_NO_SHADOW
    A constant indicating that no shadow type is set.
    const short
    TYPE_OUTER
    A constant indicating the outer shadow type.
    const short
    TYPE_PERSPECTIVE
    A constant indicating the perspective shadow type.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ShadowFormat()
    Defines an instance of the shadow formatting.

  • Method Summary

    Modifier and Type
    Method
    Description
    ShadowFormat
    Clone()
    Creates and returns a copy of this object.
    System.String
    getAlignment()
    Returns the alignment of the shadow.
    float
    getAngle()
    Returns the angle of the shadow.
    float
    getBlur()
    Returns the blur of the shadow.
    System.Drawing.Color
    getColor()
    Returns the shadow color
    float
    getDistance()
    Returns the distance of the shadow.
    int
    getShadowType()
    Returns the shadow type of the shape.
    float
    getSize()
    Returns the size of the shadow.
    ThemeColor
    getThemeColor()
    Returns the shadow color
    int
    getTransparency()
    Returns the transparency of the shadow.
    bool
    HasShadow()
    Returns true if the shape has shadow, false otherwise.
    bool
    IsLowerPerspective()
    Returns true if it is a perspective shadow displayed in front of the shape, false otherwise.
    void
    setAngle​(float angle)
    Sets the angle of the shadow.
    void
    setBlur​(float blur)
    Sets the blur of the shadow.
    void
    setColor​(ThemeColor themeColor)
    Sets the shadow color.
    This method is overridden as setColor_2 in COM+ version of EasyXLS.
    void
    setColor​(System.Drawing.Color color)
    Sets the shadow color.
    void
    setDistance​(float distance)
    Sets the distance of the shadow.
    void
    setInnerShadow​(int transparency, float blur, float angle, float distance)
    Sets the inner shadow option of the shape.
    void
    setNoShadow​(bool hasShadow)
    Sets the no shadow option of the shape.
    void
    setOuterShadow​(int transparency, float size, float blur, float angle, float distance, System.String alignment)
    Sets the outer shadow option of the shape.
    void
    setPerspectiveShadow​(int transparency, float size, float blur, float angle, float distance, System.String alignment, bool isLower)
    Sets the perspective shadow option of the shape.
    void
    setShadow​(int presetShadows)
    Sets the shadow of the shape.
    void
    setSize​(float size)
    Sets the size of the shadow.
    void
    setTransparency​(int transparency)
    Sets the transparency of the shadow.

    Methods inherited from class System.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait