Click or drag to resize

XlsWorksheet Class

Represents a worksheet. The Worksheet object is a member of the Worksheets collection. The Worksheets collection contains all the Worksheet objects in a workbook.
Inheritance Hierarchy

Namespace: Spire.Xls.Core.Spreadsheet
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
public class XlsWorksheet : XlsWorksheetBase, 
	IWorksheet, ITabSheet, IExcelApplication, INamedObject, ICloneParent, 
	IInternalWorksheet

The XlsWorksheet type exposes the following members.

Properties
Name Description
Public property ActivePane
Gets or sets index of the active pane.
Public property ActiveSelectionRange
Get active selection range.
Public property AllocatedRange
Read-only. Returns a Range object that represents a cell or a range of cells.
Public property AllocatedRangeIncludesFormatting
There are two different algorithms to create UsedRange object: 1) Default. This property = true. The cell is included into UsedRange when it has some record created for it even if data is empty (maybe some formatting changed, maybe not - cell was accessed and record was created). 2) This property = false. In this case XlsIO tries to remove empty rows and columns from all sides to make UsedRange smaller.
Public property ArcShapes
Gets the collection of arc shapes in the worksheet.
(Inherited from XlsWorksheetBase .)
Public property AutoFilters
Returns collection of worksheet's autofilters. Read-only.
Public property ButtonShapes
Gets the collection of button shapes in the worksheet.
(Inherited from XlsWorksheetBase .)
Public property CellImages
Cell image array. Read-only.
(Inherited from XlsWorksheetBase .)
Public property CellList
Returns all used cells in the worksheet. Read-only.
Public property Cells Obsolete.
Returns all used cells in the worksheet. Read-only.
Public property Charts
Returns charts collection. Read-only.
(Inherited from XlsWorksheetBase .)
Public property CheckBoxes
Returns inner checkboxes collection. Read-only.
(Inherited from XlsWorksheetBase .)
Public property CodeName
Name used by macros to access workbook items.
(Inherited from XlsWorksheetBase .)
Public property Columns
For a Worksheet object, returns an array of Range objects that represents all used columns on the specified worksheet. Read-only Range object.
Public property ComboBoxes
Returns collection with all comboboxes inside this worksheet. Read-only.
(Inherited from XlsWorksheetBase .)
Public property Comments
Returns comments collection for this worksheet. Read-only.
(Inherited from XlsWorksheetBase .)
Public property ConditionalFormats
Returns collection with all conditional formats in the worksheet. Read-only.
Public property Copying
Gets or sets a value indicating whether a copy operation is currently in progress.
Public property CustomProperties
Returns collection with all custom properties in the worksheet. Read-only.
Public property Code example DefaultColumnWidth
Returns or sets the defaultwidth of all the columns in the worksheet. Read/write Double.
Examples
The following code illustrates how to get the default column width:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Get column width</para><para>Console.Write(worksheet.DefaultColumnWidth);</para><para>//Set default width</para><para>worksheet.DefaultColumnWidth = 40;</para><para>//Save to file</para><para>workbook.SaveToFile("DefaultColumnWidth.xlsx");</para>
Public property DefaultGridlineColor
Indicates whether gridline color has default value.
(Inherited from XlsWorksheetBase .)
Public property DefaultPrintRowHeight
Return default row height.
Public property Code example DefaultRowHeight
Gets or sets default height of all the rows in the worksheet, in points.Read/write Double.
Examples
The following code illustrates how to get the default row height:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Get row height</para><para>Console.Write(worksheet.DefaultRowHeight);</para><para>//Set default height</para><para>worksheet.DefaultRowHeight = 40;</para><para>//Save to file</para><para>workbook.SaveToFile("DefaultRowHeight.xlsx");</para>
Public property DisplayPageBreaks
True if page breaks (both automatic and manual) on the specified worksheet are displayed.
Public property DVTable
Gets the data validation table associated with the current instance.
Public property FirstColumn
Gets or sets index of the first column of the worksheet.
(Inherited from XlsWorksheetBase .)
Public property FirstDataColumn
Gets index of the first data column of the worksheet.
(Inherited from XlsWorksheetBase .)
Public property FirstDataRow
Gets index of the first data row of the worksheet.
(Inherited from XlsWorksheetBase .)
Public property FirstRow
Gets / sets index of the first row of the worksheet.
(Inherited from XlsWorksheetBase .)
Public property FirstVisibleColumn
Gets or sets the index of the first visible column in a worksheet.The value is 1-based.
Public property FirstVisibleRow
Gets or sets the index of the first visible row in the worksheet. The value is 1-based.
Public property FormulasVisible
Gets or sets a value indicating whether the formulas are visible in the worksheet.
Public property Code example GridLineColor
Grid line color.
Examples
The following code illustrates how to set the grid line color:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Set grid lines color</para><para>worksheet.GridLineColor = ExcelColors.Red;</para><para>//Save to file</para><para>workbook.SaveToFile("GridLineColor.xlsx");</para>
(Inherited from XlsWorksheetBase .)
Public property Code example GridLinesVisible
True if gridlines are visible; False otherwise.
Examples
The following code illustrates how to set visibility for grid lines:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Set grid line visibility</para><para>worksheet.GridLinesVisible = false;</para><para>//Save to file</para><para>workbook.SaveToFile("GridLinesVisible.xlsx");</para>
Public property GroupBoxes
Gets the group boxes in the worksheet.
(Inherited from XlsWorksheetBase .)
Public property GroupShapeCollection
Get group shapes in worksheet.
(Inherited from XlsWorksheetBase .)
Public property HasMergedCells
Indicates whether worksheet has merged cells.
Public property Code example HasOleObjects
Indicats whether there is OLE object.
Examples
The following code illustrates how to access the IListObjects collection in the worksheet to add a new IOleObject and check Ole Object:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create image stream</para><para>System.Drawing.Image image = System.Drawing.Image.FromFile("image.png");</para><para>//Add ole object</para><para>IOleObject oleObject = worksheet.OleObjects.Add("Shapes.xlsx", image, OleLinkType.Embed);</para><para>//Check HasOleObject.Output will be true.</para>
 Console.Write(worksheet.HasOleObjects);

 <para>//Save to file</para><para>workbook.SaveToFile("HasOleObjects.xlsx");</para>
Public property HasPictures
Indicates whether tabsheet contains any picture. Read-only.
(Inherited from XlsWorksheetBase .)
Public property HasVmlShapes
Indicates whether worksheet has vml shapes. Read-only.
(Inherited from XlsWorksheetBase .)
Public property HeaderFooterShapes
Header / footer shapes collection.
(Inherited from XlsWorksheetBase .)
Public property HorizontalSplit
Gets or sets the number of rows from the top of the worksheet that are frozen in a horizontal split.
Public property HPageBreaks
Returns an HPageBreaks collection that represents the horizontal page breaks on the sheet. Read-only.
Public property HyperLinks
Collection of all worksheet's hyperlinks.
Public property Index
Returns the index number of the object within the collection of objects.
(Inherited from XlsWorksheetBase .)
Protected property InnerHyperLinks
Collection of all hyperlinks in the current worksheet.
Public property IsDisplayZeros
Indicates whether zero values to be displayed
Public property IsEmpty
Indicates whether worksheet is empty. Read-only.
Public property IsFreezePanes
Indicates whether freezed panes are applied.
Public property IsPasswordProtected
True if the worksheet has been protected with password.
(Inherited from XlsWorksheetBase .)
Public property IsRightToLeft
Indicates whether worksheet is displayed right to left.
(Inherited from XlsWorksheetBase .)
Public property IsRowColHeadersVisible
Gets or sets whether the worksheet will display row and column headers. Default is true.
(Inherited from XlsWorksheetBase .)
Public property IsSelected
Indicates whether tab of this sheet is selected. Read-only.
(Inherited from XlsWorksheetBase .)
Public property IsStringsPreserved
Indicates if all values in the workbook are preserved as strings.
Public property IsTransitionEvaluation
Gets or sets a value indicating whether transition evaluation is enabled.
(Inherited from XlsWorksheetBase .)
Public property Item String
Get cell range.
Public property Item Int32, Int32
Get cell by row and index.
Public property Item Int32, Int32, Int32, Int32
Get cell range.
Public property LabelShapes
Gets the collection of label shapes in the worksheet.
(Inherited from XlsWorksheetBase .)
Public property LastColumn
Gets or sets index of the last column of the worksheet.
(Inherited from XlsWorksheetBase .)
Public property LastDataColumn
Gets index of the last data column of the worksheet.
(Inherited from XlsWorksheetBase .)
Public property LastDataRow
Gets index of the last data row of the worksheet.
(Inherited from XlsWorksheetBase .)
Public property LastRow
Gets or sets one-based index of the last row of the worksheet.
(Inherited from XlsWorksheetBase .)
Public property Code example LeftVisibleColumn
Gets/sets left visible column of the worksheet.
Examples
The following code illustrates how to set the left visible column:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Set left visible column</para><para>worksheet.LeftVisibleColumn = 3;</para><para>//Get left visible column</para><para>Console.Write(worksheet.LeftVisibleColumn);</para><para>//Save to file</para><para>workbook.SaveToFile("LeftVisibleColumn.xlsx");</para>
(Inherited from XlsWorksheetBase .)
Public property Lines
Gets the lines of the chart.
(Inherited from XlsWorksheetBase .)
Public property ListBoxes
Gets the list of list boxes in the workbook.
(Inherited from XlsWorksheetBase .)
Public property ListObjects
Returns all list objects in the worksheet.
Public property MaxDisplayRange
Read-only. Returns a Range object that represents Maximum Display Range
Public property MergedCells
Returns all merged ranges. Read-only.
Public property Name
Returns or sets the name of the object. Read / write String.
(Inherited from XlsWorksheetBase .)
Public property Names
Name range used by macros to access to workbook items.
Public property Code example OleObjects
Gets the OLE objects.
Examples
The following code illustrates how to access the IListObjects collection in the worksheet to add a new IOleObject:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create image stream</para><para>System.Drawing.Image image = System.Drawing.Image.FromFile("image.png");</para><para>//Add ole object</para><para>IOleObject oleObject = worksheet.OleObjects.Add("Shapes.xlsx", image, OleLinkType.Embed);</para><para>//Save to file</para><para>workbook.SaveToFile("OLEObjects.xlsx");</para>
Public property OvalShapes
Gets the oval shapes in the worksheet.
(Inherited from XlsWorksheetBase .)
Public property PageSetup
Returns a PageSetup object that contains all the page setup settings for the specified object. Read-only.
Public property Parent
Reference to Parent object. Read-only.
(Inherited from XlsObject .)
Public property ParentWorkbook
Returns parent workbook. Read-only.
(Inherited from XlsWorksheetBase .)
Public property Pictures
Pictures collection. Read-only.
(Inherited from XlsWorksheetBase .)
Public property PivotTables
Returns charts collection. Read-only.
Public property ProtectContents
Indicates whether current sheet is protected.
(Overrides XlsWorksheetBase ProtectContents .)
Public property ProtectDrawingObjects
True if objects are protected. Read only.
(Inherited from XlsWorksheetBase .)
Public property Protection
Gets protected options. Read-only. For sets protection options use "Protect" method.
(Inherited from XlsWorksheetBase .)
Public property ProtectScenarios
True if the scenarios of the current sheet are protected. Read only.
(Inherited from XlsWorksheetBase .)
Public property PrstGeomShapes
Gets the collection of preset geometric shapes.
(Inherited from XlsWorksheetBase .)
Public property QueryTables
Gets the collection of query tables in the worksheet.
(Inherited from XlsWorksheetBase .)
Public property QuotedName
Returns quoted name of the worksheet.
Public property RadioButtons
Returns inner radiobutton collection. Read-only.
(Inherited from XlsWorksheetBase .)
Public property Range
Returns a Range object that represents the used range on the specified worksheet. Read-only.
Public property RealIndex
Index of the worksheet in the workbook (not necessary in Worksheets collection)
(Inherited from XlsWorksheetBase .)
Public property RectangleShapes
Gets the rectangle shapes in the worksheet.
(Inherited from XlsWorksheetBase .)
Protected property ReferenceCount
Get quantity of instance references.
(Inherited from XlsObject .)
Public property RowColumnHeadersVisible
True if row and column headers are visible. False otherwise.
Public property Rows
Represents all the rows on the specified worksheet. Read-only Range object.
Public property ScrollBarShapes
Gets the scroll bar shapes associated with the worksheet.
(Inherited from XlsWorksheetBase .)
Public property SelectionCount
Gets array with selection count. Read-only.
Public property Shapes
Shapes collection.
(Inherited from XlsWorksheetBase .)
Public property SheetId
Gets or sets sheetId for this sheet.
(Inherited from XlsWorksheetBase .)
Public property Slicers
Returns slicer collection. Read-only.
Public property SparklineGroups
Gets the sparkline groups.
Public property SpinnerShapes
Gets the spinner shapes in the worksheet.
(Inherited from XlsWorksheetBase .)
Public property StandardHeightFlag
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.
Public property TabColor
Tab color.
(Inherited from XlsWorksheetBase .)
Public property TabColorObject
Tab color.
(Inherited from XlsWorksheetBase .)
Public property TabKnownColor
Tab excel color.
(Inherited from XlsWorksheetBase .)
Public property TextBoxes
Returns inner textboxes collection. Read-only.
(Inherited from XlsWorksheetBase .)
Public property TopLeftCell
Gets top left cell of the worksheet.
Public property Code example TopVisibleRow
Gets/sets top visible row of the worksheet.
Examples
The following code illustrates how to set the top visible row:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Set top visible row</para><para>worksheet.TopVisibleRow = 5;</para><para>//Get top visible row</para><para>Console.Write(worksheet.TopVisibleRow);</para><para>//Save to file</para><para>workbook.SaveToFile("TopVisibleRow.xlsx");</para>
(Inherited from XlsWorksheetBase .)
Public property Type
Returns or sets the worksheet type.
Public property TypedArcs
Returns inner Arcs collection. Read-only.
(Inherited from XlsWorksheetBase .)
Public property TypedButtons
Returns inner buttons collection. Read-only.
(Inherited from XlsWorksheetBase .)
Public property TypedCheckBoxes
Returns inner checkboxes collection. Read-only.
(Inherited from XlsWorksheetBase .)
Public property TypedComboBoxes
Returns inner comboboxes collection. Read-only.
(Inherited from XlsWorksheetBase .)
Public property TypedGroupBoxes
Returns inner gourpboxes collection. Read-only.
(Inherited from XlsWorksheetBase .)
Public property TypedLabels
Returns inner labels collection. Read-only.
(Inherited from XlsWorksheetBase .)
Public property TypedLines
Returns inner lines collection. Read-only.
(Inherited from XlsWorksheetBase .)
Public property TypedListBoxes
Returns inner listboxes collection. Read-only.
(Inherited from XlsWorksheetBase .)
Public property TypedOvals
Returns inner ovals collection. Read-only.
(Inherited from XlsWorksheetBase .)
Public property TypedPictures
Returns inner pictures collection. Read-only.
(Inherited from XlsWorksheetBase .)
Public property TypedRadioButtons
Returns inner radiobutton collection. Read-only.
(Inherited from XlsWorksheetBase .)
Public property TypedRects
Returns inner rects collection. Read-only.
(Inherited from XlsWorksheetBase .)
Public property TypedScollBars
Returns inner scollbars collection. Read-only.
(Inherited from XlsWorksheetBase .)
Public property TypedSpinners
Returns inner spinners collection. Read-only.
(Inherited from XlsWorksheetBase .)
Public property TypedTextBoxes
Returns inner textboxes collection. Read-only.
(Inherited from XlsWorksheetBase .)
Public property UnknownVmlShapes
Indicates whether worksheet contains some unknown vml shapes.
(Inherited from XlsWorksheetBase .)
Public property UseRangesCache
Indicates whether all created range objects should be cached. Default value is true.
Public property Version
Gets or sets excel file version.
Public property VerticalSplit
Gets or sets the number of columns to freeze for vertical splitting in the worksheet.
Public property ViewMode
Gets or sets the view mode of the sheet.
Public property Visibility
Controls end user visibility of worksheet.
(Inherited from XlsWorksheetBase .)
Public property VmlShapesCount
Returns number of known vml shapes. Read-only.
(Inherited from XlsWorksheetBase .)
Public property VPageBreaks
Returns a VPageBreaks collection that represents the vertical page breaks on the sheet. Read-only.
Public property Workbook
Get parent workbook of current worksheet.
(Inherited from XlsWorksheetBase .)
Public property Code example Zoom
Zoom factor of document.
Examples
The following code illustrates how to set zoom level of the sheet:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Set zoom</para><para>worksheet.Zoom = 200;</para><para>//Save to file</para><para>workbook.SaveToFile("Zoom.xlsx");</para>
Public property ZoomScaleNormal
Gets or sets the zoom scale of normal view of the sheet.
Public property ZoomScalePageBreakView
Gets or sets the zoom scale of page break preview of the sheet.
Public property ZoomScalePageLayoutView
Gets or sets the zoom scale of page layout view of the sheet.
Top
Methods
Name Description
Protected method AccessColumn
Updates FirstColumn and LastColumn indexes.
Protected method AccessRow
Updates FirstRow and LastRow indexes.
Public method Activate
Makes the current sheet the active sheet. Equivalent to clicking the sheet's tab in MS Excel.
(Inherited from XlsWorksheetBase .)
Public method AddAllowEditRange(String, CellRange)
AddAllowEditRange : add a range of cells that allow editing
Public method AddAllowEditRange(String, CellRange, String)
AddAllowEditRange : add a range of cells that allow editing
Protected method AddReference
Increase the quantity of reference. User must use this method when new wrapper on object is created or reference on object stored.
(Inherited from XlsObject .)
Public method AddTextEffectShape
Adds a text effect shape to the worksheet.
(Inherited from XlsWorksheetBase .)
Public method ApplyStyle(CellStyle)
Apply style to whole sheet.
Public method ApplyStyle(CellStyle, Boolean, Boolean)
Apply style to whole sheet.
Public method Code example AutoFitColumn(Int32)
Autofit the column width.
Examples
The following code illustrates how to Auto-fit the column:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Set text</para><para>worksheet["A1"].Text = "Sample text in cell";</para><para>//Set auto fit</para><para>worksheet.AutoFitColumn(1);</para><para>//Save to file</para><para>workbook.SaveToFile("AutoFitColumn.xlsx");</para>
Public method AutoFitColumn(Int32, AutoFitterOptions)
Autofit the column width.
Public method AutoFitColumn(Int32, Int32, Int32)
Autofit the column width.
Public method AutoFitColumn(Int32, Int32, Int32, AutoFitterOptions)
Autofit the column width.
Public method Code example AutoFitRow(Int32)
Autofit the row height.
Examples
The following code illustrates how to Auto-fit the row:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Set text</para><para>worksheet["C2"].Value = "Sample text";</para><para>//Set Style</para><para>CellStyle style = workbook.Styles.Add("CustomStyle");</para><para>IFont font = style.Font;</para><para>font.Size = 18;</para><para>worksheet["C2"].Style = style;</para><para>//Set auto fit</para><para>worksheet.AutoFitRow(2);</para><para>//Save to file</para><para>workbook.SaveToFile("AutoFitRow.xlsx");</para>
Public method AutoFitRow(Int32, Int32, Int32, AutoFitterOptions)
Autofit the row height.
Public method AutoFitRow(Int32, Int32, Int32, Boolean)
Autofit the row height.
Public method AutoFitRow(Int32, Int32, Int32, Boolean, AutoFitterOptions)
Autofit the row height.
Public method CalculateAllValue
Caculate all formula for the specified worksheet
Protected method CheckDisposed
Checks whether object was disposed and throws exception if it was.
(Inherited from XlsObject .)
Public method Code example CheckExistence
Indicates whether cell has been initialized.
Examples
The following code illustrates if the cells was initialized or accessed by the user:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Set text</para><para>worksheet.Range["A1"].Text = "Hello";</para><para>//Check the cell.Output will be true.</para><para>Console.Write(worksheet.CheckExistence(1, 1));</para><para>//Save to file</para><para>workbook.SaveToFile("CheckExistence.xlsx");</para>
Public method Clear
Clears data the worksheet.
Public method ClearCellImageCache
Clear Cell image array cache,not delete CellImage in cell.
(Inherited from XlsWorksheetBase .)
Public method ClearData
Clears contents of a range.
Public method Clone Obsolete.
Creates copy of the current object.
(Inherited from XlsWorksheetBase .)
Public method ColumnWidthToPixels
Converts column width into pixels.
Public method CopyFrom Obsolete.
Copies all data from another worksheet.
Public method CopyToClipboard Obsolete.
Copies worksheet into the clipboard.
Public method CreateNamedRanges
Create Named Ranges
Public method CreateRanges
Creates a collection of ranges from the specified array of CellRange objects.
Public method DeleteColumn(Int32)
Deletes a column.
Public method DeleteColumn(Int32, Int32)
Removes specified column.
Public method DeleteRange
delete a range in worksheet
Public method DeleteRow(Int32)
Delete a row.
Public method DeleteRow(Int32, Int32)
Removes specified row.
Public method DeleteRows
Removes specified rows.
Public method Dispose
Dispose object and free resources.
(Inherited from XlsObject .)
Public method Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object .)
Public method ExportDataTable
Exports worksheet data into a DataTable
Protected method Finalize
Destructor. Call dispose method of current object.
(Inherited from XlsObject .)
Protected method FindParent(Type)
This method is used to find parent with specific type.
(Inherited from XlsObject .)
Protected method FindParent( Type )
Find parent of object.
(Inherited from XlsObject .)
Protected method FindParent(Type, Boolean)
This method is used to find parent with specific type.
(Inherited from XlsObject .)
Protected method FindParents
Finds parent objects.
(Inherited from XlsObject .)
Protected method FreeRange
Clears the specified range of cells in the worksheet.
Public method GetBoolean
Gets bool value from cell.
Public method GetCaculateValue Obsolete.
Returns the formula string if the cell contains a formula, or the value if the cell cantains anything other than a formula.
Public method GetCalculateValue
Returns the formula string if the cell contains a formula, or the value if the cell cantains anything other than a formula.
Public method GetCellType
Gets cell type from current column.
Public method GetClonedObject
Gets object that is clone of current worksheet in the specified workbook.
Public method GetColumnIsAutoFit
Get ColumnIsAutofit By columnIndex
Public method GetColumnIsHide
Indicates whether the column is hidden.
Public method GetColumnWidth
Gets the width of the specified column
Public method Code example GetColumnWidthPixels
Gets the width of the specified column, in units of pixel.
Examples
The following code illustrates how to get the column width for a particular column:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Set text</para><para>worksheet["A1"].Text = "Sample text in cell";</para><para>//Set auto fit</para><para>worksheet.AutoFitColumn(1);</para><para>//Get column width</para><para>Console.WriteLine(worksheet.GetColumnWidthPixels(1));</para><para>//Save to file</para><para>workbook.SaveToFile("UsedRange.xlsx");</para>
Public method GetDefaultColumnStyle
Returns default column style.
Public method GetDefaultRowStyle
Returns default row style.
Public method GetError
Gets error value from cell.
Public method GetFormula(Int32, Int32, Boolean)
Returns formula corresponding to the cell.
Public method GetFormula(Int32, Int32, Boolean, Boolean)
Returns formula corresponding to the cell.
Public method GetFormulaBoolValue
Gets formula bool value from cell.
Public method GetFormulaErrorValue
Gets formula error value from cell.
Public method GetFormulaNumberValue
Returns formula number value corresponding to the cell.
Public method GetFormulaStringValue
Returns formula string value corresponding to the cell.
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object .)
Public method GetNumber
Returns number value corresponding to the cell.
Public method GetRowHeight
Gets the height of a specified row.
Public method Code example GetRowHeightPixels
Gets the height of a specified row in unit of pixel.
Examples
The following code illustrates how to get the row height for a particular row:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Set text</para><para>worksheet["C2"].Text = "Sample text";</para><para>worksheet["C2"].Style.Font.Size = 18;</para><para>//Set auto fit</para><para>worksheet.AutoFitRow(2);</para><para>//Get row height</para><para>Console.WriteLine(worksheet.GetRowHeightPixels(2));</para><para>//Save to file</para><para>workbook.SaveToFile("UsedRange.xlsx");</para>
Public method GetRowIsAutoFit
Get GetRowIsAutoFit By rowIndex
Public method GetRowIsHide
Indicates whether the row is hidden.
Public method GetStringValue(Int64) Obsolete.
Returns string value corresponding to the cell.
Public method GetStringValue(Int32, Int32)
Returns string value corresponding to the cell.
Public method GetText
Returns string value corresponding to the cell.
Public method GetTextObject(Int64) Obsolete.
Returns TextWithFormat object corresponding to the specified cell.
Public method GetTextObject(Int32, Int32)
Returns TextWithFormat object corresponding to the specified cell.
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Public method GroupByColumns
Groups columns.
Public method GroupByRows
Groups rows.
Public method HasArrayFormula Obsolete.
Indicates whether cell contains array-entered formula.
Public method HasArrayFormulaRecord
Indicates is has array formula.
Public method HideColumn
Hides a column.
Public method HideColumns
Hides columns.
Public method HideRow
Hides a row.
Public method HideRows
Hides a row.
Public method ImportCustomObjects(ICollection, Int32, Int32, ImportObjectOptions)
Imports custom objects into the worksheet.
Public method ImportCustomObjects(ICollection, String , Boolean, Int32, Int32, Int32, Boolean, String, Boolean)
Imports custom objects into a worksheet.
Protected method InitializeCollections
Initializes various collections and objects used by the spreadsheet.
(Overrides XlsWorksheetBase InitializeCollections .)
Public method Code example InsertArray( Object , Int32, Int32)
Imports an array of objects into a worksheet.
Examples
The following code illustrates how to Imports a two-dimensional array of Object into a worksheet with the specified row and column:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Initialize the Object Array</para><para>object[,] arrayTwoDimen = new object[3, 2] { { "AND", "OR" }, { "NAND", "XOR" },{ "NOR", "NOT" } };</para><para>//Insert the Object Array to Sheet</para><para>worksheet.InsertArray(arrayTwoDimen, 1, 1);</para><para>//Save to file</para><para>workbook.SaveToFile(InsertArray.xlsx");</para>
Public method Code example InsertArray( DateTime , Int32, Int32, Boolean)
Imports an array of datetimes into worksheet.
Examples
The following code illustrates how to Imports an array of DateTime values into a worksheet with the specified row and colum:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Initialize the DateTime Array</para><para>DateTime[] arrayDate = new DateTime[4] { DateTime.Parse("06:45"), DateTime.Parse("08:30"), DateTime.Parse("09:40"), DateTime.Parse("10:30") };</para><para>//Insert the DateTime Array to Sheet</para><para>worksheet.InsertArray(arrayDate, 1, 1, true);</para><para>//Save to file</para><para>workbook.SaveToFile(InsertArray.xlsx");</para>
Public method Code example InsertArray( Double , Int32, Int32, Boolean)
Imports an array of doubles into a worksheet.
Examples
The following code illustrates how to Imports an array of Double values into a worksheet with the specified row and column:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Initialize the double Array</para><para>double[] arrayDouble = new double[4] { 344.0045, 345.0045, 346.0045, 347.0045 };</para><para>//Insert the double Array to Sheet</para><para>worksheet.InsertArray(arrayDouble, 1, 1, true);</para><para>//Save to file</para><para>workbook.SaveToFile(InsertArray.xlsx");</para>
Public method Code example InsertArray( Int32 , Int32, Int32, Boolean)
Imports an array of integer into a worksheet.
Examples
The following code illustrates how to Imports an array of integer values into a worksheet with the specified row and column:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Initialize the integer Array</para><para>int[] arrayInt = new int[4] {1000, 2000, 3000, 4000};</para><para>//Insert the integer Array to Sheet</para><para>worksheet.InsertArray(arrayInt, 1, 1, true);</para><para>//Save to file</para><para>workbook.SaveToFile(InsertArray.xlsx");</para>
Public method InsertArray( Object , Int32, Int32, Boolean)
Imports an array of objects into a worksheet.
Public method Code example InsertArray( Object , Int32, Int32, Boolean)
Imports an array of objects into a worksheet.
Examples
The following code illustrates how to Imports an array of Object into a worksheet with specified alignment:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Initialize the Object Array</para><para>object[] array = new object[4] { "Total Income", "Actual Expense", "Expected Expenses", "Profit" };</para><para>//Insert the Object Array to Sheet</para><para>worksheet.InsertArray(array, 1, 1, true);</para><para>//Save to file</para><para>workbook.SaveToFile(InsertArray.xlsx");</para>
Public method Code example InsertArray( String , Int32, Int32, Boolean)
Imports an array of strings into a worksheet.
Examples
The following code illustrates how to Imports an array of String into a worksheet with specified row and column:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Initialize the string Array</para><para>string[] arrayString = new string[4] { "Total Income", "Actual Expense", "Expected Expenses", "Profit" };</para><para>//Insert the string Array to Sheet</para><para>worksheet.InsertArray(arrayString, 1, 1, true);</para><para>//Save to file</para><para>workbook.SaveToFile(InsertArray.xlsx");</para>
Public method InsertArray T ( T , Int32, Int32, Boolean, Boolean)
Inserts an array of objects into a worksheet.
Public method InsertArrayList(ArrayList, Int32, Int32, Boolean)
Imports an arraylist of data into a worksheet.
Public method InsertArrayList(ArrayList, Int32, Int32, Boolean, Boolean)
Imports an arraylist of data into a worksheet.
Public method InsertColumn(Int32)
Inserts a new column into the worksheet.
Public method InsertColumn(Int32, Int32)
Inserts specified number column into the worksheet.
Public method InsertColumn(Int32, Int32, InsertOptionsType)
Inserts an empty column with default formatting.
Public method InsertCutRange
Insert cut range into worksheet at specified position.
Public method Code example InsertDataColumn
Imports data column.
Examples
The following code illustrates how to Imports data from a DataColumn into a worksheet with the specified row and column:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create a DataTable</para><para>System.Data.DataTable table = new System.Data.DataTable();</para><para>table.Columns.Add("ID", typeof(int));
 table.Columns.Add("Item", typeof(string));
 table.Columns.Add("Name", typeof(string));</para><para>table.Rows.Add(1, "Soap", "David");
 table.Rows.Add(2, "Paste", "Sam");
 table.Rows.Add(3, "Cream", "Christoff");</para><para>//Insert the DataColumn to worksheet</para><para>System.Data.DataColumn column = table.Columns[2];</para><para>worksheet.InsertDataColumn(column, true, 1, 1);</para><para>//Save to file</para><para>workbook.SaveToFile(InsertDataColumn.xlsx");</para>
Public method InsertDataColumns
Imports array of data columns.
Public method Code example InsertDataTable(DataTable, Boolean, Int32, Int32)
Imports data from a DataTable into worksheet.
Examples
The following code illustrates how to Imports data from a DataTable into a worksheet with the specified row and column:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create a DataTable</para><para>System.Data.DataTable table = new System.Data.DataTable();</para><para>table.Columns.Add("ID", typeof(int));
 table.Columns.Add("Item", typeof(string));
 table.Columns.Add("Name", typeof(string));</para><para>table.Rows.Add(1, "Soap", "David");
 table.Rows.Add(2, "Paste", "Sam");
 table.Rows.Add(3, "Cream", "Christoff");</para><para>//Insert the DataTable to worksheet</para><para>worksheet.InsertDataTable(table, true, 1, 1);</para><para>//Save to file</para><para>workbook.SaveToFile(InsertDataTable.xlsx");</para>
Public method Code example InsertDataTable(DataTable, Boolean, Int32, Int32, Boolean)
Imports data from a DataTable into worksheet.
Examples
The following code illustrates how to Imports data from a DataTable into a worksheet with the specified row and column along with the preserve type:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create a DataTable</para><para>System.Data.DataTable table = new System.Data.DataTable();</para><para>table.Columns.Add("ID", typeof(int));
 table.Columns.Add("Item", typeof(string));
 table.Columns.Add("Name", typeof(string));</para><para>table.Rows.Add(1, "Soap", "David");
 table.Rows.Add(2, "Paste", "Sam");
 table.Rows.Add(3, "Cream", "Christoff");</para><para>//Insert the DataTable to worksheet</para><para>worksheet.InsertDataTable(table, true, 1, 1 , true);</para><para>//Save to file</para><para>workbook.SaveToFile(InsertDataTable.xlsx");</para>
Public method Code example InsertDataTable(DataTable, Boolean, Int32, Int32, Int32, Int32)
Imports data from a DataTable into worksheet.
Examples
The following code illustrates how to Imports data from a DataTable into a worksheet with the specified range:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create a DataTable</para><para>System.Data.DataTable table = new System.Data.DataTable();</para><para>table.Columns.Add("ID", typeof(int));
 table.Columns.Add("Item", typeof(string));
 table.Columns.Add("Name", typeof(string));</para><para>table.Rows.Add(1, "Soap", "David");
 table.Rows.Add(2, "Paste", "Sam");
 table.Rows.Add(3, "Cream", "Christoff");</para><para>//Insert the DataTable to worksheet</para><para>worksheet.InsertDataTable(table, true, 1 , 1 , 2 , 2);</para><para>//Save to file</para><para>workbook.SaveToFile(InsertDataTable.xlsx");</para>
Public method Code example InsertDataTable(DataTable, Boolean, Int32, Int32, Int32, Int32, Boolean)
Imports data from a DataTable into worksheet.
Examples
The following code illustrates how to Imports data from a DataTable into a worksheet with specified range along with preserve type:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create a DataTable</para><para>System.Data.DataTable table = new System.Data.DataTable();</para><para>table.Columns.Add("ID", typeof(int));
 table.Columns.Add("Item", typeof(string));
 table.Columns.Add("Name", typeof(string));</para><para>table.Rows.Add(1, "Soap", "David");
 table.Rows.Add(2, "Paste", "Sam");
 table.Rows.Add(3, "Cream", "Christoff");</para><para>//Insert the DataTable to worksheet</para><para>worksheet.InsertDataTable(table, true, 1 , 1 , 2 , 2 , true);</para><para>//Save to file</para><para>workbook.SaveToFile(InsertDataTable.xlsx");</para>
Public method InsertDataTable(DataTable, Boolean, Int32, Int32, Int32, Int32, DataColumn , Boolean)
Imports data from a DataTable into worksheet
Public method Code example InsertDataView(DataView, Boolean, Int32, Int32)
Imports data from a DataView into worksheet.
Examples
The following code illustrates how to Imports data from a DataView into a worksheet with the specified row and column:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create a DataTable</para><para>System.Data.DataTable table = new System.Data.DataTable();</para><para>table.Columns.Add("ID", typeof(int));
 table.Columns.Add("Item", typeof(string));
 table.Columns.Add("Name", typeof(string));</para><para>table.Rows.Add(1, "Soap", "David");
 table.Rows.Add(2, "Paste", "Sam");
 table.Rows.Add(3, "Cream", "Christoff");</para><para>//Initialize dataview of datatable</para><para>System.Data.DataView view = table.DefaultView;</para><para>//Import data from DataView</para><para>worksheet.InsertDataView(view, true, 1, 1);</para><para>//Save to file</para><para>workbook.SaveToFile(InsertDataView.xlsx");</para>
Public method Code example InsertDataView(DataView, Boolean, Int32, Int32, Boolean)
Imports data from a DataView into worksheet.
Examples
The following code illustrates how to Imports data from a DataView into a worksheet with the specified row and column along with preserve type:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create a DataTable</para><para>System.Data.DataTable table = new System.Data.DataTable();</para><para>table.Columns.Add("ID", typeof(int));
 table.Columns.Add("Item", typeof(string));
 table.Columns.Add("Name", typeof(string));</para><para>table.Rows.Add(1, "Soap", "David");
 table.Rows.Add(2, "Paste", "Sam");
 table.Rows.Add(3, "Cream", "Christoff");</para><para>//Initialize dataview of datatable</para><para>System.Data.DataView view = table.DefaultView;</para><para>//Import data from DataView</para><para>worksheet.InsertDataView(view, true, 1, 1 , true);</para><para>//Save to file</para><para>workbook.SaveToFile(InsertDataView.xlsx");</para>
Public method Code example InsertDataView(DataView, Boolean, Int32, Int32, Int32, Int32)
Imports data from a DataView into worksheet.
Examples
The following code illustrates how to Imports data from a DataView into a worksheet with the specified range:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create a DataTable</para><para>System.Data.DataTable table = new System.Data.DataTable();</para><para>table.Columns.Add("ID", typeof(int));
 table.Columns.Add("Item", typeof(string));
 table.Columns.Add("Name", typeof(string));</para><para>table.Rows.Add(1, "Soap", "David");
 table.Rows.Add(2, "Paste", "Sam");
 table.Rows.Add(3, "Cream", "Christoff");</para><para>//Initialize dataview of datatable</para><para>System.Data.DataView view = table.DefaultView;</para><para>//Import data from DataView</para><para>worksheet.InsertDataView(view, true, 1, 1 , 2 , 2);</para><para>//Save to file</para><para>workbook.SaveToFile(InsertDataView.xlsx");</para>
Public method Code example InsertDataView(DataView, Boolean, Int32, Int32, Int32, Int32, Boolean)
Imports data from a DataView into worksheet.
Examples
The following code illustrates how to Imports data from a DataView into a worksheet with the specified range along with preserve type:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create a DataTable</para><para>System.Data.DataTable table = new System.Data.DataTable();</para><para>table.Columns.Add("ID", typeof(int));
 table.Columns.Add("Item", typeof(string));
 table.Columns.Add("Name", typeof(string));</para><para>table.Rows.Add(1, "Soap", "David");
 table.Rows.Add(2, "Paste", "Sam");
 table.Rows.Add(3, "Cream", "Christoff");</para><para>//Initialize dataview of datatable</para><para>System.Data.DataView view = table.DefaultView;</para><para>//Import data from DataView</para><para>worksheet.InsertDataView(view, true, 1, 1 , 2 , 2 , true);</para><para>//Save to file</para><para>workbook.SaveToFile(InsertDataView.xlsx");</para>
Public method InsertRange
Insert a cell range into worksheet
Public method InsertRow(Int32)
Inserts a new row into the worksheet.
Public method InsertRow(Int32, Int32)
Inserts multiple rows into the worksheet.
Public method InsertRow(Int32, Int32, InsertOptionsType)
Inserts an empty row with default formatting.
Protected method IntersectRanges
Intersects two ranges and returns the resulting range.
Public method IsArrayFormula(Int64) Obsolete.
Indicates whether cell contains array-entered formula.
Public method IsArrayFormula(Int32, Int32)
Indicates whether cell contains array-entered formula.
Public method IsColumnVisible
Indicates whether column is visible.
Public method IsExternalFormula
Indicates is formula in cell is formula to external workbook.
Public method IsRowVisible
Indicates whether row is visible.
Protected method MemberwiseClone
Creates a shallow copy of the current Object .
(Inherited from Object .)
Protected method MergeRanges
Merges two ranges if they have the same dimensions and are adjacent.
Public method MoveSheet
Moves sheet into new position, including chartsheet and worksheet.
(Inherited from XlsWorksheetBase .)
Public method MoveWorksheet
Moves worksheet into new position.
Protected method OnDispose
Method which can be overriden by users to take any specific actions when object is disposed.
(Inherited from XlsObject .)
Public method PixelsToColumnWidth
Converts pixels count into column width value.
Public method Code example Protect(String)
Protects worksheet with password.protect the sheet except select lock/unlock cells.
Examples
The following code illustrates how to protect the sheet except select lock/unlock cells:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Protects the first worksheet's content with password</para><para>worksheet.Protect("123456");</para><para>//Save to file</para><para>workbook.SaveToFile("Protect.xlsx");</para>
(Inherited from XlsWorksheetBase .)
Public method Protect(String, SheetProtectionType)
Protects worksheet with password.
(Inherited from XlsWorksheetBase .)
Protected method ReleaseReference
Decrease quantity of Reference. User must call this method when freeing resources.
(Inherited from XlsObject .)
Public method Remove
Removes worksheet from parernt worksheets collection.
Public method RemoveMergedCells
Removes all merged cells within the specified range.
Public method RemovePanes
Removes panes from a worksheet.
Public method ReparseFormula
Reparses all formulas on this sheet.
Public method Code example Replace(String, DateTime)
Replaces cells' values with new data.
Examples
The following code illustrates how to replace the string value with datetime:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Replace the oldValue by dateTime</para><para>string oldValue = "Find";</para><para>DateTime dateTime = DateTime.Now;</para><para>worksheet.Replace(oldValue, dateTime);</para><para>//Save to file</para><para>workbook.SaveToFile("Replace.xlsx");</para>
Public method Code example Replace(String, Double)
Replaces cells' values with new data.
Examples
The following code snippet illustrates how to replace the string with double:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Replace the oldValue by double</para><para>string oldValue = "Ten";</para><para>worksheet.Replace(oldValue, 10.0);</para><para>//Save to file</para><para>workbook.SaveToFile("Replace.xlsx");</para>
Public method Code example Replace(String, String)
Replaces cells' values with new data.
Examples
The following code snippet illustrates how to replace the string with another string:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Replace the oldValue by newValue</para><para>string oldValue = "Find";</para><para>string newValue = "NewValue";</para><para>worksheet.Replace(oldValue, newValue);</para><para>//Save to file</para><para>workbook.SaveToFile("Replace.xlsx");</para>
Public method Code example Replace(String, DataColumn, Boolean)
Replaces cells' values with new data.
Examples
The following code snippet illustrates how to replace the string value with data column:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Replace the oldValue by data column</para><para>string oldValue = "Find";</para><para>System.Data.DataTable table = new System.Data.DataTable();</para><para>table.Columns.Add("Dosage", typeof(int));</para><para>table.Rows.Add(1);</para><para>System.Data.DataColumn dataColumn = table.Columns[0];</para><para>worksheet.Replace(oldValue, dataColumn, true);</para><para>//Save to file</para><para>workbook.SaveToFile("Replace.xlsx");</para>
Public method Code example Replace(String, DataTable, Boolean)
Replaces cells' values with new data.
Examples
The following code snippet illustrates how to replace the string value with data table:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Replace the oldValue by data table</para><para>string oldValue = "Find";</para><para>System.Data.DataTable table = new System.Data.DataTable();</para><para>table.Columns.Add("Dosage", typeof(int));</para><para>table.Rows.Add(1);</para><para>worksheet.Replace(oldValue, table, true);</para><para>//Save to file</para><para>workbook.SaveToFile("Replace.xlsx");</para>
Public method Code example Replace(String, Double , Boolean)
Replaces cells' values with new data.
Examples
The following code snippet illustrates how to replace the string with array of double values:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Replace the oldValue by array of double values</para><para>string oldValue = "Find";</para><para>double[] newValues = { 1.0, 2.0 };</para><para>worksheet.Replace(oldValue, newValues, true);</para><para>//Save to file</para><para>workbook.SaveToFile("Replace.xlsx");</para>
Public method Code example Replace(String, Int32 , Boolean)
Replaces cells' values with new data.
Examples
The following code snippet illustrates how to replace the string with array of int values:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Replace the oldValue by array of int values</para><para>string oldValue = "Find";</para><para>int[] newValues = { 1, 2 };</para><para>worksheet.Replace(oldValue, newValues, true);</para><para>//Save to file</para><para>workbook.SaveToFile("Replace.xlsx");</para>
Public method Code example Replace(String, String , Boolean)
Replaces cells' values with new data.
Examples
The following code snippet illustrates how to replace the string with array of string values:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Replace the oldValue by array of string values</para><para>string oldValue = "Find";</para><para>string[] newValues = { "X values", "Y values" };</para><para>worksheet.Replace(oldValue, newValues , true);</para><para>//Save to file</para><para>workbook.SaveToFile("Replace.xlsx");</para>
Public method ReplaceAll(String, String, Boolean)
Replaces all occurrences of a specified value with a new value in the worksheet.
Public method ReplaceAll(String, CellStyle, String, CellStyle)
Replaces cells' values with new data and style.
Public method SaveAndGetShapesToImage
Save option specify shapes to image, and get option specify shapes together.
Public method SaveShapesToImage
Save option specify shapes to image.
Public method SaveToEMFImage Obsolete.
Converts range into EMF format image.
Public method Code example SaveToFile(String, String)
Save worksheet to file.
Examples
The following code illustrates how to saves the worksheet in a different file with separator:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Save to file</para><para>worksheet.SaveToFile("SaveToFile.csv" , ",");</para>
Public method SaveToFile(String, String, Boolean)
Save worksheet to file.
Public method SaveToFile(String, String, Encoding)
Save worksheet to file..
Public method SaveToFile(String, String, Encoding, Boolean)
Save worksheet to file..
Public method Code example SaveToHtml(Stream)
Save to HTML stream.
Examples
The following code snippets illustrates how to save as html as stream:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Creat stream</para><para>Stream stream = new MemoryStream();</para><para>//Save to HTML stream</para><para>worksheet.SaveToHtml(stream);</para>
Public method Code example SaveToHtml(String)
Save to HTML file.
Examples
The following code snippets illustrates how to save as html to the specified file name:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Save to HTML file</para><para>worksheet.SaveToHtml("Output.html");</para>
Public method Code example SaveToHtml(Stream, HTMLOptions)
Saves work sheet to HTML.
Examples
The following code snippets illustrates how to save as html as stream with Save option:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Creat stream</para><para>Stream stream = new MemoryStream();</para><para>//Save to HTML stream</para><para>worksheet.SaveToHtml(stream, Spire.Xls.Core.Spreadsheet.HTMLOptions.Default);</para>
Public method Code example SaveToHtml(String, HTMLOptions)
Saves as HTML.
Examples
The following code snippets illustrates how to save as html to the specified file name and save option:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Save to HTML file</para><para>worksheet.SaveToHtml("Sample.html" , Spire.Xls.Core.Spreadsheet.HTMLOptions.Default);</para>
Public method SaveToImage(String)
Save worksheet to image.
Public method SaveToImage(String, ImageFormat)
Save worksheet to image.
Public method SaveToImage(Int32, Int32, Int32, Int32) Obsolete.
Save worksheet to image.
Public method SaveToImage(String, Int32, Int32, Int32, Int32)
Save worksheet to image.
Public method Code example SaveToImage(Stream, Int32, Int32, Int32, Int32, ImageType)
Save worksheet into image.
Examples
The following code illustrates how to convert the specified range into image with the specified type:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Creat stream</para><para>Stream stream = new MemoryStream();</para><para>//Save to image</para><para>System.Drawing.Image image = worksheet.SaveToImage(stream,1, 1, 10, 20, Spire.Xls.ImageType.Bitmap);</para><para>image.Save("Sample.png", System.Drawing.Imaging.ImageFormat.Png);</para>
Public method SaveToImage(Stream, Int32, Int32, Int32, Int32, EmfType) Obsolete.
Converts range into image.
Public method SaveToImage(Stream, Int32, Int32, Int32, Int32, ImageType, EmfType) Obsolete.
Converts range into image.
Public method SaveToPdf(String)
Save worksheet to pdf.
Public method SaveToPdf(String, FileFormat) Obsolete.
Save worksheet to pdf.
Public method SaveToPdfStream(Stream)
Save worksheet to pdf Stream.
Public method SaveToPdfStream(Stream, FileFormat) Obsolete.
Saves the document to a PDF stream with the specified file format.
Public method Code example SaveToStream(Stream, String)
Save worksheet to stream.
Examples
The following code illustrates how to saves the worksheet as stream with separator:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create stream</para><para>Stream stream = new MemoryStream();</para><para>//Save to stream</para><para>worksheet.SaveToStream(stream , ",");</para>
Public method SaveToStream(Stream, String, Boolean)
Save worksheet to stream.
Public method SaveToStream(Stream, String, Encoding)
Save worksheet to stream.
Public method SaveToStream(Stream, String, Encoding, Boolean)
Save worksheet to stream.
Public method SaveToXps
Saves specific worksheet to xps.
Public method Select
Selects current tab sheet.
(Inherited from XlsWorksheetBase .)
Public method SelectTab
Adds sheet tab to the selected tab.
(Inherited from XlsWorksheetBase .)
Public method SetActiveCell(IXLSRange)
Sets active cell
Public method SetActiveCell(IXLSRange, Boolean)
Sets active cell
Public method SetBlank
Sets blank in specified cell.
Public method SetBoolean
Sets value in the specified cell.
Public method SetCaculateValue Obsolete.
Sets the value of a cell.
Public method SetCalculateValue
Sets the value of a cell.
Public method SetCellValue(Int32, Int32, Boolean)
Sets value in the specified cell.
Public method SetCellValue(Int32, Int32, String)
Sets value in the specified cell.
Public method SetChanged
This method should be called after any changes in the worksheet. Sets Saved property of the parent workbook to false.
(Inherited from XlsWorksheetBase .)
Public method SetColumnWidth
Set solumn width
Public method Code example SetColumnWidthInPixels(Int32, Int32)
Sets column width in pixels.
Examples
The following code illustrates how to set width for a column:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Set column width</para><para>worksheet.SetColumnWidthInPixels(2, 160);</para><para>//Save to file</para><para>workbook.SaveToFile("SetColumnWidthInPixels.xlsx");</para>
Public method SetColumnWidthInPixels(Int32, Int32, Int32)
Sets the width of the specified columns.
Public method SetDefaultColumnStyle(Int32, IStyle)
Sets default style for column.
Public method SetDefaultColumnStyle(Int32, Int32, IStyle)
Sets by column index default style for column.
Public method SetDefaultRowStyle(Int32, IStyle)
Sets bdefault style for row.
Public method SetDefaultRowStyle(Int32, Int32, IStyle)
Sets by column index default style for row.
Public method SetError(Int32, Int32, String)
Sets error in the specified cell.
Public method SetError(Int32, Int32, String, Boolean)
Sets error in the specified cell.
Public method SetFirstColumn
Updates first column indexe.
Public method SetFirstRow
Updates first row index.
Public method SetFormula(Int32, Int32, String)
Sets formula in the specified cell.
Public method SetFormula(Int32, Int32, String, Boolean)
Sets formula in the specified cell.
Public method SetFormulaBoolValue
Sets formula bool value.
Public method SetFormulaErrorValue
Sets formula error value.
Public method SetFormulaNumberValue
Sets formula number value.
Public method SetFormulaStringValue
Sets formula string value.
Public method SetLastColumn
Updates last column index.
Public method SetLastRow
Updates last row index.
Public method SetNumber
Sets value in the specified cell.
Protected method SetParent
Sets parent of the object.
(Inherited from XlsObject .)
Public method SetRowHeight
Sets the height of the specified row.
Public method SetRowHeightInPixels
Set Row height from Start Row index
Public method Code example SetRowHeightPixels
Sets the height of the specified row.
Examples
The following code illustrates how to set height for a row:
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Set row height</para><para>worksheet.SetRowHeightPixels(3, 150);</para><para>//Save to file</para><para>workbook.SaveToFile("SetRowHeightPixels.xlsx");</para>
Public method SetText
Sets text in the specified cell.
Public method SetValue
Sets the value of a cell in the grid.
Public method ShowColumn
Shows a column.
Public method ShowRow
Shows a row.
Public method Subtotal(IXLSRange, Int32, Int32 , SubtotalTypes)
Creates subtotals for the range.
Public method Subtotal(IXLSRange, Int32, Int32 , SubtotalTypes, Boolean, Boolean, Boolean)
Creates subtotals for the range.
Public method ToEMFStream(Stream, Int32, Int32, Int32, Int32)
Converts a range of cells in the worksheet to an EMF (Enhanced Metafile) stream.
Public method ToEMFStream(Stream, Int32, Int32, Int32, Int32, EmfType)
Converts a range of cells in the worksheet to an EMF (Enhanced Metafile) stream.
Public method ToImage
Convert worksheet to Image.
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)
Public method ToSVGStream
Convert CellRange to Svg stream
Public method UngroupByColumns
Ungroups columns.
Public method UngroupByRows
Ungroups rows.
Public method Unprotect
Unprotects this wokrsheet.
(Inherited from XlsWorksheetBase .)
Public method Unprotect(String)
Unprotects this worksheet using specified password.
(Inherited from XlsWorksheetBase .)
Public method Unselect
Unselects current tab sheet if possible.
(Inherited from XlsWorksheetBase .)
Public method Unselect(Boolean)
Unselects current tab sheet if possible.
(Inherited from XlsWorksheetBase .)
Top
Events
Name Description
Public event CellValueChanged
Represents the event handler for the CellValueChanged event of the XlsRange class.
Top
Fields
Name Description
Protected field m_bIsDisposed
Flag which indicates if the object was disposed or not.
(Inherited from XlsObject .)
Protected field m_book
Represents the workbook object.
(Inherited from XlsWorksheetBase .)
Protected field m_iFirstColumn
The first column index, initialized to the default minimum column index.
(Inherited from XlsWorksheetBase .)
Protected field m_iFirstRow
One field from Worksheet dimension records.
(Inherited from XlsWorksheetBase .)
Protected field m_iLastColumn
One field from Worksheet dimension records.
(Inherited from XlsWorksheetBase .)
Protected field m_iLastRow
One field from Worksheet dimension records
(Inherited from XlsWorksheetBase .)
Top
See Also