Platforms to show: All Mac Windows Linux Cross-Platform

Back to XLSheetMBS class.

Next items

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
Function: Adds a data validation for the specified range (only for xlsx files).
Notes:
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
Function: Adds a data validation for the specified range (only for xlsx files).
Notes:
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.AddDataValidationDouble(type as Integer, op as integer, rowFirst as integer, colFirst as integer, rowLast as integer, colLast as integer, value1 as Double, value2 as Double)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 17.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Adds a data validation for the specified range with double or date values for the relational operator (only for xlsx files).
Notes: See parameters in the addDataValidation() method.

See also:

XLSheetMBS.AddDataValidationDouble(type as Integer, op as integer, rowFirst as integer, colFirst as integer, rowLast as integer, colLast as integer, value1 as Double, value2 as Double, 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
Function: Adds a data validation for the specified range with double or date values for the relational operator (only for xlsx files).
Notes: See parameters in the addDataValidation() method.

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
Function: 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
Function: Adds the ignored error for specified range.
Notes:
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
Function: Converts a cell reference to row and column.
Example: 
// create new xls file
dim book as new XLBookMBS(false)

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

dim row, col as Integer
dim 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
Function: Adds a range to the selection.
XLSheetMBS.ApplyFilter
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 16.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Applies the AutoFilter to the sheet.

Some examples using this method:

XLSheetMBS.CellFormat(row as Integer, col as Integer) as XLFormatMBS
Type Topic Plugin Version macOS Windows Linux iOS Targets
property XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: The cell's format.
Notes: (Read and Write computed property)
XLSheetMBS.CellType(row as Integer, col as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Returns cell's type.
Notes: See CellType constants.

Some examples using this method:

XLSheetMBS.Clear(rowFirst as Integer = 0, rowLast as Integer = 1048575, colFirst as Integer = 0, colLast as Integer = 16383) as Boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Clears cells in specified area.
XLSheetMBS.ClearPrintArea
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Clears the print area.
XLSheetMBS.ClearPrintRepeats
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Clears repeated rows and columns on each page.
XLSheetMBS.ColHidden(col as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
property XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Whether column is hidden.
Notes: (Read and Write computed property)
XLSheetMBS.ColWidth(col as Integer) as Double
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Returns column width.
XLSheetMBS.ColWidthPx(col as integer) as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 20.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Returns column width in pixels.
XLSheetMBS.Constructor   Private
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: The private constructor.
XLSheetMBS.CopyCell(rowSrc as Integer, colSrc as Integer, rowDst as Integer, colDst as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Copies cell with format from (rowSrc, colSrc) to (rowDst, colDst).
Notes: Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
XLSheetMBS.CopyCellValue(dest as XLSheetMBS, SourceRow as Integer, DestRow as Integer, SourceColumn as Integer, DestColumn as Integer, Options as XLCopyOptionsMBS = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 21.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Copies a cell from one sheet to another.
Notes:
Source and destination sheets can be in different books.
This copies most properties and all cells.
If something is missing, please let us know.

If options is nil, we copy everything.

If source and dest sheet are the same, does same as CopyCell function.
XLSheetMBS.CopyColumn(dest as XLSheetMBS, SourceColumn as Integer, DestColumn as Integer, Options as XLCopyOptionsMBS = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 20.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Copies a column from one sheet to another.
Notes:
Sheets can be in different books.
This copies most properties and all cells.
If something is missing, please let us know.

If options is nil, we copy everything.
XLSheetMBS.CopyRow(dest as XLSheetMBS, SourceRow as Integer, DestRow as Integer, Options as XLCopyOptionsMBS = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 16.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Copies a row from one sheet to another.
Notes:
Sheets can be in different books.
This copies most properties and all cells.
If something is missing, please let us know.

If options is nil, we copy everything.
XLSheetMBS.CopySheet(dest as XLBookMBS, Options as XLCopyOptionsMBS = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 16.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Copies a sheet to the other book.
Notes:
This copies most properties and all cells.
If something is missing, please let us know.

If options is nil, we copy everything.

See also:

XLSheetMBS.CopySheet(dest as XLSheetMBS, Options as XLCopyOptionsMBS = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 16.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Copies the sheet content to the other sheet.
Notes:
This copies most properties and all cells.
If something is missing, please let us know.

If options is nil, we copy everything.

See also:

XLSheetMBS.DelHyperlink(index as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 14.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Removes hyperlink by index.
Notes: Index: The index from 0 to HyperlinkSize.
XLSheetMBS.DelMerge(row as Integer, col as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Removes merged cells.
Notes: Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.
XLSheetMBS.DelMergeByIndex(index as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 14.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Removes merged cells by index.
Notes: Index: From 0 to MergeSize-1.
XLSheetMBS.DelNamedRange(name as string, scopeId as Integer = -2) as boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 14.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Deletes the named range by name.
Notes:
Returns false if error occurs. Get error info with XLBookMBS.errorMessage().
scopeId - index of sheet for local named range or ScopeWorkbook for global named range.
XLSheetMBS.FormControl(index as integer) as XLFormControlMBS
Type Topic Plugin Version macOS Windows Linux iOS Targets
method XL MBS XL Plugin 21.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Returns a form control with the specified index.
Notes:
The index must be less than the return value of the FormControlCount property.
This allows you to batch pre-fill form fields in an Excel document.
You may need Excel to create the template with the form fields.

Next 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...


Start Chat