Platforms to show: All Mac Windows Linux Cross-Platform

Back to XLSheetMBS class.

XLSheetMBS.AddConditionalFormatting as XLConditionalFormattingMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 24.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds a conditional formatting rules to the sheet.

Only for xlsx files.
Requires LibXL in version 4.x

Some examples using this method:

XLSheetMBS.AddDataValidation(type as Integer, op as integer, rowFirst as integer, colFirst as integer, rowLast as integer, colLast as integer, value1 as String, value2 as String)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 17.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds a data validation for the specified range (only for xlsx files).

type: the type of data validation.
op: the relational operator of data validation.
rowFirst: the first row of range;
rowLast: the last row of range;
colFirst: the first column of range;
colLast: the last column of range;
value1: the first value for relational operator;
value2: the second value for ValidationOpBetween or ValidationOpNotBetween operator;

See also:

XLSheetMBS.AddDataValidation(type as Integer, op as integer, rowFirst as integer, colFirst as integer, rowLast as integer, colLast as integer, value1 as String, value2 as String, allowBlank as Boolean, hideDropDown as Boolean = false, showInputMessage as Boolean = true, showErrorMessage as Boolean = true, promptTitle as String = "", prompt as String = "", errorTitle as string = "", error as string = "", errorStyle as integer = 0)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 17.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds a data validation for the specified range (only for xlsx files).

type: the type of data validation.
op: the relational operator of data validation.
rowFirst: the first row of range;
rowLast: the last row of range;
colFirst: the first column of range;
colLast: the last column of range;
value1: the first value for relational operator;
value2: the second value for ValidationOpBetween or ValidationOpNotBetween operator;
allowBlank: a boolean value indicating whether the data validation treats empty or blank entries as valid, 'true' means empty entries are OK and do not violate the validation constraints;
hideDropDown: a boolean value indicating whether to display the dropdown combo box for a list type data validation (ValidationTypeList);
showInputMessage: a boolean value indicating whether to display the input prompt message;
showErrorMessage: a boolean value indicating whether to display the error alert message when an invalid value has been entered, according to the criteria specified;
promptTitle: title bar text of input prompt;
prompt: message text of input prompt;
errorTitle: title bar text of error alert;
error: message text of error alert;
errorStyle: the style of error alert used for this data validation:

See also:

XLSheetMBS.AddHyperlink(hyperlink as string, rowFirst as Integer, rowLast as Integer, colFirst as Integer, colLast as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 14.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds the new hyperlink.

XLSheetMBS.AddIgnoredError(rowFirst as Integer, colFirst as Integer, rowLast as Integer, colLast as Integer, iError as Integer) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 16.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds the ignored error for specified range.

It allows to hide green triangles on left sides of cells. For example, if a cell is formatted as text but contains a numeric value, this is considered to be a potential error because the number won't be treated as a number, for example, in calculations. It is possible to combine a few IgnoredError values with operator |.

Returns false if error occurs. Get error info with XLBookMBS.errorMessage.

XLSheetMBS.AddrToRowCol(addr as string, byref row as Integer, byref col as Integer, byref rowRelative as boolean, byref colRelative as boolean)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 12.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Converts a cell reference to row and column.
Example
// create new xls file
Var book as new XLBookMBS(false)

// create sheet
Var sheet as XLSheetMBS = book.AddSheet("Sheet1")

Var row, col as Integer
Var rowRelative, colRelative as boolean

sheet.AddrToRowCol("F7", row, col, rowRelative, colRelative)
MsgBox str(row)+" "+str(col) // shows 6 5

XLSheetMBS.AddSelectionRange(sqref as string)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 23.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds a range to the selection.

XLSheetMBS.AddTable(Name as String, rowFirst as Integer, rowLast as Integer, colFirst as Integer, colLast as Integer, hasHeaders as Boolean, tableStyle as Integer) as XLTableMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 25.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds a table to the sheet with the specified name, range and style.

Only for xlsx files.

name - the name of the table;
rowFirst - the first row of the table;
rowLast - the last row of the table;
rowLast - the last row of the table;
colFirst - the first column of the table;
colLast - the last column of the table;
hasHeaders - does the specified range include headers or not;
tableStyle - the table style.

See the style table here to see what constant name has what look:
https://www.libxl.com/table.html

Returns the table if successed, nil if failed.

XLSheetMBS.ApplyFilter

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 16.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Applies the AutoFilter to the sheet.

See also:

Some examples using this method:

XLSheetMBS.ApplyFilter(AutoFilter as XLAutoFilterMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 25.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Applies only the specified AutoFilter to the sheet.

Only for xlsx files.

See also:

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


The biggest plugin in space...