Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
XL.Sheet.GetText
Queries the text of a sheet in a workbook.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
XL | 3.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "XL.Sheet.GetText"; bookRef; Index { ; Flags } ) More
Parameters
Parameter | Description | Example | Flags |
---|---|---|---|
bookRef | The reference to the workbook. Please use XL.LoadBook to load a file. | $ref | |
Index | The index of the sheet you want to query text. Value can be 0 to XL.Book.SheetCount-1. | $index | |
Flags | Various flags. Whether to return formulas as text. If you pass 1 here, the formulas will be returned instead of their result. Add 2 to return rich text cells as rich text instead of plain text. |
0 | Optional |
Result
Returns text of sheet.
Description
Queries the text of a sheet in a workbook.Numbers are formatted as floating point numbers with dot as decimal separator.
Boolean values are returned as FALSE or TRUE.
See also
Release notes
- Version 13.3
- Added new flag to XL.Book.GetText and XL.Sheet.GetText to return texts as rich text.
Blog Entries
This function checks for a license.
Created 18th August 2014, last changed 12nd May 2023