com.acesoft.aceoffix.excelwriter
Class Workbook

java.lang.Object
  com.acesoft.aceoffix.excelwriter.Workbook

public class Workbook
extends java.lang.Object

Representing an Excel document, Workbook class is used to dynamically output the data to the Excel document and control the format and the editing of the document.

Workbook is an important class. Workbook object is the data source of AceoffixCtrl and used as the parameter of the AceoffixCtrl.bind method or the FileMakerCtrl..bind method.

Version:

5.0

Author:

Acesoft Corporation

Constructor Summary

Workbook()
Initializes a new instance of Workbook class.

Method Summary

Sheet	createSheet(java.lang.String newSheetName, SheetInsertType insertType, java.lang.String relativeSheetName) Creates a new worksheet and returns a Sheet object.
Sheet	openSheet(java.lang.String sheetName) Opens the specified worksheet and returns a Sheet object.
void	setDisableSheetDoubleClick(boolean disableSheetDoubleClick) Sets or retrieves a value that indicate whether double-click is disabled in current Excel sheet.
void	setDisableSheetRightClick(boolean disableSheetRightClick) Sets or retrieves a value that indicate whether right-click is disabled in current Excel sheet.
void	setDisableSheetSelection(boolean disableSheetSelection) Sets or retrieves a value that indicates whether selection is disabled in worksheet.
java.lang.String	toString(java.lang.String enc) Gets class name.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Workbook

public Workbook()
         throws java.lang.Exception,
                java.io.IOException

Initializes a new instance of Workbook class.

Throws:

java.lang.Exception

java.io.IOException

Method Detail

setDisableSheetDoubleClick

public void setDisableSheetDoubleClick(boolean disableSheetDoubleClick)

Sets or retrieves a value that indicate whether double-click is disabled in current Excel sheet.

Parameters:

disableSheetDoubleClick - The default value is false.

setDisableSheetRightClick

public void setDisableSheetRightClick(boolean disableSheetRightClick)

Sets or retrieves a value that indicate whether right-click is disabled in current Excel sheet.

Parameters:

disableSheetRightClick - The default value is false.

setDisableSheetSelection

public void setDisableSheetSelection(boolean disableSheetSelection)

Sets or retrieves a value that indicates whether selection is disabled in worksheet.

Parameters:

disableSheetSelection - The default value is false.

toString

public java.lang.String toString(java.lang.String enc)
                          throws java.io.IOException

Gets class name.

Returns:

Name of class.

Throws:

java.io.IOException

openSheet

public Sheet openSheet(java.lang.String sheetName)
                throws java.lang.Exception,
                       java.io.IOException

Opens the specified worksheet and returns a Sheet object.

sheetName The parameter of SheetName cannot be empty, and please ensure that the worksheet specified by SheetName exists.

Parameters:

sheetName - The name of the Sheet. The name of the Sheet can be found on the Tab tag at the bottom of the worksheet.

Returns:

Returns the Sheet object.

Throws:

java.lang.Exception

java.io.IOException

See Also:

Sheet.openCell() to learn how to use openSheet method.

createSheet

public Sheet createSheet(java.lang.String newSheetName,
                         SheetInsertType insertType,
                         java.lang.String relativeSheetName)
                  throws java.lang.Exception,
                         java.io.IOException

Creates a new worksheet and returns a Sheet object.

Parameters:

newSheetName - The name of the new Sheet.

insertType - The new sheet position.

relativeSheetName - The sheet name of the relative sheet. The name can be found on the Tab at the bottom of the worksheet.

Returns:

Returns the new Sheet object.

Throws:

java.lang.Exception

java.io.IOException