Namespace EasyXLS.Drawings.Formatting
Class LineColorFormat
System.Object
EasyXLS.Drawings.Formatting.LineColorFormat
public class LineColorFormat
extends System.Object
This class stores the line color options for images, shapes and other drawing objects. There are 4 types of line extends no line, solid line, gradient line
and automatic.
-
Constant Summary
Modifier and TypeFieldDescriptionconst int
A constant indicating the gradient direction from center.const int
A constant indicating the gradient direction from bottom left corner to upper right corner.const int
A constant indicating the gradient direction from bottom right corner to upper left corner.const int
A constant indicating the gradient direction from upper left corner to bottom right corner.const int
A constant indicating the gradient direction from upper right corner to bottom left corner.const int
A constant indicating the linear diagonal gradient direction (a gradient angle of 135 degrees).const int
A constant indicating the linear diagonal gradient direction (a gradient angle of 225 degrees).const int
A constant indicating the linear diagonal gradient direction (a gradient angle of 315 degrees).const int
A constant indicating the linear diagonal gradient direction (a gradient angle of 45 degrees).const int
A constant indicating the linear down gradient direction (a gradient angle of 90 degrees).const int
A constant indicating the linear left gradient direction (a gradient angle of 180 degrees).const int
A constant indicating the linear right gradient direction (a gradient angle of 0 degrees).const int
A constant indicating the linear up gradient direction (a gradient angle of 270 degrees).const int
A constant indicating the brass gradient line.const int
A constant indicating the calm water gradient line.const int
A constant indicating the chrome gradient line.const int
A constant indicating the chrome II gradient line.const int
A constant indicating the daybreak gradient line.const int
A constant indicating the default gradient line.const int
A constant indicating the desert gradient line.const int
A constant indicating the early sunset gradient line.const int
A constant indicating the fire gradient line.const int
A constant indicating the fog gradient line.const int
A constant indicating the gold gradient line.const int
A constant indicating the gold II gradient line.const int
A constant indicating the horizon gradient line.const int
A constant indicating the late sunset gradient line.const int
A constant indicating the mahogany gradient line.const int
A constant indicating the moss gradient line.const int
A constant indicating the nightfall gradient line.const int
A constant indicating the ocean gradient line.const int
A constant indicating the parchment gradient line.const int
A constant indicating the peacock gradient line.const int
A constant indicating the rainbow gradient line.const int
A constant indicating the rainbow II gradient line.const int
A constant indicating the sapphire gradient line.const int
A constant indicating the silver gradient line.const int
A constant indicating the wheat gradient line.const int
A constant indicating the linear gradient type.const int
A constant indicating the path gradient type.const int
A constant indicating the radial gradient type.const int
A constant indicating the rectangular gradient type. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addGradientStop(int position, ThemeColor color, int transparency)
Adds a gradient stop to the line color that is set as gradient line, having a specified position, color and transparency.
This method is overridden as addGradientStop_2 in COM+ version of EasyXLS.
void
addGradientStop(int position, System.Drawing.Color color, int transparency)
Adds a gradient stop to the line color that is set as gradient line, having a specified position, color and transparency.void
addGradientStop(GradientStop stop)
Adds a gradient stop to the line color that is set as gradient line.
This method is overridden as addGradientStop_3 in COM+ version of EasyXLS.
Clone()
Creates and returns a copy of this object.float
Returns the angle of the gradient.int
Returns the direction of the gradient line.getGradientStopAt(int stop)
Returns the gradient stop of the line at the specified position.int
Returns the gradient type of the gradient line.System.Drawing.Color
Returns the line color.int
Returns the pattern of the line.Returns the line color.int
Returns the transparency of the color.int
Counts the gradient stops of the line.bool
Returns true if an automatic line is set, false otherwise.bool
Returns true if a gradient line is set, false otherwise.bool
IsNoLine()
Returns true if no line is set, false otherwise.bool
Returns true if a pattern line is set, false otherwise.bool
Returns true if a solid line is set, false otherwise.void
removeGradientStopAt(int stop)
Removes the gradient stop of the line at the specified position.void
setAutomatic(bool isAutomatic)
Sets an automatic line.void
setGradientAngle(float angle)
Sets the angle of the gradient.void
setGradientDirection(int direction)
Sets the direction for the gradient line.void
setGradientLine(int presetColors)
Sets a predefined subset of colors for the gradient.void
setGradientType(int type)
Sets the gradient type of the gradient line.void
setLineColor(ThemeColor themeColor)
Sets the line color.
This method is overridden as setLineColor_2 in COM+ version of EasyXLS.
void
setLineColor(System.Drawing.Color color)
Sets the line color.void
setNoLine(bool noLine)
Sets no line for the shape.void
setPatternLine(int linePattern, System.Drawing.Color color)
Sets the pattern of the line.void
setSolidLine(ThemeColor color, int transparency)
Sets the solid line options.
This method is overridden as setSolidLine_2 in COM+ version of EasyXLS.
void
setSolidLine(System.Drawing.Color color, int transparency)
Sets the solid line options.Methods inherited from class System.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
GRADIENT_LINE_DEFAULT
public const final int GRADIENT_LINE_DEFAULTA constant indicating the default gradient line. Embedded value is "0".- See Also:
- Constant Values
-
GRADIENT_LINE_EARLY_SUNSET
public const final int GRADIENT_LINE_EARLY_SUNSETA constant indicating the early sunset gradient line. Embedded value is "1".- See Also:
- Constant Values
-
GRADIENT_LINE_LATE_SUNSET
public const final int GRADIENT_LINE_LATE_SUNSETA constant indicating the late sunset gradient line. Embedded value is "2".- See Also:
- Constant Values
-
GRADIENT_LINE_NIGHTFALL
public const final int GRADIENT_LINE_NIGHTFALLA constant indicating the nightfall gradient line. Embedded value is "3".- See Also:
- Constant Values
-
GRADIENT_LINE_DAYBREAK
public const final int GRADIENT_LINE_DAYBREAKA constant indicating the daybreak gradient line. Embedded value is "4".- See Also:
- Constant Values
-
GRADIENT_LINE_HORIZON
public const final int GRADIENT_LINE_HORIZONA constant indicating the horizon gradient line. Embedded value is "5".- See Also:
- Constant Values
-
GRADIENT_LINE_DESERT
public const final int GRADIENT_LINE_DESERTA constant indicating the desert gradient line. Embedded value is "6".- See Also:
- Constant Values
-
GRADIENT_LINE_OCEAN
public const final int GRADIENT_LINE_OCEANA constant indicating the ocean gradient line. Embedded value is "7".- See Also:
- Constant Values
-
GRADIENT_LINE_CALM_WATER
public const final int GRADIENT_LINE_CALM_WATERA constant indicating the calm water gradient line. Embedded value is "8".- See Also:
- Constant Values
-
GRADIENT_LINE_FIRE
public const final int GRADIENT_LINE_FIREA constant indicating the fire gradient line. Embedded value is "9".- See Also:
- Constant Values
-
GRADIENT_LINE_FOG
public const final int GRADIENT_LINE_FOGA constant indicating the fog gradient line. Embedded value is "10".- See Also:
- Constant Values
-
GRADIENT_LINE_MOSS
public const final int GRADIENT_LINE_MOSSA constant indicating the moss gradient line. Embedded value is "11".- See Also:
- Constant Values
-
GRADIENT_LINE_PEACOCK
public const final int GRADIENT_LINE_PEACOCKA constant indicating the peacock gradient line. Embedded value is "12".- See Also:
- Constant Values
-
GRADIENT_LINE_WHEAT
public const final int GRADIENT_LINE_WHEATA constant indicating the wheat gradient line. Embedded value is "13".- See Also:
- Constant Values
-
GRADIENT_LINE_PARCHMENT
public const final int GRADIENT_LINE_PARCHMENTA constant indicating the parchment gradient line. Embedded value is "14".- See Also:
- Constant Values
-
GRADIENT_LINE_MAHOGANY
public const final int GRADIENT_LINE_MAHOGANYA constant indicating the mahogany gradient line. Embedded value is "15".- See Also:
- Constant Values
-
GRADIENT_LINE_RAINBOW
public const final int GRADIENT_LINE_RAINBOWA constant indicating the rainbow gradient line. Embedded value is "16".- See Also:
- Constant Values
-
GRADIENT_LINE_RAINBOW_II
public const final int GRADIENT_LINE_RAINBOW_IIA constant indicating the rainbow II gradient line. Embedded value is "17".- See Also:
- Constant Values
-
GRADIENT_LINE_GOLD
public const final int GRADIENT_LINE_GOLDA constant indicating the gold gradient line. Embedded value is "18".- See Also:
- Constant Values
-
GRADIENT_LINE_GOLD_II
public const final int GRADIENT_LINE_GOLD_IIA constant indicating the gold II gradient line. Embedded value is "19".- See Also:
- Constant Values
-
GRADIENT_LINE_BRASS
public const final int GRADIENT_LINE_BRASSA constant indicating the brass gradient line. Embedded value is "20".- See Also:
- Constant Values
-
GRADIENT_LINE_CHROME
public const final int GRADIENT_LINE_CHROMEA constant indicating the chrome gradient line. Embedded value is "21".- See Also:
- Constant Values
-
GRADIENT_LINE_CHROME_II
public const final int GRADIENT_LINE_CHROME_IIA constant indicating the chrome II gradient line. Embedded value is "22".- See Also:
- Constant Values
-
GRADIENT_LINE_SILVER
public const final int GRADIENT_LINE_SILVERA constant indicating the silver gradient line. Embedded value is "23".- See Also:
- Constant Values
-
GRADIENT_LINE_SAPPHIRE
public const final int GRADIENT_LINE_SAPPHIREA constant indicating the sapphire gradient line. Embedded value is "24".- See Also:
- Constant Values
-
GRADIENT_TYPE_LINEAR
public const final int GRADIENT_TYPE_LINEARA constant indicating the linear gradient type. Embedded value is "0".- See Also:
- Constant Values
-
GRADIENT_TYPE_RADIAL
public const final int GRADIENT_TYPE_RADIALA constant indicating the radial gradient type. Embedded value is "1".- See Also:
- Constant Values
-
GRADIENT_TYPE_RECTANGULAR
public const final int GRADIENT_TYPE_RECTANGULARA constant indicating the rectangular gradient type. Embedded value is "2".- See Also:
- Constant Values
-
GRADIENT_TYPE_PATH
public const final int GRADIENT_TYPE_PATHA constant indicating the path gradient type. Embedded value is "3".- See Also:
- Constant Values
-
GRADIENT_DIRECTION_LINEAR_DIAGONAL_45_DEGREES
public const final int GRADIENT_DIRECTION_LINEAR_DIAGONAL_45_DEGREESA 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 final int GRADIENT_DIRECTION_LINEAR_DOWN_90_DEGREESA 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 final int GRADIENT_DIRECTION_LINEAR_DIAGONAL_135_DEGREESA 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 final int GRADIENT_DIRECTION_LINEAR_RIGHT_0_DEGREESA 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 final int GRADIENT_DIRECTION_LINEAR_LEFT_180_DEGREESA 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 final int GRADIENT_DIRECTION_LINEAR_DIAGONAL_315_DEGREESA 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 final int GRADIENT_DIRECTION_LINEAR_UP_270_DEGREESA 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 final int GRADIENT_DIRECTION_LINEAR_DIAGONAL_225_DEGREESA 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 final int GRADIENT_DIRECTION_FROM_CORNER_UPPER_LEFT_TO_BOTTOM_RIGHTA 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 final int GRADIENT_DIRECTION_FROM_CORNER_UPPER_RIGHT_TO_BOTTOM_LEFTA 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 final int GRADIENT_DIRECTION_FROM_CENTERA 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 final int GRADIENT_DIRECTION_FROM_CORNER_BOTTOM_LEFT_TO_UPPER_RIGHTA 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 final int GRADIENT_DIRECTION_FROM_CORNER_BOTTOM_RIGHT_TO_UPPER_LEFTA constant indicating the gradient direction from bottom right corner to upper left corner. Embedded value is "4".- See Also:
- Constant Values
-
-
Constructor Details
-
LineColorFormat
public LineColorFormat()Defines an instance of the line color formatting.
-
-
Method Details
-
IsNoLine
public bool IsNoLine()Returns true if no line is set, false otherwise.- Returns:
- true if no line is set, false otherwise.
- See Also:
setNoLine(bool)
-
setNoLine
public void setNoLine(bool noLine)Sets no line for the shape.- Parameters:
noLine
- true if no line is set, false otherwise- See Also:
IsNoLine()
-
IsSolidLine
public bool IsSolidLine()Returns true if a solid line is set, false otherwise.- Returns:
- true if a solid line is set, false otherwise.
- See Also:
setSolidLine(Color,int)
,setSolidLine(ThemeColor,int)
-
setSolidLine
public void setSolidLine(System.Drawing.Color color, int transparency)Sets the solid line options.- Parameters:
color
- the color of the linetransparency
- the transparency of the color- See Also:
IsSolidLine()
,getLineColor()
,getTransparency()
-
setSolidLine
Sets the solid line options.
This method is overridden as setSolidLine_2 in COM+ version of EasyXLS.
- Parameters:
color
- the color of the linetransparency
- the transparency of the color- See Also:
IsSolidLine()
,getLineThemeColor()
,getTransparency()
-
getTransparency
public int getTransparency()Returns the transparency of the color.- Returns:
- the transparency of the color
-
getLineColor
public System.Drawing.Color getLineColor()Returns the line color.- Returns:
- the line color
- See Also:
setLineColor(Color)
,setSolidLine(Color,int)
-
getLineThemeColor
Returns the line color.- Returns:
- the line color
- See Also:
setLineColor(ThemeColor)
,setSolidLine(ThemeColor,int)
-
setLineColor
public void setLineColor(System.Drawing.Color color)Sets the line color.- Parameters:
color
- the line color- See Also:
getLineColor()
,setSolidLine(Color,int)
-
setLineColor
Sets the line color.
This method is overridden as setLineColor_2 in COM+ version of EasyXLS.
- Parameters:
themeColor
- the line color- See Also:
getLineThemeColor()
,setSolidLine(ThemeColor,int)
-
IsPatternLine
public bool IsPatternLine()Returns true if a pattern line is set, false otherwise. Use only to ensure compatibility for Office 97-2003 documents.- Returns:
- ttrue if a pattern line is set, false otherwise
- See Also:
setPatternLine(int, System.Drawing.Color)
,getLinePattern()
-
getLinePattern
public int getLinePattern()Returns the pattern of the line. Use only to ensure compatibility for Office 97-2003 documents. Possible values are Chart.LINE_STYLE_DARK_GRAY, Chart.LINE_STYLE_LIGHT_GRAY, Chart.LINE_STYLE_MEDIUM_GRAY- Returns:
- the line pattern of the formatting
- See Also:
setPatternLine(int, System.Drawing.Color)
,IsPatternLine()
-
setPatternLine
public void setPatternLine(int linePattern, System.Drawing.Color color)Sets the pattern of the line. Use only to ensure compatibility for Office 97-2003 documents.- Parameters:
linePattern
- the pattern of the line. Possible values are Chart.LINE_STYLE_DARK_GRAY, Chart.LINE_STYLE_LIGHT_GRAY, Chart.LINE_STYLE_MEDIUM_GRAYcolor
- the color of the pattern- See Also:
getLinePattern()
,IsPatternLine()
-
IsGradientLine
public bool IsGradientLine()Returns true if a gradient line is set, false otherwise.- Returns:
- true if a gradient line is set, false otherwise.
- See Also:
setGradientLine(int)
,addGradientStop(int,Color,int)
,addGradientStop(int,ThemeColor,int)
-
getGradientType
public int getGradientType()Returns the gradient type of the gradient line. Possible values are available inLineColorFormat
class.- Returns:
- the gradient type
- See Also:
setGradientType(int)
,getGradientAngle()
,getGradientStopAt(int)
-
setGradientType
public void setGradientType(int type)Sets the gradient type of the gradient line. Possible values are available inLineColorFormat
class.- Parameters:
type
- the gradient type- 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 line. Possible values are available inLineColorFormat
class.- Returns:
- the direction of the gradient line
- See Also:
setGradientDirection(int)
,getGradientType()
,getGradientStopAt(int)
-
setGradientDirection
public void setGradientDirection(int direction)Sets the direction for the gradient line. Possible values are available inLineColorFormat
class.- Parameters:
direction
- the gradient direction- See Also:
getGradientDirection()
,setGradientType(int)
,addGradientStop(int,Color,int)
,addGradientStop(int,ThemeColor,int)
-
setGradientLine
public void setGradientLine(int presetColors)Sets a predefined subset of colors for the gradient. Possible values are available inLineColorFormat
class.- Parameters:
presetColors
- the built-in gradient- See Also:
IsGradientLine()
,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 line color that is set as gradient line, having a specified position, color and transparency.- Parameters:
position
- the gradient stop position from where the gradient to startcolor
- the gradient colortransparency
- the color transparency- See Also:
removeGradientStopAt(int)
,getGradientStopAt(int)
,GradientStopCount()
-
addGradientStop
Adds a gradient stop to the line color that is set as gradient line, having a specified position, color and transparency.
This method is overridden as addGradientStop_2 in COM+ version of EasyXLS.
- Parameters:
position
- the gradient stop position from where the gradient to startcolor
- the gradient colortransparency
- the color transparency- See Also:
removeGradientStopAt(int)
,getGradientStopAt(int)
,GradientStopCount()
-
addGradientStop
Adds a gradient stop to the line color that is set as gradient line.
This method is overridden as addGradientStop_3 in COM+ version of EasyXLS.
- Parameters:
stop
- the gradient stop- See Also:
removeGradientStopAt(int)
,getGradientStopAt(int)
,GradientStopCount()
-
getGradientStopAt
Returns the gradient stop of the line at the specified position.- Parameters:
stop
- the gradient stop of the line- Returns:
- the gradient stop of the line at the specified position
- See Also:
setGradientLine(int)
,addGradientStop(GradientStop)
,removeGradientStopAt(int)
,GradientStopCount()
-
removeGradientStopAt
public void removeGradientStopAt(int stop)Removes the gradient stop of the line at the specified position.- Parameters:
stop
- the gradient stop of the line- See Also:
setGradientLine(int)
,addGradientStop(GradientStop)
,getGradientStopAt(int)
,GradientStopCount()
-
GradientStopCount
public int GradientStopCount()Counts the gradient stops of the line.- Returns:
- the number of gradient stops for the line
- See Also:
setGradientLine(int)
,addGradientStop(GradientStop)
,removeGradientStopAt(int)
,getGradientStopAt(int)
-
IsAutomatic
public bool IsAutomatic()Returns true if an automatic line is set, false otherwise.- Returns:
- true if an automatic line is set, false otherwise.
- See Also:
setAutomatic(bool)
-
setAutomatic
public void setAutomatic(bool isAutomatic)Sets an automatic line.- Parameters:
isAutomatic
- true if an automatic line is set, false otherwise.- See Also:
IsAutomatic()
-
Clone
Creates and returns a copy of this object.- Returns:
- a clone of this instance.
-