Package com.grapecity.documents.excel.drawing

Interface IFillFormat

public interface IFillFormat
Represents fill formatting for a shape.

  • Method Details

    • getPatternColor

      IColorFormat getPatternColor()
      Returns the IColorFormat object that represents the specified patterncolor.

    • getColor

      IColorFormat getColor()
      Returns the IColorFormat object that represents the specifiedforeground fill or solid color.

    • getVisible

      boolean getVisible()
      Determines whether the object is visible.

    • setVisible

      void setVisible(boolean value)
      Determines whether the object is visible.

    • getGradientAngle

      double getGradientAngle()
      Gets the angle of the gradient fill for the specified fill format.

    • setGradientAngle

      void setGradientAngle(double value)
      Sets the angle of the gradient fill for the specified fill format.

    • getGradientPathType

      PathShapeType getGradientPathType()
      Gets the path type for the gradient fill.

    • setGradientPathType

      void setGradientPathType(PathShapeType value)
      Sets the path type for the gradient fill.

    • getGradientDegree

      double getGradientDegree()
      Returns the gradient degree of the specified one-color shaded fill as a floating-point value from 0.0 (dark) through 1.0 (light).

    • getGradientStops

      IGradientStops getGradientStops()
      Returns the end point for the gradient fill.

    • getGradientStyle

      GradientStyle getGradientStyle()
      Returns the gradient style for the specified fill.

    • getGradientVariant

      int getGradientVariant()
      Returns the shade variant for the specified fill as an integer value from 1 through 4.

    • getPattern

      PatternType getPattern()
      Returns the fill pattern.

    • getPresetGradientType

      PresetGradientType getPresetGradientType()
      Returns the preset gradient type for the specified fill.

    • getPresetTexture

      PresetTexture getPresetTexture()
      Returns the preset texture for the specified fill.

    • getRotateWithObject

      boolean getRotateWithObject()
      Gets if the fill style should rotate with the object.

    • setRotateWithObject

      void setRotateWithObject(boolean value)
      Sets if the fill style should rotate with the object.

    • getTextureAlignment

      TextureAlignment getTextureAlignment()
      Gets the text alignment for the specified IFillFormat.

    • setTextureAlignment

      void setTextureAlignment(TextureAlignment value)
      Sets the text alignment for the specified IFillFormat.

    • getTextureHorizontalScale

      double getTextureHorizontalScale()
      Gets the value for horizontally scaling the text for the IFillFormat.

    • setTextureHorizontalScale

      void setTextureHorizontalScale(double value)
      Sets the value for horizontally scaling the text for the IFillFormat.

    • getTextureOffsetX

      double getTextureOffsetX()
      Returns the offset X value for the specified fill.

    • setTextureOffsetX

      void setTextureOffsetX(double value)
      Sets the offset X value for the specified fill.

    • getTextureOffsetY

      double getTextureOffsetY()
      Returns the offset Y value for the specified fill.

    • setTextureOffsetY

      void setTextureOffsetY(double value)
      Sets the offset Y value for the specified fill.

    • getTextureVerticalScale

      double getTextureVerticalScale()
      Returns the texture vertical scale for the specified fill.

    • setTextureVerticalScale

      void setTextureVerticalScale(double value)
      Sets the texture vertical scale for the specified fill.

    • getTransparency

      double getTransparency()
      Gets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).

    • setTransparency

      void setTransparency(double value)
      Sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).

    • getType

      FillType getType()
      Returns the fill type.

    • oneColorGradient

      void oneColorGradient(GradientStyle style, int variant, double degree)
      Sets the specified fill to a one-color gradient.
      Parameters:
      style - The GradientStyle to be set.
      variant - The gradient variant. Can be a value from 1 through 4,corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If GradientStyle is GradientFromCenter, the Variant argument can only be 1 or 2.
      degree - The gradient degree. Can be a value from 0.0 (dark) through 1.0(light).

    • patterned

      void patterned(PatternType pattern)
      Sets the specified fill to a pattern.
      Parameters:
      pattern - The PatternType object.

    • presetGradient

      void presetGradient(GradientStyle style, int variant, PresetGradientType presetGradientType)
      Sets the specified fill to a preset gradient.
      Parameters:
      style - The GradientStyle object to be set.
      variant - The gradient variant. Can be a value from 1 through 4,corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If GradientStyle is GradientFromCenter, the Variant argument can only be 1 or 2.
      presetGradientType - The PresetGradientType object.

    • presetTextured

      void presetTextured(PresetTexture presetTexture)
      Sets the specified fill format to a preset texture.
      Parameters:
      presetTexture - The PresetTexture.

    • solid

      void solid()
      Sets the specified fill to a uniform color.

    • twoColorGradient

      void twoColorGradient(GradientStyle style, int variant)
      Sets the specified fill to a two-color gradient.
      Parameters:
      style - The GradientStyle object.
      variant - The gradient variant. Can be a value from 1 through 4,corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If GradientStyle is GradientFromCenter, the Variant argument can only be 1 or 2.

    • userPicture

      void userPicture(String fileName) throws IOException
      Fills the specified shape with an image.
      Parameters:
      fileName - The name of the picture file.
      Throws:
      IOException

    • userPicture

      void userPicture(InputStream stream, ImageType type) throws IOException
      Fills the specified shape with an image.
      Parameters:
      stream - The stream of the picture file.
      type - The ImageType of the stream.
      Throws:
      IOException

    • userTextured

      void userTextured(String fileName) throws IOException
      Fills the specified shape with small tiles of an image.
      Parameters:
      fileName - The name of the picture file.
      Throws:
      IOException

    • userTextured

      void userTextured(InputStream stream, ImageType type)
      Fills the specified shape with small tiles of an image.
      Parameters:
      stream - The stream of the picture file.
      type - The ImageType of the stream.