Xojo Conferences
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

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 Console & Web iOS
method XL MBS XL Plugin 17.2 Yes Yes Yes Yes No
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:

Feedback, Comments & Corrections

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 Console & Web iOS
method XL MBS XL Plugin 17.2 Yes Yes Yes Yes No
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:

Feedback, Comments & Corrections

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 Console & Web iOS
method XL MBS XL Plugin 17.2 Yes Yes Yes Yes No
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:

Feedback, Comments & Corrections

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 Console & Web iOS
method XL MBS XL Plugin 17.2 Yes Yes Yes Yes No
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:

Feedback, Comments & Corrections

XLSheetMBS.AddHyperlink(hyperlink as string, rowFirst as Integer, rowLast as Integer, colFirst as Integer, colLast as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 14.3 Yes Yes Yes Yes No
Function: Adds the new hyperlink.

Feedback, Comments & Corrections

XLSheetMBS.AddIgnoredError(rowFirst as Integer, colFirst as Integer, rowLast as Integer, colLast as Integer, iError as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 16.5 Yes Yes Yes Yes No
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.

Feedback, Comments & Corrections

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 Console & Web iOS
method XL MBS XL Plugin 12.2 Yes Yes Yes Yes No
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

Feedback, Comments & Corrections

XLSheetMBS.ApplyFilter
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 16.5 Yes Yes Yes Yes No
Function: Applies the AutoFilter to the sheet.

Feedback, Comments & Corrections

XLSheetMBS.CellFormat(row as Integer, col as Integer) as XLFormatMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: The cell's format.
Notes: (Read and Write computed property)

Feedback, Comments & Corrections

XLSheetMBS.CellType(row as Integer, col as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Returns cell's type.
Notes: See CellType constants.

Feedback, Comments & Corrections

XLSheetMBS.Clear(rowFirst as Integer = 0, rowLast as Integer = 1048575, colFirst as Integer = 0, colLast as Integer = 16383)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Clears cells in specified area.

Feedback, Comments & Corrections

XLSheetMBS.ClearPrintArea
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Clears the print area.

Feedback, Comments & Corrections

XLSheetMBS.ClearPrintRepeats
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Clears repeated rows and columns on each page.

Feedback, Comments & Corrections

XLSheetMBS.ColHidden(col as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Whether column is hidden.
Notes: (Read and Write computed property)

Feedback, Comments & Corrections

XLSheetMBS.ColWidth(col as Integer) as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Returns column width.

Feedback, Comments & Corrections

XLSheetMBS.Constructor
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: The private constructor.

Feedback, Comments & Corrections

XLSheetMBS.CopyCell(rowSrc as Integer, colSrc as Integer, rowDst as Integer, colDst as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Copies cell with format from (rowSrc, colSrc) to (rowDst, colDst).
Notes: Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.

Feedback, Comments & Corrections

XLSheetMBS.CopyRow(dest as XLSheetMBS, SourceRow as Integer, DestRow as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 16.5 Yes Yes Yes Yes No
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.

Feedback, Comments & Corrections

XLSheetMBS.CopySheet(dest as XLBookMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 16.5 Yes Yes Yes Yes No
Function: Copies a sheet to the other book.
Notes:
This copies most properties and all cells.
If something is missing, please let us know.

See also:

Feedback, Comments & Corrections

XLSheetMBS.CopySheet(dest as XLSheetMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 16.5 Yes Yes Yes Yes No
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.

See also:

Feedback, Comments & Corrections

XLSheetMBS.DelHyperlink(index as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 14.3 Yes Yes Yes Yes No
Function: Removes hyperlink by index.
Notes: Index: The index from 0 to HyperlinkSize.

Feedback, Comments & Corrections

XLSheetMBS.DelMerge(row as Integer, col as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Removes merged cells.
Notes: Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.

Feedback, Comments & Corrections

XLSheetMBS.DelMergeByIndex(index as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 14.3 Yes Yes Yes Yes No
Function: Removes merged cells by index.
Notes: Index: From 0 to MergeSize-1.

Feedback, Comments & Corrections

XLSheetMBS.DelNamedRange(name as string, scopeId as Integer = -2) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 14.0 Yes Yes Yes Yes No
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.

Feedback, Comments & Corrections

XLSheetMBS.GetHorPageBreak(index as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Returns row with horizontal page break at position index.

Feedback, Comments & Corrections

XLSheetMBS.GetMerge(row as Integer, col as Integer, byref rowFirst as Integer, byref rowLast as Integer, byref colFirst as Integer, byref colLast as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Gets merged cells for cell at row, col.
Notes:
Result is written in rowFirst, rowLast, colFirst, colLast.
Returns false if error occurs. Get error info with XLBookMBS.ErrorMessage property.

Feedback, Comments & Corrections

XLSheetMBS.GetNamedRange(name as string, byref rowFirst as Integer, byref rowLast as Integer, byref colFirst as Integer, byref colLast as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Gets the named range coordianates by name.
Notes: Returns false if specified named range isn't found or error occurs. Get error info with XLBookMBS.ErrorMessage property.

See also:

Feedback, Comments & Corrections

XLSheetMBS.GetNamedRange(name as string, byref rowFirst as Integer, byref rowLast as Integer, byref colFirst as Integer, byref colLast as Integer, ScopeID as Integer, byref Hidden as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 14.0 Yes Yes Yes Yes No
Function: Gets the named range coordianates by name.
Notes:
scopeId - index of sheet for local named range or SCOPE_WORKBOOK for global named range.
hidden - true if named range is hidden and false if isn't.
Returns false if specified named range isn't found or error occurs. Get error info with XLBookMBS.errorMessage.

See also:

Feedback, Comments & Corrections

XLSheetMBS.GetPicture(index as Integer, byref rowTop as Integer, byref colLeft as Integer, byref rowBottom as Integer, byref colRight as Integer, byref width as Integer, byref height as Integer, byref offsetX as Integer, byref offsetY as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: Returns a workbook picture index at position index in worksheet.
Notes:
Output parameters:
(rowTop, colLeft) - top left position of picture;
(rowBottom, colRight) - bottom right position of picture;
width - width of picture in pixels;
height - height of picture in pixels;
offset_x - horizontal offset of picture in pixels;
offset_y - vertical offset of picture in pixels.

Use XLBookMBS.getPicture() for extracting binary data of picture by workbook picture index.
Returns -1 if error occurs. Get error info with XLBookMBS.ErrorMessage property.

Feedback, Comments & Corrections

Next items

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




Links
MBS Xojo tutorial videos