XL.LoadBookPartially

Loads a Excel file partially.

Parameters

Parameter	Description	Example	Flags
Data	Either text with file path or container value which contains the Excel file data.	"C:\test\test.xls"
SheetIndex	The index of the sheet to delete. This number ranges from 0 to XL.Book.SheetCount-1.	0
FirstRow	The first row index to load. Starts with 0 for first one.	0
LastRow	The last row index to load.	100
Type	Which type of file this is. Pass 0 for unknown, 1 to try xml format (xlsx) and 2 to try binary format (xls).	0	Optional
keepAllSheets	Available in MBS FileMaker Plugin 14.2 or newer. If this is true, all sheets are saved back with XL.Book.Save function, But only one specified sheet is available for processing, thus LibXL can save more memory. It works only for xlsx files, LibXL ignores this flag for xls files.	false	Optional

Result

Returns book reference number on success.

Description

Examples

Try partial loading:

# Load second sheet
Set Variable [ $bookRef ; Value: MBS( "XL.LoadBookPartially"; XL::ExcelFile; 1; 0; 100) ]
Set Field [ XL::Result ; $bookRef ]
If [ MBS("IsError") ]
    Show Custom Dialog [ "Error" ; $bookRef ]
    Exit Script [ Text Result: ]
End If
# First row
# Save to container and cleanup
Set Field [ XL::OutputFile ; MBS("XL.Save"; $bookRef; "test.xlsx") ]
Set Variable [ $r ; Value: MBS( "XL.Book.Release"; $bookRef) ]
Set Field [ XL::Result ; $r ]

See also

• IsError
• XL.Book.Release
• XL.Book.Save
• XL.Book.SheetCount
• XL.LoadBook

Release notes

• Version 14.2
  • Added keepAllSheets parameter for XL.LoadBookPartially function.
• Version 8.0
  • Added XL.LoadBookPartially function.

Blog Entries

• MBS FileMaker Plugin, version 8.0pr7

This function checks for a license.

Created 10th January 2018, last changed 10th April 2024

XL.LoadBook - XL.NewBook