[]
DEMOS DOCS API PRICING
FREE TRIAL
(Showing Draft Content)

GradientStyle

Enum Class GradientStyle

java.lang.Object
java.lang.Enum<GradientStyle>
com.grapecity.documents.excel.drawing.GradientStyle
All Implemented Interfaces:
Serializable, Comparable<GradientStyle>, Constable
public enum GradientStyle extends Enum<GradientStyle>
Specifies the style for a gradient fill.

Use this enum with gradient-related members such as IFillFormat.oneColorGradient(GradientStyle,int,double), IFillFormat.twoColorGradient(GradientStyle,int), and IFillFormat.presetGradient(GradientStyle,int,PresetGradientType) to control the direction and origin of a shape's gradient effect.


 IShape shape = worksheet.getShapes().addShape("GradientRect", AutoShapeType.Rectangle, 20, 20, 120, 60);
 shape.getFill().twoColorGradient(GradientStyle.Horizontal, 1);
 IGradientStops gradientStops = shape.getFill().getGradientStops();
 gradientStops.get(0).getColor().setRGB(Color.GetBlue());
 gradientStops.get(1).getColor().setRGB(Color.GetRed());

  • Enum Constant Details

    • Horizontal

      public static final GradientStyle Horizontal
      Specifies a gradient running horizontally across the shape.

    • Vertical

      public static final GradientStyle Vertical
      Specifies a gradient running vertically down the shape.

    • DiagonalUp

      public static final GradientStyle DiagonalUp
      Specifies a diagonal gradient moving from the bottom-left corner to the opposite top-right corner.

    • DiagonalDown

      public static final GradientStyle DiagonalDown
      Specifies a diagonal gradient moving from a top corner down to the opposite corner.

    • FromCorner

      public static final GradientStyle FromCorner
      Specifies a gradient that runs from one corner to the other three corners.

    • FromTitle

      public static final GradientStyle FromTitle
      Specifies a gradient running from the title outward.

    • FromCenter

      public static final GradientStyle FromCenter
      Specifies a gradient running from the center out to the corners.

      Use this value to apply a center-based gradient style. When used with gradient APIs that accept a variant, only variants 1 and 2 are supported.

    • Mixed

      public static final GradientStyle Mixed
      Specifies a mixed gradient style.

  • Method Details

    • values

      public static GradientStyle[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static GradientStyle valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null