Please enable JavaScript to view this site.

A-Shell Reference

These functions all return or require a handle to an instance of the Sheet class. Those whose name contains “LibXL’Sheet” expect the sheet handle as the first parameter, but it can be ignored (in order to use the current default sheet) if you name all of the other parameters. Those whose name does not contain “LibXL’Sheet” move the optional sheet handle to the end of the parameter list, making it easier to omit (without requiring naming of all the other parameters).

Function / Procedure

Description

Fn'LibXL'SheetGetName$

Return name of sheet by index #

LibXL'SheetSetName

Set sheet name

Fn'LibXL'SheetGetFirstRow

Return first non-blank row index

Fn'LibXL'SheetGetLastRow

Return last non-blank row index

Fn'LibXL'SheetGetFirstCol

Return first non-blank column index

Fn'LibXL'SheetGetLastCol

Return last non-blank column index

Fn'LibXL'SheetGetCellType

Return cell type (CELLTYPE_xxx) of cell

Fn'LibXL'SheetIsFormula

Return TRUE if cell contains a formula

Fn'LibXL'SheetIsDate

Return TRUE if cell contains a date

Fn'LibXL'SheetGetCellFormat

Return handle to format instance for cell

LibXL'SheetSetCellFormat

Set format of cell

Fn'LibXL'SheetWrite

Generic cell write (based on type of value passed)

Fn'LibXL'Write

Variation of SheetWrite which assumes current sheet

Fn'LibXL'SheetWriteNum

Write numeric value to cell

Fn'LibXL'SheetWriteFormula

Write formula to cell

Fn'LibXL'WriteFormula

Variation of SheetWriteFormula which assumes current sheet

Fn'LibXL'SheetWriteComment

Write comment to cell

Fn'LibXL'SheetReadComment$

Read comment from cell

Fn'LibXL'SheetReadValue$

Read value from specified sheet, cell

Fn'LibXL'ReadValue$

Variation of SheetReadValue$ which assumes current sheet

Fn'LibXL'SheetReadStr$

Read string contents from specified sheet, cell

Fn'LibXL'SheetReadNum

Read numeric contents from specified sheet, cell

Fn'LibXL'SheetReadFormula$

Read formula from specified sheet, cell

Fn'LibXL'SheetReadBlank

Read blank from specified sheet, cell

Fn'LibXL'SheetReadBool

Read Boolean from specified sheet, cell

Fn'LibXL'SheetSetCol

Set attributes for specified sheet, column

Fn'LibXL'SheetGetColWidth

Get width of specified sheet, column

Fn'LibXL'SheetGetRowHeight

Get row height of specified sheet, row

Fn'LibXL'SheetSetRow

Set row attributes

Fn'LibXL'SheetSetPicture

Set picture on specified sheet, cell

Fn'LibXL'SheetGetPicture

Get picture from specified sheet, cell

Fn'LibXL'SheetSetProtect

Protect sheet

Fn'LibXL'SheetGetProtect

Return TRUE if sheet is protected

Fn'LibXL'SheetGetHidden

Get hidden attribute from specified sheet

LibXL'SheetSetHidden

Hide sheet

Fn'LibXL'SheetGetMergeCount

Return number of merged cells on sheet

Fn'LibXL'SheetGetMergeIdx

Get merged cells by index

Fn’LibXL’SheetGetMergeXY

Get merged cells at row, col

Fn'LibXL'SheetSetMerge

Merge specified cells

Fn'LibXL'SheetDelMergeXY

Remove specified cell merge at row,col

Fn'LibXL'SheetDelMergeIdx

Remove cell merge by index

LibXL'SheetSetDisplayGridlines

Set gridlines display option

Fn'LibXL'SheetGetDisplayGridlines

Get gridlines display option

LibXL'SheetSetPrintGridlines

Set gridlines print option

Fn'LibXL'SheetGetPrintGridlines

Get gridlines print option

Fn'LibXL'SheetGroupRows

Group rows

Fn'LibXL'SheetGroupCols

Group columns

Fn'LibXL'SheetGetSplitInfo

Get vertical and horizontal split locations

LibXL'SheetSetSplit

Set vertical and horizontal split locations

Fn'LibXL'SheetCopyCell

Copy a cell (data and format) to another cell on same sheet

Fn'LibXL'SheetGetHyperlinkCount

Return # of hyperlinks on sheet

Fn'LibXL'SheetGetHyperlink$

Get hyperlink info by index

LibXL'SheetAddHyperlink

Add hyperlink

LibXL'SheetAddrToRowCol

Convert A1 or $A$1 type address to row,col

Fn'LibXL'SheetRowColToAddr$

Convert row,col to A1 or $A$1 type address

 

 

Printing-Related routines

 

LibXL'SetLandscape

Set orientation for printing (TRUE=landscape, FALSE=portrait)

Fn'LibXL'GetLandscape

Get orientation for printing

LibXL'SetPrintFit

Fit sheet to x pages wide by y pages high

Fn'LibXL'GetPrintFit

Get fit info

Fn'LibXL'SetHeader

Set header and margin

Fn'LibXL'GetHeader$

Get header and margin

Fn'LibXL'SetFooter

Set footer and margin

Fn'LibXL'GetFooter$

Get footer and margin