ActiveXLS v6.4.0 API Documentation

ActiveXLS
Class ExcelSheet

System.Object
  extended byActiveXLS.BIFF_Records.SheetStream
      extended byActiveXLS.ExcelSheet
Direct Known Subclasses:
ExcelChartSheet, ExcelWorksheet, UnknownSheet

public abstract class ExcelSheet
extends ActiveXLS.BIFF_Records.SheetStream

This class simulates a sheet. It can be a worksheet or a chart.


Constructor Summary
ExcelSheet()
          Defines an instance of the sheet.
 
Method Summary
abstract  ExcelSheet Clone()
          Creates and returns a copy of this object.
 void Dispose()
          Disposes any resources that it has allocated.
 System.String getSheetName()
          Returns the name of the sheet.
 System.Drawing.Color getTabColor()
          Returns the tab color.
 int getZoom()
          Returns the zoom of the sheet.
 bool IsHidden()
          Returns the hidden option of the sheet.
 bool IsSheetProtected()
          Returns the protected option of the sheet.
 bool IsSheetSelected()
          Returns the selected option of the sheet.
 void setHidden(bool isHidden)
          Sets the hidden option of the sheet.
 void setSheetName(System.String sheetName)
          Sets the name of the sheet.
 void setSheetProtected(bool isSheetProtected)
          Sets the protected option of the sheet.
 void setSheetSelected(bool isSheetSelected)
          Sets the selected option of the sheet.
 void setTabColor(System.Drawing.Color colorTab)
          Sets the tab color.
 void setZoom(int zoom)
          Sets the zoom of the sheet.
 

Constructor Detail

ExcelSheet

public ExcelSheet()
Defines an instance of the sheet.

Method Detail

IsSheetSelected

public bool IsSheetSelected()
Returns the selected option of the sheet.

Returns:
true if this ExcelSheet is selected.
See Also:
setSheetSelected(bool)

setSheetSelected

public void setSheetSelected(bool isSheetSelected)
Sets the selected option of the sheet.

Parameters:
isSheetSelected - true if the sheet is selected, false otherwise
See Also:
IsSheetSelected()

setZoom

public void setZoom(int zoom)
Sets the zoom of the sheet.

Parameters:
zoom - the zoom of the sheet.
See Also:
getZoom()

getZoom

public int getZoom()
Returns the zoom of the sheet.

Returns:
the zoom of the sheet
See Also:
setZoom(int)

IsSheetProtected

public bool IsSheetProtected()
Returns the protected option of the sheet.

Returns:
true if this ExcelSheet is protected.
See Also:
setSheetProtected(bool)

setSheetProtected

public void setSheetProtected(bool isSheetProtected)
Sets the protected option of the sheet.

Parameters:
isSheetProtected - true if the sheet is protected, false otherwise
See Also:
IsSheetProtected()

IsHidden

public bool IsHidden()
Returns the hidden option of the sheet.

Returns:
true if this ExcelSheet is hidden.
See Also:
setHidden(bool)

setHidden

public void setHidden(bool isHidden)
Sets the hidden option of the sheet.

Parameters:
isHidden - true if the sheet is selected, false otherwise
See Also:
IsHidden()

getSheetName

public System.String getSheetName()
Returns the name of the sheet.

Returns:
the name of the sheet.
See Also:
setSheetName(System.String)

setSheetName

public void setSheetName(System.String sheetName)
Sets the name of the sheet.

Parameters:
sheetName - the name of the sheet
See Also:
getSheetName()

getTabColor

public System.Drawing.Color getTabColor()
Returns the tab color.

Returns:
the tab color.
See Also:
setSheetName(System.String)

setTabColor

public void setTabColor(System.Drawing.Color colorTab)
Sets the tab color.

Parameters:
colorTab - the tab color
See Also:
getTabColor()

Dispose

public void Dispose()
Disposes any resources that it has allocated.


Clone

public abstract ExcelSheet Clone()
Creates and returns a copy of this object.

Returns:
a clone of this instance.

Copyright 2009 On Time Computing Solutions