Namespace EasyXLS

Class ExcelChartSheet

System.Object

EasyXLS.BIFF_Records.SheetStream

EasyXLS.ExcelSheet

EasyXLS.ExcelChartSheet

public class ExcelChartSheet
extends ExcelSheet

This class stores chart information like series, legend, axis, plot area, chart area, data table, title, series gap and overlap, 3D perspective, 3D elevation, 3D rotation and 3D height.

Constructor Summary

Constructors

Constructor	Description
ExcelChartSheet()	Defines an instance of a sheet that contains a chart.
ExcelChartSheet(System.String chartName)	Defines an instance of a sheet that has the sheet name defined and contains a chart.

Method Summary

Modifier and Type	Method	Description
ExcelSheet	Clone()	Creates and returns a copy of this object.
void	Dispose()	Disposes the allocated resources.
void	easy_addImage(System.String path, int horizontalOffset, int verticalOffset)	Adds an image that has the specified path and location to chart sheet.
void	easy_addImage(System.String path, int horizontalOffset, int verticalOffset, int width, int height)	Adds an image that has the specified path, location and size to chart sheet.
ExcelChart	easy_getExcelChart()	Returns the chart of the sheet.
void	easy_setExcelChart(ExcelChart xlsChart)	Sets the chart of the sheet.
bool	ProtectContents()	Returns true if the contents are protected when the sheet is protected, false otherwise.
bool	ProtectObjects()	Returns true if the objects are protected when the sheet is protected, false otherwise.
void	RestoreDefaults()	Internal use only
void	setProtectContents(bool protect)	Sets if the contents are protected when the sheet is protected.
void	setProtectObjects(bool protect)	Sets if the objects are protected when the sheet is protected.

Methods inherited from class EasyXLS.ExcelSheet

easy_addImage, easy_addImage, easy_getImage, easy_getImageAt, easy_removeImage, easy_removeImage, getHashedPassword, getSheetName, getTabColor, getTabThemeColor, getZoom, ImageCount, IsHidden, IsSheetProtected, IsSheetSelected, setHashedPassword, setHidden, setProtectionPassword, setSheetName, setSheetProtected, setSheetSelected, setTabColor, setTabColor, setZoom

Methods inherited from class EasyXLS.BIFF_Records.SheetStream

biffList, BIFFsLength

Constructor Detail

ExcelChartSheet

public ExcelChartSheet()

Defines an instance of a sheet that contains a chart.

ExcelChartSheet

public ExcelChartSheet(System.String chartName)

Defines an instance of a sheet that has the sheet name defined and contains a chart.

Parameters:

chartName - the chart sheet name.

Method Detail

easy_setExcelChart

public void easy_setExcelChart(ExcelChart xlsChart)

Sets the chart of the sheet.

Parameters:

xlsChart - the chart of the sheet

See Also:

easy_getExcelChart()

easy_getExcelChart

public ExcelChart easy_getExcelChart()

Returns the chart of the sheet.

Returns:

chart of the sheet

See Also:

easy_setExcelChart(EasyXLS.Charts.ExcelChart)

easy_addImage

public void easy_addImage(System.String path,
                          int horizontalOffset,
                          int verticalOffset)

Adds an image that has the specified path and location to chart sheet.

Parameters:

path - the file path to image file

horizontalOffset - the distance from the left margin of the chart to the left border of the image

verticalOffset - the distance from the left margin of the chart to the top border of the image

See Also:

ExcelSheet.easy_removeImage(int), ExcelSheet.easy_getImageAt(int), ExcelSheet.ImageCount()

easy_addImage

public void easy_addImage(System.String path,
                          int horizontalOffset,
                          int verticalOffset,
                          int width,
                          int height)

Adds an image that has the specified path, location and size to chart sheet.

Parameters:

path - the file path to image file

horizontalOffset - the distance from the left margin of the chart to the left border of the image

verticalOffset - the distance from the left margin of the chart to the top border of the image

width - the image width

height - the image height

See Also:

ExcelSheet.easy_removeImage(int), ExcelSheet.easy_getImageAt(int), ExcelSheet.ImageCount()

ProtectObjects

public bool ProtectObjects()

Returns true if the objects are protected when the sheet is protected, false otherwise.

Returns:

true if the objects are protected when the sheet is protected, false otherwise

See Also:

setProtectObjects(bool), setProtectContents(bool)

setProtectObjects

public void setProtectObjects(bool protect)

Sets if the objects are protected when the sheet is protected.

Parameters:

protect - true if the objects are protected when the sheet is protected, false otherwise

See Also:

ProtectObjects(), ProtectContents()

ProtectContents

public bool ProtectContents()

Returns true if the contents are protected when the sheet is protected, false otherwise.

Returns:

true if the contents are protected when the sheet is protected, false otherwise

See Also:

setProtectContents(bool), setProtectObjects(bool)

setProtectContents

public void setProtectContents(bool protect)

Sets if the contents are protected when the sheet is protected.

Parameters:

protect - true if the contents are protected when the sheet is protected, false otherwise

See Also:

ProtectContents(), ProtectObjects()

Dispose

public void Dispose()

Disposes the allocated resources.

Overrides:

Dispose in class ExcelSheet

Clone

public ExcelSheet Clone()

Creates and returns a copy of this object.

Specified by:

Clone in class ExcelSheet

Returns:

a clone of this instance.

RestoreDefaults

public void RestoreDefaults()

Internal use only

Overrides:

RestoreDefaults in class EasyXLS.BIFF_Records.SheetStream