Platforms to show: All Mac Windows Linux Cross-Platform

Back to XLBookMBS class.

Previous items

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

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 18.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Private method to avoid you call this on an object.

Please call shared method in app.open.
Because if you make a new object and set key, it's too late.

See also:

XLBookMBS.SetLocale(locale as string)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the locale.
Example
dim book as new XLBookMBS(false)
book.SetLocale "en_US.UTF-8"

Sets the locale for this library. It has no effect for unicode projects.

XLBookMBS.Sheet(index as Integer) as XLSheetMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Gets the sheet with specified index.

Returns nil if error occurs. Get error info with XLBookMBS.ErrorMessage property.

XLBookMBS.SheetCount as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns a number of sheets in this book.

Some examples using this method:

XLBookMBS.Sheets as XLSheetMBS()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Returns array with all sheets.
Example
Function SheetByName(book as XLBookMBS, name as string) As XLSheetMBS
dim sheets() as XLSheetMBS = book.Sheets
for each s as XLSheetMBS in sheets
if s.Name = name then
Return s
end if
next
End Function

Some examples using this method:

XLBookMBS.SheetType(index as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 13.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries type of the sheet.

XLBookMBS.UnpackColor(ColorValue as Integer) as color

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Unpacks color type to red, green and blue components.

See also:

XLBookMBS.UnpackColor(ColorValue as Integer, byref red as Integer, byref green as Integer, byref blue as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Unpacks color type to red, green and blue components.

See also:

XLBookMBS.UnpackDateTime(Value as double) as dateTime

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 20.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Unpacks date and time information from double type.

Returns nil if error occurs.

Previous items

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


💬 Ask a question or report a problem
The biggest plugin in space...