XlsWorksheet Class |
Namespace: Spire.Xls.Core.Spreadsheet
The XlsWorksheet type exposes the following members.
| Name | Description | |
|---|---|---|
|
|
ActivePane |
Gets or sets index of the active pane.
|
|
|
ActiveSelectionRange |
Get active selection range.
|
|
|
AllocatedRange |
Read-only. Returns a Range object that represents a cell or a range of cells.
|
|
|
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.
|
|
|
ArcShapes |
Gets the collection of arc shapes in the worksheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
AutoFilters |
Returns collection of worksheet's autofilters. Read-only.
|
|
|
ButtonShapes |
Gets the collection of button shapes in the worksheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
CellImages |
Cell image array. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
CellList |
Returns all used cells in the worksheet. Read-only.
|
|
|
Cells |
Obsolete.
Returns all used cells in the worksheet. Read-only.
|
|
|
Charts |
Returns charts collection. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
CheckBoxes |
Returns inner checkboxes collection. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
CodeName |
Name used by macros to access workbook items.
(Inherited from
XlsWorksheetBase
.)
|
|
|
Columns |
For a Worksheet object, returns an array of Range objects that represents
all used columns on the specified worksheet. Read-only Range object.
|
|
|
ComboBoxes |
Returns collection with all comboboxes inside this worksheet. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
Comments |
Returns comments collection for this worksheet. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
ConditionalFormats |
Returns collection with all conditional formats in the worksheet. Read-only.
|
|
|
Copying |
Gets or sets a value indicating whether a copy operation is currently in progress.
|
|
|
CustomProperties |
Returns collection with all custom properties in the worksheet. Read-only.
|
|
|
DefaultColumnWidth |
Returns or sets the defaultwidth of all the columns in the worksheet. Read/write Double.
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>
|
|
|
DefaultGridlineColor |
Indicates whether gridline color has default value.
(Inherited from
XlsWorksheetBase
.)
|
|
|
DefaultPrintRowHeight |
Return default row height.
|
|
|
DefaultRowHeight |
Gets or sets default height of all the rows in the worksheet,
in points.Read/write Double.
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>
|
|
|
DisplayPageBreaks |
True if page breaks (both automatic and manual) on the specified
worksheet are displayed.
|
|
|
DVTable |
Gets the data validation table associated with the current instance.
|
|
|
FirstColumn |
Gets or sets index of the first column of the worksheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
FirstDataColumn |
Gets index of the first data column of the worksheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
FirstDataRow |
Gets index of the first data row of the worksheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
FirstRow |
Gets / sets index of the first row of the worksheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
FirstVisibleColumn |
Gets or sets the index of the first visible column in a worksheet.The value is 1-based.
|
|
|
FirstVisibleRow |
Gets or sets the index of the first visible row in the worksheet. The value is 1-based.
|
|
|
FormulasVisible |
Gets or sets a value indicating whether the formulas are visible in the worksheet.
|
|
|
GridLineColor |
Grid line color.
(Inherited from
XlsWorksheetBase
.)
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>
|
|
|
GridLinesVisible |
True if gridlines are visible;
False otherwise.
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>
|
|
|
GroupBoxes |
Gets the group boxes in the worksheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
GroupShapeCollection |
Get group shapes in worksheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
HasMergedCells |
Indicates whether worksheet has merged cells.
|
|
|
HasOleObjects |
Indicats whether there is OLE object.
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> |
|
|
HasPictures |
Indicates whether tabsheet contains any picture. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
HasVmlShapes |
Indicates whether worksheet has vml shapes. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
HeaderFooterShapes |
Header / footer shapes collection.
(Inherited from
XlsWorksheetBase
.)
|
|
|
HorizontalSplit |
Gets or sets the number of rows from the top of the worksheet that are frozen in a horizontal split.
|
|
|
HPageBreaks |
Returns an HPageBreaks collection that represents the horizontal
page breaks on the sheet. Read-only.
|
|
|
HyperLinks |
Collection of all worksheet's hyperlinks.
|
|
|
Index |
Returns the index number of the object within the collection of objects.
(Inherited from
XlsWorksheetBase
.)
|
|
|
InnerHyperLinks |
Collection of all hyperlinks in the current worksheet.
|
|
|
IsDisplayZeros |
Indicates whether zero values to be displayed
|
|
|
IsEmpty |
Indicates whether worksheet is empty. Read-only.
|
|
|
IsFreezePanes |
Indicates whether freezed panes are applied.
|
|
|
IsPasswordProtected |
True if the worksheet has been protected with password.
(Inherited from
XlsWorksheetBase
.)
|
|
|
IsRightToLeft |
Indicates whether worksheet is displayed right to left.
(Inherited from
XlsWorksheetBase
.)
|
|
|
IsRowColHeadersVisible |
Gets or sets whether the worksheet will display row and column headers. Default is true.
(Inherited from
XlsWorksheetBase
.)
|
|
|
IsSelected |
Indicates whether tab of this sheet is selected. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
IsStringsPreserved |
Indicates if all values in the workbook are preserved as strings.
|
|
|
IsTransitionEvaluation |
Gets or sets a value indicating whether transition evaluation is enabled.
(Inherited from
XlsWorksheetBase
.)
|
|
|
Item String |
Get cell range.
|
|
|
Item Int32, Int32 |
Get cell by row and index.
|
|
|
Item Int32, Int32, Int32, Int32 |
Get cell range.
|
|
|
LabelShapes |
Gets the collection of label shapes in the worksheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
LastColumn |
Gets or sets index of the last column of the worksheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
LastDataColumn |
Gets index of the last data column of the worksheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
LastDataRow |
Gets index of the last data row of the worksheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
LastRow |
Gets or sets one-based index of the last row of the worksheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
LeftVisibleColumn |
Gets/sets left visible column of the worksheet.
(Inherited from
XlsWorksheetBase
.)
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>
|
|
|
Lines |
Gets the lines of the chart.
(Inherited from
XlsWorksheetBase
.)
|
|
|
ListBoxes |
Gets the list of list boxes in the workbook.
(Inherited from
XlsWorksheetBase
.)
|
|
|
ListObjects |
Returns all list objects in the worksheet.
|
|
|
MaxDisplayRange |
Read-only. Returns a Range object that represents Maximum Display Range
|
|
|
MergedCells |
Returns all merged ranges. Read-only.
|
|
|
Name |
Returns or sets the name of the object. Read / write String.
(Inherited from
XlsWorksheetBase
.)
|
|
|
Names |
Name range used by macros to access to workbook items.
|
|
|
OleObjects |
Gets the OLE objects.
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>
|
|
|
OvalShapes |
Gets the oval shapes in the worksheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
PageSetup |
Returns a PageSetup object that contains all the page setup settings
for the specified object. Read-only.
|
|
|
Parent |
Reference to Parent object. Read-only.
(Inherited from
XlsObject
.)
|
|
|
ParentWorkbook |
Returns parent workbook. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
Pictures |
Pictures collection. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
PivotTables |
Returns charts collection. Read-only.
|
|
|
ProtectContents |
Indicates whether current sheet is protected.
(Overrides
XlsWorksheetBase
ProtectContents
.)
|
|
|
ProtectDrawingObjects |
True if objects are protected. Read only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
Protection |
Gets protected options. Read-only. For sets protection options use "Protect" method.
(Inherited from
XlsWorksheetBase
.)
|
|
|
ProtectScenarios |
True if the scenarios of the current sheet are protected. Read only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
PrstGeomShapes |
Gets the collection of preset geometric shapes.
(Inherited from
XlsWorksheetBase
.)
|
|
|
QueryTables |
Gets the collection of query tables in the worksheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
QuotedName |
Returns quoted name of the worksheet.
|
|
|
RadioButtons |
Returns inner radiobutton collection. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
Range |
Returns a Range object that represents the used range on the
specified worksheet. Read-only.
|
|
|
RealIndex |
Index of the worksheet in the workbook
(not necessary in Worksheets collection)
(Inherited from
XlsWorksheetBase
.)
|
|
|
RectangleShapes |
Gets the rectangle shapes in the worksheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
ReferenceCount |
Get quantity of instance references.
(Inherited from
XlsObject
.)
|
|
|
RowColumnHeadersVisible |
True if row and column headers are visible.
False otherwise.
|
|
|
Rows |
Represents all the rows on the specified worksheet. Read-only Range object.
|
|
|
ScrollBarShapes |
Gets the scroll bar shapes associated with the worksheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
SelectionCount |
Gets array with selection count. Read-only.
|
|
|
Shapes |
Shapes collection.
(Inherited from
XlsWorksheetBase
.)
|
|
|
SheetId |
Gets or sets sheetId for this sheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
Slicers |
Returns slicer collection. Read-only.
|
|
|
SparklineGroups |
Gets the sparkline groups.
|
|
|
SpinnerShapes |
Gets the spinner shapes in the worksheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
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.
|
|
|
TabColor |
Tab color.
(Inherited from
XlsWorksheetBase
.)
|
|
|
TabColorObject |
Tab color.
(Inherited from
XlsWorksheetBase
.)
|
|
|
TabKnownColor |
Tab excel color.
(Inherited from
XlsWorksheetBase
.)
|
|
|
TextBoxes |
Returns inner textboxes collection. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
TopLeftCell |
Gets top left cell of the worksheet.
|
|
|
TopVisibleRow |
Gets/sets top visible row of the worksheet.
(Inherited from
XlsWorksheetBase
.)
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>
|
|
|
Type |
Returns or sets the worksheet type.
|
|
|
TypedArcs |
Returns inner Arcs collection. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
TypedButtons |
Returns inner buttons collection. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
TypedCheckBoxes |
Returns inner checkboxes collection. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
TypedComboBoxes |
Returns inner comboboxes collection. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
TypedGroupBoxes |
Returns inner gourpboxes collection. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
TypedLabels |
Returns inner labels collection. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
TypedLines |
Returns inner lines collection. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
TypedListBoxes |
Returns inner listboxes collection. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
TypedOvals |
Returns inner ovals collection. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
TypedPictures |
Returns inner pictures collection. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
TypedRadioButtons |
Returns inner radiobutton collection. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
TypedRects |
Returns inner rects collection. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
TypedScollBars |
Returns inner scollbars collection. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
TypedSpinners |
Returns inner spinners collection. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
TypedTextBoxes |
Returns inner textboxes collection. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
UnknownVmlShapes |
Indicates whether worksheet contains some unknown vml shapes.
(Inherited from
XlsWorksheetBase
.)
|
|
|
UseRangesCache |
Indicates whether all created range objects should be cached. Default value is true.
|
|
|
Version |
Gets or sets excel file version.
|
|
|
VerticalSplit |
Gets or sets the number of columns to freeze for vertical splitting in the worksheet.
|
|
|
ViewMode |
Gets or sets the view mode of the sheet.
|
|
|
Visibility |
Controls end user visibility of worksheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
VmlShapesCount |
Returns number of known vml shapes. Read-only.
(Inherited from
XlsWorksheetBase
.)
|
|
|
VPageBreaks |
Returns a VPageBreaks collection that represents the vertical page
breaks on the sheet. Read-only.
|
|
|
Workbook |
Get parent workbook of current worksheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
Zoom |
Zoom factor of document.
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>
|
|
|
ZoomScaleNormal |
Gets or sets the zoom scale of normal view of the sheet.
|
|
|
ZoomScalePageBreakView |
Gets or sets the zoom scale of page break preview of the sheet.
|
|
|
ZoomScalePageLayoutView |
Gets or sets the zoom scale of page layout view of the sheet.
|
| Name | Description | |
|---|---|---|
|
|
AccessColumn |
Updates FirstColumn and LastColumn indexes.
|
|
|
AccessRow |
Updates FirstRow and LastRow indexes.
|
|
|
Activate |
Makes the current sheet the active sheet. Equivalent to clicking the
sheet's tab in MS Excel.
(Inherited from
XlsWorksheetBase
.)
|
|
|
AddAllowEditRange(String, CellRange) |
AddAllowEditRange : add a range of cells that allow editing
|
|
|
AddAllowEditRange(String, CellRange, String) |
AddAllowEditRange : add a range of cells that allow editing
|
|
|
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
.)
|
|
|
AddTextEffectShape |
Adds a text effect shape to the worksheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
ApplyStyle(CellStyle) |
Apply style to whole sheet.
|
|
|
ApplyStyle(CellStyle, Boolean, Boolean) |
Apply style to whole sheet.
|
|
|
AutoFitColumn(Int32) |
Autofit the column width.
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>
|
|
|
AutoFitColumn(Int32, AutoFitterOptions) |
Autofit the column width.
|
|
|
AutoFitColumn(Int32, Int32, Int32) |
Autofit the column width.
|
|
|
AutoFitColumn(Int32, Int32, Int32, AutoFitterOptions) |
Autofit the column width.
|
|
|
AutoFitRow(Int32) |
Autofit the row height.
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>
|
|
|
AutoFitRow(Int32, Int32, Int32, AutoFitterOptions) |
Autofit the row height.
|
|
|
AutoFitRow(Int32, Int32, Int32, Boolean) |
Autofit the row height.
|
|
|
AutoFitRow(Int32, Int32, Int32, Boolean, AutoFitterOptions) |
Autofit the row height.
|
|
|
CalculateAllValue |
Caculate all formula for the specified worksheet
|
|
|
CheckDisposed |
Checks whether object was disposed and throws exception if it was.
(Inherited from
XlsObject
.)
|
|
|
CheckExistence |
Indicates whether cell has been initialized.
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>
|
|
|
Clear |
Clears data the worksheet.
|
|
|
ClearCellImageCache |
Clear Cell image array cache,not delete CellImage in cell.
(Inherited from
XlsWorksheetBase
.)
|
|
|
ClearData |
Clears contents of a range.
|
|
|
Clone |
Obsolete.
Creates copy of the current object.
(Inherited from
XlsWorksheetBase
.)
|
|
|
ColumnWidthToPixels |
Converts column width into pixels.
|
|
|
CopyFrom |
Obsolete.
Copies all data from another worksheet.
|
|
|
CopyToClipboard |
Obsolete.
Copies worksheet into the clipboard.
|
|
|
CreateNamedRanges |
Create Named Ranges
|
|
|
CreateRanges |
Creates a collection of ranges from the specified array of CellRange objects.
|
|
|
DeleteColumn(Int32) |
Deletes a column.
|
|
|
DeleteColumn(Int32, Int32) |
Removes specified column.
|
|
|
DeleteRange |
delete a range in worksheet
|
|
|
DeleteRow(Int32) |
Delete a row.
|
|
|
DeleteRow(Int32, Int32) |
Removes specified row.
|
|
|
DeleteRows |
Removes specified rows.
|
|
|
Dispose |
Dispose object and free resources.
(Inherited from
XlsObject
.)
|
|
|
Equals |
Determines whether the specified object is equal to the current object.
(Inherited from
Object
.)
|
|
|
ExportDataTable |
Exports worksheet data into a DataTable
|
|
|
Finalize |
Destructor. Call dispose method of current object.
(Inherited from
XlsObject
.)
|
|
|
FindParent(Type) |
This method is used to find parent with specific type.
(Inherited from
XlsObject
.)
|
|
|
FindParent( Type ) |
Find parent of object.
(Inherited from
XlsObject
.)
|
|
|
FindParent(Type, Boolean) |
This method is used to find parent with specific type.
(Inherited from
XlsObject
.)
|
|
|
FindParents |
Finds parent objects.
(Inherited from
XlsObject
.)
|
|
|
FreeRange |
Clears the specified range of cells in the worksheet.
|
|
|
GetBoolean |
Gets bool value from cell.
|
|
|
GetCaculateValue |
Obsolete.
Returns the formula string if the cell contains a formula, or the value if
the cell cantains anything other than a formula.
|
|
|
GetCalculateValue |
Returns the formula string if the cell contains a formula, or the value if
the cell cantains anything other than a formula.
|
|
|
GetCellType |
Gets cell type from current column.
|
|
|
GetClonedObject |
Gets object that is clone of current worksheet in the specified workbook.
|
|
|
GetColumnIsAutoFit |
Get ColumnIsAutofit By columnIndex
|
|
|
GetColumnIsHide |
Indicates whether the column is hidden.
|
|
|
GetColumnWidth |
Gets the width of the specified column
|
|
|
GetColumnWidthPixels |
Gets the width of the specified column, in units of pixel.
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>
|
|
|
GetDefaultColumnStyle |
Returns default column style.
|
|
|
GetDefaultRowStyle |
Returns default row style.
|
|
|
GetError |
Gets error value from cell.
|
|
|
GetFormula(Int32, Int32, Boolean) |
Returns formula corresponding to the cell.
|
|
|
GetFormula(Int32, Int32, Boolean, Boolean) |
Returns formula corresponding to the cell.
|
|
|
GetFormulaBoolValue |
Gets formula bool value from cell.
|
|
|
GetFormulaErrorValue |
Gets formula error value from cell.
|
|
|
GetFormulaNumberValue |
Returns formula number value corresponding to the cell.
|
|
|
GetFormulaStringValue |
Returns formula string value corresponding to the cell.
|
|
|
GetHashCode |
Serves as the default hash function.
(Inherited from
Object
.)
|
|
|
GetNumber |
Returns number value corresponding to the cell.
|
|
|
GetRowHeight |
Gets the height of a specified row.
|
|
|
GetRowHeightPixels |
Gets the height of a specified row in unit of pixel.
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>
|
|
|
GetRowIsAutoFit |
Get GetRowIsAutoFit By rowIndex
|
|
|
GetRowIsHide |
Indicates whether the row is hidden.
|
|
|
GetStringValue(Int64) |
Obsolete.
Returns string value corresponding to the cell.
|
|
|
GetStringValue(Int32, Int32) |
Returns string value corresponding to the cell.
|
|
|
GetText |
Returns string value corresponding to the cell.
|
|
|
GetTextObject(Int64) |
Obsolete.
Returns TextWithFormat object corresponding to the specified cell.
|
|
|
GetTextObject(Int32, Int32) |
Returns TextWithFormat object corresponding to the specified cell.
|
|
|
GetType |
Gets the
Type
of the current instance.
(Inherited from
Object
.)
|
|
|
GroupByColumns |
Groups columns.
|
|
|
GroupByRows |
Groups rows.
|
|
|
HasArrayFormula |
Obsolete.
Indicates whether cell contains array-entered formula.
|
|
|
HasArrayFormulaRecord |
Indicates is has array formula.
|
|
|
HideColumn |
Hides a column.
|
|
|
HideColumns |
Hides columns.
|
|
|
HideRow |
Hides a row.
|
|
|
HideRows |
Hides a row.
|
|
|
ImportCustomObjects(ICollection, Int32, Int32, ImportObjectOptions) |
Imports custom objects into the worksheet.
|
|
|
ImportCustomObjects(ICollection, String , Boolean, Int32, Int32, Int32, Boolean, String, Boolean) |
Imports custom objects into a worksheet.
|
|
|
InitializeCollections |
Initializes various collections and objects used by the spreadsheet.
(Overrides
XlsWorksheetBase
InitializeCollections
.)
|
|
|
InsertArray( Object , Int32, Int32) |
Imports an array of objects into a worksheet.
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>
|
|
|
InsertArray( DateTime , Int32, Int32, Boolean) |
Imports an array of datetimes into worksheet.
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>
|
|
|
InsertArray( Double , Int32, Int32, Boolean) |
Imports an array of doubles into a worksheet.
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>
|
|
|
InsertArray( Int32 , Int32, Int32, Boolean) |
Imports an array of integer into a worksheet.
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>
|
|
|
InsertArray( Object , Int32, Int32, Boolean) |
Imports an array of objects into a worksheet.
|
|
|
InsertArray( Object , Int32, Int32, Boolean) |
Imports an array of objects into a worksheet.
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>
|
|
|
InsertArray( String , Int32, Int32, Boolean) |
Imports an array of strings into a worksheet.
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>
|
|
|
InsertArray T ( T , Int32, Int32, Boolean, Boolean) |
Inserts an array of objects into a worksheet.
|
|
|
InsertArrayList(ArrayList, Int32, Int32, Boolean) |
Imports an arraylist of data into a worksheet.
|
|
|
InsertArrayList(ArrayList, Int32, Int32, Boolean, Boolean) |
Imports an arraylist of data into a worksheet.
|
|
|
InsertColumn(Int32) |
Inserts a new column into the worksheet.
|
|
|
InsertColumn(Int32, Int32) |
Inserts specified number column into the worksheet.
|
|
|
InsertColumn(Int32, Int32, InsertOptionsType) |
Inserts an empty column with default formatting.
|
|
|
InsertCutRange |
Insert cut range into worksheet at specified position.
|
|
|
InsertDataColumn |
Imports data column.
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> |
|
|
InsertDataColumns |
Imports array of data columns.
|
|
|
InsertDataTable(DataTable, Boolean, Int32, Int32) |
Imports data from a DataTable into worksheet.
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> |
|
|
InsertDataTable(DataTable, Boolean, Int32, Int32, Boolean) |
Imports data from a DataTable into worksheet.
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> |
|
|
InsertDataTable(DataTable, Boolean, Int32, Int32, Int32, Int32) |
Imports data from a DataTable into worksheet.
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> |
|
|
InsertDataTable(DataTable, Boolean, Int32, Int32, Int32, Int32, Boolean) |
Imports data from a DataTable into worksheet.
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> |
|
|
InsertDataTable(DataTable, Boolean, Int32, Int32, Int32, Int32, DataColumn , Boolean) |
Imports data from a DataTable into worksheet
|
|
|
InsertDataView(DataView, Boolean, Int32, Int32) |
Imports data from a DataView into worksheet.
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> |
|
|
InsertDataView(DataView, Boolean, Int32, Int32, Boolean) |
Imports data from a DataView into worksheet.
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> |
|
|
InsertDataView(DataView, Boolean, Int32, Int32, Int32, Int32) |
Imports data from a DataView into worksheet.
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> |
|
|
InsertDataView(DataView, Boolean, Int32, Int32, Int32, Int32, Boolean) |
Imports data from a DataView into worksheet.
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> |
|
|
InsertRange |
Insert a cell range into worksheet
|
|
|
InsertRow(Int32) |
Inserts a new row into the worksheet.
|
|
|
InsertRow(Int32, Int32) |
Inserts multiple rows into the worksheet.
|
|
|
InsertRow(Int32, Int32, InsertOptionsType) |
Inserts an empty row with default formatting.
|
|
|
IntersectRanges |
Intersects two ranges and returns the resulting range.
|
|
|
IsArrayFormula(Int64) |
Obsolete.
Indicates whether cell contains array-entered formula.
|
|
|
IsArrayFormula(Int32, Int32) |
Indicates whether cell contains array-entered formula.
|
|
|
IsColumnVisible |
Indicates whether column is visible.
|
|
|
IsExternalFormula |
Indicates is formula in cell is formula to external workbook.
|
|
|
IsRowVisible |
Indicates whether row is visible.
|
|
|
MemberwiseClone |
Creates a shallow copy of the current
Object
.
(Inherited from
Object
.)
|
|
|
MergeRanges |
Merges two ranges if they have the same dimensions and are adjacent.
|
|
|
MoveSheet |
Moves sheet into new position, including chartsheet and worksheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
MoveWorksheet |
Moves worksheet into new position.
|
|
|
OnDispose |
Method which can be overriden by users to take any specific actions when
object is disposed.
(Inherited from
XlsObject
.)
|
|
|
PixelsToColumnWidth |
Converts pixels count into column width value.
|
|
|
Protect(String) |
Protects worksheet with password.protect the sheet except select lock/unlock cells.
(Inherited from
XlsWorksheetBase
.)
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>
|
|
|
Protect(String, SheetProtectionType) |
Protects worksheet with password.
(Inherited from
XlsWorksheetBase
.)
|
|
|
ReleaseReference |
Decrease quantity of Reference. User must call this method
when freeing resources.
(Inherited from
XlsObject
.)
|
|
|
Remove |
Removes worksheet from parernt worksheets collection.
|
|
|
RemoveMergedCells |
Removes all merged cells within the specified range.
|
|
|
RemovePanes |
Removes panes from a worksheet.
|
|
|
ReparseFormula |
Reparses all formulas on this sheet.
|
|
|
Replace(String, DateTime) |
Replaces cells' values with new data.
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>
|
|
|
Replace(String, Double) |
Replaces cells' values with new data.
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>
|
|
|
Replace(String, String) |
Replaces cells' values with new data.
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>
|
|
|
Replace(String, DataColumn, Boolean) |
Replaces cells' values with new data.
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>
|
|
|
Replace(String, DataTable, Boolean) |
Replaces cells' values with new data.
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>
|
|
|
Replace(String, Double , Boolean) |
Replaces cells' values with new data.
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>
|
|
|
Replace(String, Int32 , Boolean) |
Replaces cells' values with new data.
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>
|
|
|
Replace(String, String , Boolean) |
Replaces cells' values with new data.
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>
|
|
|
ReplaceAll(String, String, Boolean) |
Replaces all occurrences of a specified value with a new value in the worksheet.
|
|
|
ReplaceAll(String, CellStyle, String, CellStyle) |
Replaces cells' values with new data and style.
|
|
|
SaveAndGetShapesToImage |
Save option specify shapes to image, and get option specify shapes together.
|
|
|
SaveShapesToImage |
Save option specify shapes to image.
|
|
|
SaveToEMFImage |
Obsolete.
Converts range into EMF format image.
|
|
|
SaveToFile(String, String) |
Save worksheet to file.
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>
|
|
|
SaveToFile(String, String, Boolean) |
Save worksheet to file.
|
|
|
SaveToFile(String, String, Encoding) |
Save worksheet to file..
|
|
|
SaveToFile(String, String, Encoding, Boolean) |
Save worksheet to file..
|
|
|
SaveToHtml(Stream) |
Save to HTML stream.
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>
|
|
|
SaveToHtml(String) |
Save to HTML file.
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>
|
|
|
SaveToHtml(Stream, HTMLOptions) |
Saves work sheet to HTML.
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>
|
|
|
SaveToHtml(String, HTMLOptions) |
Saves as HTML.
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>
|
|
|
SaveToImage(String) |
Save worksheet to image.
|
|
|
SaveToImage(String, ImageFormat) |
Save worksheet to image.
|
|
|
SaveToImage(Int32, Int32, Int32, Int32) |
Obsolete.
Save worksheet to image.
|
|
|
SaveToImage(String, Int32, Int32, Int32, Int32) |
Save worksheet to image.
|
|
|
SaveToImage(Stream, Int32, Int32, Int32, Int32, ImageType) |
Save worksheet into image.
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>
|
|
|
SaveToImage(Stream, Int32, Int32, Int32, Int32, EmfType) |
Obsolete.
Converts range into image.
|
|
|
SaveToImage(Stream, Int32, Int32, Int32, Int32, ImageType, EmfType) |
Obsolete.
Converts range into image.
|
|
|
SaveToPdf(String) |
Save worksheet to pdf.
|
|
|
SaveToPdf(String, FileFormat) |
Obsolete.
Save worksheet to pdf.
|
|
|
SaveToPdfStream(Stream) |
Save worksheet to pdf Stream.
|
|
|
SaveToPdfStream(Stream, FileFormat) |
Obsolete.
Saves the document to a PDF stream with the specified file format.
|
|
|
SaveToStream(Stream, String) |
Save worksheet to stream.
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>
|
|
|
SaveToStream(Stream, String, Boolean) |
Save worksheet to stream.
|
|
|
SaveToStream(Stream, String, Encoding) |
Save worksheet to stream.
|
|
|
SaveToStream(Stream, String, Encoding, Boolean) |
Save worksheet to stream.
|
|
|
SaveToXps |
Saves specific worksheet to xps.
|
|
|
Select |
Selects current tab sheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
SelectTab |
Adds sheet tab to the selected tab.
(Inherited from
XlsWorksheetBase
.)
|
|
|
SetActiveCell(IXLSRange) |
Sets active cell
|
|
|
SetActiveCell(IXLSRange, Boolean) |
Sets active cell
|
|
|
SetBlank |
Sets blank in specified cell.
|
|
|
SetBoolean |
Sets value in the specified cell.
|
|
|
SetCaculateValue |
Obsolete.
Sets the value of a cell.
|
|
|
SetCalculateValue |
Sets the value of a cell.
|
|
|
SetCellValue(Int32, Int32, Boolean) |
Sets value in the specified cell.
|
|
|
SetCellValue(Int32, Int32, String) |
Sets value in the specified cell.
|
|
|
SetChanged |
This method should be called after any changes in the worksheet.
Sets Saved property of the parent workbook to false.
(Inherited from
XlsWorksheetBase
.)
|
|
|
SetColumnWidth |
Set solumn width
|
|
|
SetColumnWidthInPixels(Int32, Int32) |
Sets column width in pixels.
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>
|
|
|
SetColumnWidthInPixels(Int32, Int32, Int32) |
Sets the width of the specified columns.
|
|
|
SetDefaultColumnStyle(Int32, IStyle) |
Sets default style for column.
|
|
|
SetDefaultColumnStyle(Int32, Int32, IStyle) |
Sets by column index default style for column.
|
|
|
SetDefaultRowStyle(Int32, IStyle) |
Sets bdefault style for row.
|
|
|
SetDefaultRowStyle(Int32, Int32, IStyle) |
Sets by column index default style for row.
|
|
|
SetError(Int32, Int32, String) |
Sets error in the specified cell.
|
|
|
SetError(Int32, Int32, String, Boolean) |
Sets error in the specified cell.
|
|
|
SetFirstColumn |
Updates first column indexe.
|
|
|
SetFirstRow |
Updates first row index.
|
|
|
SetFormula(Int32, Int32, String) |
Sets formula in the specified cell.
|
|
|
SetFormula(Int32, Int32, String, Boolean) |
Sets formula in the specified cell.
|
|
|
SetFormulaBoolValue |
Sets formula bool value.
|
|
|
SetFormulaErrorValue |
Sets formula error value.
|
|
|
SetFormulaNumberValue |
Sets formula number value.
|
|
|
SetFormulaStringValue |
Sets formula string value.
|
|
|
SetLastColumn |
Updates last column index.
|
|
|
SetLastRow |
Updates last row index.
|
|
|
SetNumber |
Sets value in the specified cell.
|
|
|
SetParent |
Sets parent of the object.
(Inherited from
XlsObject
.)
|
|
|
SetRowHeight |
Sets the height of the specified row.
|
|
|
SetRowHeightInPixels |
Set Row height from Start Row index
|
|
|
SetRowHeightPixels |
Sets the height of the specified row.
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>
|
|
|
SetText |
Sets text in the specified cell.
|
|
|
SetValue |
Sets the value of a cell in the grid.
|
|
|
ShowColumn |
Shows a column.
|
|
|
ShowRow |
Shows a row.
|
|
|
Subtotal(IXLSRange, Int32, Int32 , SubtotalTypes) |
Creates subtotals for the range.
|
|
|
Subtotal(IXLSRange, Int32, Int32 , SubtotalTypes, Boolean, Boolean, Boolean) |
Creates subtotals for the range.
|
|
|
ToEMFStream(Stream, Int32, Int32, Int32, Int32) |
Converts a range of cells in the worksheet to an EMF (Enhanced Metafile) stream.
|
|
|
ToEMFStream(Stream, Int32, Int32, Int32, Int32, EmfType) |
Converts a range of cells in the worksheet to an EMF (Enhanced Metafile) stream.
|
|
|
ToImage |
Convert worksheet to Image.
|
|
|
ToString |
Returns a string that represents the current object.
(Inherited from
Object
.)
|
|
|
ToSVGStream |
Convert CellRange to Svg stream
|
|
|
UngroupByColumns |
Ungroups columns.
|
|
|
UngroupByRows |
Ungroups rows.
|
|
|
Unprotect |
Unprotects this wokrsheet.
(Inherited from
XlsWorksheetBase
.)
|
|
|
Unprotect(String) |
Unprotects this worksheet using specified password.
(Inherited from
XlsWorksheetBase
.)
|
|
|
Unselect |
Unselects current tab sheet if possible.
(Inherited from
XlsWorksheetBase
.)
|
|
|
Unselect(Boolean) |
Unselects current tab sheet if possible.
(Inherited from
XlsWorksheetBase
.)
|
| Name | Description | |
|---|---|---|
|
|
CellValueChanged |
Represents the event handler for the CellValueChanged event of the XlsRange class.
|
| Name | Description | |
|---|---|---|
|
|
m_bIsDisposed |
Flag which indicates if the object was disposed or not.
(Inherited from
XlsObject
.)
|
|
|
m_book |
Represents the workbook object.
(Inherited from
XlsWorksheetBase
.)
|
|
|
m_iFirstColumn |
The first column index, initialized to the default minimum column index.
(Inherited from
XlsWorksheetBase
.)
|
|
|
m_iFirstRow |
One field from Worksheet dimension records.
(Inherited from
XlsWorksheetBase
.)
|
|
|
m_iLastColumn |
One field from Worksheet dimension records.
(Inherited from
XlsWorksheetBase
.)
|
|
|
m_iLastRow |
One field from Worksheet dimension records
(Inherited from
XlsWorksheetBase
.)
|