XlsWorksheet module

class XlsWorksheet.XlsWorksheet

Bases: XlsWorksheetBase, IInternalWorksheet

Represents a worksheet in an Excel workbook.

This class provides properties and methods for manipulating worksheets in Excel, including cell operations, formatting, ranges, rows, columns, and other worksheet-specific functionality. It extends XlsWorksheetBase and implements the IInternalWorksheet interface.

property ActivePane: int

Gets or sets index of the active pane.

AddAllowEditRange

add a range of cells that allow editing

Parameters:
  • title – title

  • range – range

  • password – password

Type:

AddAllowEditRange

property AllocatedRange: IXLSRange
property AllocatedRangeIncludesFormatting: bool
ApplyStyle

Applies a cell style to the entire worksheet.

This method applies the specified cell style to all cells in the worksheet.

Parameters:

style (CellStyle) – The cell style to apply to the entire worksheet.

property AutoFilters: IAutoFilters
AutoFitColumn

Autofit the column width.

Parameters:

columnIndex – Column index.

Example:

#Create worksheet
workbook = Workbook()
worksheet = workbook.Worksheets[0]
#Set text
worksheet["A1"].Text = "Sample text in cell"
#Set auto fit
worksheet.AutoFitColumn(1)
#Save to file
workbook.SaveToFile("AutoFitColumn.xlsx")
AutoFitRow

Autofit the row height.

Parameters:

rowIndex – Row index

Example:

#Create worksheet
workbook = Workbook()
worksheet = workbook.Worksheets[0]
#Set text
worksheet["C2"].Value = "Sample text"
#Set Style
style = workbook.Styles.Add("CustomStyle")
font = style.Font
font.Size = 18
worksheet["C2"].Style = style
#Set auto fit
worksheet.AutoFitRow(2)
#Save to file
workbook.SaveToFile("AutoFitRow.xlsx")
CalculateAllValue()

Caculate all formula for the specified worksheet

property Cells: ListXlsRanges

Gets a collection of all cells in the worksheet.

Returns:

A collection of XlsRange objects representing all cells in the worksheet.

Return type:

ListXlsRanges

CheckExistence(row: int, column: int) bool

Indicates whether cell has been initialized.

Parameters:
  • row – Row index.

  • column – Column index.

Returns:

Value indicating whether the cell was initialized or accessed by the user.

Example:

#Create worksheet
workbook = Workbook()
worksheet = workbook.Worksheets[0]
#Set text
worksheet.Range["A1"].Text = "Hello"
#Check the cell.Output will be true.
Console.Write(worksheet.CheckExistence(1, 1))
#Save to file
workbook.SaveToFile("CheckExistence.xlsx")
Clear()

Clears data the worksheet.

ClearData()

Clears contents of a range.

ColumnWidthToPixels(widthInChars: float) int
property Columns: ListXlsRanges

Gets a collection of all columns in the worksheet.

Returns:

A collection of XlsRange objects representing all columns in the worksheet.

Return type:

ListXlsRanges

property ConditionalFormats: IConditionalFormatsCollection

Returns collection with all conditional formats in the worksheet. Read-only.

CopyToClipboard()
property Copying: bool
CreateNamedRanges(namedRange: str, referRange: str, vertical: bool)
CreateRanges(ranges: ListCellRanges) XlsRangesCollection
property DVTable: IDataValidationTable
property DefaultColumnWidth: float

Returns or sets the default width of all the columns in the worksheet. Read/write Double. Example:

#Create worksheet
workbook = Workbook()
worksheet = workbook.Worksheets[0]
#Get column width
Console.Write(worksheet.DefaultColumnWidth)
#Set default width
worksheet.DefaultColumnWidth = 40
#Save to file
workbook.SaveToFile("DefaultColumnWidth.xlsx")
property DefaultPrintRowHeight: int

Return default row height.

property DefaultRowHeight: float

Gets or sets default height of all the rows in the worksheet, in points.Read/write Double. Example:

#Create worksheet
workbook = Workbook()
worksheet = workbook.Worksheets[0]
#Get row height
Console.Write(worksheet.DefaultRowHeight)
#Set default height
worksheet.DefaultRowHeight = 40
#Save to file
workbook.SaveToFile("DefaultRowHeight.xlsx")
DeleteColumn

Deletes a column.

Parameters:

columnIndex – Column index to remove..

DeleteRange(range: CellRange, deleteOption: DeleteOption)

delete a range in worksheet

Parameters:
  • range – the range to be deleted

  • deleteOption – Choose to move the right range to left or move the below range to above

DeleteRow

Delete a row.

Parameters:

index – Row index to remove

property DisplayPageBreaks: bool

True if page breaks (both automatic and manual) on the specified worksheet are displayed.

property FirstVisibleColumn: int
property FirstVisibleRow: int
property FormulasVisible: bool
GetActiveSelectionRange() List[CellRange]

Gets the currently selected ranges in the worksheet.

Returns:

A list of CellRange objects representing the selected ranges.

Return type:

List[CellRange]

GetBoolean(row: int, column: int) bool

Gets bool value from cell.

Parameters:
  • row – Represents row index.

  • column – Represents column index.

Returns:

Returns found bool value. If cannot found returns false.

GetCaculateValue(row: int, col: int) str
GetCellType(row: int, column: int, bNeedFormulaSubType: bool) TRangeValueType

Gets cell type from current column.

Parameters:
  • row – Indicates row.

  • column – Indicates column.

  • bNeedFormulaSubType – Indicates is need to indified formula sub type.

Returns:

Returns cell type.

GetColumnIsAutoFit(columnIndex: int) bool

Get ColumnIsAutofit By columnIndex

Parameters:

columnIndex

Returns:

If the column is null Return false,else if the column width is Autofit Return true, the column width is CustomWidth Return false

GetColumnIsHide(columnIndex: int) bool

Indicates whether the column is hidden.

Parameters:

columnIndex – Column index.

GetColumnWidth(columnIndex: int) float

Gets the width of the specified column

Parameters:

columnIndex – Column index

Returns:

Width of column

GetColumnWidthPixels(columnIndex: int) int

Gets the width of the specified column, in units of pixel.

Parameters:

columnIndex – Column index.

Returns:

Width of column

Example:

#Create worksheet
workbook = Workbook()
worksheet = workbook.Worksheets[0]
#Set text
worksheet["A1"].Text = "Sample text in cell"
#Set auto fit
worksheet.AutoFitColumn(1)
#Get column width
print(worksheet.GetColumnWidthPixels(1))
#Save to file
workbook.SaveToFile("UsedRange.xlsx")
GetDefaultColumnStyle(columnIndex: int) IStyle
GetDefaultRowStyle(rowIndex: int) IStyle

Get the default row style for a given row index.

Parameters:

rowIndex (int) – The row index.

Returns:

The default style of the row.

Return type:

IStyle

GetError(row: int, column: int) str

Gets error value from cell.

Parameters:
  • row – Row index.

  • column – Column index.

Returns:

Returns error value or null.

GetFormula

Get the formula from a cell.

Parameters:
  • row (int) – Row index.

  • column (int) – Column index.

  • bR1C1 (bool) – Whether to use R1C1 notation.

Returns:

The formula string.

Return type:

str

GetFormulaBoolValue(row: int, column: int) bool

Gets formula bool value from cell.

Parameters:
  • row – Represents row index.

  • column – Represents column index.

Returns:

Returns found bool value. If cannot found returns false.

GetFormulaErrorValue(row: int, column: int) str

Gets formula error value from cell.

Parameters:
  • row – Row index.

  • column – Column index.

Returns:

Returns error value or null.

GetFormulaNumberValue(row: int, column: int) float

Returns formula number value corresponding to the cell.

Parameters:
  • row – One-based row index of the cell to get value from.

  • column – One-based column index of the cell to get value from.

Returns:

Number contained by the cell.

GetFormulaStringValue(row: int, column: int) str

Returns formula string value corresponding to the cell.

Parameters:
  • row – One-based row index of the cell to get value from.

  • column – One-based column index of the cell to get value from.

Returns:

String contained by the cell.

GetNumber(row: int, column: int) float

Returns number value corresponding to the cell.

Parameters:
  • row – One-based row index of the cell to get value from.

  • column – One-based column index of the cell to get value from.

Returns:

Number contained by the cell.

GetRowHeight(row: int) float

Gets the height of a specified row.

Parameters:

row – Row index.

Returns:

Height of row

GetRowHeightPixels(rowIndex: int) int

Gets the height of a specified row in unit of pixel.

Parameters:

rowIndex – Row index.

Returns:

Height of row

Example:

#Create worksheet
workbook = Workbook()
worksheet = workbook.Worksheets[0]
#Set text
worksheet["C2"].Text = "Sample text"
#Set auto fit
worksheet.AutoFitRow(2)
#Get row height
print(worksheet.GetRowHeightPixels(2))
#Save to file
workbook.SaveToFile("UsedRange.xlsx")
GetRowIsAutoFit(rowIndex: int) bool

Get GetRowIsAutoFit By rowIndex

Parameters:

rowIndex

Returns:

If the row is null Return false,else if the row height is Autofit Return true, the row height is CustomHeight Return false

GetRowIsHide(rowIndex: int) bool

Indicates whether the row is hidden.

Parameters:

rowIndex – Row index.

GetStringValue

Returns string value corresponding to the cell.

Parameters:

iCellIndex – Cell index to get value from.

Returns:

String contained by the cell.

GetText(row: int, column: int) str

Returns string value corresponding to the cell.

Parameters:
  • row – One-based row index of the cell to get value from.

  • column – One-based column index of the cell to get value from.

Returns:

String contained by the cell.

GetTextObject

Returns TextWithFormat object corresponding to the specified cell.

Parameters:

cellIndex – Cell index.

Returns:

Object corresponding to the specified cell.

property GridLinesVisible: bool

True if gridlines are visible; False otherwise. Example:

#Create worksheet
workbook = Workbook()
worksheet = workbook.Worksheets[0]
#Set grid line visibility
worksheet.GridLinesVisible = false
#Save to file
workbook.SaveToFile("GridLinesVisible.xlsx")
GroupByColumns(firstColumn: int, lastColumn: int, isCollapsed: bool) CellRange

Groups a range of columns in the worksheet.

Parameters:
  • firstColumn (int) – The index of the first column to be grouped.

  • lastColumn (int) – The index of the last column to be grouped.

  • isCollapsed (bool) – Indicates whether the group should be collapsed initially.

Returns:

A CellRange object representing the grouped columns.

Return type:

CellRange

GroupByRows(firstRow: int, lastRow: int, isCollapsed: bool) CellRange

Groups a range of rows in the worksheet.

Parameters:
  • firstRow (int) – The index of the first row to be grouped.

  • lastRow (int) – The index of the last row to be grouped.

  • isCollapsed (bool) – Indicates whether the group should be collapsed initially.

Returns:

A CellRange object representing the grouped rows.

Return type:

CellRange

property HPageBreaks: IHPageBreaks
HasArrayFormula(cellIndex: int) bool

Indicates whether cell contains array-entered formula.

Parameters:

cellIndex – cell index.

HasArrayFormulaRecord(row: int, column: int) bool

Indicates is has array formula.

Parameters:
  • row – Represents row index.

  • column – Represents column index.

Returns:

Indicates is contain array formula record.

property HasMergedCells: bool

Indicates whether worksheet has merged cells.

property HasOleObjects: bool

Indicats whether there is OLE object. Example:

#Create worksheet
workbook = Workbook()
worksheet = workbook.Worksheets[0]
#Create image stream
System.Drawing.image = System.Drawing.Image.FromFile("image.png")
#Add ole object
oleObject = worksheet.OleObjects.Add("Shapes.xlsx", image, OleLinkType.Embed)
#Check HasOleObject.Output will be true.</para>
Console.Write(worksheet.HasOleObjects)

                 <para>#Save to file
        workbook.SaveToFile("HasOleObjects.xlsx");
HideColumn(columnIndex: int)

Hides a column.

Parameters:

columnIndex – Column index.

HideColumns(columnIndex: int, columnCount: int)

Hides columns.

Parameters:
  • columnIndex – Column index.

  • columnCount – Column count.

HideRow(rowIndex: int)

Hides a row.

Parameters:

rowIndex – Row index.

HideRows(rowIndex: int, rowCount: int)

Hides a row.

Parameters:
  • rowIndex – Row index.

  • rowCount – Row count.

property HorizontalSplit: int
ImportCustomObjects
InsertArray

Imports an array of doubles into a worksheet.

Parameters:
  • doubleArray – Double array

  • firstRow – The row number of the first cell to import in.

  • firstColumn – The column number of the first cell to import in.

  • isVertical – Specifies to import data vertically or horizontally.

Example:

#Create worksheet
workbook = Workbook()
worksheet = workbook.Worksheets[0]
#Initialize the double Array
double[] arrayDouble = new double[4] { 344.0045, 345.0045, 346.0045, 347.0045 }
#Insert the double Array to Sheet
worksheet.InsertArray(arrayDouble, 1, 1, true)
#Save to file
workbook.SaveToFile(InsertArray.xlsx")
InsertColumn

Inserts a new column into the worksheet.

Parameters:

columnIndex – Column index

InsertCutRange(cutRange: IXLSRange, rowIndex: int, colIndex: int, moveOptions: InsertMoveOption)

Insert cut range into worksheet at specified position.

Parameters:
  • cutRange – the cut range

  • rowIndex – the dest range first row index

  • colIndex – the dest range first column index

  • moveOptions – insert options.

InsertRange(rowIndex: int, columnIndex: int, rowCount: int, columnCount: int, moveOptions: InsertMoveOption, insertOptions: InsertOptionsType) IXLSRange

Insert a cell range into worksheet

Parameters:
  • rowIndex – the cell range first row index

  • columnIndex – the cell range first column index

  • rowCount – the number of rows

  • columnCount – the number of columns

  • moveOptions – Insert options.

  • insertOptions – Move the cell on the right to right or Move the cell below down

Returns:

return the range that insert into worksheet

InsertRow

Inserts a new row into the worksheet.

Parameters:

rowIndex – Index at which new row should be inserted

IsArrayFormula
IsColumnVisible(columnIndex: int) bool

Indicates whether column is visible.

Parameters:

columnIndex – Column index.

Returns:

true - visible, otherwise false.

property IsDisplayZeros: bool

Indicates whether zero values to be displayed

property IsEmpty: bool

Indicates whether worksheet is empty. Read-only.

IsExternalFormula(row: int, column: int) bool

Indicates is formula in cell is formula to external workbook.

Parameters:
  • row – Represents row index.

  • column – Represents column index.

Returns:

If contain extern formula returns true; otherwise false.

property IsFreezePanes: bool

Indicates whether freezed panes are applied.

IsRowVisible(rowIndex: int) bool

Indicates whether row is visible.

Parameters:

rowIndex – Row index.

Returns:

true - visible, otherwise false.

property IsStringsPreserved: bool

Indicates if all values in the workbook are preserved as strings.

property ListObjects: IListObjects

Returns all list objects in the worksheet.

property MaxDisplayRange: IXLSRange
property MergedCells: ListXlsRanges
MoveWorksheet(destIndex: int)

Moves worksheet into new position.

Parameters:

destIndex – Destination index.

property Names: INameRanges

Name range used by macros to access to workbook items.

property OleObjects: IOleObjects

Gets the OLE objects. Example:

#Create worksheet
workbook = Workbook()
worksheet = workbook.Worksheets[0]
#Create image stream
System.Drawing.image = System.Drawing.Image.FromFile("image.png")
#Add ole object
oleObject = worksheet.OleObjects.Add("Shapes.xlsx", image, OleLinkType.Embed)
#Save to file
workbook.SaveToFile("OLEObjects.xlsx")
property PageSetup: IPageSetup
property PivotTables: PivotTablesCollection

Returns charts collection. Read-only.

PixelsToColumnWidth(pixels: float) float
property ProtectContents: bool

Indicates whether current sheet is protected.

property QuotedName: str

Returns quoted name of the worksheet.

property Range: XlsRange

Gets the range object representing the entire worksheet.

Returns:

A range object representing the entire worksheet.

Return type:

XlsRange

Remove()

Removes worksheet from parernt worksheets collection.

RemoveMergedCells(range: IXLSRange)
RemovePanes()

Removes panes from a worksheet.

ReparseFormula()
Replace

Replaces cells’ values with new data.

Parameters:
  • oldValue – String value to replace.

  • newValue – New value for the range with specified string.

Example:

#Create worksheet
workbook = Workbook()
workbook.LoadFromFile("Sample.xlsx")
worksheet = workbook.Worksheets[0]
#Replace the oldValue by dateTime
oldValue = "Find"
dateTime = DateTime.Now
worksheet.Replace(oldValue, dateTime)
#Save to file
workbook.SaveToFile("Replace.xlsx")
ReplaceAll
property RowColumnHeadersVisible: bool

True if row and column headers are visible. False otherwise.

property Rows: ListXlsRanges

Gets a collection of all rows in the worksheet.

Returns:

A collection of XlsRange objects representing all rows in the worksheet.

Return type:

ListXlsRanges

SaveShapesToImage(option: SaveShapeTypeOption) List[Stream]

Saves all shapes in the worksheet to images.

This method converts all shapes in the worksheet to images according to the specified options.

Parameters:

option (SaveShapeTypeOption) – The options for saving shapes as images, including format settings and other parameters.

Returns:

A list of Stream objects containing the image data for each shape.

Return type:

List[Stream]

SaveToEMFImage(FilePath: str, firstRow: int, firstColumn: int, lastRow: int, lastColumn: int, emfType: EmfType)
SaveToFile

Save worksheet to file.

Parameters:
  • fileName – File name.

  • separator – Seperator.

Example:

#Create worksheet
workbook = Workbook()
workbook.LoadFromFile("Sample.xlsx")
worksheet = workbook.Worksheets[0]
#Save to file
worksheet.SaveToFile("SaveToFile.csv" , ",")
SaveToHtml

Save to HTML stream.

Parameters:

stream – Stream object

Example:

#Create worksheet
workbook = Workbook()
workbook.LoadFromFile("Sample.xlsx")
worksheet = workbook.Worksheets[0]
#Creat stream
stream = MemoryStream()
#Save to HTML stream
worksheet.SaveToHtml(stream)
SaveToImage
SaveToPdf

Save worksheet to pdf.

Parameters:

fileName – File name.

SaveToPdfStream
SaveToStream

Save worksheet to stream.

Parameters:
  • stream – Stream object.

  • separator – Seperator.

Example:

#Create worksheet
workbook = Workbook()
workbook.LoadFromFile("Sample.xlsx")
worksheet = workbook.Worksheets[0]
#Create stream
stream = MemoryStream()
#Save to stream
worksheet.SaveToStream(stream , ",")
SaveToXps(fileName: str)

Saves specific worksheet to xps.

Parameters:

fileName – File name.

property SelectionCount: int
SetActiveCell
SetBlank(iRow: int, iColumn: int)

Sets blank in specified cell.

Parameters:
  • iRow – One-based row index of the cell to set value.

  • iColumn – One-based column index of the cell to set value.

SetBoolean(iRow: int, iColumn: int, value: bool)

Sets value in the specified cell.

Parameters:
  • iRow – One-based row index of the cell to set value.

  • iColumn – One-based column index of the cell to set value.

  • value – Value to set.

SetCaculateValue(value: SpireObject, row: int, col: int)
SetCellValue

Sets value in the specified cell.

Parameters:
  • rowIndex – Row index.

  • columnIndex – Column index.

  • boolValue – Value to set.

SetColumnWidth(columnIndex: int, width: float)

Set solumn width

Parameters:
  • columnIndex – Column index.

  • width – Width to set.

SetColumnWidthInPixels

Sets column width in pixels.

Parameters:
  • iColumn – One-based column index.

  • value – Width in pixels to set.

Example:

#Create worksheet
workbook = Workbook()
worksheet = workbook.Worksheets[0]
#Set column width
worksheet.SetColumnWidthInPixels(2, 160)
#Save to file
workbook.SaveToFile("SetColumnWidthInPixels.xlsx")
SetDefaultColumnStyle

Sets default style for column.

Parameters:
  • columnIndex – Column index.

  • defaultStyle – Default style.

SetDefaultRowStyle
SetError

Sets error in the specified cell.

Parameters:
  • iRow – One-based row index of the cell to set value.

  • iColumn – One-based column index of the cell to set value.

  • value – Error to set.

SetFirstColumn(columnIndex: int)
SetFirstRow(rowIndex: int)

Updates first row index.

Parameters:

rowIndex – Row index.

SetFormula

Sets formula in the specified cell.

Parameters:
  • iRow – One-based row index of the cell to set value.

  • iColumn – One-based column index of the cell to set value.

  • value – Formula to set.

SetFormulaBoolValue(iRow: int, iColumn: int, value: bool)

Sets formula bool value.

Parameters:
  • iRow – One based row index.

  • iColumn – One based column index.

  • value – Represents formula bool value for set.

SetFormulaErrorValue(iRow: int, iColumn: int, value: str)

Sets formula error value.

Parameters:
  • iRow – One based row index.

  • iColumn – One based column index.

  • value – Represents formula error value for set.

SetFormulaNumberValue(iRow: int, iColumn: int, value: float)

Sets formula number value.

Parameters:
  • iRow – One based row index.

  • iColumn – One based column index.

  • value – Represents formula number value for set.

SetFormulaStringValue(iRow: int, iColumn: int, value: str)

Sets formula string value.

Parameters:
  • iRow – One based row index.

  • iColumn – One based column index.

  • value – Represents formula string value for set.

SetLastColumn(columnIndex: int)

Updates last column index.

Parameters:

columnIndex – Column index.

SetLastRow(rowIndex: int)

Updates last row index.

Parameters:

rowIndex – Row index.

SetNumber(iRow: int, iColumn: int, value: float)

Sets value in the specified cell.

Parameters:
  • iRow – One-based row index of the cell to set value.

  • iColumn – One-based column index of the cell to set value.

  • value – Value to set.

SetRowHeight(rowIndex: int, height: float)

Sets the height of the specified row.

Parameters:
  • rowIndex – Row index.

  • height – Height.

SetRowHeightInPixels(rowIndex: int, count: int, value: float)

Set Row height from Start Row index

Parameters:
  • rowIndex – Row index

  • Count – count

  • value – Value

SetRowHeightPixels(rowIndex: int, height: float)

Sets the height of the specified row.

Parameters:
  • rowIndex – Row index.

  • height – Height.

Example:

#Create worksheet
workbook = Workbook()
worksheet = workbook.Worksheets[0]
#Set row height
worksheet.SetRowHeightPixels(3, 150)
#Save to file
workbook.SaveToFile("SetRowHeightPixels.xlsx")
SetText(iRow: int, iColumn: int, value: str)

Sets text in the specified cell.

Parameters:
  • iRow – One-based row index of the cell to set value.

  • iColumn – One-based column index of the cell to set value.

  • value – Text to set.

SetValue(rowIndex: int, columnIndex: int, stringValue: str)
ShowColumn(columnIndex: int)

Shows a column.

Parameters:

columnIndex – Column index.

ShowRow(rowIndex: int)
property SparklineGroups: SparklineGroupCollection
property StandardHeightFlag: bool

Gets or sets the standard (default) height option flag, which defines that standard (default) row height and book default font height do not match. Bool.

Subtotal

Creates subtotals for the specified range.

This method creates subtotals for the specified range using the given grouping field, total fields, and subtotal type.

Parameters:
  • range (IXLSRange) – The range to create subtotals for.

  • groupByIndex (int) – The zero-based index of the field to group by.

  • totalFields (List[int]) – A list of zero-based field indices indicating the fields to which the subtotals are added.

  • subtotalType (SubtotalTypes) – The type of subtotal to calculate (e.g., sum, average, count).

ToImage(firstRow: int, firstColumn: int, lastRow: int, lastColumn: int) Stream
Parameters:
  • firstRow – One-based index of the first row to convert.

  • firstColumn – One-based index of the first column to convert.

  • lastRow – One-based index of the last row to convert.

  • lastColumn – One-based index of the last column to convert.

ToSVGStream(stream: Stream, firstRow: int, firstColumn: int, lastRow: int, lastColumn: int)

Convert CellRange to Svg stream

Parameters:
  • stream – stream.

  • firstRow – One-based index of the first row to convert.

  • firstColumn – One-based index of the first column to convert.

  • lastRow – One-based index of the last row to convert.

  • lastColumn – One-based index of the last column to convert.

property TopLeftCell: CellRange

Gets top left cell of the worksheet.

property Type: ExcelSheetType
UngroupByColumns(firstColumn: int, lastColumn: int) CellRange

Ungroups a range of previously grouped columns in the worksheet.

Parameters:
  • firstColumn (int) – The index of the first column to be ungrouped.

  • lastColumn (int) – The index of the last column to be ungrouped.

Returns:

A CellRange object representing the ungrouped columns.

Return type:

CellRange

UngroupByRows(firstRow: int, lastRow: int) CellRange

Ungroups a range of previously grouped rows in the worksheet.

Parameters:
  • firstRow (int) – The index of the first row to be ungrouped.

  • lastRow (int) – The index of the last row to be ungrouped.

Returns:

A CellRange object representing the ungrouped rows.

Return type:

CellRange

property UseRangesCache: bool

Indicates whether all created range objects should be cached. Default value is true.

property VPageBreaks: IVPageBreaks
property Version: ExcelVersion

Gets or sets excel file version.

property VerticalSplit: int
property ViewMode: ViewMode

Gets or sets the view mode of the sheet.

property Zoom: int

Zoom factor of document. Example:

#Create worksheet
workbook = Workbook()
worksheet = workbook.Worksheets[0]
#Set zoom
worksheet.Zoom = 200
#Save to file
workbook.SaveToFile("Zoom.xlsx")
property ZoomScaleNormal: int

Gets or sets the zoom scale of normal view of the sheet.

property ZoomScalePageBreakView: int

Gets or sets the zoom scale of page break preview of the sheet.

property ZoomScalePageLayoutView: int

Gets or sets the zoom scale of page layout view of the sheet.

add_CellValueChanged(value: CellValueChangedEventHandler)
get_Item
remove_CellValueChanged(value: CellValueChangedEventHandler)