XLBookMBS.available as boolean

Returns false on PPC targets.

XLBookMBS.LibVersion as string

MsgBox XLBookMBS.LibVersion

Returns for example "3.8.0".
With plugin version 17.4 or newer, this returns 4 numbers, so you may see another .0 on the end.

XLBookMBS.LibVersionNumber as Integer

MsgBox str(XLBookMBS.LibVersionNumber)

Returns for example 3 * 256*256*256 + 8 * 256*256 + 0 * 256 + 0.

XLBookMBS.Load2(path as folderitem) as XLBookMBS

Autodetects if format is old (binary) or new (xml).
Returns nil if error occurs. On success returns a valid book.
Optionally returns error with ErrorMessage parameter.

Loading a file into the book object clears existing formats, sheets and fonts from previous book. You can recreate the ones you need or search them in the existing formats, fonts or sheets.

See also:

• Load2(path as folderitem, byref ErrorMessage as String) as XLBookMBS
• Load2(path as string) as XLBookMBS
• Load2(path as string, byref ErrorMessage as String) as XLBookMBS

XLBookMBS.Load2(path as folderitem, byref ErrorMessage as String) as XLBookMBS

Var f as FolderItem = SpecialFolder.Desktop.Child("XING contacts.xlsx")
Var e as string
Var b as XLBookMBS = XLBookMBS.Load2(f,e)

if b = nil then
  MsgBox e
  Return
end if

Var s as XLSheetMBS = b.Sheet(0)
MsgBox s.ReadString(1,1)

Autodetects if format is old (binary) or new (xml).
Returns nil if error occurs. On success returns a valid book.
Optionally returns error with ErrorMessage parameter.

Loading a file into the book object clears existing formats, sheets and fonts from previous book. You can recreate the ones you need or search them in the existing formats, fonts or sheets.

See also:

• Load2(path as folderitem) as XLBookMBS
• Load2(path as string) as XLBookMBS
• Load2(path as string, byref ErrorMessage as String) as XLBookMBS

XLBookMBS.Load2(path as string) as XLBookMBS

Var f as FolderItem = SpecialFolder.Desktop.Child("XING contacts.xlsx")
Var b as XLBookMBS = XLBookMBS.Load2(f)

if b = nil then
  MsgBox e
  Return
end if

Var s as XLSheetMBS = b.Sheet(0)
MsgBox s.ReadString(1,1)

Autodetects if format is old (binary) or new (xml).
Returns nil if error occurs. On success returns a valid book.
Optionally returns error with ErrorMessage parameter.

Loading a file into the book object clears existing formats, sheets and fonts from previous book. You can recreate the ones you need or search them in the existing formats, fonts or sheets.

See also:

• Load2(path as folderitem) as XLBookMBS
• Load2(path as folderitem, byref ErrorMessage as String) as XLBookMBS
• Load2(path as string, byref ErrorMessage as String) as XLBookMBS

XLBookMBS.Load2(path as string, byref ErrorMessage as String) as XLBookMBS

Autodetects if format is old (binary) or new (xml).
Returns nil if error occurs. On success returns a valid book.
Optionally returns error with ErrorMessage parameter.

Loading a file into the book object clears existing formats, sheets and fonts from previous book. You can recreate the ones you need or search them in the existing formats, fonts or sheets.

See also:

• Load2(path as folderitem) as XLBookMBS
• Load2(path as folderitem, byref ErrorMessage as String) as XLBookMBS
• Load2(path as string) as XLBookMBS

XLBookMBS.LoadError as String

Var f as FolderItem = SpecialFolder.Desktop.Child("test.dylib")

if XLBookMBS.LoadLibrary(f) then
  MsgBox "OK"
else
  MsgBox XLBookMBS.LoadError
end if

XLBookMBS.LoadLibrary(File as FolderItem) as boolean

MsgBox "Version before: "+XLBookMBS.LibVersion

Var f as FolderItem = SpecialFolder.Desktop.Child("libxl.dylib")

if XLBookMBS.LoadLibrary(f) then
  MsgBox "Version after: "+XLBookMBS.LibVersion
else
  MsgBox XLBookMBS.LoadError
end if

Returns true on success or false on failure.

While the plugin comes with an internal libXL library, you can use this method to load a different version of the library.

See also:

• LoadLibrary(Path as string) as boolean

XLBookMBS.LoadLibrary(Path as string) as boolean

Returns true on success or false on failure.

While the plugin comes with an internal libXL library, you can use this method to load a different version of the library.

See also:

• LoadLibrary(File as FolderItem) as boolean

XLBookMBS.LoadRaw2(data as MemoryBlock) as XLBookMBS

Autodetects if format is old (binary) or new (xml).
Returns nil if error occurs. On success returns a valid book.
Optionally returns error with ErrorMessage parameter.

Loading a file into the book object clears existing formats, sheets and fonts from previous book. You can recreate the ones you need or search them in the existing formats, fonts or sheets.

See also:

• LoadRaw2(data as MemoryBlock, byref ErrorMessage as String) as XLBookMBS
• LoadRaw2(data as string) as XLBookMBS
• LoadRaw2(data as string, byref ErrorMessage as String) as XLBookMBS

XLBookMBS.LoadRaw2(data as MemoryBlock, byref ErrorMessage as String) as XLBookMBS

Autodetects if format is old (binary) or new (xml).
Returns nil if error occurs. On success returns a valid book.
Optionally returns error with ErrorMessage parameter.

Loading a file into the book object clears existing formats, sheets and fonts from previous book. You can recreate the ones you need or search them in the existing formats, fonts or sheets.

See also:

• LoadRaw2(data as MemoryBlock) as XLBookMBS
• LoadRaw2(data as string) as XLBookMBS
• LoadRaw2(data as string, byref ErrorMessage as String) as XLBookMBS

XLBookMBS.LoadRaw2(data as string) as XLBookMBS

Autodetects if format is old (binary) or new (xml).
Returns nil if error occurs. On success returns a valid book.
Optionally returns error with ErrorMessage parameter.

Loading a file into the book object clears existing formats, sheets and fonts from previous book. You can recreate the ones you need or search them in the existing formats, fonts or sheets.

See also:

• LoadRaw2(data as MemoryBlock) as XLBookMBS
• LoadRaw2(data as MemoryBlock, byref ErrorMessage as String) as XLBookMBS
• LoadRaw2(data as string, byref ErrorMessage as String) as XLBookMBS

XLBookMBS.LoadRaw2(data as string, byref ErrorMessage as String) as XLBookMBS

Autodetects if format is old (binary) or new (xml).
Returns nil if error occurs. On success returns a valid book.
Optionally returns error with ErrorMessage parameter.

Loading a file into the book object clears existing formats, sheets and fonts from previous book. You can recreate the ones you need or search them in the existing formats, fonts or sheets.

See also:

• LoadRaw2(data as MemoryBlock) as XLBookMBS
• LoadRaw2(data as MemoryBlock, byref ErrorMessage as String) as XLBookMBS
• LoadRaw2(data as string) as XLBookMBS

XLBookMBS.SetKeyGlobal(name as string, key as string)

// add this to app.open

#if TargetMacOS then
  // Mac license
  XLBookMBS.SetKeyGlobal("Your Name", "Your Key")
#elseif TargetLinux then
  // Linux license
  XLBookMBS.SetKeyGlobal("Your Name", "Your Key")
#elseif TargetWin32 then
  // Win license
  XLBookMBS.SetKeyGlobal("Your Name", "Your Key")
#else
  // missing
#endif

You can call this before using the other plugin functions to set key on application startup. Simply call it in app.open event.

If you have keys for more than one platform, please use #if condition to make sure you pass right key for current platform.

See also:

• SetKeyGlobal(name as string, key as string)

Some examples using this method:

• /XL/AutoFilter by Values
• /XL/AutoFilter Sort
• /XL/Convert
• /XL/Generate
• /XL/Invoice
• /XL/Invoice with Template for Web/Invoice with Template for Web
• /XL/Invoice with Template/Invoice with Template
• /XL/List Hyperlinks
• /XL/Performance
• /XL/Writing data