ActiveXLS.Charts
Class ExcelChartLegend

System.Object
  ActiveXLS.Charts.ExcelChartLegend

public class ExcelChartLegend

extends System.Object

This class stores the ChartLegend information like border style, border color, border weight, shadow presence, background color, font name, font size, font bold, font italic, font underline style, font subscript, font superscript, font strikethrough, foreground color, legend position, keys arrangement direction, visibility .

Constructor Summary

ExcelChartLegend()
Defines an instance of the excel legend.

Method Summary

ExcelChartLegend	Clone() Creates and returns a copy of this object.
System.Drawing.Color	getBackground() Returns the background color of the chart legend.
System.Drawing.Color	getBorderColor() Returns the border color of the chart legend.
int	getBorderStyle() Returns the border style of the chart legend.
int	getBorderWeight() Returns the border weight of the chart legend.
System.String	getFont() Returns the font name used in the chart legend.
int	getFontSize() Returns the size of the font used in the chart legend.
System.Drawing.Color	getForeground() Returns the text color of the chart legend.
int	getKeysArrangementDirection() Returns the direction in which the keys are arranged inside the legend: vertically or horizontally.
int	getPlacement() Returns the position of the chart legend within the chart area.
int	getUnderlineStyle() Returns the underline style of the chart legend text.
bool	IsBold() Returns the bold setting of the chart legend font.
bool	IsItalic() Returns the italic setting of the chart legend font.
bool	IsShadow() Returns the shadow setting of the chart legend.
bool	IsStrikethrough() Returns the strikethrough setting of the chart legend font.
bool	IsSubscript() Returns the subscript setting of the chart legend font.
bool	IsSuperscript() Returns the superscript setting of the chart legend font.
bool	IsVisible() Returns the visible setting of the chart legend.
void	setBackground(System.Drawing.Color background) Sets the background color of the chart legend.
void	setBold(bool isBold) Sets the bold setting of the chart legend font.
void	setBorderColor(System.Drawing.Color borderColor) Sets the color of the chart legend border.
void	setBorderStyle(int borderStyle) Sets the style of the chart legend border.
void	setBorderWeight(int borderWeight) Sets the weight of the chart legend border.
void	setFont(System.String fontName) Sets the chart legend 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 legend font.
void	setForeground(System.Drawing.Color foreground) Sets the foreground color of the chart legend.
void	setItalic(bool isItalic) Sets the italic setting of the chart legend font.
void	setKeysArrangementDirection(int direction) Sets the direction in which the keys will be arranged: vertical or horizontal.
void	setPlacement(int location) Sets the placement setting (position) of the chart legend within the chart area.
void	setShadow(bool isShadow) Sets the shadow setting of the chart legend.
void	setStrikethrough(bool isStrikethrough) Sets the strikethrough setting of the chart legend font.
void	setSubscript(bool isSubscript) Sets the subscript setting of the chart legend font.
void	setSuperscript(bool isSuperscript) Sets the superscript setting of the chart legend font.
void	setUnderlineStyle(int underlineStyle) Sets the underline style of the chart legend text.
void	setVisible(bool value) Sets the visible setting of the chart legend.

Constructor Detail

ExcelChartLegend

public ExcelChartLegend()

Defines an instance of the excel legend.

Method Detail

IsVisible

public bool IsVisible()

Returns the visible setting of the chart legend.

Returns:

the visible setting of the chart legend

See Also:

setVisible(bool)

setVisible

public void setVisible(bool value)

Sets the visible setting of the chart legend.

Parameters:

value - the new visible setting of the chart legend

See Also:

IsVisible()

getBorderStyle

public int getBorderStyle()

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

Returns:

the border style of the chart legend

See Also:

setBorderStyle(int)

setBorderStyle

public void setBorderStyle(int borderStyle)

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

Parameters:

borderStyle - the new style of the chart legend border

See Also:

getBorderStyle()

getBorderWeight

public int getBorderWeight()

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

Returns:

the border weight of the chart legend

See Also:

setBorderWeight(int)

setBorderWeight

public void setBorderWeight(int borderWeight)

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

Parameters:

borderWeight - the new weight value of the chart legend border

See Also:

getBorderWeight()

getBorderColor

public System.Drawing.Color getBorderColor()

Returns the border color of the chart legend.

Returns:

the border color of the chart legend

See Also:

setBorderColor(System.Drawing.Color)

setBorderColor

public void setBorderColor(System.Drawing.Color borderColor)

Sets the color of the chart legend border.

Parameters:

borderColor - the new color of the chart legend border

See Also:

getBorderColor()

IsShadow

public bool IsShadow()

Returns the shadow setting of the chart legend.

Returns:

the shadow setting of the chart legend

See Also:

setShadow(bool)

setShadow

public void setShadow(bool isShadow)

Sets the shadow setting of the chart legend.

Parameters:

isShadow - the new shadow setting of the chart legend.

See Also:

IsShadow()

getForeground

public System.Drawing.Color getForeground()

Returns the text color of the chart legend.

Returns:

the text color of the chart legend

See Also:

setForeground(System.Drawing.Color)

setForeground

public void setForeground(System.Drawing.Color foreground)

Sets the foreground color of the chart legend.

Parameters:

foreground - the new color of the chart legend foreground

See Also:

getForeground()

getBackground

public System.Drawing.Color getBackground()

Returns the background color of the chart legend.

Returns:

the chart legend's background color

See Also:

setBackground(System.Drawing.Color)

setBackground

public void setBackground(System.Drawing.Color background)

Sets the background color of the chart legend.

Parameters:

background - the new color of the legend background

See Also:

getBackground()

IsStrikethrough

public bool IsStrikethrough()

Returns the strikethrough setting of the chart legend font.

Returns:

the strikethrough setting of the chart legend font

See Also:

setStrikethrough(bool)

setStrikethrough

public void setStrikethrough(bool isStrikethrough)

Sets the strikethrough setting of the chart legend font.

Parameters:

isStrikethrough - the new value of the strikethrough setting

See Also:

IsStrikethrough()

IsSuperscript

public bool IsSuperscript()

Returns the superscript setting of the chart legend font.

Returns:

Returns the superscript setting of the chart legend font.

See Also:

setSuperscript(bool)

setSuperscript

public void setSuperscript(bool isSuperscript)

Sets the superscript setting of the chart legend font.

Parameters:

isSuperscript - the new superscript setting of the chart legend font

See Also:

IsSuperscript()

IsSubscript

public bool IsSubscript()

Returns the subscript setting of the chart legend font.

Returns:

the subscript setting of the chart legend font

See Also:

setSubscript(bool)

setSubscript

public void setSubscript(bool isSubscript)

Sets the subscript setting of the chart legend font.

Parameters:

isSubscript - the new subscript setting of the chart legend font

See Also:

IsSubscript()

getUnderlineStyle

public int getUnderlineStyle()

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

Returns:

the underline style of the chart legend text

See Also:

setUnderlineStyle(int)

setUnderlineStyle

public void setUnderlineStyle(int underlineStyle)

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

Parameters:

underlineStyle - the new underline style of the chart legend

See Also:

getUnderlineStyle()

getFontSize

public int getFontSize()

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

Returns:

the size of the font used in the chart legend

See Also:

setFontSize(int)

setFontSize

public void setFontSize(int fontSize)

Sets the size of the chart legend font.

Parameters:

fontSize - the new value of the chart legend font size.

See Also:

getFontSize()

getFont

public System.String getFont()

Returns the font name used in the chart legend.

Returns:

the font name used in the chart legend

See Also:

setFont(System.String)

setFont

public void setFont(System.String fontName)

Sets the chart legend font name.

Parameters:

fontName - the name of the new font

See Also:

getFont()

IsBold

public bool IsBold()

Returns the bold setting of the chart legend font.

Returns:

the bold setting of the chart legend font

See Also:

setBold(bool)

setBold

public void setBold(bool isBold)

Sets the bold setting of the chart legend font.

Parameters:

isBold - the new value of the bold setting

See Also:

IsBold()

IsItalic

public bool IsItalic()

Returns the italic setting of the chart legend font.

Returns:

the italic setting of the chart legend font

See Also:

setItalic(bool)

setItalic

public void setItalic(bool isItalic)

Sets the italic setting of the chart legend 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

getPlacement

public int getPlacement()

Returns the position of the chart legend within the chart area. Possible values are available in Chart class.

Returns:

the position of the chart legend within the chart area

See Also:

setPlacement(int)

setPlacement

public void setPlacement(int location)

Sets the placement setting (position) of the chart legend within the chart area. Possible values are available in Chart class.

Parameters:

location - the new position of the chart legend.

See Also:

getPlacement()

getKeysArrangementDirection

public int getKeysArrangementDirection()

Returns the direction in which the keys are arranged inside the legend: vertically or horizontally. Possible values are available in Chart class.

Returns:

the direction for keys arrangement

See Also:

setKeysArrangementDirection(int)

setKeysArrangementDirection

public void setKeysArrangementDirection(int direction)

Sets the direction in which the keys will be arranged: vertical or horizontal. Possible values are available in Chart class.

Parameters:

direction - the new direction

See Also:

getKeysArrangementDirection()

Clone

public ExcelChartLegend Clone()

Creates and returns a copy of this object.

Returns:

a clone of this instance.