XlsWorksheet module
- class XlsWorksheet.XlsWorksheet
Bases:
XlsWorksheetBase,IInternalWorksheet- property ActivePane: int
- <summary>
Gets or sets index of the active pane.
</summary>
- AddAllowEditRange
- <summary>
AddAllowEditRange : add a range of cells that allow editing
</summary> <param name=”title”>title</param> <param name=”range”>range</param> <param name=”password”>password</param>
- property AllocatedRange: IXLSRange
- property AllocatedRangeIncludesFormatting: bool
- ApplyStyle
- property AutoFilters: IAutoFilters
- AutoFitColumn
- <summary>
Autofit the column width.
<example>The following code illustrates how to Auto-fit the column: <code> //Create worksheet Workbook workbook = new Workbook(); Worksheet 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”); </code> </example>
</summary> <param name=”columnIndex”>Column index.</param>
- AutoFitRow
- <summary>
Autofit the row height.
<example>The following code illustrates how to Auto-fit the row: <code> //Create worksheet Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets[0]; //Set text worksheet[“C2”].Value = “Sample text”; //Set Style CellStyle style = workbook.Styles.Add(“CustomStyle”); IFont font = style.Font; font.Size = 18; worksheet[“C2”].Style = style; //Set auto fit worksheet.AutoFitRow(2); //Save to file workbook.SaveToFile(“AutoFitRow.xlsx”); </code> </example>
</summary> <param name=”rowIndex”>Row index</param>
- CalculateAllValue()
- <summary>
Caculate all formula for the specified worksheet
</summary>
- property Cells: ListXlsRanges
- CheckExistence(row: int, column: int) bool
- <summary>
Indicates whether cell has been initialized.
<example>The following code illustrates if the cells was initialized or accessed by the user: <code> //Create worksheet Workbook workbook = new Workbook(); Worksheet 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”); </code> </example>
</summary> <param name=”row”>Row index.</param> <param name=”column”>Column index.</param> <returns>Value indicating whether the cell was initialized or accessed by the user.</returns>
- Clear()
- <summary>
Clears data the worksheet.
</summary>
- ClearData()
- <summary>
Clears contents of a range.
</summary>
- ColumnWidthToPixels(widthInChars: float) int
- property Columns: ListXlsRanges
- property ConditionalFormats: IConditionalFormatsCollection
- <summary>
Returns collection with all conditional formats in the worksheet. Read-only.
</summary>
- CopyToClipboard()
- property Copying: bool
- CreateNamedRanges(namedRange: str, referRange: str, vertical: bool)
- CreateRanges(ranges: ListCellRanges) XlsRangesCollection
- property DVTable: IDataValidationTable
- property DefaultColumnWidth: float
- <summary>
Returns or sets the default width of all the columns in the worksheet. Read/write Double.
<example>The following code illustrates how to get the default column width: <code> //Create worksheet Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets[0]; //Get column width Console.Write(worksheet.DefaultColumnWidth); //Set default width worksheet.DefaultColumnWidth = 40; //Save to file workbook.SaveToFile(“DefaultColumnWidth.xlsx”); </code> </example>
</summary>
- property DefaultPrintRowHeight: int
- <summary>
Return default row height.
</summary>
- property DefaultRowHeight: float
- <summary>
- Gets or sets default height of all the rows in the worksheet,
in points.Read/write Double.
<example>The following code illustrates how to get the default row height: <code> //Create worksheet Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets[0]; //Get row height Console.Write(worksheet.DefaultRowHeight); //Set default height worksheet.DefaultRowHeight = 40; //Save to file workbook.SaveToFile(“DefaultRowHeight.xlsx”); </code> </example>
</summary>
- DeleteColumn
- <summary>
Deletes a column.
</summary> <param name=”columnIndex”>Column index to remove..</param>
- DeleteRange(range: CellRange, deleteOption: DeleteOption)
- <summary>
delete a range in worksheet
</summary> <param name=”range”>the range to be deleted</param> <param name=”deleteOption”>Choose to move the right range to left or move the below range to above</param>
- DeleteRow
- <summary>
Delete a row.
</summary> <param name=”index”>Row index to remove</param>
- property DisplayPageBreaks: bool
- <summary>
- True if page breaks (both automatic and manual) on the specified
worksheet are displayed.
</summary>
- property FirstVisibleColumn: int
- property FirstVisibleRow: int
- property FormulasVisible: bool
- GetBoolean(row: int, column: int) bool
- <summary>
Gets bool value from cell.
</summary> <param name=”row”>Represents row index.</param> <param name=”column”>Represents column index.</param> <returns>Returns found bool value. If cannot found returns false.</returns>
- GetCaculateValue(row: int, col: int) str
- GetCellType(row: int, column: int, bNeedFormulaSubType: bool) TRangeValueType
- <summary>
Gets cell type from current column.
</summary> <param name=”row”>Indicates row.</param> <param name=”column”>Indicates column.</param> <param name=”bNeedFormulaSubType”>Indicates is need to indified formula sub type.</param> <returns>Returns cell type.</returns>
- GetColumnIsAutoFit(columnIndex: int) bool
- <summary>
Get ColumnIsAutofit By columnIndex
</summary> <param name=”columnIndex”></param> <returns>If the column is null Return false,else if the column width is Autofit Return true, the column width is CustomWidth Return false</returns>
- GetColumnIsHide(columnIndex: int) bool
- <summary>
Indicates whether the column is hidden.
</summary> <param name=”columnIndex”>Column index.</param> <returns></returns>
- GetColumnWidth(columnIndex: int) float
- <summary>
Gets the width of the specified column
</summary> <param name=”columnIndex”>Column index</param> <returns>Width of column</returns>
- GetColumnWidthPixels(columnIndex: int) int
- <summary>
Gets the width of the specified column, in units of pixel.
<example>The following code illustrates how to get the column width for a particular column: <code> //Create worksheet Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets[0]; //Set text worksheet[“A1”].Text = “Sample text in cell”; //Set auto fit worksheet.AutoFitColumn(1); //Get column width Console.WriteLine(worksheet.GetColumnWidthPixels(1)); //Save to file workbook.SaveToFile(“UsedRange.xlsx”); </code> </example>
</summary> <param name=”columnIndex”>Column index.</param> <returns>Width of column</returns>
- GetDefaultColumnStyle(columnIndex: int) IStyle
- GetDefaultRowStyle(rowIndex: int) IStyle
- GetError(row: int, column: int) str
- <summary>
Gets error value from cell.
</summary> <param name=”row”>Row index.</param> <param name=”column”>Column index.</param> <returns>Returns error value or null.</returns>
- GetFormula
- GetFormulaBoolValue(row: int, column: int) bool
- <summary>
Gets formula bool value from cell.
</summary> <param name=”row”>Represents row index.</param> <param name=”column”>Represents column index.</param> <returns>Returns found bool value. If cannot found returns false.</returns>
- GetFormulaErrorValue(row: int, column: int) str
- <summary>
Gets formula error value from cell.
</summary> <param name=”row”>Row index.</param> <param name=”column”>Column index.</param> <returns>Returns error value or null.</returns>
- GetFormulaNumberValue(row: int, column: int) float
- <summary>
Returns formula number value corresponding to the cell.
</summary> <param name=”row”>One-based row index of the cell to get value from.</param> <param name=”column”>One-based column index of the cell to get value from.</param> <returns>Number contained by the cell.</returns>
- GetFormulaStringValue(row: int, column: int) str
- <summary>
Returns formula string value corresponding to the cell.
</summary> <param name=”row”>One-based row index of the cell to get value from.</param> <param name=”column”>One-based column index of the cell to get value from.</param> <returns>String contained by the cell.</returns>
- GetNumber(row: int, column: int) float
- <summary>
Returns number value corresponding to the cell.
</summary> <param name=”row”>One-based row index of the cell to get value from.</param> <param name=”column”>One-based column index of the cell to get value from.</param> <returns>Number contained by the cell.</returns>
- GetRowHeight(row: int) float
- <summary>
Gets the height of a specified row.
</summary> <param name=”row”>Row index.</param> <returns>Height of row</returns>
- GetRowHeightPixels(rowIndex: int) int
- <summary>
Gets the height of a specified row in unit of pixel.
<example>The following code illustrates how to get the row height for a particular row: <code> //Create worksheet Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets[0]; //Set text worksheet[“C2”].Text = “Sample text”; worksheet[“C2”].Style.Font.Size = 18; //Set auto fit worksheet.AutoFitRow(2); //Get row height Console.WriteLine(worksheet.GetRowHeightPixels(2)); //Save to file workbook.SaveToFile(“UsedRange.xlsx”); </code> </example>
</summary> <param name=”rowIndex”>Row index.</param> <returns>Height of row</returns>
- GetRowIsAutoFit(rowIndex: int) bool
- <summary>
Get GetRowIsAutoFit By rowIndex
</summary> <param name=”rowIndex”></param> <returns>If the row is null Return false,else if the row height is Autofit Return true, the row height is CustomHeight Return false</returns>
- GetRowIsHide(rowIndex: int) bool
- <summary>
Indicates whether the row is hidden.
</summary> <param name=”rowIndex”>Row index.</param> <returns></returns>
- GetStringValue
- <summary>
Returns string value corresponding to the cell.
</summary> <param name=”iCellIndex”>Cell index to get value from.</param> <returns>String contained by the cell.</returns>
- GetText(row: int, column: int) str
- <summary>
Returns string value corresponding to the cell.
</summary> <param name=”row”>One-based row index of the cell to get value from.</param> <param name=”column”>One-based column index of the cell to get value from.</param> <returns>String contained by the cell.</returns>
- GetTextObject
- <summary>
Returns TextWithFormat object corresponding to the specified cell.
</summary> <param name=”cellIndex”>Cell index.</param> <returns>Object corresponding to the specified cell.</returns>
- property GridLinesVisible: bool
- <summary>
- True if gridlines are visible;
False otherwise.
<example>The following code illustrates how to set visibility for grid lines: <code> //Create worksheet Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets[0]; //Set grid line visibility worksheet.GridLinesVisible = false; //Save to file workbook.SaveToFile(“GridLinesVisible.xlsx”); </code> </example>
</summary>
- GroupByColumns(firstColumn: int, lastColumn: int, isCollapsed: bool) CellRange
- <summary>
Groups columns.
</summary> <param name=”firstColumn”>The first column index to be grouped.</param> <param name=”lastColumn”>The last column index to be grouped.</param> <param name=”isCollapsed”>Indicates whether group should be collapsed.</param> <returns></returns>
- GroupByRows(firstRow: int, lastRow: int, isCollapsed: bool) CellRange
- <summary>
Groups rows.
</summary> <param name=”firstRow”>The first row index to be grouped.</param> <param name=”lastRow”>The last row index to be grouped.</param> <param name=”isCollapsed”>Indicates whether group should be collapsed.</param> <returns></returns>
- property HPageBreaks: IHPageBreaks
- HasArrayFormula(cellIndex: int) bool
- <summary>
Indicates whether cell contains array-entered formula.
</summary> <param name=”cellIndex”>cell index.</param> <returns></returns>
- HasArrayFormulaRecord(row: int, column: int) bool
- <summary>
Indicates is has array formula.
</summary> <param name=”row”>Represents row index.</param> <param name=”column”>Represents column index.</param> <returns>Indicates is contain array formula record.</returns>
- property HasMergedCells: bool
- <summary>
Indicates whether worksheet has merged cells.
</summary>
- property HasOleObjects: bool
- <summary>
Indicats whether there is OLE object.
<example>The following code illustrates how to access the IListObjects collection in the worksheet to add a new IOleObject and check Ole Object: <code> //Create worksheet Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets[0]; //Create image stream System.Drawing.Image image = System.Drawing.Image.FromFile(“image.png”); //Add ole object IOleObject 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”); </code> </example>
</summary>
- <value>
- <c>true</c> if this instance is OLE object; otherwise, <c>false</c>.
</value>
- HideColumn(columnIndex: int)
- <summary>
Hides a column.
</summary> <param name=”columnIndex”>Column index.</param>
- HideColumns(columnIndex: int, columnCount: int)
- <summary>
Hides columns.
</summary> <param name=”columnIndex”>Column index.</param> <param name=”columnCount”>Column count.</param>
- HideRow(rowIndex: int)
- <summary>
Hides a row.
</summary> <param name=”rowIndex”>Row index.</param>
- HideRows(rowIndex: int, rowCount: int)
- <summary>
Hides a row.
</summary> <param name=”rowIndex”>Row index.</param> <param name=”rowCount”>Row count.</param>
- property HorizontalSplit: int
- property HyperLinks: IHyperLinks
- ImportCustomObjects
- InsertArray
- <summary>
Imports an array of doubles into a worksheet.
<example>The following code illustrates how to Imports an array of Double values into a worksheet with the specified row and column: <code> //Create worksheet Workbook workbook = new Workbook(); Worksheet 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”); </code> </example>
</summary> <param name=”doubleArray”>Double array</param> <param name=”firstRow”>The row number of the first cell to import in.</param> <param name=”firstColumn”>The column number of the first cell to import in.</param> <param name=”isVertical”>Specifies to import data vertically or horizontally.</param> <returns></returns>
- InsertColumn
- <summary>
Inserts a new column into the worksheet.
</summary> <param name=”columnIndex”>Column index</param>
- InsertCutRange(cutRange: IXLSRange, rowIndex: int, colIndex: int, moveOptions: InsertMoveOption)
- <summary>
Insert cut range into worksheet at specified position.
</summary> <param name=”cutRange”>the cut range</param> <param name=”rowIndex”>the dest range first row index</param> <param name=”colIndex”>the dest range first column index</param> <param name=”moveOptions”>insert options.</param>
- InsertRange(rowIndex: int, columnIndex: int, rowCount: int, columnCount: int, moveOptions: InsertMoveOption, insertOptions: InsertOptionsType) IXLSRange
- <summary>
Insert a cell range into worksheet
</summary> <param name=”rowIndex”>the cell range first row index</param> <param name=”columnIndex”>the cell range first column index</param> <param name=”rowCount”>the number of rows</param> <param name=”columnCount”>the number of columns</param> <param name=”moveOptions”>Insert options.</param> <param name=”insertOptions”>Move the cell on the right to right or Move the cell below down</param> <returns>return the range that insert into worksheet</returns>
- InsertRow
- <summary>
Inserts a new row into the worksheet.
</summary> <param name=”rowIndex”>Index at which new row should be inserted</param>
- IsArrayFormula
- IsColumnVisible(columnIndex: int) bool
- <summary>
Indicates whether column is visible.
</summary> <param name=”columnIndex”>Column index.</param> <returns>true - visible, otherwise false.</returns>
- property IsDisplayZeros: bool
- <summary>
Indicates whether zero values to be displayed
</summary>
- property IsEmpty: bool
- <summary>
Indicates whether worksheet is empty. Read-only.
</summary>
- IsExternalFormula(row: int, column: int) bool
- <summary>
Indicates is formula in cell is formula to external workbook.
</summary> <param name=”row”>Represents row index.</param> <param name=”column”>Represents column index.</param> <returns>If contain extern formula returns true; otherwise false.</returns>
- property IsFreezePanes: bool
- <summary>
Indicates whether freezed panes are applied.
</summary>
- IsRowVisible(rowIndex: int) bool
- <summary>
Indicates whether row is visible.
</summary> <param name=”rowIndex”>Row index.</param> <returns>true - visible, otherwise false.</returns>
- property IsStringsPreserved: bool
- <summary>
Indicates if all values in the workbook are preserved as strings.
</summary>
- property ListObjects: IListObjects
- <summary>
Returns all list objects in the worksheet.
</summary>
- property MaxDisplayRange: IXLSRange
- property MergedCells: ListXlsRanges
- MoveWorksheet(destIndex: int)
- <summary>
Moves worksheet into new position.
</summary> <param name=”destIndex”>Destination index.</param>
- property Names: INameRanges
- <summary>
Name range used by macros to access to workbook items.
</summary>
- property OleObjects: IOleObjects
- <summary>
Gets the OLE objects.
<example>The following code illustrates how to access the IListObjects collection in the worksheet to add a new IOleObject: <code> //Create worksheet Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets[0]; //Create image stream System.Drawing.Image image = System.Drawing.Image.FromFile(“image.png”); //Add ole object IOleObject oleObject = worksheet.OleObjects.Add(“Shapes.xlsx”, image, OleLinkType.Embed); //Save to file workbook.SaveToFile(“OLEObjects.xlsx”); </code> </example>
</summary>
<value>The OLE objects.</value>
- property PageSetup: IPageSetup
- property PivotTables: PivotTablesCollection
- <summary>
Returns charts collection. Read-only.
</summary>
- PixelsToColumnWidth(pixels: float) float
- property ProtectContents: bool
- <summary>
Indicates whether current sheet is protected.
</summary>
- property QuotedName: str
- <summary>
Returns quoted name of the worksheet.
</summary>
- property Range: XlsRange
- Remove()
- <summary>
Removes worksheet from parernt worksheets collection.
</summary>
- RemoveMergedCells(range: IXLSRange)
- RemovePanes()
- <summary>
Removes panes from a worksheet.
</summary>
- ReparseFormula()
- Replace
- <summary>
Replaces cells’ values with new data.
<example>The following code illustrates how to replace the string value with datetime: <code> //Create worksheet Workbook workbook = new Workbook(); workbook.LoadFromFile(“Sample.xlsx”); Worksheet worksheet = workbook.Worksheets[0]; //Replace the oldValue by dateTime string oldValue = “Find”; DateTime dateTime = DateTime.Now; worksheet.Replace(oldValue, dateTime); //Save to file workbook.SaveToFile(“Replace.xlsx”); </code> </example>
</summary> <param name=”oldValue”>String value to replace.</param> <param name=”newValue”>New value for the range with specified string.</param>
- <remarks>
This can be long operation (needs iteration through all cells in the worksheet). Better use named ranges instead and call Import function instead of placeholders. </remarks>
- ReplaceAll(oldValue: str, newValue: str, matchCase: bool) int
- property RowColumnHeadersVisible: bool
- <summary>
- True if row and column headers are visible.
False otherwise.
</summary>
- property Rows: ListXlsRanges
- SaveToEMFImage(FilePath: str, firstRow: int, firstColumn: int, lastRow: int, lastColumn: int, emfType: EmfType)
- SaveToFile
- <summary>
- Save worksheet to file.
<example>The following code illustrates how to saves the worksheet in a different file with separator: <code>
//Create worksheet Workbook workbook = new Workbook(); workbook.LoadFromFile(“Sample.xlsx”); Worksheet worksheet = workbook.Worksheets[0]; //Save to file worksheet.SaveToFile(“SaveToFile.csv” , “,”); </code> </example>
</summary> <param name=”fileName”>File name.</param> <param name=”separator”>Seperator.</param>
- SaveToHtml
- <summary>
- Save to HTML stream.
<example>The following code snippets illustrates how to save as html as stream: <code>
//Create worksheet Workbook workbook = new Workbook(); workbook.LoadFromFile(“Sample.xlsx”); Worksheet worksheet = workbook.Worksheets[0]; //Creat stream Stream stream = new MemoryStream(); //Save to HTML stream worksheet.SaveToHtml(stream); </code> </example>
</summary> <param name=”stream”>Stream object</param>
- SaveToImage
- SaveToPdf
- <summary>
Save worksheet to pdf.
</summary> <param name=”fileName”>File name.</param>
- SaveToPdfStream
- SaveToStream
- <summary>
- Save worksheet to stream.
<example>The following code illustrates how to saves the worksheet as stream with separator: <code>
//Create worksheet Workbook workbook = new Workbook(); workbook.LoadFromFile(“Sample.xlsx”); Worksheet worksheet = workbook.Worksheets[0]; //Create stream Stream stream = new MemoryStream(); //Save to stream worksheet.SaveToStream(stream , “,”); </code> </example>
</summary> <param name=”stream”>Stream object.</param> <param name=”separator”>Seperator.</param>
- SaveToXps(fileName: str)
- <summary>
Saves specific worksheet to xps.
</summary> <param name=”fileName”>File name.</param>
- property SelectionCount: int
- SetActiveCell
- SetBlank(iRow: int, iColumn: int)
- <summary>
Sets blank in specified cell.
</summary> <param name=”iRow”>One-based row index of the cell to set value.</param> <param name=”iColumn”>One-based column index of the cell to set value.</param>
- SetBoolean(iRow: int, iColumn: int, value: bool)
- <summary>
Sets value in the specified cell.
</summary> <param name=”iRow”>One-based row index of the cell to set value.</param> <param name=”iColumn”>One-based column index of the cell to set value.</param> <param name=”value”>Value to set.</param>
- SetCaculateValue(value: SpireObject, row: int, col: int)
- SetCellValue
- <summary>
Sets value in the specified cell.
</summary> <param name=”rowIndex”>Row index.</param> <param name=”columnIndex”>Column index.</param> <param name=”boolValue”>Value to set.</param>
- SetColumnWidth(columnIndex: int, width: float)
- <summary>
Set solumn width
</summary> <param name=”columnIndex”>Column index.</param> <param name=”width”>Width to set.</param>
- SetColumnWidthInPixels
- <summary>
Sets column width in pixels.
<example>The following code illustrates how to set width for a column: <code> //Create worksheet Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets[0]; //Set column width worksheet.SetColumnWidthInPixels(2, 160); //Save to file workbook.SaveToFile(“SetColumnWidthInPixels.xlsx”); </code> </example>
</summary> <param name=”iColumn”>One-based column index.</param> <param name=”value”>Width in pixels to set.</param>
- SetDefaultColumnStyle
- <summary>
Sets default style for column.
</summary> <param name=”columnIndex”>Column index.</param> <param name=”defaultStyle”>Default style.</param>
- SetDefaultRowStyle
- SetError
- <summary>
Sets error in the specified cell.
</summary> <param name=”iRow”>One-based row index of the cell to set value.</param> <param name=”iColumn”>One-based column index of the cell to set value.</param> <param name=”value”>Error to set.</param>
- SetFirstColumn(columnIndex: int)
- SetFirstRow(rowIndex: int)
- <summary>
Updates first row index.
</summary> <param name=”rowIndex”>Row index.</param>
- SetFormula
- <summary>
Sets formula in the specified cell.
</summary> <param name=”iRow”>One-based row index of the cell to set value.</param> <param name=”iColumn”>One-based column index of the cell to set value.</param> <param name=”value”>Formula to set.</param>
- SetFormulaBoolValue(iRow: int, iColumn: int, value: bool)
- <summary>
Sets formula bool value.
</summary> <param name=”iRow”>One based row index.</param> <param name=”iColumn”>One based column index.</param> <param name=”value”>Represents formula bool value for set.</param>
- SetFormulaErrorValue(iRow: int, iColumn: int, value: str)
- <summary>
Sets formula error value.
</summary> <param name=”iRow”>One based row index.</param> <param name=”iColumn”>One based column index.</param> <param name=”value”>Represents formula error value for set.</param>
- SetFormulaNumberValue(iRow: int, iColumn: int, value: float)
- <summary>
Sets formula number value.
</summary> <param name=”iRow”>One based row index.</param> <param name=”iColumn”>One based column index.</param> <param name=”value”>Represents formula number value for set.</param>
- SetFormulaStringValue(iRow: int, iColumn: int, value: str)
- <summary>
Sets formula string value.
</summary> <param name=”iRow”>One based row index.</param> <param name=”iColumn”>One based column index.</param> <param name=”value”>Represents formula string value for set.</param>
- SetLastColumn(columnIndex: int)
- <summary>
Updates last column index.
</summary> <param name=”columnIndex”>Column index.</param>
- SetLastRow(rowIndex: int)
- <summary>
Updates last row index.
</summary> <param name=”rowIndex”>Row index.</param>
- SetNumber(iRow: int, iColumn: int, value: float)
- <summary>
Sets value in the specified cell.
</summary> <param name=”iRow”>One-based row index of the cell to set value.</param> <param name=”iColumn”>One-based column index of the cell to set value.</param> <param name=”value”>Value to set.</param>
- SetRowHeight(rowIndex: int, height: float)
- <summary>
Sets the height of the specified row.
</summary> <param name=”rowIndex”>Row index.</param> <param name=”height”>Height.</param>
- SetRowHeightInPixels(rowIndex: int, count: int, value: float)
- <summary>
Set Row height from Start Row index
</summary> <param name=”rowIndex”>Row index</param> <param name=”Count”>count</param> <param name=”value”>Value</param>
- SetRowHeightPixels(rowIndex: int, height: float)
- <summary>
Sets the height of the specified row.
<example>The following code illustrates how to set height for a row: <code> //Create worksheet Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets[0]; //Set row height worksheet.SetRowHeightPixels(3, 150); //Save to file workbook.SaveToFile(“SetRowHeightPixels.xlsx”); </code> </example>
</summary> <param name=”rowIndex”>Row index.</param> <param name=”height”>Height.</param>
- SetText(iRow: int, iColumn: int, value: str)
- <summary>
Sets text in the specified cell.
</summary> <param name=”iRow”>One-based row index of the cell to set value.</param> <param name=”iColumn”>One-based column index of the cell to set value.</param> <param name=”value”>Text to set.</param>
- SetValue(rowIndex: int, columnIndex: int, stringValue: str)
- ShowColumn(columnIndex: int)
- <summary>
Shows a column.
</summary> <param name=”columnIndex”>Column index.</param>
- ShowRow(rowIndex: int)
- property SparklineGroups: SparklineGroupCollection
- property StandardHeightFlag: bool
- <summary>
- 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.
</summary>
- Subtotal
- <summary>
Creates subtotals for the range.
</summary> <param name=”range”>The range</param> <param name=”groupByIndex”>The field index to group by, offset from zero</param> <param name=”totalFields”>An array of zero-based field index offsets, indicating the fields to which the subtotals are added.</param> <param name=”subtotalType”>The subtotal type.</param>
- ToImage(firstRow: int, firstColumn: int, lastRow: int, lastColumn: int) Stream
- <summary></summary>
<param name=”firstRow”>One-based index of the first row to convert.</param> <param name=”firstColumn”>One-based index of the first column to convert.</param> <param name=”lastRow”>One-based index of the last row to convert.</param> <param name=”lastColumn”>One-based index of the last column to convert.</param>
- ToSVGStream(stream: Stream, firstRow: int, firstColumn: int, lastRow: int, lastColumn: int)
- <summary>
Convert CellRange to Svg stream
</summary> <param name=”stream”>stream.</param> <param name=”firstRow”>One-based index of the first row to convert.</param> <param name=”firstColumn”>One-based index of the first column to convert.</param> <param name=”lastRow”>One-based index of the last row to convert.</param> <param name=”lastColumn”>One-based index of the last column to convert.</param>
- property TopLeftCell: CellRange
- <summary>
Gets top left cell of the worksheet.
</summary> <returns></returns>
- property Type: ExcelSheetType
- UngroupByColumns(firstColumn: int, lastColumn: int) CellRange
- <summary>
Ungroups columns.
</summary> <param name=”firstColumn”>The first column index to be grouped.</param> <param name=”lastColumn”>The last column index to be grouped.</param> <returns></returns>
- UngroupByRows(firstRow: int, lastRow: int) CellRange
- <summary>
Ungroups rows.
</summary> <param name=”firstRow”>The first row index to be grouped.</param> <param name=”lastRow”>The last row index to be grouped.</param> <returns></returns>
- property UseRangesCache: bool
- <summary>
Indicates whether all created range objects should be cached. Default value is true.
</summary>
- property VPageBreaks: IVPageBreaks
- property Version: ExcelVersion
- <summary>
Gets or sets excel file version.
</summary>
- property VerticalSplit: int
- property ViewMode: ViewMode
- <summary>
Gets or sets the view mode of the sheet.
</summary>
<value></value>
- property Zoom: int
- <summary>
Zoom factor of document.
<example>The following code illustrates how to set zoom level of the sheet: <code> //Create worksheet Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets[0]; //Set zoom worksheet.Zoom = 200; //Save to file workbook.SaveToFile(“Zoom.xlsx”); </code> </example>
</summary>
<remarks> Value of zoom should be between 10 and 400.</remarks>
- property ZoomScaleNormal: int
- <summary>
Gets or sets the zoom scale of normal view of the sheet.
</summary>
<value></value>
- property ZoomScalePageBreakView: int
- <summary>
Gets or sets the zoom scale of page break preview of the sheet.
</summary>
<value></value>
- property ZoomScalePageLayoutView: int
- <summary>
Gets or sets the zoom scale of page layout view of the sheet.
</summary>
<value></value>
- add_CellValueChanged(value: CellValueChangedEventHandler)
- get_Item
- remove_CellValueChanged(value: CellValueChangedEventHandler)