ActiveXLS.Charts
Class ExcelChartArea

System.Object
  ActiveXLS.Charts.ExcelChartArea

public class ExcelChartArea

extends System.Object

This class stores the chart area information like font name, font size, font bold, font italic, font underline style, font subscript, font superscript, font strikethrough, background color, foreground color, border style, border color, border weight, shadow presence.

Constructor Summary

ExcelChartArea()
Defines an instance of the chart area.

Method Summary

ExcelChartArea	Clone() Creates and returns a copy of this object.
System.Drawing.Color	getBackground() Returns the chart area background color.
System.Drawing.Color	getBorderColor() Returns the border color of the chart area.
int	getBorderStyle() Returns the border style of the chart area.
int	getBorderWeight() Returns the border weight of the chart area.
System.String	getFont() Returns the font name used in the chart area.
int	getFontSize() Returns the size of the font used in the chart area.
System.Drawing.Color	getForeground() Returns the text color of the chart area.
int	getUnderlineStyle() Returns the underline style of the chart area text.
bool	IsBold() Returns the bold setting of the chart area font.
bool	IsItalic() Returns the italic setting of the chart area font.
bool	IsShadow() Returns the shadow setting of the chart area.
bool	IsStrikethrough() Returns the strikethrough setting of the chart area font.
bool	IsSubscript() Returns the subscript setting of the chart area font.
bool	IsSuperscript() Returns the superscript setting of the chart area font.
void	setBackground(System.Drawing.Color background) Sets the background color of the chart area.
void	setBold(bool isBold) Sets the bold setting of the chart area font.
void	setBorderColor(System.Drawing.Color borderColor) Sets the color of the chart area border.
void	setBorderStyle(int borderStyle) Sets the style of the chart area border.
void	setBorderWeight(int borderWeight) Sets the weight of the chart area border.
void	setFont(System.String fontName) Sets the chart area font name.
void	setFontSettings(System.String fontName, int fontSize, bool isBold, bool isItalic, System.Drawing.Color foreground) Sets the font settings.
void	setFontSize(int fontSize) Sets the size of the chart area font.
void	setForeground(System.Drawing.Color foreground) Sets the foreground color of the chart area.
void	setItalic(bool isItalic) Sets the italic setting of the chart area font.
void	setShadow(bool isShadow) Sets the shadow setting of the chart area.
void	setStrikethrough(bool isStrikethrough) Sets the strikethrough setting of the chart area font.
void	setSubscript(bool isSubscript) Sets the subscript setting of the chart area font.
void	setSuperscript(bool isSuperscript) Sets the superscript setting of the chart area font.
void	setUnderlineStyle(int underlineStyle) Sets the underline style of the chart area.

Constructor Detail

ExcelChartArea

public ExcelChartArea()

Defines an instance of the chart area.

Method Detail

getBorderStyle

public int getBorderStyle()

Returns the border style of the chart area. Possible values are available in Chart class.

Returns:

the border style of the chart area

See Also:

setBorderStyle(int)

setBorderStyle

public void setBorderStyle(int borderStyle)

Sets the style of the chart area border. Possible values are available in Chart class.

Parameters:

borderStyle - the new value of the border style

See Also:

getBorderStyle()

getBorderWeight

public int getBorderWeight()

Returns the border weight of the chart area. Possible values are available in Chart class.

Returns:

the border style of the chart area

See Also:

setBorderWeight(int)

setBorderWeight

public void setBorderWeight(int borderWeight)

Sets the weight of the chart area border. Possible values are available in Chart class.

Parameters:

borderWeight - the new value of the border weight

See Also:

getBorderWeight()

getBorderColor

public System.Drawing.Color getBorderColor()

Returns the border color of the chart area.

Returns:

the border color of the chart area

See Also:

setBorderColor(System.Drawing.Color)

setBorderColor

public void setBorderColor(System.Drawing.Color borderColor)

Sets the color of the chart area border.

Parameters:

borderColor - the new color of the border

See Also:

getBorderColor()

IsShadow

public bool IsShadow()

Returns the shadow setting of the chart area.

Returns:

the shadow setting of the chart area

See Also:

setShadow(bool)

setShadow

public void setShadow(bool isShadow)

Sets the shadow setting of the chart area.

Parameters:

isShadow - the new value of the shadow setting

See Also:

IsShadow()

getForeground

public System.Drawing.Color getForeground()

Returns the text color of the chart area.

Returns:

the text color of the chart area

See Also:

setForeground(System.Drawing.Color)

setForeground

public void setForeground(System.Drawing.Color foreground)

Sets the foreground color of the chart area.

Parameters:

foreground - the new color of the foreground

See Also:

getForeground()

getBackground

public System.Drawing.Color getBackground()

Returns the chart area background color.

Returns:

the background color of the chart area

See Also:

setBackground(System.Drawing.Color)

setBackground

public void setBackground(System.Drawing.Color background)

Sets the background color of the chart area.

Parameters:

background - the new color of the area background

See Also:

getBackground()

IsStrikethrough

public bool IsStrikethrough()

Returns the strikethrough setting of the chart area font.

Returns:

the strikethrough setting of the chart area font

See Also:

setStrikethrough(bool)

setStrikethrough

public void setStrikethrough(bool isStrikethrough)

Sets the strikethrough setting of the chart area font.

Parameters:

isStrikethrough - the new value of the strikethrough setting

See Also:

IsStrikethrough()

IsSuperscript

public bool IsSuperscript()

Returns the superscript setting of the chart area font.

Returns:

the superscript setting of the chart area font

See Also:

setSuperscript(bool)

setSuperscript

public void setSuperscript(bool isSuperscript)

Sets the superscript setting of the chart area font.

Parameters:

isSuperscript - the new superscript setting of the chart area

See Also:

IsSuperscript()

IsSubscript

public bool IsSubscript()

Returns the subscript setting of the chart area font.

Returns:

the subscript setting of the chart area font

See Also:

setSubscript(bool)

setSubscript

public void setSubscript(bool isSubscript)

Sets the subscript setting of the chart area font.

Parameters:

isSubscript - the new subscript setting of the chart area font

See Also:

IsSubscript()

getUnderlineStyle

public int getUnderlineStyle()

Returns the underline style of the chart area text. Possible values are available in FontSettings class.

Returns:

the underline style

See Also:

setUnderlineStyle(int)

setUnderlineStyle

public void setUnderlineStyle(int underlineStyle)

Sets the underline style of the chart area. Possible values are available in FontSettings class.

Parameters:

underlineStyle - the underline style of the chart area

See Also:

getUnderlineStyle()

getFontSize

public int getFontSize()

Returns the size of the font used in the chart area.

Returns:

the size of the font used in the chart area

See Also:

setFontSize(int)

setFontSize

public void setFontSize(int fontSize)

Sets the size of the chart area font.

Parameters:

fontSize - the new value of the font size

See Also:

getFontSize()

getFont

public System.String getFont()

Returns the font name used in the chart area.

Returns:

the name of the font used in the chart area

See Also:

setFont(System.String)

setFont

public void setFont(System.String fontName)

Sets the chart area font name.

Parameters:

fontName - the name of the new font

See Also:

getFont()

IsBold

public bool IsBold()

Returns the bold setting of the chart area font.

Returns:

the bold setting of the chart area font

See Also:

setBold(bool)

setBold

public void setBold(bool isBold)

Sets the bold setting of the chart area font.

Parameters:

isBold - the new value of the bold setting

See Also:

IsBold()

IsItalic

public bool IsItalic()

Returns the italic setting of the chart area font.

Returns:

the italic setting of the chart area font

See Also:

setItalic(bool)

setItalic

public void setItalic(bool isItalic)

Sets the italic setting of the chart area font.

Parameters:

isItalic - the new italic style of the chart area font

See Also:

IsItalic()

setFontSettings

public void setFontSettings(System.String fontName,
                            int fontSize,
                            bool isBold,
                            bool isItalic,
                            System.Drawing.Color foreground)

Sets the font settings.

Parameters:

fontName - the name of the font

fontSize - the size of the font

isBold - the bold option of the font

isItalic - the italic option of the font

foreground - the foreground color

Clone

public ExcelChartArea Clone()

Creates and returns a copy of this object.

Returns:

a clone of this instance.