Xojo Conferences
MBSSep2018MunichDE
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

XLBookMBS.available as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Whether the library is available.
Notes: Returns false on PPC targets.

Feedback, Comments & Corrections

XLBookMBS.LibVersion as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method XL MBS XL Plugin 13.2 Yes Yes Yes Yes No
Function: Returns version of library as string.
Example:
MsgBox XLBookMBS.LibVersion
Notes:
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.

Feedback, Comments & Corrections

XLBookMBS.LibVersionNumber as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method XL MBS XL Plugin 17.4 Yes Yes Yes Yes No
Function: Returns version of library as number.
Example:
MsgBox str(XLBookMBS.LibVersionNumber)
Notes: Returns for example 3 * 256*256*256 + 8 * 256*256 + 0 * 256 + 0.

Feedback, Comments & Corrections

XLBookMBS.Load2(path as folderitem) as XLBookMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method XL MBS XL Plugin 15.1 Yes Yes Yes Yes No
Function: Loads a xls-file from file.
Notes:
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:

Feedback, Comments & Corrections

XLBookMBS.Load2(path as folderitem, byref ErrorMessage as String) as XLBookMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method XL MBS XL Plugin 15.1 Yes Yes Yes Yes No
Function: Loads a xls-file from file.
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("XING contacts.xlsx")
dim e as string
dim b as XLBookMBS = XLBookMBS.Load2(f,e)

if b = nil then
MsgBox e
Return
end if

dim s as XLSheetMBS = b.Sheet(0)
MsgBox s.ReadString(1,1)
Notes:
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:

Feedback, Comments & Corrections

XLBookMBS.Load2(path as string) as XLBookMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method XL MBS XL Plugin 15.1 Yes Yes Yes Yes No
Function: Loads a xls-file from file.
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("XING contacts.xlsx")
dim b as XLBookMBS = XLBookMBS.Load2(f)

if b = nil then
MsgBox e
Return
end if

dim s as XLSheetMBS = b.Sheet(0)
MsgBox s.ReadString(1,1)
Notes:
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:

Feedback, Comments & Corrections

XLBookMBS.Load2(path as string, byref ErrorMessage as String) as XLBookMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method XL MBS XL Plugin 15.1 Yes Yes Yes Yes No
Function: Loads a xls-file from file.
Notes:
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:

Feedback, Comments & Corrections

XLBookMBS.LoadError as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method XL MBS XL Plugin 16.5 Yes Yes Yes Yes No
Function: The last error message from LoadLibrary call.
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.dylib")

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

Feedback, Comments & Corrections

XLBookMBS.LoadLibrary(File as FolderItem) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method XL MBS XL Plugin 16.5 Yes Yes Yes Yes No
Function: Loads the libXL library file.
Example:
MsgBox "Version before: "+XLBookMBS.LibVersion

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

if XLBookMBS.LoadLibrary(f) then
MsgBox "Version after: "+XLBookMBS.LibVersion
else
MsgBox XLBookMBS.LoadError
end if
Notes:
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:

Feedback, Comments & Corrections

XLBookMBS.LoadLibrary(Path as string) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method XL MBS XL Plugin 16.5 Yes Yes Yes Yes No
Function: Loads the libXL library file.
Notes:
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:

Feedback, Comments & Corrections

XLBookMBS.LoadRaw2(data as MemoryBlock) as XLBookMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method XL MBS XL Plugin 15.1 Yes Yes Yes Yes No
Function: Loads a xls-file from user's memory buffer.
Notes:
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:

Feedback, Comments & Corrections

XLBookMBS.LoadRaw2(data as MemoryBlock, byref ErrorMessage as String) as XLBookMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method XL MBS XL Plugin 15.1 Yes Yes Yes Yes No
Function: Loads a xls-file from user's memory buffer.
Notes:
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:

Feedback, Comments & Corrections

XLBookMBS.LoadRaw2(data as string) as XLBookMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method XL MBS XL Plugin 15.1 Yes Yes Yes Yes No
Function: Loads a xls-file from user's string buffer.
Notes:
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:

Feedback, Comments & Corrections

XLBookMBS.LoadRaw2(data as string, byref ErrorMessage as String) as XLBookMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method XL MBS XL Plugin 15.1 Yes Yes Yes Yes No
Function: Loads a xls-file from user's string buffer.
Notes:
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:

Feedback, Comments & Corrections

XLBookMBS.SetKeyGlobal(name as string, key as string)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
shared method XL MBS XL Plugin 12.1 Yes Yes Yes Yes No
Function: Sets customer's license key.
Example:
// 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
Notes:
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:

Feedback, Comments & Corrections

The items on this page are in the following plugins: MBS XL Plugin.




Links
MBS Xojo Chart Plugins