Xojo Conferences
MBSSep2018MunichDE
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

XLSheetMBS class

Type Topic Plugin Version macOS Windows Linux Console & Web iOS
class XL MBS XL Plugin 11.3 Yes Yes Yes Yes No
Function: The class for an Excel worksheet.
Notes: This is an abstract class. You can't create an instance, but you can get one from various plugin functions.

Feedback, Comments & Corrections

  • 24 properties
  • 113 methods
    • method 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)
    • method 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)
    • method 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)
    • method 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)
    • method AddHyperlink(hyperlink as string, rowFirst as Integer, rowLast as Integer, colFirst as Integer, colLast as Integer)
    • method AddIgnoredError(rowFirst as Integer, colFirst as Integer, rowLast as Integer, colLast as Integer, iError as Integer)
    • method AddrToRowCol(addr as string, byref row as Integer, byref col as Integer, byref rowRelative as boolean, byref colRelative as boolean)
    • method ApplyFilter
    • method AutoFilter as XLAutoFilterMBS
    • method CellType(row as Integer, col as Integer) as Integer
    • method Clear(rowFirst as Integer = 0, rowLast as Integer = 1048575, colFirst as Integer = 0, colLast as Integer = 16383)
    • method ClearPrintArea
    • method ClearPrintRepeats
    • method ColWidth(col as Integer) as Double
    • method Constructor
    • method CopyCell(rowSrc as Integer, colSrc as Integer, rowDst as Integer, colDst as Integer) as boolean
    • method CopyRow(dest as XLSheetMBS, SourceRow as Integer, DestRow as Integer)
    • method CopySheet(dest as XLBookMBS)
    • method CopySheet(dest as XLSheetMBS)
    • method DelHyperlink(index as Integer) as Boolean
    • method DelMerge(row as Integer, col as Integer) as boolean
    • method DelMergeByIndex(index as Integer) as Boolean
    • method DelNamedRange(name as string, scopeId as Integer = -2) as boolean
    • method FirstCol as Integer
    • method FirstRow as Integer
    • method Footer as string
    • method FooterMargin as Double
    • method GetHorPageBreak(index as Integer) as Integer
    • method GetHorPageBreakCount as Integer
    • method 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
    • method GetNamedRange(name as string, byref rowFirst as Integer, byref rowLast as Integer, byref colFirst as Integer, byref colLast as Integer) as boolean
    • method 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
    • method 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
    • method GetPrintArea(byref rowFirst as Integer, byref colFirst as Integer, byref rowLast as Integer, byref colLast as Integer) as boolean
    • method GetPrintFit(byref wPages as Integer, byref hPages as Integer) as boolean
    • method GetPrintRepeatCols(byref colFirst as Integer, byref colLast as Integer) as boolean
    • method GetPrintRepeatRows(byref rowFirst as Integer, byref rowLast as Integer) as boolean
    • method GetTopLeftView(byref row as Integer, byref col as Integer)
    • method GetVerPageBreak(index as Integer) as Integer
    • method GetVerPageBreakCount as Integer
    • method GroupCols(colFirst as Integer, colLast as Integer, collapsed as boolean = true) as boolean
    • method GroupRows(rowFirst as Integer, rowLast as Integer, collapsed as boolean = true) as boolean
    • method Header as string
    • method HeaderMargin as Double
    • method Hyperlink(index as Integer, byref rowFirst as Integer, byref rowLast as Integer, byref colFirst as Integer, byref colLast as Integer) as String
    • method HyperlinkSize as Integer
    • method InsertCol(colFirst as Integer, colLast as Integer) as boolean
    • method InsertRow(rowFirst as Integer, rowLast as Integer) as boolean
    • method IsDate(row as Integer, col as Integer) as boolean
    • method IsFormula(row as Integer, col as Integer) as boolean
    • method LastCol as Integer
    • method LastRow as Integer
    • method Merge(index as Integer, byref rowFirst as Integer, byref rowLast as Integer, byref colFirst as Integer, byref colLast as Integer) as Boolean
    • method MergeSize as Integer
    • method NamedRange(index as Integer, byref rowFirst as Integer, byref rowLast as Integer, byref ColFirst as Integer, byref ColLast as Integer) as string
    • method NamedRange(index as Integer, byref rowFirst as Integer, byref rowLast as Integer, byref ColFirst as Integer, byref ColLast as Integer, byref scopeId as Integer, byref Hidden as Boolean) as string
    • method NamedRangeCount as Integer
    • method PictureCount as Integer
    • method ReadBlank(row as Integer, col as Integer) as boolean
    • method ReadBlank(row as Integer, col as Integer, byref format as XLFormatMBS) as boolean
    • method ReadBoolean(row as Integer, col as Integer) as boolean
    • method ReadBoolean(row as Integer, col as Integer, byref format as XLFormatMBS) as boolean
    • method ReadComment(row as Integer, col as Integer) as string
    • method ReadDate(row as Integer, col as Integer) as date
    • method ReadDate(row as Integer, col as Integer, byref format as XLFormatMBS) as date
    • method ReadError(row as Integer, col as Integer) as Integer
    • method ReadFormula(row as Integer, col as Integer) as string
    • method ReadFormula(row as Integer, col as Integer, byref format as XLFormatMBS) as string
    • method ReadNumber(row as Integer, col as Integer) as Double
    • method ReadNumber(row as Integer, col as Integer, byref format as XLFormatMBS) as Double
    • method ReadString(row as Integer, col as Integer) as string
    • method ReadString(row as Integer, col as Integer, byref format as XLFormatMBS) as string
    • method RemoveCol(colFirst as Integer, colLast as Integer) as boolean
    • method RemoveComment(row as Integer, col as Integer)
    • method RemoveDataValidations
    • method RemoveFilter
    • method RemoveRow(rowFirst as Integer, rowLast as Integer) as boolean
    • method RowColToAddr(row as Integer, col as Integer, rowRelative as boolean = true, colRelative as boolean = true) as string
    • method RowHeight(row as Integer) as Double
    • method SetAutoFitArea(rowFirst as Integer = 0, colFirst as Integer = 0, rowLast as Integer = -1, colLast as Integer = -1)
    • method SetCol(colFirst as Integer, colLast as Integer, width as Double, format as XLFormatMBS = nil, hidden as boolean = false) as boolean
    • method SetFooter(footer as string, margin as Double) as boolean
    • method SetHeader(header as string, margin as Double) as boolean
    • method SetHorPageBreak(row as Integer, pageBreak as boolean = true) as boolean
    • method SetMerge(rowFirst as Integer, rowLast as Integer, colFirst as Integer, colLast as Integer) as boolean
    • method SetNamedRange(name as string, rowFirst as Integer, rowLast as Integer, colFirst as Integer, colLast as Integer, scopeId as Integer = -2) as boolean
    • method SetPicture(row as Integer, col as Integer, PictureID as Integer, scale as Double = 1.0, OffsetX as Integer = 0, OffsetY as Integer = 0, pos as Integer = 0)
    • method SetPicture(row as Integer, col as Integer, PictureID as Integer, width as Integer, height as Integer, OffsetX as Integer = 0, OffsetY as Integer = 0, pos as Integer = 0)
    • method SetPrintArea(rowFirst as Integer, rowLast as Integer, colFirst as Integer, colLast as Integer)
    • method SetPrintFit(wPages as Integer, hPages as Integer)
    • method SetPrintRepeatCols(colFirst as Integer, colLast as Integer)
    • method SetPrintRepeatRows(rowFirst as Integer, rowLast as Integer)
    • method SetProtectEx(protect as boolean = true, password as string = "", enhancedProtection as Integer = -1)
    • method SetRow(row as Integer, height as Double, format as XLFormatMBS = nil, hidden as boolean = false) as boolean
    • method SetTabColor(colorValue as Integer)
    • method SetTabRgbColor(red as Integer, green as Integer, blue as Integer)
    • method SetTopLeftView(row as Integer, col as Integer)
    • method SetVerPageBreak(row as Integer, pageBreak as boolean = true) as boolean
    • method Split(row as Integer, col as Integer)
    • method SplitInfo(byref row as Integer, byref col as Integer) as Boolean
    • method Table(index as Integer, byref rowFirst as Integer, byref rowLast as Integer, byref ColFirst as Integer, byref ColLast as Integer, byref headerRowCount as Integer, byref totalsRowCount as Integer) as string
    • method TableSize as Integer
    • method WriteBlank(row as Integer, col as Integer, format as XLFormatMBS = nil) as boolean
    • method WriteBoolean(row as Integer, col as Integer, value as boolean, format as XLFormatMBS = nil) as boolean
    • method WriteComment(row as Integer, col as Integer, value as string, author as string, width as Integer, height as Integer)
    • method WriteDate(row as Integer, col as Integer, value as date, format as XLFormatMBS = nil) as boolean
    • method WriteError(row as Integer, col as Integer, Error as Integer, format as XLFormatMBS = nil)
    • method WriteFormula(row as Integer, col as Integer, value as string, format as XLFormatMBS = nil) as boolean
    • method WriteFormulaBool(row as Integer, col as Integer, Expression as string, value as Boolean, format as XLFormatMBS = nil) as boolean
    • method WriteFormulaNum(row as Integer, col as Integer, Expression as string, value as Double, format as XLFormatMBS = nil) as boolean
    • method WriteFormulaString(row as Integer, col as Integer, Expression as string, value as String, format as XLFormatMBS = nil) as boolean
    • method WriteNumber(row as Integer, col as Integer, value as Double, format as XLFormatMBS = nil) as boolean
    • method WriteString(row as Integer, col as Integer, value as string, format as XLFormatMBS = nil) as boolean
  • 181 constants

This class has no sub classes.

Some methods using this class:

Some examples which use this class:


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


XLFormatMBS   -   XMPAssertNotifyMBS




Links
MBS Xojo PDF Plugins