Methods

add(type) → Number

Adds a worksheet to the collection.

Example

var workbook = new aspose.cells.Workbook();
workbook.getWorksheets().add(aspose.cells.SheetType.CHART);
var cells = workbook.getWorksheets().get(0).getCells();
cells.get("c2").putValue(5000);
cells.get("c3").putValue(3000);
cells.get("c4").putValue(4000);
cells.get("c5").putValue(5000);
cells.get("c6").putValue(6000);
var charts = workbook.getWorksheets().get(1).getCharts();
var chartIndex = charts.add(aspose.cells.ChartType.COLUMN, 10, 10, 20, 20);
var chart = charts.get(chartIndex);
chart.getNSeries().add("Sheet1!C2:C6", true);

Parameter

Name Type Optional Description

type

Number

 

SheetType

Returns

Number Worksheet object index.

add() → Number

Adds a worksheet to the collection.

Returns

Number Worksheet object index.

add(sheetName) → Worksheet

Adds a worksheet to the collection.

Parameter

Name Type Optional Description

sheetName

String

 

Worksheet name

Returns

Worksheet Worksheet object.

add()

Reserved for internal use.

addCopy(sheetName) → Number

Adds a worksheet to the collection and copies data from an existed worksheet.

Parameter

Name Type Optional Description

sheetName

String

 

Name of source worksheet.

Returns

Number Worksheet object index.

addCopy(sheetIndex) → Number

Adds a worksheet to the collection and copies data from an existed worksheet.

Parameter

Name Type Optional Description

sheetIndex

Number

 

Index of source worksheet.

Returns

Number Worksheet object index.

clear()

Clear all worksheets. A workbook must contains a worksheet.

clearPivottables()

Clears pivot tables from the spreadsheet.

contains()

Reserved for internal use.

createRange(address, sheetIndex) → Range

Creates a Range object from an address of the range.

Parameters

Name Type Optional Description

address

String

 

The address of the range.

sheetIndex

Number

 

The sheet index.

Returns

Range A Range object

createUnionRange(address, sheetIndex) → UnionRange

Creates a Range object from an address of the range.

Parameters

Name Type Optional Description

address

String

 

The address of the range.

sheetIndex

Number

 

The sheet index.

Returns

UnionRange A Range object

get(index) → Worksheet

Gets the Worksheet element at the specified index.

Parameter

Name Type Optional Description

index

Number

 

The zero based index of the element.

Returns

Worksheet The element at the specified index.

get(sheetName) → Worksheet

Gets the Worksheet element with the specified name.

Parameter

Name Type Optional Description

sheetName

String

 

Worksheet name

Returns

Worksheet The element with the specified name.

get()

Reserved for internal use.

getActiveSheetIndex()

Represents the index of active worksheet when the spreadsheet is opened. Sheet index is zero based.

getActiveSheetName()

Represents the name of active worksheet when the spreadsheet is opened.

getBuiltInDocumentProperties()

Returns a DocumentProperty collection that represents all the built-in document properties of the spreadsheet. A new property cannot be added to built-in document properties list. You can only get a built-in property and change its value. The following is the built-in properties name list: TitleSubjectAuthorKeywordsCommentsTemplateLast AuthorRevision NumberApplication NameLast Print DateCreation DateLast Save TimeTotal Editing TimeNumber of PagesNumber of WordsNumber of CharactersSecurityCategoryFormatManagerCompanyNumber of BytesNumber of LinesNumber of ParagraphsNumber of SlidesNumber of NotesNumber of Hidden SlidesNumber of Multimedia Clips

Example

var doc = workbook.getWorksheets().getBuiltInDocumentProperties().get("Author");
doc.setValue("John Smith");

getCount()

getCustomDocumentProperties()

Returns a DocumentProperty collection that represents all the custom document properties of the spreadsheet.

Example

excel.getWorksheets().getCustomDocumentProperties().add("Checked by", "Jane");

getDxfs()

Gets the master differential formatting records.

Represents external links in a workbook.

getNamedRanges() → Array of Range

Gets all pre-defined named ranges in the spreadsheet.

Returns

Array of Range An array of Range objects. If the defined Name's reference is external or has multiple ranges, no Range object will be returned for this Name. Returns null if the named range does not exist.

getNamedRangesAndTables() → Array of Range

Gets all pre-defined named ranges in the spreadsheet.

Returns

Array of Range An array of Range objects.Returns null if the named range does not exist.

getNames()

Gets the collection of all the Name objects in the spreadsheet.

getOleSize()

Gets and Sets displayed size when Workbook file is used as an Ole object. Null means no ole size setting.

getRangeByName(rangeName) → Range

Gets Range object by pre-defined name.

Parameter

Name Type Optional Description

rangeName

String

 

Name of range.

Returns

Range Range object.Returns null if the named range does not exist.

getRangeByName(rangeName, currentSheetIndex, includeTable) → Range

Gets Range by pre-defined name or table's name

Parameters

Name Type Optional Description

rangeName

String

 

Name of range or table's name.

currentSheetIndex

Number

 

The sheet index. -1 represents global .

includeTable

boolean

 

Indicates whether checking all tables.

Returns

Range 

getRevisionLogs()

Represents revision logs.

getSheetByCodeName(codeName) → Worksheet

Gets the worksheet by the code name.

Parameter

Name Type Optional Description

codeName

String

 

Worksheet code name.

Returns

Worksheet The element with the specified code name.

getTableStyles()

Gets TableStyles object.

getThreadedCommentAuthors()

Gets the list of threaded comment authors.

getWebExtensions()

Gets the list of task panes.

getWebExtensionTaskPanes()

Gets the list of task panes.

getXmlMaps()

Gets and sets the XML maps in the workbook.

indexOf()

Reserved for internal use.

insert(index, sheetType) → Worksheet

Insert a worksheet.

Parameters

Name Type Optional Description

index

Number

 

The sheet index

sheetType

Number

 

SheetType

Returns

Worksheet Returns an inserted worksheet.

insert(index, sheetType, sheetName) → Worksheet

Insert a worksheet.

Parameters

Name Type Optional Description

index

Number

 

The sheet index

sheetType

Number

 

SheetType

sheetName

String

 

The sheet name.

Returns

Worksheet Returns an inserted worksheet.

isRefreshAllConnections()

Indicates whether refresh all connections on opening file in MS Excel.

iterator()

refreshPivotTables()

Refreshes all the PivotTables in the WorksheetCollection.

registerAddInFunction(addInFile, functionName, lib) → Number

Adds addin function into the workbook

Parameters

Name Type Optional Description

addInFile

String

 

the file contains the addin functions

functionName

String

 

the addin function name

lib

boolean

 

whether the given addin file is in the directory or sub-directory of Workbook Add-In library. This flag takes effect and makes difference when given addInFile is of relative path: true denotes the path is relative to Add-In library and false denotes the path is relative to this Workbook.

Returns

Number ID of the data which contains given addin function

registerAddInFunction(id, functionName) → String

Adds addin function into the workbook

Parameters

Name Type Optional Description

id

Number

 

ID of the data which contains addin functions, can be got by the first call of

functionName

String

 

the addin function name

Returns

String URL of the addin file which contains addin functions

removeAt(name)

Removes the element at a specified name.

Parameter

Name Type Optional Description

name

String

 

The name of the element to remove.

removeAt(index)

Removes the element at a specified index.

Parameter

Name Type Optional Description

index

Number

 

The index value of the element to remove.

setActiveSheetIndex()

Represents the index of active worksheet when the spreadsheet is opened. Sheet index is zero based.

setActiveSheetName()

Represents the name of active worksheet when the spreadsheet is opened.

setOleSize()

Gets and Sets displayed size when Workbook file is used as an Ole object. Null means no ole size setting.

setOleSize(startRow, endRow, startColumn, endColumn)

Sets displayed size when Workbook file is used as an Ole object. This method is generally used to adjust display size in ppt file or doc file.

Parameters

Name Type Optional Description

startRow

Number

 

Start row index.

endRow

Number

 

End row index.

startColumn

Number

 

Start column index.

endColumn

Number

 

End column index.

setRefreshAllConnections()

Indicates whether refresh all connections on opening file in MS Excel.

setXmlMaps()

Gets and sets the XML maps in the workbook.

sortNames()

Sorts the defined names. If you create a large amount of named ranges in the Excel file, please call this method after all named ranges are created and before saving

swapSheet(sheetIndex1, sheetIndex2)

Swaps the two sheets.

Parameters

Name Type Optional Description

sheetIndex1

Number

 

The first worksheet.

sheetIndex2

Number

 

The second worksheet.