Namespace EasyXLS.Drawings.Formatting
Class FillFormat
- System.Object
-
- EasyXLS.Drawings.Formatting.FillFormat
-
public class FillFormat extends System.Object
This class stores the fill options for images, shapes and other drawing objects. There are 6 types of fill extends no fill, solid fill, gradient fill, picture or texture fill, pattern fill and automatic.
-
-
Constant Summary
Fields Modifier and Type Field Description const int
GRADIENT_DIRECTION_FROM_CENTER
A constant indicating the gradient direction from center.const int
GRADIENT_DIRECTION_FROM_CORNER_BOTTOM_LEFT_TO_UPPER_RIGHT
A constant indicating the gradient direction from bottom left corner to upper right corner.const int
GRADIENT_DIRECTION_FROM_CORNER_BOTTOM_RIGHT_TO_UPPER_LEFT
A constant indicating the gradient direction from bottom right corner to upper left corner.const int
GRADIENT_DIRECTION_FROM_CORNER_UPPER_LEFT_TO_BOTTOM_RIGHT
A constant indicating the gradient direction from upper left corner to bottom right corner.const int
GRADIENT_DIRECTION_FROM_CORNER_UPPER_RIGHT_TO_BOTTOM_LEFT
A constant indicating the gradient direction from upper right corner to bottom left corner.const int
GRADIENT_DIRECTION_LINEAR_DIAGONAL_135_DEGREES
A constant indicating the linear diagonal gradient direction (a gradient angle of 135 degrees).const int
GRADIENT_DIRECTION_LINEAR_DIAGONAL_225_DEGREES
A constant indicating the linear diagonal gradient direction (a gradient angle of 225 degrees).const int
GRADIENT_DIRECTION_LINEAR_DIAGONAL_315_DEGREES
A constant indicating the linear diagonal gradient direction (a gradient angle of 315 degrees).const int
GRADIENT_DIRECTION_LINEAR_DIAGONAL_45_DEGREES
A constant indicating the linear diagonal gradient direction (a gradient angle of 45 degrees).const int
GRADIENT_DIRECTION_LINEAR_DOWN_90_DEGREES
A constant indicating the linear down gradient direction (a gradient angle of 90 degrees).const int
GRADIENT_DIRECTION_LINEAR_LEFT_180_DEGREES
A constant indicating the linear left gradient direction (a gradient angle of 180 degrees).const int
GRADIENT_DIRECTION_LINEAR_RIGHT_0_DEGREES
A constant indicating the linear right gradient direction (a gradient angle of 0 degrees).const int
GRADIENT_DIRECTION_LINEAR_UP_270_DEGREES
A constant indicating the linear up gradient direction (a gradient angle of 270 degrees).const int
GRADIENT_FILL_BRASS
A constant indicating the brass gradient fill.const int
GRADIENT_FILL_CALM_WATER
A constant indicating the calm water gradient fill.const int
GRADIENT_FILL_CHROME
A constant indicating the chrome gradient fill.const int
GRADIENT_FILL_CHROME_II
A constant indicating the chrome II gradient fill.const int
GRADIENT_FILL_DAYBREAK
A constant indicating the daybreak gradient fill.const int
GRADIENT_FILL_DEFAULT
A constant indicating the default gradient fill.const int
GRADIENT_FILL_DESERT
A constant indicating the desert gradient fill.const int
GRADIENT_FILL_EARLY_SUNSET
A constant indicating the early sunset gradient fill.const int
GRADIENT_FILL_FIRE
A constant indicating the fire gradient fill.const int
GRADIENT_FILL_FOG
A constant indicating the fog gradient fill.const int
GRADIENT_FILL_GOLD
A constant indicating the gold gradient fill.const int
GRADIENT_FILL_GOLD_II
A constant indicating the gold II gradient fill.const int
GRADIENT_FILL_HORIZON
A constant indicating the horizon gradient fill.const int
GRADIENT_FILL_LATE_SUNSET
A constant indicating the late sunset gradient fill.const int
GRADIENT_FILL_MAHOGANY
A constant indicating the mahogany gradient fill.const int
GRADIENT_FILL_MOSS
A constant indicating the moss gradient fill.const int
GRADIENT_FILL_NIGHTFALL
A constant indicating the nightfall gradient fill.const int
GRADIENT_FILL_OCEAN
A constant indicating the ocean gradient fill.const int
GRADIENT_FILL_PARCHMENT
A constant indicating the parchment gradient fill.const int
GRADIENT_FILL_PEACOCK
A constant indicating the peacock gradient fill.const int
GRADIENT_FILL_RAINBOW
A constant indicating the rainbow gradient fill.const int
GRADIENT_FILL_RAINBOW_II
A constant indicating the rainbow II gradient fill.const int
GRADIENT_FILL_SAPPHIRE
A constant indicating the sapphire gradient fill.const int
GRADIENT_FILL_SILVER
A constant indicating the silver gradient fill.const int
GRADIENT_FILL_WHEAT
A constant indicating the wheat gradient fill.const int
GRADIENT_TYPE_LINEAR
A constant indicating the linear gradient type.const int
GRADIENT_TYPE_PATH
A constant indicating the path gradient type.const int
GRADIENT_TYPE_RADIAL
A constant indicating the radial gradient type.const int
GRADIENT_TYPE_RECTANGULAR
A constant indicating the rectangular gradient type.const int
PATTERN_10_PERCENT
A constant indicating the 10 percent pattern.const int
PATTERN_20_PERCENT
A constant indicating the 20 percent pattern.const int
PATTERN_25_PERCENT
A constant indicating the 25 percent pattern.const int
PATTERN_30_PERCENT
A constant indicating the 30 percent pattern.const int
PATTERN_40_PERCENT
A constant indicating the 40 percent pattern.const int
PATTERN_5_PERCENT
A constant indicating the 5 percent pattern.const int
PATTERN_50_PERCENT
A constant indicating the 50 percent pattern.const int
PATTERN_60_PERCENT
A constant indicating the 60 percent pattern.const int
PATTERN_70_PERCENT
A constant indicating the 70 percent pattern.const int
PATTERN_75_PERCENT
A constant indicating the 75 percent pattern.const int
PATTERN_80_PERCENT
A constant indicating the 80 percent pattern.const int
PATTERN_90_PERCENT
A constant indicating the 90 percent pattern.const int
PATTERN_DARK_DOWNWARD_DIAGONAL
A constant indicating the dark downward diagonal pattern.const int
PATTERN_DARK_HORIZONTAL
A constant indicating the dark horizontal pattern.const int
PATTERN_DARK_UPWARD_DIAGONAL
A constant indicating the dark upward diagonal pattern.const int
PATTERN_DARK_VERTICAL
A constant indicating the dark vertical pattern.const int
PATTERN_DASHED_DOWNWARD_DIAGONAL
A constant indicating the dashed downward diagonal pattern.const int
PATTERN_DASHED_HORIZONTAL
A constant indicating the dashed horizontal pattern.const int
PATTERN_DASHED_UPWARD_DIAGONAL
A constant indicating the dashed upward diagonal pattern.const int
PATTERN_DASHED_VERTICAL
A constant indicating the dashed vertical pattern.const int
PATTERN_DIAGONAL_BRICK
A constant indicating the diagonal brick pattern.const int
PATTERN_DIVOT
A constant indicating the divot pattern.const int
PATTERN_DOTTED_DIAMOND
A constant indicating the dotted diamond pattern.const int
PATTERN_DOTTED_GRID
A constant indicating the dotted grid pattern.const int
PATTERN_HORIZONTAL_BRICK
A constant indicating the horizontal brick pattern.const int
PATTERN_LARGE_CHECKER_BOARD
A constant indicating the large checker board pattern.const int
PATTERN_LARGE_CONFETTI
A constant indicating the large confetti pattern.const int
PATTERN_LARGE_GRID
A constant indicating the large grid pattern.const int
PATTERN_LIGHT_DOWNWARD_DIAGONAL
A constant indicating the light downward diagonal pattern.const int
PATTERN_LIGHT_HORIZONTAL
A constant indicating the light horizontal pattern.const int
PATTERN_LIGHT_UPWARD_DIAGONAL
A constant indicating the light upward diagonal pattern.const int
PATTERN_LIGHT_VERTICAL
A constant indicating the light vertical pattern.const int
PATTERN_NARROW_HORIZONTAL
A constant indicating the narrow horizontal pattern.const int
PATTERN_NARROW_VERTICAL
A constant indicating the narrow vertical pattern.const int
PATTERN_NONE
A constant indicating that no pattern is set.const int
PATTERN_OUTLINED_DIAMOND
A constant indicating the outlined diamond pattern.const int
PATTERN_PLAID
A constant indicating the plaid pattern.const int
PATTERN_SHINGLE
A constant indicating the shingle pattern.const int
PATTERN_SMALL_CHECKER_BOARD
A constant indicating the small checker board pattern.const int
PATTERN_SMALL_CONFETTI
A constant indicating the small confetti pattern.const int
PATTERN_SMALL_GRID
A constant indicating the small grid pattern.const int
PATTERN_SOLID
A constant indicating the solid pattern.const int
PATTERN_SOLID_DIAMOND
A constant indicating the solid diamond pattern.const int
PATTERN_SPHERE
A constant indicating the sphere pattern.const int
PATTERN_TRELLIS
A constant indicating the trellis pattern.const int
PATTERN_WAVE
A constant indicating the wave pattern.const int
PATTERN_WEAVE
A constant indicating the weave pattern.const int
PATTERN_WIDE_DOWNWARD_DIAGONAL
A constant indicating the wide downward diagonal pattern.const int
PATTERN_WIDE_UPWARD_DIAGONAL
A constant indicating the wide upward diagonal pattern.const int
PATTERN_ZIG_ZAG
A constant indicating the zig zag pattern.const int
TEXTURE_BLUE_TISSUE_PAPER
A constant indicating the blue tissue paper texture.const int
TEXTURE_BOUQUET
A constant indicating the bouquet texture.const int
TEXTURE_BROWN_MARBLE
A constant indicating the brown marble texture.const int
TEXTURE_CANVAS
A constant indicating the canvas texture.const int
TEXTURE_CORK
A constant indicating the cork texture.const int
TEXTURE_DENIM
A constant indicating the denim texture.const int
TEXTURE_FISH_FOSIL
A constant indicating the fish fosil texture.const int
TEXTURE_GRANITE
A constant indicating the granite texture.const int
TEXTURE_GREEN_MARBLE
A constant indicating the green marble texture.const int
TEXTURE_MEDIUM_WOOD
A constant indicating the medium wood texture.const int
TEXTURE_NEWSPRINT
A constant indicating the newsprint texture.const int
TEXTURE_OAK
A constant indicating the oak texture.const int
TEXTURE_PAPER_BAG
A constant indicating the paper bag texture.const int
TEXTURE_PAPYRUS
A constant indicating the papyrus texture.const int
TEXTURE_PARCHMENT
A constant indicating the parchment texture.const int
TEXTURE_PINK_TISSUE_PAPER
A constant indicating the pink tissue paper texture.const int
TEXTURE_PURPLE_MESH
A constant indicating the purple mesh texture.const int
TEXTURE_RECYCLED_PAPER
A constant indicating the recycled paper texture.const int
TEXTURE_SAND
A constant indicating the sand texture.const int
TEXTURE_STATIONERY
A constant indicating the stationery texture.const int
TEXTURE_WALNUT
A constant indicating the walnut texture.const int
TEXTURE_WATER_DROPLETS
A constant indicating the water droplets texture.const int
TEXTURE_WHITE_MARBLE
A constant indicating the white marble texture.const int
TEXTURE_WOVEN_MAT
A constant indicating the woven mat texture.const System.String
TILING_ALIGNMENT_BOTTOM
A constant indicating the bottom tiling alignment.const System.String
TILING_ALIGNMENT_BOTTOM_LEFT
A constant indicating the bottom left tiling alignment.const System.String
TILING_ALIGNMENT_BOTTOM_RIGHT
A constant indicating the bottom right tiling alignment.const System.String
TILING_ALIGNMENT_CENTER
A constant indicating the center tiling alignment.const System.String
TILING_ALIGNMENT_LEFT
A constant indicating the left tiling alignment.const System.String
TILING_ALIGNMENT_RIGHT
A constant indicating the right tiling alignment.const System.String
TILING_ALIGNMENT_TOP
A constant indicating the top tiling alignment.const System.String
TILING_ALIGNMENT_TOP_LEFT
A constant indicating the top left tiling alignment.const System.String
TILING_ALIGNMENT_TOP_RIGHT
A constant indicating the top right tiling alignment.const System.String
TILING_MIRROR_TYPE_BOTH
A constant indicating the horizontal and vertical tiling mirror type.const System.String
TILING_MIRROR_TYPE_HORIZONTAL
A constant indicating the horizontal tiling mirror type.const System.String
TILING_MIRROR_TYPE_NONE
A constant indicating that no tiling mirror type is set.const System.String
TILING_MIRROR_TYPE_VERTICAL
A constant indicating the vertical tiling mirror type.
-
Constructor Summary
Constructors Constructor Description FillFormat()
Defines an instance of the fill formatting.
-
Method Summary
Modifier and Type Method Description void
addGradientStop(int position, ThemeColor color, int transparency)
Adds a gradient stop to the shape fill that is set as gradient fill, having a specified position, color and transparency.void
addGradientStop(int position, System.Drawing.Color color, int transparency)
Adds a gradient stop to the shape fill that is set as gradient fill, having a specified position, color and transparency.void
addGradientStop(GradientStop stop)
Adds a gradient stop to the shape fill that is set as gradient fill.FillFormat
Clone()
Creates and returns a copy of this object.System.Drawing.Color
getBackground()
Returns the background color of the shape.ThemeColor
getBackgroundThemeColor()
Returns the background color of the shape.System.Drawing.Color
getForeground()
Returns the foreground color.float
getGradientAngle()
Returns the angle of the gradient.int
getGradientDirection()
Returns the direction of the gradient fill.GradientStop
getGradientStopAt(int stop)
Returns the gradient stop of the shape fill at the specified position.int
getGradientType()
Returns the gradient type of the gradient fill.int
getPattern()
Returns the pattern fill.float
getStretchBottomOffset()
Returns the offset of the picture from the bottom border of the shape.float
getStretchLeftOffset()
Returns the offset of the picture from the left border of the shapefloat
getStretchRightOffset()
Returns the offset of the picture from the right border of the shape.float
getStretchTopOffset()
Returns the offset of the picture from the top border of the shape.ExcelImage
getTexturePicture()
Returns the image set as fill.System.String
getTileAlignment()
Returns the alignment of the tiled picture.System.String
getTileMirrorType()
Returns the mirror type of the tiled picture.float
getTileOffsetX()
Returns the offset of the picture fill to the left (negative numbers) or the right (positive numbers).float
getTileOffsetY()
Returns the offset of the picture fill to the top (negative numbers) or to the bottom (positive numbers).float
getTileScaleX()
Returns the percentage for the horizontal scaling of the original image.float
getTileScaleY()
Returns the percentage for the vertical scaling of the original image.int
getTransparency()
Returns the transparency of the color.int
GradientStopCount()
Counts the gradient stops of the shape fill.bool
IsAutomatic()
Returns true if automatic fill is set, false otherwise.bool
IsGradientFill()
Returns true if gradient fill is set, false otherwise.bool
IsNoFill()
Returns true if no fill is set, false otherwise.bool
IsPatternFill()
Returns true if pattern fill is set, false otherwise.bool
IsPictureFill()
Returns true if picture fill is set, false otherwise.bool
IsRotateWithShape()
Returns true if rotate with shape is active, false otherwise.bool
IsSolidFill()
Returns true if solid fill is set, false otherwise.bool
IsTilePictureAsTexture()
Returns true if the picture is tiled as texture, false otherwise.void
removeGradientStopAt(int stop)
Removes the gradient stop of the shape fill at the specified position.void
setAutomatic(bool isAutomatic)
Sets the automatic option of the shape.void
setBackground(ThemeColor themeColor)
Sets the background color of the shape.void
setBackground(System.Drawing.Color background)
Sets the background color of the shape.void
setForeground(System.Drawing.Color foreground)
Sets the foreground color.void
setGradientAngle(float angle)
Sets the angle of the gradient.void
setGradientDirection(int direction)
Sets the direction for the gradient fill.void
setGradientFill(int presetColors)
Sets a predefined subset of colors for the gradient.void
setGradientType(int type)
Sets the gradient type of the gradient fill.void
setNoFill(bool noFill)
Sets no fill for the shape.void
setPattern(int pattern)
Sets the pattern fill.void
setPictureFill(ExcelImage xlsImage, int transparency)
Sets the picture fill for the shape.void
setPictureFill(System.String path, int transparency)
Sets the picture fill for the shape.void
setRotateWithShape(bool isRotateWithShape)
Sets the rotate with shape option of the shape.void
setSolidFill(ThemeColor background, int transparency)
Sets the solid fill for the shape.void
setSolidFill(System.Drawing.Color background, int transparency)
Sets the solid fill for the shape.void
setStretchOptions(float leftOffset, float rightOffset, float topOffset, float bottomOffset)
Sets the stretch options for the texture.void
setTextureFill(int presetTexture)
Sets a predefined texture for the shape.void
setTilingOptions(float offsetX, float offsetY, float scaleX, float scaleY, System.String alignment, System.String mirrorType)
Sets the tiling options for the picture fill.
-
-
-
Field Detail
-
PATTERN_NONE
public const int PATTERN_NONE
A constant indicating that no pattern is set. Embedded value is "255".- See Also:
- Constant Values
-
PATTERN_SOLID
public const int PATTERN_SOLID
A constant indicating the solid pattern. Embedded value is "1".- See Also:
- Constant Values
-
PATTERN_5_PERCENT
public const int PATTERN_5_PERCENT
A constant indicating the 5 percent pattern. Embedded value is "196".- See Also:
- Constant Values
-
PATTERN_50_PERCENT
public const int PATTERN_50_PERCENT
A constant indicating the 50 percent pattern. Embedded value is "197".- See Also:
- Constant Values
-
PATTERN_LIGHT_DOWNWARD_DIAGONAL
public const int PATTERN_LIGHT_DOWNWARD_DIAGONAL
A constant indicating the light downward diagonal pattern. Embedded value is "198".- See Also:
- Constant Values
-
PATTERN_LIGHT_VERTICAL
public const int PATTERN_LIGHT_VERTICAL
A constant indicating the light vertical pattern. Embedded value is "199".- See Also:
- Constant Values
-
PATTERN_DASHED_DOWNWARD_DIAGONAL
public const int PATTERN_DASHED_DOWNWARD_DIAGONAL
A constant indicating the dashed downward diagonal pattern. Embedded value is "200".- See Also:
- Constant Values
-
PATTERN_ZIG_ZAG
public const int PATTERN_ZIG_ZAG
A constant indicating the zig zag pattern. Embedded value is "201".- See Also:
- Constant Values
-
PATTERN_DIVOT
public const int PATTERN_DIVOT
A constant indicating the divot pattern. Embedded value is "202".- See Also:
- Constant Values
-
PATTERN_SMALL_GRID
public const int PATTERN_SMALL_GRID
A constant indicating the small grid pattern. Embedded value is "203".- See Also:
- Constant Values
-
PATTERN_10_PERCENT
public const int PATTERN_10_PERCENT
A constant indicating the 10 percent pattern. Embedded value is "204".- See Also:
- Constant Values
-
PATTERN_60_PERCENT
public const int PATTERN_60_PERCENT
A constant indicating the 60 percent pattern. Embedded value is "205".- See Also:
- Constant Values
-
PATTERN_LIGHT_UPWARD_DIAGONAL
public const int PATTERN_LIGHT_UPWARD_DIAGONAL
A constant indicating the light upward diagonal pattern. Embedded value is "206".- See Also:
- Constant Values
-
PATTERN_LIGHT_HORIZONTAL
public const int PATTERN_LIGHT_HORIZONTAL
A constant indicating the light horizontal pattern. Embedded value is "207".- See Also:
- Constant Values
-
PATTERN_DASHED_UPWARD_DIAGONAL
public const int PATTERN_DASHED_UPWARD_DIAGONAL
A constant indicating the dashed upward diagonal pattern. Embedded value is "208".- See Also:
- Constant Values
-
PATTERN_WAVE
public const int PATTERN_WAVE
A constant indicating the wave pattern. Embedded value is "209".- See Also:
- Constant Values
-
PATTERN_DOTTED_GRID
public const int PATTERN_DOTTED_GRID
A constant indicating the dotted grid pattern. Embedded value is "210".- See Also:
- Constant Values
-
PATTERN_LARGE_GRID
public const int PATTERN_LARGE_GRID
A constant indicating the large grid pattern. Embedded value is "211".- See Also:
- Constant Values
-
PATTERN_20_PERCENT
public const int PATTERN_20_PERCENT
A constant indicating the 20 percent pattern. Embedded value is "212".- See Also:
- Constant Values
-
PATTERN_70_PERCENT
public const int PATTERN_70_PERCENT
A constant indicating the 70 percent pattern. Embedded value is "213".- See Also:
- Constant Values
-
PATTERN_DARK_DOWNWARD_DIAGONAL
public const int PATTERN_DARK_DOWNWARD_DIAGONAL
A constant indicating the dark downward diagonal pattern. Embedded value is "214".- See Also:
- Constant Values
-
PATTERN_NARROW_VERTICAL
public const int PATTERN_NARROW_VERTICAL
A constant indicating the narrow vertical pattern. Embedded value is "215".- See Also:
- Constant Values
-
PATTERN_DASHED_HORIZONTAL
public const int PATTERN_DASHED_HORIZONTAL
A constant indicating the dashed horizontal pattern. Embedded value is "216".- See Also:
- Constant Values
-
PATTERN_DIAGONAL_BRICK
public const int PATTERN_DIAGONAL_BRICK
A constant indicating the diagonal brick pattern. Embedded value is "217".- See Also:
- Constant Values
-
PATTERN_DOTTED_DIAMOND
public const int PATTERN_DOTTED_DIAMOND
A constant indicating the dotted diamond pattern. Embedded value is "218".- See Also:
- Constant Values
-
PATTERN_SMALL_CHECKER_BOARD
public const int PATTERN_SMALL_CHECKER_BOARD
A constant indicating the small checker board pattern. Embedded value is "219".- See Also:
- Constant Values
-
PATTERN_25_PERCENT
public const int PATTERN_25_PERCENT
A constant indicating the 25 percent pattern. Embedded value is "220".- See Also:
- Constant Values
-
PATTERN_75_PERCENT
public const int PATTERN_75_PERCENT
A constant indicating the 75 percent pattern. Embedded value is "221".- See Also:
- Constant Values
-
PATTERN_DARK_UPWARD_DIAGONAL
public const int PATTERN_DARK_UPWARD_DIAGONAL
A constant indicating the dark upward diagonal pattern. Embedded value is "222".- See Also:
- Constant Values
-
PATTERN_NARROW_HORIZONTAL
public const int PATTERN_NARROW_HORIZONTAL
A constant indicating the narrow horizontal pattern. Embedded value is "223".- See Also:
- Constant Values
-
PATTERN_DASHED_VERTICAL
public const int PATTERN_DASHED_VERTICAL
A constant indicating the dashed vertical pattern. Embedded value is "224".- See Also:
- Constant Values
-
PATTERN_HORIZONTAL_BRICK
public const int PATTERN_HORIZONTAL_BRICK
A constant indicating the horizontal brick pattern. Embedded value is "225".- See Also:
- Constant Values
-
PATTERN_SHINGLE
public const int PATTERN_SHINGLE
A constant indicating the shingle pattern. Embedded value is "226".- See Also:
- Constant Values
-
PATTERN_LARGE_CHECKER_BOARD
public const int PATTERN_LARGE_CHECKER_BOARD
A constant indicating the large checker board pattern. Embedded value is "227".- See Also:
- Constant Values
-
PATTERN_30_PERCENT
public const int PATTERN_30_PERCENT
A constant indicating the 30 percent pattern. Embedded value is "228".- See Also:
- Constant Values
-
PATTERN_80_PERCENT
public const int PATTERN_80_PERCENT
A constant indicating the 80 percent pattern. Embedded value is "229".- See Also:
- Constant Values
-
PATTERN_WIDE_DOWNWARD_DIAGONAL
public const int PATTERN_WIDE_DOWNWARD_DIAGONAL
A constant indicating the wide downward diagonal pattern. Embedded value is "230".- See Also:
- Constant Values
-
PATTERN_DARK_VERTICAL
public const int PATTERN_DARK_VERTICAL
A constant indicating the dark vertical pattern. Embedded value is "231".- See Also:
- Constant Values
-
PATTERN_SMALL_CONFETTI
public const int PATTERN_SMALL_CONFETTI
A constant indicating the small confetti pattern. Embedded value is "232".- See Also:
- Constant Values
-
PATTERN_WEAVE
public const int PATTERN_WEAVE
A constant indicating the weave pattern. Embedded value is "233".- See Also:
- Constant Values
-
PATTERN_TRELLIS
public const int PATTERN_TRELLIS
A constant indicating the trellis pattern. Embedded value is "234".- See Also:
- Constant Values
-
PATTERN_OUTLINED_DIAMOND
public const int PATTERN_OUTLINED_DIAMOND
A constant indicating the outlined diamond pattern. Embedded value is "235".- See Also:
- Constant Values
-
PATTERN_40_PERCENT
public const int PATTERN_40_PERCENT
A constant indicating the 40 percent pattern. Embedded value is "236".- See Also:
- Constant Values
-
PATTERN_90_PERCENT
public const int PATTERN_90_PERCENT
A constant indicating the 90 percent pattern. Embedded value is "237".- See Also:
- Constant Values
-
PATTERN_WIDE_UPWARD_DIAGONAL
public const int PATTERN_WIDE_UPWARD_DIAGONAL
A constant indicating the wide upward diagonal pattern. Embedded value is "238".- See Also:
- Constant Values
-
PATTERN_DARK_HORIZONTAL
public const int PATTERN_DARK_HORIZONTAL
A constant indicating the dark horizontal pattern. Embedded value is "239".- See Also:
- Constant Values
-
PATTERN_LARGE_CONFETTI
public const int PATTERN_LARGE_CONFETTI
A constant indicating the large confetti pattern. Embedded value is "240".- See Also:
- Constant Values
-
PATTERN_PLAID
public const int PATTERN_PLAID
A constant indicating the plaid pattern. Embedded value is "241".- See Also:
- Constant Values
-
PATTERN_SPHERE
public const int PATTERN_SPHERE
A constant indicating the sphere pattern. Embedded value is "242".- See Also:
- Constant Values
-
PATTERN_SOLID_DIAMOND
public const int PATTERN_SOLID_DIAMOND
A constant indicating the solid diamond pattern. Embedded value is "243".- See Also:
- Constant Values
-
GRADIENT_FILL_DEFAULT
public const int GRADIENT_FILL_DEFAULT
A constant indicating the default gradient fill. Embedded value is "0".- See Also:
- Constant Values
-
GRADIENT_FILL_EARLY_SUNSET
public const int GRADIENT_FILL_EARLY_SUNSET
A constant indicating the early sunset gradient fill. Embedded value is "1".- See Also:
- Constant Values
-
GRADIENT_FILL_LATE_SUNSET
public const int GRADIENT_FILL_LATE_SUNSET
A constant indicating the late sunset gradient fill. Embedded value is "2".- See Also:
- Constant Values
-
GRADIENT_FILL_NIGHTFALL
public const int GRADIENT_FILL_NIGHTFALL
A constant indicating the nightfall gradient fill. Embedded value is "3".- See Also:
- Constant Values
-
GRADIENT_FILL_DAYBREAK
public const int GRADIENT_FILL_DAYBREAK
A constant indicating the daybreak gradient fill. Embedded value is "4".- See Also:
- Constant Values
-
GRADIENT_FILL_HORIZON
public const int GRADIENT_FILL_HORIZON
A constant indicating the horizon gradient fill. Embedded value is "5".- See Also:
- Constant Values
-
GRADIENT_FILL_DESERT
public const int GRADIENT_FILL_DESERT
A constant indicating the desert gradient fill. Embedded value is "6".- See Also:
- Constant Values
-
GRADIENT_FILL_OCEAN
public const int GRADIENT_FILL_OCEAN
A constant indicating the ocean gradient fill. Embedded value is "7".- See Also:
- Constant Values
-
GRADIENT_FILL_CALM_WATER
public const int GRADIENT_FILL_CALM_WATER
A constant indicating the calm water gradient fill. Embedded value is "8".- See Also:
- Constant Values
-
GRADIENT_FILL_FIRE
public const int GRADIENT_FILL_FIRE
A constant indicating the fire gradient fill. Embedded value is "9".- See Also:
- Constant Values
-
GRADIENT_FILL_FOG
public const int GRADIENT_FILL_FOG
A constant indicating the fog gradient fill. Embedded value is "10".- See Also:
- Constant Values
-
GRADIENT_FILL_MOSS
public const int GRADIENT_FILL_MOSS
A constant indicating the moss gradient fill. Embedded value is "11".- See Also:
- Constant Values
-
GRADIENT_FILL_PEACOCK
public const int GRADIENT_FILL_PEACOCK
A constant indicating the peacock gradient fill. Embedded value is "12".- See Also:
- Constant Values
-
GRADIENT_FILL_WHEAT
public const int GRADIENT_FILL_WHEAT
A constant indicating the wheat gradient fill. Embedded value is "13".- See Also:
- Constant Values
-
GRADIENT_FILL_PARCHMENT
public const int GRADIENT_FILL_PARCHMENT
A constant indicating the parchment gradient fill. Embedded value is "14".- See Also:
- Constant Values
-
GRADIENT_FILL_MAHOGANY
public const int GRADIENT_FILL_MAHOGANY
A constant indicating the mahogany gradient fill. Embedded value is "15".- See Also:
- Constant Values
-
GRADIENT_FILL_RAINBOW
public const int GRADIENT_FILL_RAINBOW
A constant indicating the rainbow gradient fill. Embedded value is "16".- See Also:
- Constant Values
-
GRADIENT_FILL_RAINBOW_II
public const int GRADIENT_FILL_RAINBOW_II
A constant indicating the rainbow II gradient fill. Embedded value is "17".- See Also:
- Constant Values
-
GRADIENT_FILL_GOLD
public const int GRADIENT_FILL_GOLD
A constant indicating the gold gradient fill. Embedded value is "18".- See Also:
- Constant Values
-
GRADIENT_FILL_GOLD_II
public const int GRADIENT_FILL_GOLD_II
A constant indicating the gold II gradient fill. Embedded value is "19".- See Also:
- Constant Values
-
GRADIENT_FILL_BRASS
public const int GRADIENT_FILL_BRASS
A constant indicating the brass gradient fill. Embedded value is "20".- See Also:
- Constant Values
-
GRADIENT_FILL_CHROME
public const int GRADIENT_FILL_CHROME
A constant indicating the chrome gradient fill. Embedded value is "21".- See Also:
- Constant Values
-
GRADIENT_FILL_CHROME_II
public const int GRADIENT_FILL_CHROME_II
A constant indicating the chrome II gradient fill. Embedded value is "22".- See Also:
- Constant Values
-
GRADIENT_FILL_SILVER
public const int GRADIENT_FILL_SILVER
A constant indicating the silver gradient fill. Embedded value is "23".- See Also:
- Constant Values
-
GRADIENT_FILL_SAPPHIRE
public const int GRADIENT_FILL_SAPPHIRE
A constant indicating the sapphire gradient fill. Embedded value is "24".- See Also:
- Constant Values
-
GRADIENT_TYPE_LINEAR
public const int GRADIENT_TYPE_LINEAR
A constant indicating the linear gradient type. Embedded value is "0".- See Also:
- Constant Values
-
GRADIENT_TYPE_RADIAL
public const int GRADIENT_TYPE_RADIAL
A constant indicating the radial gradient type. Embedded value is "1".- See Also:
- Constant Values
-
GRADIENT_TYPE_RECTANGULAR
public const int GRADIENT_TYPE_RECTANGULAR
A constant indicating the rectangular gradient type. Embedded value is "2".- See Also:
- Constant Values
-
GRADIENT_TYPE_PATH
public const int GRADIENT_TYPE_PATH
A constant indicating the path gradient type. Embedded value is "3".- See Also:
- Constant Values
-
GRADIENT_DIRECTION_LINEAR_DIAGONAL_45_DEGREES
public const int GRADIENT_DIRECTION_LINEAR_DIAGONAL_45_DEGREES
A constant indicating the linear diagonal gradient direction (a gradient angle of 45 degrees). Embedded value is "45".- See Also:
- Constant Values
-
GRADIENT_DIRECTION_LINEAR_DOWN_90_DEGREES
public const int GRADIENT_DIRECTION_LINEAR_DOWN_90_DEGREES
A constant indicating the linear down gradient direction (a gradient angle of 90 degrees). Embedded value is "90".- See Also:
- Constant Values
-
GRADIENT_DIRECTION_LINEAR_DIAGONAL_135_DEGREES
public const int GRADIENT_DIRECTION_LINEAR_DIAGONAL_135_DEGREES
A constant indicating the linear diagonal gradient direction (a gradient angle of 135 degrees). Embedded value is "135".- See Also:
- Constant Values
-
GRADIENT_DIRECTION_LINEAR_RIGHT_0_DEGREES
public const int GRADIENT_DIRECTION_LINEAR_RIGHT_0_DEGREES
A constant indicating the linear right gradient direction (a gradient angle of 0 degrees). Embedded value is "0".- See Also:
- Constant Values
-
GRADIENT_DIRECTION_LINEAR_LEFT_180_DEGREES
public const int GRADIENT_DIRECTION_LINEAR_LEFT_180_DEGREES
A constant indicating the linear left gradient direction (a gradient angle of 180 degrees). Embedded value is "180".- See Also:
- Constant Values
-
GRADIENT_DIRECTION_LINEAR_DIAGONAL_315_DEGREES
public const int GRADIENT_DIRECTION_LINEAR_DIAGONAL_315_DEGREES
A constant indicating the linear diagonal gradient direction (a gradient angle of 315 degrees). Embedded value is "315".- See Also:
- Constant Values
-
GRADIENT_DIRECTION_LINEAR_UP_270_DEGREES
public const int GRADIENT_DIRECTION_LINEAR_UP_270_DEGREES
A constant indicating the linear up gradient direction (a gradient angle of 270 degrees). Embedded value is "270".- See Also:
- Constant Values
-
GRADIENT_DIRECTION_LINEAR_DIAGONAL_225_DEGREES
public const int GRADIENT_DIRECTION_LINEAR_DIAGONAL_225_DEGREES
A constant indicating the linear diagonal gradient direction (a gradient angle of 225 degrees). Embedded value is "225".- See Also:
- Constant Values
-
GRADIENT_DIRECTION_FROM_CORNER_UPPER_LEFT_TO_BOTTOM_RIGHT
public const int GRADIENT_DIRECTION_FROM_CORNER_UPPER_LEFT_TO_BOTTOM_RIGHT
A constant indicating the gradient direction from upper left corner to bottom right corner. Embedded value is "0".- See Also:
- Constant Values
-
GRADIENT_DIRECTION_FROM_CORNER_UPPER_RIGHT_TO_BOTTOM_LEFT
public const int GRADIENT_DIRECTION_FROM_CORNER_UPPER_RIGHT_TO_BOTTOM_LEFT
A constant indicating the gradient direction from upper right corner to bottom left corner. Embedded value is "1".- See Also:
- Constant Values
-
GRADIENT_DIRECTION_FROM_CENTER
public const int GRADIENT_DIRECTION_FROM_CENTER
A constant indicating the gradient direction from center. Embedded value is "2".- See Also:
- Constant Values
-
GRADIENT_DIRECTION_FROM_CORNER_BOTTOM_LEFT_TO_UPPER_RIGHT
public const int GRADIENT_DIRECTION_FROM_CORNER_BOTTOM_LEFT_TO_UPPER_RIGHT
A constant indicating the gradient direction from bottom left corner to upper right corner. Embedded value is "3".- See Also:
- Constant Values
-
GRADIENT_DIRECTION_FROM_CORNER_BOTTOM_RIGHT_TO_UPPER_LEFT
public const int GRADIENT_DIRECTION_FROM_CORNER_BOTTOM_RIGHT_TO_UPPER_LEFT
A constant indicating the gradient direction from bottom right corner to upper left corner. Embedded value is "4".- See Also:
- Constant Values
-
TEXTURE_PAPYRUS
public const int TEXTURE_PAPYRUS
A constant indicating the papyrus texture. Embedded value is "0".- See Also:
- Constant Values
-
TEXTURE_CANVAS
public const int TEXTURE_CANVAS
A constant indicating the canvas texture. Embedded value is "1".- See Also:
- Constant Values
-
TEXTURE_DENIM
public const int TEXTURE_DENIM
A constant indicating the denim texture. Embedded value is "2".- See Also:
- Constant Values
-
TEXTURE_WOVEN_MAT
public const int TEXTURE_WOVEN_MAT
A constant indicating the woven mat texture. Embedded value is "3".- See Also:
- Constant Values
-
TEXTURE_WATER_DROPLETS
public const int TEXTURE_WATER_DROPLETS
A constant indicating the water droplets texture. Embedded value is "4".- See Also:
- Constant Values
-
TEXTURE_PAPER_BAG
public const int TEXTURE_PAPER_BAG
A constant indicating the paper bag texture. Embedded value is "5".- See Also:
- Constant Values
-
TEXTURE_FISH_FOSIL
public const int TEXTURE_FISH_FOSIL
A constant indicating the fish fosil texture. Embedded value is "6".- See Also:
- Constant Values
-
TEXTURE_SAND
public const int TEXTURE_SAND
A constant indicating the sand texture. Embedded value is "7".- See Also:
- Constant Values
-
TEXTURE_GREEN_MARBLE
public const int TEXTURE_GREEN_MARBLE
A constant indicating the green marble texture. Embedded value is "8".- See Also:
- Constant Values
-
TEXTURE_WHITE_MARBLE
public const int TEXTURE_WHITE_MARBLE
A constant indicating the white marble texture. Embedded value is "9".- See Also:
- Constant Values
-
TEXTURE_BROWN_MARBLE
public const int TEXTURE_BROWN_MARBLE
A constant indicating the brown marble texture. Embedded value is "10".- See Also:
- Constant Values
-
TEXTURE_GRANITE
public const int TEXTURE_GRANITE
A constant indicating the granite texture. Embedded value is "11".- See Also:
- Constant Values
-
TEXTURE_NEWSPRINT
public const int TEXTURE_NEWSPRINT
A constant indicating the newsprint texture. Embedded value is "12".- See Also:
- Constant Values
-
TEXTURE_RECYCLED_PAPER
public const int TEXTURE_RECYCLED_PAPER
A constant indicating the recycled paper texture. Embedded value is "13".- See Also:
- Constant Values
-
TEXTURE_PARCHMENT
public const int TEXTURE_PARCHMENT
A constant indicating the parchment texture. Embedded value is "14".- See Also:
- Constant Values
-
TEXTURE_STATIONERY
public const int TEXTURE_STATIONERY
A constant indicating the stationery texture. Embedded value is "15".- See Also:
- Constant Values
-
TEXTURE_BLUE_TISSUE_PAPER
public const int TEXTURE_BLUE_TISSUE_PAPER
A constant indicating the blue tissue paper texture. Embedded value is "16".- See Also:
- Constant Values
-
TEXTURE_PINK_TISSUE_PAPER
public const int TEXTURE_PINK_TISSUE_PAPER
A constant indicating the pink tissue paper texture. Embedded value is "17".- See Also:
- Constant Values
-
TEXTURE_PURPLE_MESH
public const int TEXTURE_PURPLE_MESH
A constant indicating the purple mesh texture. Embedded value is "18".- See Also:
- Constant Values
-
TEXTURE_BOUQUET
public const int TEXTURE_BOUQUET
A constant indicating the bouquet texture. Embedded value is "19".- See Also:
- Constant Values
-
TEXTURE_CORK
public const int TEXTURE_CORK
A constant indicating the cork texture. Embedded value is "20".- See Also:
- Constant Values
-
TEXTURE_WALNUT
public const int TEXTURE_WALNUT
A constant indicating the walnut texture. Embedded value is "21".- See Also:
- Constant Values
-
TEXTURE_OAK
public const int TEXTURE_OAK
A constant indicating the oak texture. Embedded value is "22".- See Also:
- Constant Values
-
TEXTURE_MEDIUM_WOOD
public const int TEXTURE_MEDIUM_WOOD
A constant indicating the medium wood texture. Embedded value is "23".- See Also:
- Constant Values
-
TILING_ALIGNMENT_TOP_LEFT
public const System.String TILING_ALIGNMENT_TOP_LEFT
A constant indicating the top left tiling alignment. Embedded value is "tl".- See Also:
- Constant Values
-
TILING_ALIGNMENT_TOP
public const System.String TILING_ALIGNMENT_TOP
A constant indicating the top tiling alignment. Embedded value is "t".- See Also:
- Constant Values
-
TILING_ALIGNMENT_TOP_RIGHT
public const System.String TILING_ALIGNMENT_TOP_RIGHT
A constant indicating the top right tiling alignment. Embedded value is "tr".- See Also:
- Constant Values
-
TILING_ALIGNMENT_LEFT
public const System.String TILING_ALIGNMENT_LEFT
A constant indicating the left tiling alignment. Embedded value is "l".- See Also:
- Constant Values
-
TILING_ALIGNMENT_CENTER
public const System.String TILING_ALIGNMENT_CENTER
A constant indicating the center tiling alignment. Embedded value is "ctr".- See Also:
- Constant Values
-
TILING_ALIGNMENT_RIGHT
public const System.String TILING_ALIGNMENT_RIGHT
A constant indicating the right tiling alignment. Embedded value is "r".- See Also:
- Constant Values
-
TILING_ALIGNMENT_BOTTOM_LEFT
public const System.String TILING_ALIGNMENT_BOTTOM_LEFT
A constant indicating the bottom left tiling alignment. Embedded value is "bl".- See Also:
- Constant Values
-
TILING_ALIGNMENT_BOTTOM
public const System.String TILING_ALIGNMENT_BOTTOM
A constant indicating the bottom tiling alignment. Embedded value is "b".- See Also:
- Constant Values
-
TILING_ALIGNMENT_BOTTOM_RIGHT
public const System.String TILING_ALIGNMENT_BOTTOM_RIGHT
A constant indicating the bottom right tiling alignment. Embedded value is "br".- See Also:
- Constant Values
-
TILING_MIRROR_TYPE_NONE
public const System.String TILING_MIRROR_TYPE_NONE
A constant indicating that no tiling mirror type is set. Embedded value is "none".- See Also:
- Constant Values
-
TILING_MIRROR_TYPE_HORIZONTAL
public const System.String TILING_MIRROR_TYPE_HORIZONTAL
A constant indicating the horizontal tiling mirror type. Embedded value is "x".- See Also:
- Constant Values
-
TILING_MIRROR_TYPE_VERTICAL
public const System.String TILING_MIRROR_TYPE_VERTICAL
A constant indicating the vertical tiling mirror type. Embedded value is "y".- See Also:
- Constant Values
-
TILING_MIRROR_TYPE_BOTH
public const System.String TILING_MIRROR_TYPE_BOTH
A constant indicating the horizontal and vertical tiling mirror type. Embedded value is "xy".- See Also:
- Constant Values
-
-
Method Detail
-
IsNoFill
public bool IsNoFill()
Returns true if no fill is set, false otherwise.- Returns:
- true if no fill is set, false otherwise
- See Also:
setNoFill(bool)
-
setNoFill
public void setNoFill(bool noFill)
Sets no fill for the shape. Clears all the formatting if true, sets to automatic otherwise.- Parameters:
noFill
- true if no fill is set, false otherwise- See Also:
IsNoFill()
-
IsSolidFill
public bool IsSolidFill()
Returns true if solid fill is set, false otherwise.- Returns:
- true if solid fill is set, false otherwise
- See Also:
setSolidFill(Color, int)
,setSolidFill(ThemeColor, int)
-
setSolidFill
public void setSolidFill(System.Drawing.Color background, int transparency)
Sets the solid fill for the shape.- Parameters:
background
- the color of the shapetransparency
- the transparency of the color- See Also:
IsSolidFill()
,setSolidFill(ThemeColor, int)
,getBackground()
,getTransparency()
-
setSolidFill
public void setSolidFill(ThemeColor background, int transparency)
Sets the solid fill for the shape.- Parameters:
background
- the color of the shapetransparency
- the transparency of the color- See Also:
IsSolidFill()
,setSolidFill(Color, int)
,getBackgroundThemeColor()
,getTransparency()
-
getTransparency
public int getTransparency()
Returns the transparency of the color.- Returns:
- the transparency of the color
- See Also:
setSolidFill(Color,int)
,setSolidFill(ThemeColor,int)
-
getBackground
public System.Drawing.Color getBackground()
Returns the background color of the shape.- Returns:
- the background color of the shape
- See Also:
setBackground(Color)
-
getBackgroundThemeColor
public ThemeColor getBackgroundThemeColor()
Returns the background color of the shape.- Returns:
- the background color of the shape
- See Also:
setBackground(ThemeColor)
-
setBackground
public void setBackground(System.Drawing.Color background)
Sets the background color of the shape.- Parameters:
background
- the background color of the shape- See Also:
getBackground()
-
setBackground
public void setBackground(ThemeColor themeColor)
Sets the background color of the shape.- Parameters:
themeColor
- the background color of the shape- See Also:
getBackgroundThemeColor()
-
setPattern
public void setPattern(int pattern)
Sets the pattern fill. Valid only for Office 97-2003 documents. Possible values are available inFillFormat
class.- Parameters:
pattern
- the pattern fill- See Also:
getPattern()
,IsPatternFill()
-
getPattern
public int getPattern()
Returns the pattern fill. Valid only for Office 97-2003 documents. Possible values are available inFillFormat
class.- Returns:
- the pattern fill
- See Also:
setPattern(int)
,IsPatternFill()
-
setForeground
public void setForeground(System.Drawing.Color foreground)
Sets the foreground color. The foreground is applied only if a pattern is set. Valid only for Office 97-2003 documents.- Parameters:
foreground
- the foreground color- See Also:
getForeground()
,setPattern(int)
,IsPatternFill()
-
getForeground
public System.Drawing.Color getForeground()
Returns the foreground color. The foreground is applied only if a pattern is set. Valid only for Office 97-2003 documents.- Returns:
- the foreground color
- See Also:
setForeground(System.Drawing.Color)
,setPattern(int)
,IsPatternFill()
-
IsPatternFill
public bool IsPatternFill()
Returns true if pattern fill is set, false otherwise.- Returns:
- true if pattern fill is set, false otherwise
- See Also:
setPattern(int)
,getPattern()
-
IsGradientFill
public bool IsGradientFill()
Returns true if gradient fill is set, false otherwise.- Returns:
- true if gradient fill is set, false otherwise
- See Also:
setGradientFill(int)
,addGradientStop(int, Color, int)
,addGradientStop(int, ThemeColor, int)
-
getGradientType
public int getGradientType()
Returns the gradient type of the gradient fill. Possible values are available inFillFormat
class.- Returns:
- the gradient type of the gradient fill
- See Also:
setGradientType(int)
,getGradientAngle()
,getGradientStopAt(int)
-
setGradientType
public void setGradientType(int type)
Sets the gradient type of the gradient fill. Possible values are available inFillFormat
class.- Parameters:
type
- the gradient type of the gradient fill- See Also:
getGradientType()
,setGradientDirection(int)
,addGradientStop(int, Color, int)
,addGradientStop(int, ThemeColor, int)
-
getGradientAngle
public float getGradientAngle()
Returns the angle of the gradient.- Returns:
- the angle of the gradient
- See Also:
setGradientAngle(float)
,getGradientType()
,getGradientStopAt(int)
-
setGradientAngle
public void setGradientAngle(float angle)
Sets the angle of the gradient.- Parameters:
angle
- the angle of the gradient- See Also:
getGradientAngle()
,setGradientDirection(int)
,setGradientType(int)
,addGradientStop(int,Color,int)
,addGradientStop(int,ThemeColor,int)
-
getGradientDirection
public int getGradientDirection()
Returns the direction of the gradient fill. Possible values are available inFillFormat
class.- Returns:
- the direction of the gradient fill
- See Also:
setGradientDirection(int)
,getGradientType()
,getGradientStopAt(int)
-
setGradientDirection
public void setGradientDirection(int direction)
Sets the direction for the gradient fill. Possible values are available inFillFormat
class.- Parameters:
direction
- the gradient direction of the gradient fill- See Also:
getGradientDirection()
,setGradientType(int)
,addGradientStop(int,Color,int)
,addGradientStop(int,ThemeColor,int)
-
setGradientFill
public void setGradientFill(int presetColors)
Sets a predefined subset of colors for the gradient. Possible values are available inFillFormat
class.- Parameters:
presetColors
- the built-in gradient- See Also:
IsGradientFill()
,addGradientStop(int,Color,int)
,addGradientStop(int,ThemeColor,int)
-
addGradientStop
public void addGradientStop(int position, System.Drawing.Color color, int transparency)
Adds a gradient stop to the shape fill that is set as gradient fill, having a specified position, color and transparency.- Parameters:
position
- the gradient stop position from where the gradient to startcolor
- the gradient colortransparency
- the gradient stop transparency- See Also:
removeGradientStopAt(int)
,getGradientStopAt(int)
,GradientStopCount()
-
addGradientStop
public void addGradientStop(int position, ThemeColor color, int transparency)
Adds a gradient stop to the shape fill that is set as gradient fill, having a specified position, color and transparency.- Parameters:
position
- the gradient stop position from where the gradient to startcolor
- the gradient colortransparency
- the gradient stop transparency- See Also:
removeGradientStopAt(int)
,getGradientStopAt(int)
,GradientStopCount()
-
addGradientStop
public void addGradientStop(GradientStop stop)
Adds a gradient stop to the shape fill that is set as gradient fill.- Parameters:
stop
- the gradient stop- See Also:
removeGradientStopAt(int)
,getGradientStopAt(int)
,GradientStopCount()
-
getGradientStopAt
public GradientStop getGradientStopAt(int stop)
Returns the gradient stop of the shape fill at the specified position.- Parameters:
stop
- the gradient stop of the shape- Returns:
- the gradient stop of the shape fill at the specified position
- See Also:
setGradientFill(int)
,addGradientStop(GradientStop)
,removeGradientStopAt(int)
,GradientStopCount()
-
removeGradientStopAt
public void removeGradientStopAt(int stop)
Removes the gradient stop of the shape fill at the specified position.- Parameters:
stop
- the gradient stop of the shape fill- See Also:
setGradientFill(int)
,addGradientStop(GradientStop)
,getGradientStopAt(int)
,GradientStopCount()
-
GradientStopCount
public int GradientStopCount()
Counts the gradient stops of the shape fill.- Returns:
- the number of gradient stops for the shape fill
- See Also:
setGradientFill(int)
,addGradientStop(GradientStop)
,removeGradientStopAt(int)
,getGradientStopAt(int)
-
IsRotateWithShape
public bool IsRotateWithShape()
Returns true if rotate with shape is active, false otherwise.- Returns:
- true if rotate with shape is active, false otherwise
- See Also:
setRotateWithShape(bool)
-
setRotateWithShape
public void setRotateWithShape(bool isRotateWithShape)
Sets the rotate with shape option of the shape.- Parameters:
isRotateWithShape
- the rotate with shape option of the shape- See Also:
IsRotateWithShape()
-
IsPictureFill
public bool IsPictureFill()
Returns true if picture fill is set, false otherwise.- Returns:
- true if picture fill is set, false otherwise
- See Also:
setPictureFill(String, int)
,setPictureFill(ExcelImage, int)
,getTexturePicture()
,IsTilePictureAsTexture()
-
setPictureFill
public void setPictureFill(System.String path, int transparency)
Sets the picture fill for the shape.- Parameters:
path
- the file path to image filetransparency
- the transparency of the picture- See Also:
IsPictureFill()
,setStretchOptions(float, float, float, float)
,setTextureFill(int)
,setTilingOptions(float, float, float, float, System.String, System.String)
-
setPictureFill
public void setPictureFill(ExcelImage xlsImage, int transparency)
Sets the picture fill for the shape.- Parameters:
xlsImage
- the image to be settransparency
- the transparency of the picture- See Also:
IsPictureFill()
,setStretchOptions(float, float, float, float)
,setTextureFill(int)
,setTilingOptions(float, float, float, float, System.String, System.String)
-
setTextureFill
public void setTextureFill(int presetTexture)
Sets a predefined texture for the shape. Possible values are available inFillFormat
class.- Parameters:
presetTexture
- the texture to be set- See Also:
setTilingOptions(float, float, float, float, System.String, System.String)
,IsTilePictureAsTexture()
,setPictureFill(String, int)
,setPictureFill(ExcelImage, int)
-
getTexturePicture
public ExcelImage getTexturePicture()
Returns the image set as fill.- Returns:
- the image set as fill
- See Also:
IsPictureFill()
,IsTilePictureAsTexture()
,setPictureFill(String, int)
,setPictureFill(ExcelImage, int)
,setTextureFill(int)
-
IsTilePictureAsTexture
public bool IsTilePictureAsTexture()
Returns true if the picture is tiled as texture, false otherwise.- Returns:
- true if the picture is tiled as texture, false otherwise.
- See Also:
IsPictureFill()
,setPictureFill(String, int)
,setPictureFill(ExcelImage, int)
,setTextureFill(int)
-
setTilingOptions
public void setTilingOptions(float offsetX, float offsetY, float scaleX, float scaleY, System.String alignment, System.String mirrorType)
Sets the tiling options for the picture fill.- Parameters:
offsetX
- shifts the entire tiled picture fill to the left (negative numbers) or the right (positive numbers)offsetY
- shifts the entire tiled picture fill up (negative numbers) or down (positive numbers)scaleX
- specifies a percentage for the horizontal scaling of the original imagescaleY
- specifies a percentage for the vertical scaling of the original imagealignment
- describes the anchor position where the picture tiling begins. Possible values are available inFillFormat
class.mirrorType
- specifies whether the alternating horizontal or vertical tiles display a mirror or flip image with every other tile. Possible values are available inFillFormat
class.- See Also:
setPictureFill(String, int)
,setPictureFill(ExcelImage, int)
-
setStretchOptions
public void setStretchOptions(float leftOffset, float rightOffset, float topOffset, float bottomOffset)
Sets the stretch options for the texture.- Parameters:
leftOffset
- specifies a percentage to shift the entire picture from the left border of the shaperightOffset
- specifies a percentage to shift the entire picture from the right border of the shapetopOffset
- specifies a percentage to shift the entire picture from the top border of the shapebottomOffset
- specifies a percentage to shift the entire picture from the bottom border of the shape- See Also:
setTextureFill(int)
-
getTileOffsetX
public float getTileOffsetX()
Returns the offset of the picture fill to the left (negative numbers) or the right (positive numbers).- Returns:
- the offset of the picture fill to the left (negative numbers) or the right (positive numbers)
- See Also:
getTileOffsetY()
,getTileScaleX()
,getTileScaleY()
,getTileAlignment()
,getTileMirrorType()
,setTilingOptions(float, float, float, float, System.String, System.String)
-
getTileOffsetY
public float getTileOffsetY()
Returns the offset of the picture fill to the top (negative numbers) or to the bottom (positive numbers).- Returns:
- the offset of the picture fill to the top (negative numbers) or to the bottom (positive numbers)
- See Also:
getTileOffsetX()
,getTileScaleX()
,getTileScaleY()
,getTileAlignment()
,getTileMirrorType()
,setTilingOptions(float, float, float, float, System.String, System.String)
-
getTileScaleX
public float getTileScaleX()
Returns the percentage for the horizontal scaling of the original image.- Returns:
- the percentage for the horizontal scaling of the original image
- See Also:
getTileOffsetX()
,getTileOffsetY()
,getTileScaleY()
,getTileAlignment()
,getTileMirrorType()
,setTilingOptions(float, float, float, float, System.String, System.String)
-
getTileScaleY
public float getTileScaleY()
Returns the percentage for the vertical scaling of the original image.- Returns:
- the percentage for the vertical scaling of the original image
- See Also:
getTileOffsetX()
,getTileOffsetY()
,getTileScaleX()
,getTileAlignment()
,getTileMirrorType()
,setTilingOptions(float, float, float, float, System.String, System.String)
-
getTileAlignment
public System.String getTileAlignment()
Returns the alignment of the tiled picture.- Returns:
- the alignment of the tiled picture
- See Also:
getTileOffsetX()
,getTileOffsetY()
,getTileScaleX()
,getTileScaleY()
,getTileMirrorType()
,setTilingOptions(float, float, float, float, System.String, System.String)
-
getTileMirrorType
public System.String getTileMirrorType()
Returns the mirror type of the tiled picture.- Returns:
- the mirror type of the tiled picture
- See Also:
getTileOffsetX()
,getTileOffsetY()
,getTileScaleX()
,getTileScaleY()
,getTileAlignment()
,setTilingOptions(float, float, float, float, System.String, System.String)
-
getStretchLeftOffset
public float getStretchLeftOffset()
Returns the offset of the picture from the left border of the shape- Returns:
- the offset of the picture from the left border of the shape
- See Also:
getStretchRightOffset()
,getStretchTopOffset()
,getStretchBottomOffset()
,setStretchOptions(float, float, float, float)
-
getStretchRightOffset
public float getStretchRightOffset()
Returns the offset of the picture from the right border of the shape.- Returns:
- the offset of the picture from the right border of the shape
- See Also:
getStretchLeftOffset()
,getStretchTopOffset()
,getStretchBottomOffset()
,setStretchOptions(float, float, float, float)
-
getStretchTopOffset
public float getStretchTopOffset()
Returns the offset of the picture from the top border of the shape.- Returns:
- the offset of the picture from the top border of the shape
- See Also:
getStretchLeftOffset()
,getStretchRightOffset()
,getStretchBottomOffset()
,setStretchOptions(float, float, float, float)
-
getStretchBottomOffset
public float getStretchBottomOffset()
Returns the offset of the picture from the bottom border of the shape.- Returns:
- the offset of the picture from the bottom border of the shape
- See Also:
getStretchLeftOffset()
,getStretchRightOffset()
,getStretchTopOffset()
,setStretchOptions(float, float, float, float)
-
IsAutomatic
public bool IsAutomatic()
Returns true if automatic fill is set, false otherwise.- Returns:
- true if automatic fill is set, false otherwise
- See Also:
setAutomatic(bool)
-
setAutomatic
public void setAutomatic(bool isAutomatic)
Sets the automatic option of the shape.- Parameters:
isAutomatic
- whether automatic option is set- See Also:
IsAutomatic()
-
Clone
public FillFormat Clone()
Creates and returns a copy of this object.- Returns:
- a clone of this instance.
-
-