public class WorksheetImpl : WorksheetBaseImpl, IDisposable, ISerializableNamedObject, INamedObject, IParseable, ICloneParent, IInternalWorksheet, IWorksheet, ITabSheet, IParentApplication, ISheetData, ICalcData

Constructors

WorksheetImpl(IApplication, Object)

Initializes a new instance of the Worksheet class with specified application and parent properties.

Declaration

public WorksheetImpl(IApplication application, object parent)

Parameters

Type	Name	Description
IApplication	application	Application object for the worksheet.
System.Object	parent	Parent object for the worksheet.

WorksheetImpl(IApplication, Object, BiffReader, ExcelParseOptions, Boolean, Dictionary<Int32, Int32>, IDecryptor)

Initializes a new instance of the Worksheet class with specified parsing option along with application and parent properties.

Declaration

public WorksheetImpl(IApplication application, object parent, BiffReader reader, ExcelParseOptions options, bool bSkipParsing, Dictionary<int, int> hashNewXFormatIndexes, IDecryptor decryptor)

Parameters

Type	Name	Description
IApplication	application	Application object for the worksheet.
System.Object	parent	Parent object for the worksheet.
BiffReader	reader	reader object for the worksheet data.
ExcelParseOptions	options	Parse options.
System.Boolean	bSkipParsing	Indicates whether to skip the parsing of data or not.
System.Collections.Generic.Dictionary<System.Int32, System.Int32>	hashNewXFormatIndexes	Dictionary with new extended format indexes used in ignore styles mode.
IDecryptor	decryptor	Object used to decrypt encrypted records.

Properties

ActivePane

Gets or sets index of the active pane.

Declaration

public int ActivePane { get; set; }

Property Value

Type
System.Int32

AutoFilters

Gets the auto filters collection in the worksheet. Read-only.

Declaration

public IAutoFilters AutoFilters { get; }

Property Value

Type
IAutoFilters

CalcEngine

Gets or sets the a CalcEngine object associated with ICalcData implementation.

Declaration

public CalcEngine CalcEngine { get; set; }

Property Value

Type
CalcEngine

CellRecords

Returns collection of cell records. Read-only.

Declaration

public CellRecordCollection CellRecords { get; }

Property Value

Type
CellRecordCollection

Cells

Gets the used cells in the worksheet. Read-only.

Declaration

public IRange[] Cells { get; }

Property Value

Type
IRange[]

ColumnInformation

Read-only. Access to column info records.

Declaration

public ColumnInfoRecord[] ColumnInformation { get; }

Property Value

Type
ColumnInfoRecord[]

Columns

Gets a Range object that represents all the columns in the specified worksheet. Read-only.

Declaration

public IRange[] Columns { get; }

Property Value

Type
IRange[]

ColumnsOutlineLevel

Returns the columns outline level count

Declaration

public int ColumnsOutlineLevel { get; }

Property Value

Type
System.Int32

ConditionalFormats

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

Declaration

public WorksheetConditionalFormats ConditionalFormats { get; }

Property Value

Type
WorksheetConditionalFormats

ContainsProtection

Returns if contains protection

Declaration

protected override bool ContainsProtection { get; }

Property Value

Type
System.Boolean

Overrides

WorksheetBaseImpl.ContainsProtection

CustomProperties

Gets a collection of custom properties of the worksheet. Read-only.

Declaration

public IWorksheetCustomProperties CustomProperties { get; }

Property Value

Type
IWorksheetCustomProperties

DataSorter

Gets the DataSorter.

Declaration

public IDataSort DataSorter { get; }

Property Value

Type	Description
IDataSort	The DataSorter.

Examples

The following code illustrates how to get the DataSorter from the sheet.

ExcelEngine excelEngine = new ExcelEngine();
IApplication application = excelEngine.Excel;
application.DefaultVersion = ExcelVersion.Excel2013;
IWorkbook workbook = application.Workbooks.Open("Sorting.xlsx");

//Create DataSorter for worksheet.
IDataSort sheetSort = workbook.Worksheets[0].DataSorter;

//Adding Sort range for worksheet
sheetSort.SortRange = workbook.Worksheets[0].UsedRange;

//Adding Sorting fields for DataSorter.
sheetSort.SortFields.Add(1, SortOn.Values, OrderBy.Ascending);

//Perform Sorting for worksheet range.
sheetSort.Sort();

workbook.SaveAs("SortedExcel.xlsx");
workbook.Close();
excelEngine.Dispose();

DefaultProtectionOptions

Gets default protection options for the worksheet.

Declaration

protected override ExcelSheetProtection DefaultProtectionOptions { get; }

Property Value

Type
ExcelSheetProtection

Overrides

WorksheetBaseImpl.DefaultProtectionOptions

DefaultRowHeight

Return default row height in pixel.

Declaration

public int DefaultRowHeight { get; set; }

Property Value

Type
System.Int32

DisplayPageBreaks

Gets or sets a value that indicates whether page breaks (both automatic and manual) on the worksheet are displayed.

Declaration

public bool DisplayPageBreaks { get; set; }

Property Value

Type
System.Boolean

DVTable

Gets data validation collection.

Declaration

public DataValidationTable DVTable { get; }

Property Value

Type
DataValidationTable

ErrorIndicators

Represents error indicators.

Declaration

public ErrorIndicatorsCollection ErrorIndicators { get; }

Property Value

Type
ErrorIndicatorsCollection

FirstVisibleColumn

Gets or sets the first visible column index.

Declaration

public int FirstVisibleColumn { get; set; }

Property Value

Type
System.Int32

FirstVisibleRow

Gets or sets the first visible row index.

Declaration

public int FirstVisibleRow { get; set; }

Property Value

Type
System.Int32

HasMergedCells

Indicates whether worksheet has merged cells. Read-only.

Declaration

public bool HasMergedCells { get; }

Property Value

Type
System.Boolean

HasOleObject

Gets whether the OLE object is present in the worksheet. Read-only.

Declaration

public bool HasOleObject { get; }

Property Value

Type	Description
System.Boolean	True if this instance is OLE object; otherwise, False.

Remarks

This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

HorizontalSplit

Gets or sets the position of horizontal split in the worksheet.

Declaration

public int HorizontalSplit { get; set; }

Property Value

Type
System.Int32

Remarks

Position of the horizontal split (by, 0 = No horizontal split): Unfrozen pane: Height of the top pane(s) (in twips = 1/20 of a point) Frozen pane: Number of visible rows in top pane(s)

HPageBreaks

Gets a HPageBreaksCollection that represents the horizontal page breaks in the worksheet. Read-only.

Declaration

public IHPageBreaks HPageBreaks { get; }

Property Value

Type
IHPageBreaks

HyperLinks

Gets a hyperlink collections in the worksheet. Read-only.

Declaration

public IHyperLinks HyperLinks { get; }

Property Value

Type
IHyperLinks

InnerCustomProperties

Returns collection of the custom properties. Read-only.

Declaration

public WorksheetCustomProperties InnerCustomProperties { get; }

Property Value

Type
WorksheetCustomProperties

InnerDVTable

Returns inner data validation table. Read-only.

Declaration

public DataValidationTable InnerDVTable { get; }

Property Value

Type
DataValidationTable

InnerHyperLinks

Collection of all hyperlinks in the current worksheet.

Declaration

public HyperLinksCollection InnerHyperLinks { get; }

Property Value

Type
HyperLinksCollection

InnerHyperLinksOrNull

Collection of all hyperlinks in the current worksheet.

Declaration

public HyperLinksCollection InnerHyperLinksOrNull { get; }

Property Value

Type
HyperLinksCollection

InnerListObjects

Gets collection of all list objects in the worksheet.

Declaration

public ListObjectCollection InnerListObjects { get; }

Property Value

Type
ListObjectCollection

InnerNames

Returns inner names collection. Read-only.

Declaration

public WorksheetNamesCollection InnerNames { get; }

Property Value

Type
WorksheetNamesCollection

InnerPivotTables

Retruns internal pivot table collection. Read-only.

Declaration

public PivotTableCollection InnerPivotTables { get; }

Property Value

Type
PivotTableCollection

IsDisplayZeros

True if zero values to be displayed. otherwise, False.

Declaration

public bool IsDisplayZeros { get; set; }

Property Value

Type
System.Boolean

IsEmpty

Indicates whether worksheet is empty. Read-only.

Declaration

public bool IsEmpty { get; }

Property Value

Type
System.Boolean

IsFreezePanes

Defines whether freezed panes are applied.

Declaration

public bool IsFreezePanes { get; }

Property Value

Type
System.Boolean

IsGridLinesVisible

True if grid lines are visible. otherwise, False.

Declaration

public bool IsGridLinesVisible { get; set; }

Property Value

Type
System.Boolean

IsRowColumnHeadersVisible

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

Declaration

public bool IsRowColumnHeadersVisible { get; set; }

Property Value

Type
System.Boolean

IsStringsPreserved

True if all values in the worksheet are preserved as strings. otherwise, False.

Declaration

public bool IsStringsPreserved { get; set; }

Property Value

Type
System.Boolean

Item[Int32, Int32]

Gets or sets cell range by row and column index. Row and column indexes are one-based.

Declaration

public IRange this[int row, int column] { get; }

Parameters

Type	Name	Description
System.Int32	row	One-based row index.
System.Int32	column	One-based column index.

Property Value

Type
IRange

Item[Int32, Int32, Int32, Int32]

Get cell Range. Row and column indexes are one-based. Read-only.

Declaration

public IRange this[int row, int column, int lastRow, int lastColumn] { get; }

Parameters

Type	Name	Description
System.Int32	row	First row index. One-based.
System.Int32	column	First column index. One-based.
System.Int32	lastRow	Last row index. One-based.
System.Int32	lastColumn	Last column index. One-based.

Property Value

Type
IRange

Item[String]

Gets cell Range. Read-only.

Declaration

public IRange this[string name] { get; }

Parameters

Type	Name	Description
System.String	name

Property Value

Type
IRange

Item[String, Boolean]

Gets cell Range with R1C1Notation flag. Read-only.

Declaration

public IRange this[string name, bool IsR1C1Notation] { get; }

Parameters

Type	Name	Description
System.String	name
System.Boolean	IsR1C1Notation

Property Value

Type
IRange

ListObjects

Gets a collection of list objects in the worksheet. Read-only.

Declaration

public IListObjects ListObjects { get; }

Property Value

Type
IListObjects

MergeCells

Read-only. Access to merged cells.

Declaration

public MergeCellsImpl MergeCells { get; }

Property Value

Type
MergeCellsImpl

MergedCells

Gets all the merged ranges in the worksheet. Read-only.

Declaration

public IRange[] MergedCells { get; }

Property Value

Type
IRange[]

MigrantRange

Gets instance of migrant range. Read-only.

Declaration

public IMigrantRange MigrantRange { get; }

Property Value

Type
IMigrantRange

Remarks

The IMigrantRange interface can also be used to access a single cell or group of cells and manipulate it. You can prefer IMigrantRange instead of IRange while writing large amount of data which is an optimal way. Row and Column index can be changed by using ResetRowColumn(Int32, Int32) method.

Names

Gets a Names collection that represents the worksheet-specific names (names defined with the "WorksheetName!" prefix) in the worksheet. Read-only.

Declaration

public INames Names { get; }

Property Value

Type
INames

OleObjects

Gets a collection of OleObjects in the worksheet.

Declaration

public IOleObjects OleObjects { get; }

Property Value

Type	Description
IOleObjects	The OLE objects.

Remarks

This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

OutlineWrappers

Returns or sets the list of outline wrapper collection

Declaration

public List<IOutlineWrapper> OutlineWrappers { get; set; }

Property Value

Type
System.Collections.Generic.List<IOutlineWrapper>

PageSetup

Gets a PageSetup object that contains all the page setup settings for the specified object. Read-only.

Declaration

public IPageSetup PageSetup { get; }

Property Value

Type
IPageSetup

PageSetupBase

Returns a PageSetup object that contains all the page setup settings for the specified object. Read-only.

Declaration

public override PageSetupBaseImpl PageSetupBase { get; }

Property Value

Type
PageSetupBaseImpl

Overrides

WorksheetBaseImpl.PageSetupBase

Pane

Gets pain record or null. Read-only.

Declaration

public PaneRecord Pane { get; }

Property Value

Type
PaneRecord

PaneFirstVisible

Gets or sets range indicating first visible row and column.

Declaration

public IRange PaneFirstVisible { get; set; }

Property Value

Type
IRange

PivotTables

Gets a collection of pivot tables in the worksheet. Read-only.

Declaration

public IPivotTables PivotTables { get; }

Property Value

Type
IPivotTables

PrintArea

Worksheet's print area.

Declaration

public IRange PrintArea { get; }

Property Value

Type
IRange

ProtectContents

Indicates is current sheet is protected.

Declaration

public override bool ProtectContents { get; }

Property Value

Type
System.Boolean

Overrides

WorksheetBaseImpl.ProtectContents

QuotedName

Returns quoted name of the worksheet.

Declaration

public string QuotedName { get; }

Property Value

Type
System.String

Range

Gets a Range object that represents a cell or a range of cells in the worksheet.

Declaration

public IRange Range { get; }

Property Value

Type
IRange

RecordExtractor

Returns object used for records creation/extraction from data provider. Read-only.

Declaration

public RecordExtractor RecordExtractor { get; }

Property Value

Type
RecordExtractor

Rows

Gets a Range object that represents the rows in the specified worksheet. Read-only.

Declaration

public IRange[] Rows { get; }

Property Value

Type
IRange[]

RowsOutlineLevel

Returns the rows outline level count

Declaration

public int RowsOutlineLevel { get; }

Property Value

Type
System.Int32

Scenarios

Get the scenarios collection for the current worksheet.

Declaration

public IScenarios Scenarios { get; }

Property Value

Type
IScenarios

SelectionCount

Gets a value indicating selection count of pane.

Declaration

public int SelectionCount { get; }

Property Value

Type
System.Int32

Selections

Gets array with selection records or null. Read-only.

Declaration

public List<SelectionRecord> Selections { get; }

Property Value

Type
System.Collections.Generic.List<SelectionRecord>

Slicers

Gets the Slicers.

Declaration

public ISlicers Slicers { get; }

Property Value

Type
ISlicers

SparklineGroups

Gets the sparkline groups.

Declaration

public ISparklineGroups SparklineGroups { get; }

Property Value

Type	Description
ISparklineGroups	The sparkline groups.

SplitCell

Gets split cell range.

Declaration

public IRange SplitCell { get; set; }

Property Value

Type
IRange

StandardHeight

Gets or sets the standard (default) height of all the rows in the worksheet, in points. Standard Height sets the height for each row if the row contains data. So To improve performance, set standard height of the worksheet before set value in cells.

Declaration

public double StandardHeight { get; set; }

Property Value

Type
System.Double

StandardHeightFlag

Gets or sets the standard (default) height option flag.

Declaration

public bool StandardHeightFlag { get; set; }

Property Value

Type
System.Boolean

Remarks

Which defines that standard (default) row height and book default font height do not match.

StandardWidth

Gets or sets the standard (default) width of all the columns in the worksheet.

Declaration

public double StandardWidth { get; set; }

Property Value

Type
System.Double

ThreadedComments

Gets the threaded comments collection for a current worksheet.

Declaration

public IThreadedComments ThreadedComments { get; }

Property Value

Type	Description
IThreadedComments	The IThreadedComments collection.

TopLeftCell

Gets top left cell of the worksheet.

Declaration

public IRange TopLeftCell { get; set; }

Property Value

Type
IRange

Type

Gets the worksheet type. Read-only ExcelSheetType.

Declaration

public ExcelSheetType Type { get; set; }

Property Value

Type
ExcelSheetType

UnprotectedOptions

Returns un protected options

Declaration

protected override ExcelSheetProtection UnprotectedOptions { get; }

Property Value

Type
ExcelSheetProtection

Overrides

WorksheetBaseImpl.UnprotectedOptions

UsedCells

Gets all not empty or accessed cells. Read-only.

Declaration

public IRange[] UsedCells { get; }

Property Value

Type
IRange[]

Remarks

WARNING: This property creates Range object for each cell in the worksheet and creates new array each time user calls to it. It can cause huge memory usage especially if called frequently.

UsedRange

Gets a Range object that represents the used range on the specified worksheet. Read-only.

Declaration

public IRange UsedRange { get; }

Property Value

Type
IRange

UsedRangeIncludesFormatting

Gets or sets whether used range should include cells with formatting.

Declaration

public bool UsedRangeIncludesFormatting { get; set; }

Property Value

Type
System.Boolean

Remarks

There are two different algorithms to create UsedRange object:

Default. This property = true. The cell is included into UsedRange, even data is empty (maybe some formatting changed, maynot be - cell was accessed and record was created).
This property = false. In this case XlsIO tries to remove empty rows and columns from all sides to make UsedRange smaller.

UseRangesCache

Indicates whether all created range objects should be cached or not.

Declaration

public bool UseRangesCache { get; set; }

Property Value

Type
System.Boolean

Version

Gets or sets excel version.

Declaration

public ExcelVersion Version { get; set; }

Property Value

Type
ExcelVersion

VerticalSplit

Gets or sets the position of vertical split in the worksheet.

Declaration

public int VerticalSplit { get; set; }

Property Value

Type
System.Int32

Remarks

Position of the vertical split (px, 0 = No vertical split): Unfrozen pane: Width of the left pane(s) (in twips = 1/20 of a point) Frozen pane: Number of visible columns in left pane(s)

View

Gets or sets the view setting of the worksheet.

Declaration

public SheetView View { get; set; }

Property Value

Type
SheetView

VPageBreaks

Gets a VPageBreaksCollection that represents the vertical page breaks on the sheet. Read-only.

Declaration

public IVPageBreaks VPageBreaks { get; }

Property Value

Type
IVPageBreaks

Methods

add_CellValueChanged(RangeImpl.CellValueChangedEventHandler)

Declaration

public void add_CellValueChanged(RangeImpl.CellValueChangedEventHandler value)

Parameters

Type	Name	Description
RangeImpl.CellValueChangedEventHandler	value

add_ColumnWidthChanged(ValueChangedEventHandler)

Declaration

public void add_ColumnWidthChanged(ValueChangedEventHandler value)

Parameters

Type	Name	Description
Syncfusion.XlsIO.Implementation.ValueChangedEventHandler	value

add_ExportDataTableEvent(WorksheetImpl.ExportDataTableEventHandler)

Declaration

public void add_ExportDataTableEvent(WorksheetImpl.ExportDataTableEventHandler value)

Parameters

Type	Name	Description
WorksheetImpl.ExportDataTableEventHandler	value

add_MissingFunction(MissingFunctionEventHandler)

Declaration

public void add_MissingFunction(MissingFunctionEventHandler value)

Parameters

Type	Name	Description
MissingFunctionEventHandler	value

add_RowHeightChanged(ValueChangedEventHandler)

Declaration

public void add_RowHeightChanged(ValueChangedEventHandler value)

Parameters

Type	Name	Description
Syncfusion.XlsIO.Implementation.ValueChangedEventHandler	value

add_ValueChanged(ValueChangedEventHandler)

Declaration

public void add_ValueChanged(ValueChangedEventHandler value)

Parameters

Type	Name	Description
ValueChangedEventHandler	value

AddNote(NoteRecord)

Adds note

Declaration

protected void AddNote(NoteRecord note)

Parameters

Type	Name	Description
NoteRecord	note	Specifies a comment associated with a particular cell

AdvancedFilter(ExcelFilterAction, IRange, IRange, IRange, Boolean)

Filters or copies data from a list based on a criteria range..

Declaration

public void AdvancedFilter(ExcelFilterAction action, IRange filterRange, IRange criteriaRange, IRange copyToRange, bool isUnique)

Parameters

Type	Name	Description
ExcelFilterAction	action	Whether filter in the place or copy to another place.
IRange	filterRange	The filter range.
IRange	criteriaRange	The criteria range.
IRange	copyToRange	The destination range for the copied rows if ExcelFilterAction is FilterCopy. Otherwise, this argument is ignored.
System.Boolean	isUnique	True to filter unique records; Otherwise filters all the records that meet the criteria. The default value is False.

AttachEvents()

Binds the specified function to an event, so that the function gets called whenever the event fires on the object.

Declaration

protected void AttachEvents()

AutofitColumn(Int32)

Changes the width of the specified column to achieve the best fit.

Declaration

public void AutofitColumn(int colIndex)

Parameters

Type	Name	Description
System.Int32	colIndex	Column index.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET, ASP.NET MVC, WinRT, Windows Phone, Universal, UWP, Xamarin and NetStandard platforms only.

AutofitColumn(Int32, Int32, Int32)

Autofits column by checking only the cells in the column that are specified by row range

Declaration

public void AutofitColumn(int colIndex, int firstRow, int lastRow)

Parameters

Type	Name	Description
System.Int32	colIndex	Column index.
System.Int32	firstRow	One-based index of the first row to be used for autofit operation.
System.Int32	lastRow	One-based index of the last row to be used for autofit operation.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET, ASP.NET MVC, WinRT, Windows Phone, Universal, UWP, Xamarin and NetStandard platforms only.

AutofitRow(Int32)

Changes the height of the specified row to achieve the best fit.

Declaration

public void AutofitRow(int rowIndex)

Parameters

Type	Name	Description
System.Int32	rowIndex	Row Index

Remarks

This method is supported on Windows Forms, WPF, ASP.NET, ASP.NET MVC, WinRT, Windows Phone, Universal, UWP, Xamarin and NetStandard platforms only.

AutofitRow(Int32, Int32, Int32, Boolean)

Autofits row by checking only the cells in the row that are specified by column range

Declaration

public void AutofitRow(int rowIndex, int firstColumn, int lastColumn, bool bRaiseEvents)

Parameters

Type	Name	Description
System.Int32	rowIndex	Row index.
System.Int32	firstColumn	One-based index of the first column to be used for autofit operation.
System.Int32	lastColumn	One-based index of the last column to be used for autofit operation.
System.Boolean	bRaiseEvents	If true then raise events.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET, ASP.NET MVC, WinRT, Windows Phone, Universal, UWP, Xamarin and NetStandard platforms only.

Calculate()

Calculate all the formulas in worksheet.

Declaration

public void Calculate()

Examples

The following code illustrates how to calculate all the formulas in the worksheet.

ExcelEngine excelEngine = new ExcelEngine();
IApplication application = excelEngine.Excel;
application.DefaultVersion = ExcelVersion.Excel2013;
IWorkbook workbook = application.Workbooks.Open("Formulas.xlsx");
IWorksheet worksheet = workbook.Worksheets[0];

// Calculate all the formulas in the worksheet.
worksheet.Calculate();

workbook.SaveAs("Calculation.xlsx");
workbook.Close();
excelEngine.Dispose();

CanInsertColumn(Int32, Int32, ExcelInsertOptions)

Checks whether it is possible to insert column into iRowIndex.

Declaration

public bool CanInsertColumn(int iColumnIndex, int iColumnCount, ExcelInsertOptions options)

Parameters

Type	Name	Description
System.Int32	iColumnIndex	Index of column to insert.
System.Int32	iColumnCount	Number of columns to insert.
ExcelInsertOptions	options	Insert options.

Returns

Type	Description
System.Boolean	True if it is possible to insert column.

CanInsertRow(Int32, Int32, ExcelInsertOptions)

Checks whether it is possible insert row into iRowIndex.

Declaration

public bool CanInsertRow(int iRowIndex, int iRowCount, ExcelInsertOptions options)

Parameters

Type	Name	Description
System.Int32	iRowIndex	Index of row to insert.
System.Int32	iRowCount	Number of rows to insert.
ExcelInsertOptions	options	Insert options.

Returns

Type	Description
System.Boolean	True if it is possible to insert row.

CanMove(ref IRange, IRange)

Indicates whether source range can be moved into new location.

Declaration

public bool CanMove(ref IRange destination, IRange source)

Parameters

Type	Name	Description
IRange	destination	Destination range.
IRange	source	Source range.

Returns

Type	Description
System.Boolean	True if source range can be moved.

CheckRangesSizes(IRange, IRange)

Checks the source snd destination ranges

Declaration

protected void CheckRangesSizes(IRange destination, IRange source)

Parameters

Type	Name	Description
IRange	destination	Destination range.
IRange	source	Source Range.

Clear()

Clears the worksheet data, formats and merged cells.

Declaration

public void Clear()

ClearAll()

Clear all internal collections.

Declaration

protected void ClearAll()

ClearAll(ExcelWorksheetCopyFlags)

Clear all internal collections but excluding mentioned flags.

Declaration

protected override void ClearAll(ExcelWorksheetCopyFlags flags)

Parameters

Type	Name	Description
ExcelWorksheetCopyFlags	flags	Allows to avoid clearing of some properties.

Overrides

WorksheetBaseImpl.ClearAll(ExcelWorksheetCopyFlags)

ClearData()

Clears the worksheet data.

Declaration

public void ClearData()

Clone(Object, Boolean)

Creates copy of the current object and indicates whether we should copy the shapes or not.

Declaration

public override object Clone(object parent, bool cloneShapes)

Parameters

Type	Name	Description
System.Object	parent	Parent object for the new object.
System.Boolean	cloneShapes	Indicates whether we should clone shapes or not.

Returns

Type	Description
System.Object	Copy of the current object.

Overrides

WorksheetBaseImpl.Clone(Object, Boolean)

ColumnWidthToPixels(Double)

Converts the specified column width from points to pixels.

Declaration

public int ColumnWidthToPixels(double widthInChars)

Parameters

Type	Name	Description
System.Double	widthInChars	Width in points.

Returns

Type	Description
System.Int32	Column width in pixels.

Contains(Int32, Int32)

Checks whether the specified cell is initialized or accessed.

Declaration

public bool Contains(int iRow, int iColumn)

Parameters

Type	Name	Description
System.Int32	iRow	One-based row index of the cell.
System.Int32	iColumn	One-based column index of the cell.

Returns

Type	Description
System.Boolean	True if the cell was initialized or accessed by the user; otherwise False.

ConvertToImage(IRange, ExportImageOptions, Stream)

Converts the specified range into image with the image settings given.

Declaration

public void ConvertToImage(IRange range, ExportImageOptions imageOptions, Stream outputStream)

Parameters

Type	Name	Description
IRange	range	The range which is to be converted to image.
ExportImageOptions	imageOptions	object that defines Image quality and image format to be used for conversion.
System.IO.Stream	outputStream	Stream to hold the converted image data.

ConvertToImage(IRange, Stream)

Converts the specified range into image with the image settings given.

Declaration

public void ConvertToImage(IRange range, Stream outputStream)

Parameters

Type	Name	Description
IRange	range	The range which is to be converted to image.
System.IO.Stream	outputStream	Stream to hold the converted image data.

ConvertToImage(Int32, Int32, Int32, Int32, ExportImageOptions, Stream)

Converts the specified range into image with the image options given. Default image format is PNG.

Declaration

public void ConvertToImage(int firstRow, int firstColumn, int lastRow, int lastColumn, ExportImageOptions imageOptions, Stream outputStream)

Parameters

Type	Name	Description
System.Int32	firstRow	First row index. One-based.
System.Int32	firstColumn	First column index. One-based.
System.Int32	lastRow	Last row index. One-based.
System.Int32	lastColumn	Last column index. One-based.
ExportImageOptions	imageOptions	object that defines Image quality and image format to be used for conversion.
System.IO.Stream	outputStream	Stream to hold the converted image data.

ConvertToImage(Int32, Int32, Int32, Int32, Stream)

Converts the specified range into image with the image options given. Default image format is PNG.

Declaration

public void ConvertToImage(int firstRow, int firstColumn, int lastRow, int lastColumn, Stream outputStream)

Parameters

Type	Name	Description
System.Int32	firstRow	First row index. One-based.
System.Int32	firstColumn	First column index. One-based.
System.Int32	lastRow	Last row index. One-based.
System.Int32	lastColumn	Last column index. One-based.
System.IO.Stream	outputStream	Stream to hold the converted image data.

CopyAutoFilters(WorksheetImpl)

Copies autofilters.

Declaration

protected void CopyAutoFilters(WorksheetImpl sourceSheet)

Parameters

Type	Name	Description
WorksheetImpl	sourceSheet	Base worksheet.

CopyCell(IRange, IRange)

Copies cell value from sourceCell into destCell. DOES NOT COPY FORMULAARRAYS (THIS SHOULD BE DONE IN DIFFERENT PLACE).

Declaration

protected void CopyCell(IRange destCell, IRange sourceCell)

Parameters

Type	Name	Description
IRange	destCell	Destination cell.
IRange	sourceCell	Source cell.

CopyCell(IRange, IRange, ExcelCopyRangeOptions)

Copies cell value from sourceCell into destCell. DOES NOT COPY FORMULAARRAYS (THIS SHOULD BE DONE IN DIFFERENT PLACE).

Declaration

protected void CopyCell(IRange destCell, IRange sourceCell, ExcelCopyRangeOptions options)

Parameters

Type	Name	Description
IRange	destCell	Destination cell.
IRange	sourceCell	Source cell.
ExcelCopyRangeOptions	options	Options for coping.

CopyCell(ICellPositionFormat, String, IDictionary, Int64, WorkbookImpl, Dictionary<Int32, Int32>, ExcelCopyRangeOptions)

Copies cell into another worksheet.

Declaration

public void CopyCell(ICellPositionFormat cell, string strFormulaValue, IDictionary dicXFIndexes, long lNewIndex, WorkbookImpl book, Dictionary<int, int> dicFontIndexes, ExcelCopyRangeOptions options)

Parameters

Type	Name	Description
ICellPositionFormat	cell	Cell to copy.
System.String	strFormulaValue	Formula string value of the cell.
System.Collections.IDictionary	dicXFIndexes	Dictionary with updated extended format indexes, or Null if indexes were not updated.
System.Int64	lNewIndex	New cell index
WorkbookImpl	book	Source workbook.
System.Collections.Generic.Dictionary<System.Int32, System.Int32>	dicFontIndexes	Dictionary with updated font indexes or Null if indexes were not updated.
ExcelCopyRangeOptions	options	Copy options.

CopyColumnWidth(WorksheetImpl, Dictionary<Int32, Int32>)

Copies column width.

Declaration

protected void CopyColumnWidth(WorksheetImpl sourceSheet, Dictionary<int, int> hashExtFormatIndexes)

Parameters

Type	Name	Description
WorksheetImpl	sourceSheet	Source worksheet.
System.Collections.Generic.Dictionary<System.Int32, System.Int32>	hashExtFormatIndexes	Array with new extended format indexes.

CopyConditionalFormats(WorksheetImpl)

Copies conditional formats.

Declaration

protected void CopyConditionalFormats(WorksheetImpl sourceSheet)

Parameters

Type	Name	Description
WorksheetImpl	sourceSheet	Base worksheet.

CopyDataValidations(WorksheetImpl)

Copies data validations.

Declaration

protected void CopyDataValidations(WorksheetImpl sourceSheet)

Parameters

Type	Name	Description
WorksheetImpl	sourceSheet	Base worksheet.

CopyFrom(WorksheetImpl, Dictionary<String, String>, Dictionary<String, String>, Dictionary<Int32, Int32>, ExcelWorksheetCopyFlags)

Copies all data from another worksheet.

Declaration

public void CopyFrom(WorksheetImpl worksheet, Dictionary<string, string> hashStyleNames, Dictionary<string, string> hashWorksheetNames, Dictionary<int, int> dicFontIndexes, ExcelWorksheetCopyFlags flags)

Parameters

Type	Name	Description
WorksheetImpl	worksheet	Parent worksheet.
System.Collections.Generic.Dictionary<System.String, System.String>	hashStyleNames	Dictionary with style names.
System.Collections.Generic.Dictionary<System.String, System.String>	hashWorksheetNames	Dictionary with new worksheet names.
System.Collections.Generic.Dictionary<System.Int32, System.Int32>	dicFontIndexes	Dictionary with new font indexes.
ExcelWorksheetCopyFlags	flags	Copy flags.

CopyFrom(WorksheetImpl, Dictionary<String, String>, Dictionary<String, String>, Dictionary<Int32, Int32>, ExcelWorksheetCopyFlags, Dictionary<Int32, Int32>, Dictionary<Int32, Int32>)

Copies all data from another worksheet.

Declaration

public void CopyFrom(WorksheetImpl worksheet, Dictionary<string, string> hashStyleNames, Dictionary<string, string> hashWorksheetNames, Dictionary<int, int> dicFontIndexes, ExcelWorksheetCopyFlags flags, Dictionary<int, int> hashExtFormatIndexes, Dictionary<int, int> hashNameIndexes)

Parameters

Type	Name	Description
WorksheetImpl	worksheet	Parent worksheet.
System.Collections.Generic.Dictionary<System.String, System.String>	hashStyleNames	Dictionary with style names.
System.Collections.Generic.Dictionary<System.String, System.String>	hashWorksheetNames	Dictionary with new worksheet names.
System.Collections.Generic.Dictionary<System.Int32, System.Int32>	dicFontIndexes	Dictionary with new font indexes.
ExcelWorksheetCopyFlags	flags	Copy flags.
System.Collections.Generic.Dictionary<System.Int32, System.Int32>	hashExtFormatIndexes	Dictionary with new extended format indexes.
System.Collections.Generic.Dictionary<System.Int32, System.Int32>	hashNameIndexes	Dictionary with new name indexes.

CopyFrom(WorksheetImpl, Dictionary<String, String>, Dictionary<String, String>, Dictionary<Int32, Int32>, ExcelWorksheetCopyFlags, Dictionary<Int32, Int32>, Dictionary<Int32, Int32>, Dictionary<Int32, Int32>)

Copies all data from another worksheet.

Declaration

public void CopyFrom(WorksheetImpl worksheet, Dictionary<string, string> hashStyleNames, Dictionary<string, string> hashWorksheetNames, Dictionary<int, int> dicFontIndexes, ExcelWorksheetCopyFlags flags, Dictionary<int, int> hashExtFormatIndexes, Dictionary<int, int> hashNameIndexes, Dictionary<int, int> hashExternSheets)

Parameters

Type	Name	Description
WorksheetImpl	worksheet	Parent worksheet.
System.Collections.Generic.Dictionary<System.String, System.String>	hashStyleNames	Dictionary with style names.
System.Collections.Generic.Dictionary<System.String, System.String>	hashWorksheetNames	Dictionary with new worksheet names.
System.Collections.Generic.Dictionary<System.Int32, System.Int32>	dicFontIndexes	Dictionary with new font indexes.
ExcelWorksheetCopyFlags	flags	Copy flags.
System.Collections.Generic.Dictionary<System.Int32, System.Int32>	hashExtFormatIndexes	Dictionary with new extended format indexes.
System.Collections.Generic.Dictionary<System.Int32, System.Int32>	hashNameIndexes	Dictionary with new name indexes.
System.Collections.Generic.Dictionary<System.Int32, System.Int32>	hashExternSheets	Represents collection with extern sheets indexes.

CopyMerges(WorksheetImpl)

Copies merged regions.

Declaration

protected void CopyMerges(WorksheetImpl sourceSheet)

Parameters

Type	Name	Description
WorksheetImpl	sourceSheet	Source worksheet.

CopyNames(WorksheetImpl, Dictionary<String, String>, Dictionary<Int32, Int32>, Dictionary<Int32, Int32>)

Copies names from another worksheet.

Declaration

protected void CopyNames(WorksheetImpl basedOn, Dictionary<string, string> hashNewSheetNames, Dictionary<int, int> hashNewNameIndexes, Dictionary<int, int> hashExternSheetIndexes)

Parameters

Type	Name	Description
WorksheetImpl	basedOn	Worksheet to copy names from.
System.Collections.Generic.Dictionary<System.String, System.String>	hashNewSheetNames	Dictionary with new worksheet names.
System.Collections.Generic.Dictionary<System.Int32, System.Int32>	hashNewNameIndexes	Dictionary, key - old name index, value - new name index.
System.Collections.Generic.Dictionary<System.Int32, System.Int32>	hashExternSheetIndexes	Represents hash table with new extern sheet indexes.

CopyOptions(WorksheetBaseImpl)

Copies different sheet options.

Declaration

protected override void CopyOptions(WorksheetBaseImpl sourceSheet)

Parameters

Type	Name	Description
WorksheetBaseImpl	sourceSheet	Source sheet.

Overrides

WorksheetBaseImpl.CopyOptions(WorksheetBaseImpl)

CopyPageSetup(WorksheetImpl)

Copies page setup from another worksheet.

Declaration

protected void CopyPageSetup(WorksheetImpl sourceSheet)

Parameters

Type	Name	Description
WorksheetImpl	sourceSheet	Worksheet to copy from.

CopyRange(IRange, IRange)

Copies range from one range into another with formulas update.

Declaration

public IRange CopyRange(IRange destination, IRange source)

Parameters

Type	Name	Description
IRange	destination	Destination range.
IRange	source	Source range.

Returns

Type	Description
IRange	Range into which source was copied.

CopyRange(IRange, IRange, ExcelCopyRangeOptions)

Copies range from one range into another.

Declaration

public IRange CopyRange(IRange destination, IRange source, ExcelCopyRangeOptions options)

Parameters

Type	Name	Description
IRange	destination	Destination range.
IRange	source	Source range.
ExcelCopyRangeOptions	options	Copy options.

Returns

Type	Description
IRange	Range into which source was copied.

CopyRange(Int32, Int32, Int32, Int32, Int32, Int32, WorksheetImpl, RecordTable, Rectangle, ExcelCopyRangeOptions)

Copies cells from one range into another.

Declaration

public void CopyRange(int iSourceRow, int iSourceColumn, int iRowCount, int iColumnCount, int iDestRow, int iDestColumn, WorksheetImpl destSheet, RecordTable intersection, Rectangle rectIntersection, ExcelCopyRangeOptions options)

Parameters

Type	Name	Description
System.Int32	iSourceRow	One-based index of the source row.
System.Int32	iSourceColumn	One-based index of the source column.
System.Int32	iRowCount	Number of rows to copy.
System.Int32	iColumnCount	Number of columns to copy.
System.Int32	iDestRow	One-based index of the destination row.
System.Int32	iDestColumn	One-based index of the destination column.
WorksheetImpl	destSheet	Destination worksheet.
RecordTable	intersection	DictionaryEntry with records and strings intersection part.
Rectangle	rectIntersection	Rectangle with intersection information.
ExcelCopyRangeOptions	options	Copy options.

CopyRangeWithoutCheck(RangeImpl, RangeImpl, ExcelCopyRangeOptions)

Copies range without checking range sizes.

Declaration

public void CopyRangeWithoutCheck(RangeImpl source, RangeImpl destination, ExcelCopyRangeOptions options)

Parameters

Type	Name	Description
RangeImpl	source	Source range to copy.
RangeImpl	destination	Destination range.
ExcelCopyRangeOptions	options	Copy options.

CopyRowHeight(WorksheetImpl, Dictionary<Int32, Int32>)

Copies row height.

Declaration

protected void CopyRowHeight(WorksheetImpl sourceSheet, Dictionary<int, int> hashExtFormatIndexes)

Parameters

Type	Name	Description
WorksheetImpl	sourceSheet	Source worksheet.
System.Collections.Generic.Dictionary<System.Int32, System.Int32>	hashExtFormatIndexes	Dictionary with new extended format indexes.

CreateEmptyPane()

Creates default pane.

Declaration

protected void CreateEmptyPane()

CreateLabelSSTRTFString(Int64)

Creates Rtf string for LabelSST record.

Declaration

public RangeRichTextString CreateLabelSSTRTFString(long cellIndex)

Parameters

Type	Name	Description
System.Int64	cellIndex	Cell index.

Returns

Type	Description
RangeRichTextString	Created rtf string.

CreateNamedRanges(String, String, Boolean)

Creates a named ranges with the specified named range's value as a name for the specified range.

Declaration

public void CreateNamedRanges(string namedRange, string referRange, bool vertical)

Parameters

Type	Name	Description
System.String	namedRange	Existing named ranged.
System.String	referRange	Address of the named range to be created.
System.Boolean	vertical	True if the named range values are vertically placed in the sheet.

Remarks

This method is used to create named ranges from the discontinuous ranges.

CreateRangesCollection()

Creates a new instance of the IRanges.

Declaration

public IRanges CreateRangesCollection()

Returns

Type	Description
IRanges	New instance of ranges collection.

CreateTemplateMarkersProcessor()

Create an instance of ITemplateMarkersProcessor that can be used for template markers processing.

Declaration

public ITemplateMarkersProcessor CreateTemplateMarkersProcessor()

Returns

Type	Description
ITemplateMarkersProcessor	Object that can be used for template markers processing.

DeleteColumn(Int32)

Removes the specified column.

Declaration

public void DeleteColumn(int index)

Parameters

Type	Name	Description
System.Int32	index	One-based column index.

DeleteColumn(Int32, Int32)

Removes the specified number of columns from the given index.

Declaration

public void DeleteColumn(int index, int count)

Parameters

Type	Name	Description
System.Int32	index	One-based column index.
System.Int32	count	Number of columns to remove.

DeleteRow(Int32)

Removes specified row (with formula update).

Declaration

public void DeleteRow(int index)

Parameters

Type	Name	Description
System.Int32	index	One-based row index to remove

DeleteRow(Int32, Int32)

Removes the specified number of rows from the given index(with formula update).

Declaration

public void DeleteRow(int index, int count)

Parameters

Type	Name	Description
System.Int32	index	One-based row index to remove
System.Int32	count	Number of rows to delete.

DetachEvents()

Unbinds the specified function from the event, so that the function stops receiving notifications when the event fires.

Declaration

protected void DetachEvents()

DisableSheetCalculations()

Disables the calculation support in this workbook and disposes of the associative CalcEngine objects.

Declaration

public void DisableSheetCalculations()

EnableSheetCalculations()

Enables the calculation support.

Declaration

public void EnableSheetCalculations()

Remarks

Enabling this method will initialize CalcEngine objects and retrieves calculated values of formulas in a worksheet.

ExportData<T>(Int32, Int32, Int32, Int32)

Declaration

public List<T> ExportData<T>(int firstRow, int firstColumn, int lastRow, int lastColumn)
    where T : new()

Parameters

Type	Name	Description
System.Int32	firstRow
System.Int32	firstColumn
System.Int32	lastRow
System.Int32	lastColumn

Returns

Type
System.Collections.Generic.List<T>

Type Parameters

Name
T

ExportData<T>(Int32, Int32, Int32, Int32, Dictionary<String, String>)

Declaration

public List<T> ExportData<T>(int firstRow, int firstColumn, int lastRow, int lastColumn, Dictionary<string, string> mappingProperties)
    where T : new()

Parameters

Type	Name	Description
System.Int32	firstRow
System.Int32	firstColumn
System.Int32	lastRow
System.Int32	lastColumn
System.Collections.Generic.Dictionary<System.String, System.String>	mappingProperties

Returns

Type
System.Collections.Generic.List<T>

Type Parameters

Name
T

ExportDataTable(IRange, ExcelExportDataTableOptions)

Exports worksheet data into a DataTable with the specified data range based on the exporting options.

Declaration

public DataTable ExportDataTable(IRange range, ExcelExportDataTableOptions options)

Parameters

Type	Name	Description
IRange	range	Range to export.
ExcelExportDataTableOptions	options	Export options.

Returns

Type	Description
System.Data.DataTable	Data Table with worksheet data.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

ExportDataTable(IRange, ExcelExportDataTableOptions, ExcelExportDataOptions)

Exports worksheet data into a DataTable with the specified data range based on the export options.

Declaration

public DataTable ExportDataTable(IRange range, ExcelExportDataTableOptions options, ExcelExportDataOptions exportDataOptions)

Parameters

Type	Name	Description
IRange	range	Range to export.
ExcelExportDataTableOptions	options	Export options.
ExcelExportDataOptions	exportDataOptions	Export Data options

Returns

Type	Description
System.Data.DataTable	Data Table with worksheet Data.

Remarks

When exportDataOption is null or the value of the ColumnTypeDeductionRow property in a row is less than or equal to 0, then By default the second row from the export range is used for detecting the column types. And the default value will be exported in the data table if the cell value does not match with the column type.

ExportDataTable(Int32, Int32, Int32, Int32, ExcelExportDataTableOptions)

Exports worksheet data in the specified row and column into a DataTable.

Declaration

public DataTable ExportDataTable(int firstRow, int firstColumn, int maxRows, int maxColumns, ExcelExportDataTableOptions options)

Parameters

Type	Name	Description
System.Int32	firstRow	Row of the first cell from where DataTable should be exported.
System.Int32	firstColumn	Column of the first cell from where DataTable should be exported.
System.Int32	maxRows	Maximum number of rows to export.
System.Int32	maxColumns	Maximum number of columns to export.
ExcelExportDataTableOptions	options	Export options.

Returns

Type	Description
System.Data.DataTable	DataTable with worksheet data.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

ExportDataTable(Int32, Int32, Int32, Int32, ExcelExportDataTableOptions, ExcelExportDataOptions)

Exports worksheet data in the specified row and column into a DataTable based on the export options.

Declaration

public DataTable ExportDataTable(int firstRow, int firstColumn, int maxRows, int maxColumns, ExcelExportDataTableOptions options, ExcelExportDataOptions exportDataOptions)

Parameters

Type	Name	Description
System.Int32	firstRow	Row of the first cell from where DataTable should be exported.
System.Int32	firstColumn	Column of the first cell from where DataTable should be exported.
System.Int32	maxRows	Maximum number of rows to export.
System.Int32	maxColumns	Maximum number of columns to export.
ExcelExportDataTableOptions	options	Export options.
ExcelExportDataOptions	exportDataOptions	Export Data options.

Returns

Type	Description
System.Data.DataTable	Data Table with worksheet Data.

Remarks

ExportDataTable(Int32, Int32, Int32, Int32, ExcelExportDataTableOptions, PivotTableImpl)

Exports worksheet data into a DataTable.

Declaration

public DataTable ExportDataTable(int firstRow, int firstColumn, int maxRows, int maxColumns, ExcelExportDataTableOptions options, PivotTableImpl pivotTable)

Parameters

Type	Name	Description
System.Int32	firstRow	Row of the first cell from where DataTable should be exported
System.Int32	firstColumn	Column of the first cell from where DataTable should be exported
System.Int32	maxRows	Maximum number of rows to export
System.Int32	maxColumns	Maximum number of columns to export
ExcelExportDataTableOptions	options	Export options.
PivotTableImpl	pivotTable

Returns

Type	Description
System.Data.DataTable	Data Table with worksheet data

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

ExtractCalculationOptions()

Extracts calculation options.

Declaration

protected int ExtractCalculationOptions()

Returns

Type	Description
System.Int32	Position in the records array after extraction.

ExtractConditionalFormats(Int32)

Extracts conditional formats from biff records array

Declaration

protected void ExtractConditionalFormats(int iCondFmtPos)

Parameters

Type	Name	Description
System.Int32	iCondFmtPos	Position of the first conditional format

ExtractCustomProperties(Int32)

Extracts custom properties from the records array.

Declaration

protected void ExtractCustomProperties(int iCustomPropertyPos)

Parameters

Type	Name	Description
System.Int32	iCustomPropertyPos	Position of the first custom property record.

ExtractDataValidation(Int32)

Extracts data validation data from internal records array.

Declaration

protected void ExtractDataValidation(int iDValPos)

Parameters

Type	Name	Description
System.Int32	iDValPos	Position of the first data validation record.

ExtractHyperLinks(Int32)

Extracts hyperlinks from internal array of biff records.

Declaration

protected void ExtractHyperLinks(int iLinkIndex)

Parameters

Type	Name	Description
System.Int32	iLinkIndex	Index to the first hyperlink in the array of biff records, less then zero if there are no hyperlinks.

ExtractPageSetup(Int32)

Extracts page setup from biff records array

Declaration

protected void ExtractPageSetup(int iStartIndex)

Parameters

Type	Name	Description
System.Int32	iStartIndex	Start index of the first pagesetup record.

ExtractPivotTables(Int32)

Extracts pivot tables from records array.

Declaration

protected void ExtractPivotTables(int iStartIndex)

Parameters

Type	Name	Description
System.Int32	iStartIndex	Index to the first pivot table record.

Find(IRange, Byte, Boolean, Boolean)

Returns found values or null.

Declaration

public IRange[] Find(IRange range, byte findValue, bool bIsError, bool bIsFindFirst)

Parameters

Type	Name	Description
IRange	range	Storage range.
System.Byte	findValue	Value for finding.
System.Boolean	bIsError	If true - finds as error; otherwise as bool value.
System.Boolean	bIsFindFirst	If true - finds first value; otherwise - all values.

Returns

Type	Description
IRange[]	If findfirst - true then returns range; otherwise - array with all found values.

Find(IRange, Double, ExcelFindType, Boolean)

Returns found values or null.

Declaration

public IRange[] Find(IRange range, double findValue, ExcelFindType flags, bool bIsFindFirst)

Parameters

Type	Name	Description
IRange	range	Storage range.
System.Double	findValue	Value for finding.
ExcelFindType	flags	Finding flags.
System.Boolean	bIsFindFirst	If true - finds first value; otherwise - all values.

Returns

Type	Description
IRange[]	If findfirst - true then returns range; otherwise - array with all found values.

Find(IRange, String, ExcelFindType, ExcelFindOptions, Boolean)

Returns found values or null.

Declaration

public IRange[] Find(IRange range, string findValue, ExcelFindType flags, ExcelFindOptions findOptions, bool bIsFindFirst)

Parameters

Type	Name	Description
IRange	range	Storage range.
System.String	findValue	Value for finding.
ExcelFindType	flags	If true - finds first value; otherwise - all values.
ExcelFindOptions	findOptions
System.Boolean	bIsFindFirst	If findfirst - true then returns range; otherwise - array with all found values.

Returns

Type	Description
IRange[]	Range array with found values.

Find(IRange, String, ExcelFindType, Boolean)

Returns found values or null.

Declaration

public IRange[] Find(IRange range, string findValue, ExcelFindType flags, bool bIsFindFirst)

Parameters

Type	Name	Description
IRange	range	Storage range.
System.String	findValue	Value for finding.
ExcelFindType	flags	If true - finds first value; otherwise - all values.
System.Boolean	bIsFindFirst	If findfirst - true then returns range; otherwise - array with all found values.

Returns

Type	Description
IRange[]	Range array with found values.

FindAll(Boolean)

Returns the cells of the specified bool value.

Declaration

public IRange[] FindAll(bool findValue)

Parameters

Type	Name	Description
System.Boolean	findValue	Value to search.

Returns

Type	Description
IRange[]	Returns the cells with a specified bool value, or null if value was not found.

FindAll(DateTime)

Returns the cells of the specified DateTime value.

Declaration

public IRange[] FindAll(DateTime findValue)

Parameters

Type	Name	Description
System.DateTime	findValue	Value to search.

Returns

Type	Description
IRange[]	Returns the cells with a specified DateTime value, or null if value was not found.

FindAll(Double, ExcelFindType)

Returns the cells of the specified double value with the specified ExcelFindType.

Declaration

public IRange[] FindAll(double findValue, ExcelFindType flags)

Parameters

Type	Name	Description
System.Double	findValue	Value to search.
ExcelFindType	flags	Type of value to search.

Returns

Type	Description
IRange[]	All found cells, or Null if value was not found.

FindAll(String, ExcelFindType)

Returns the cells of the specified string value with the specified ExcelFindType.

Declaration

public IRange[] FindAll(string findValue, ExcelFindType flags)

Parameters

Type	Name	Description
System.String	findValue	Value to search.
ExcelFindType	flags	Type of value to search.

Returns

Type	Description
IRange[]	Returns the cells with a specified string value, or null if value was not found.

FindAll(String, ExcelFindType, ExcelFindOptions)

Returns the cells of the specified string value with the specified ExcelFindType and ExcelFindOptions.

Declaration

public IRange[] FindAll(string findValue, ExcelFindType flags, ExcelFindOptions findOptions)

Parameters

Type	Name	Description
System.String	findValue	Value to search.
ExcelFindType	flags	Type of value to search.
ExcelFindOptions	findOptions	Way to search.

Returns

Type	Description
IRange[]	Returns the cells with a specified string value and specified find options , or null if value was not found.

FindAll(TimeSpan)

Returns the cells of the specified TimeSpan value.

Declaration

public IRange[] FindAll(TimeSpan findValue)

Parameters

Type	Name	Description
System.TimeSpan	findValue	Value to search.

Returns

Type	Description
IRange[]	Returns the cells with a specified TimeSpan value, or null if value was not found.

FindFirst(Boolean)

Returns the first occurrence of the specified bool value.

Declaration

public IRange FindFirst(bool findValue)

Parameters

Type	Name	Description
System.Boolean	findValue	Value to search.

Returns

Type	Description
IRange	Returns the first cell with a specified bool value, or null if value was not found.

FindFirst(DateTime)

Returns the first occurrence of the specified DateTime value.

Declaration

public IRange FindFirst(DateTime findValue)

Parameters

Type	Name	Description
System.DateTime	findValue	Value to search.

Returns

Type	Description
IRange	Returns the first cell with a specified DateTime value, or null if value was not found.

FindFirst(Double, ExcelFindType)

Returns the first occurrence of the specified double value with the specified ExcelFindType.

Declaration

public IRange FindFirst(double findValue, ExcelFindType flags)

Parameters

Type	Name	Description
System.Double	findValue	Value to search.
ExcelFindType	flags	Type of value to search.

Returns

Type	Description
IRange	Returns the first cell with a specified double value, or null if value was not found.

FindFirst(String, ExcelFindType)

Returns the first occurrence of the specified string value with the specified ExcelFindType.

Declaration

public IRange FindFirst(string findValue, ExcelFindType flags)

Parameters

Type	Name	Description
System.String	findValue	Value to search.
ExcelFindType	flags	Type of value to search.

Returns

Type	Description
IRange	Returns the first cell with a specified string value, or null if value was not found.

FindFirst(String, ExcelFindType, ExcelFindOptions)

Returns the first occurrence of the specified string value with the specified ExcelFindType and ExcelFindOptions.

Declaration

public IRange FindFirst(string findValue, ExcelFindType flags, ExcelFindOptions findOptions)

Parameters

Type	Name	Description
System.String	findValue	Value to search.
ExcelFindType	flags	Type of value to search.
ExcelFindOptions	findOptions	Way to search the value.

Returns

Type	Description
IRange	Returns the first cell with a specified string value and specified find options , or null if value was not found.

FindFirst(TimeSpan)

Returns the first occurrence of the specified TimeSpan value.

Declaration

public IRange FindFirst(TimeSpan findValue)

Parameters

Type	Name	Description
System.TimeSpan	findValue	Value to search.

Returns

Type	Description
IRange	Returns the first cell with a specified TimeSpan value, or null if value was not found.

FindStringEndsWith(String, ExcelFindType)

Returns the first occurrence that ends with the specified string value.

Declaration

public IRange FindStringEndsWith(string findValue, ExcelFindType flags)

Parameters

Type	Name	Description
System.String	findValue	Value to search.
ExcelFindType	flags	Type of value to search.

Returns

Type	Description
IRange	Returns the first occurrence that ends with the specified string value, or null if value was not found.

FindStringEndsWith(String, ExcelFindType, Boolean)

Returns the first occurrence that ends with the specified string value which ignores the case.

Declaration

public IRange FindStringEndsWith(string findValue, ExcelFindType flags, bool ignoreCase)

Parameters

Type	Name	Description
System.String	findValue	Value to search.
ExcelFindType	flags	Type of value to search.
System.Boolean	ignoreCase	True to ignore case when comparing this string to the value; otherwise, False.

Returns

Type	Description
IRange	Returns the first occurrence that ends with the specified string value, or null if value was not found.

FindStringStartsWith(String, ExcelFindType)

Returns the first occurrence that starts with the specified string value.

Declaration

public IRange FindStringStartsWith(string findValue, ExcelFindType flags)

Parameters

Type	Name	Description
System.String	findValue	Value to search.
ExcelFindType	flags	Type of value to search.

Returns

Type	Description
IRange	Returns the first occurrence that starts with the specified string value, or null if value was not found.

FindStringStartsWith(String, ExcelFindType, Boolean)

Returns the first occurrence that starts with the specified string value which ignores the case.

Declaration

public IRange FindStringStartsWith(string findValue, ExcelFindType flags, bool ignoreCase)

Parameters

Type	Name	Description
System.String	findValue	Value to search.
ExcelFindType	flags	Type of value to search.
System.Boolean	ignoreCase	true to ignore case wen comparing this string to the value;otherwise,false

Returns

Type	Description
IRange	Returns the first occurrence that starts with the specified string value, or null if value was not found.

FreeRange(IRange)

Frees range object.

Declaration

public void FreeRange(IRange range)

Parameters

Type	Name	Description
IRange	range	Range to remove from internal cache.

FreeRange(Int32, Int32)

Frees range object for the specified row and column.

Declaration

public void FreeRange(int iRow, int iColumn)

Parameters

Type	Name	Description
System.Int32	iRow	One-based row index of the range object to remove from internal cache.
System.Int32	iColumn	One-based column index of the range object to remove from internal cache.

GetActiveCell()

Returns active cell.

Declaration

public IRange GetActiveCell()

Returns

Type	Description
IRange	Currently active cell.

GetBoolean(Int32, Int32)

Returns bool value from the specified row and column.

Declaration

public bool GetBoolean(int row, int column)

Parameters

Type	Name	Description
System.Int32	row	One-based row index.
System.Int32	column	One-based column index.

Returns

Type	Description
System.Boolean	Returns found bool value. If cannot found returns false.

GetCellType(Int32, Int32, Boolean)

Gets cell type from current column.

Declaration

public WorksheetImpl.TRangeValueType GetCellType(int row, int column, bool bNeedFormulaSubType)

Parameters

Type	Name	Description
System.Int32	row	Indicates row.
System.Int32	column	Indicates column.
System.Boolean	bNeedFormulaSubType	Indicates is need to indentify formula sub type.

Returns

Type	Description
WorksheetImpl.TRangeValueType	Returns cell type.

GetClonedObject(Dictionary<String, String>, WorkbookImpl)

Gets object that is clone of current worksheet in the specified workbook.

Declaration

public IInternalWorksheet GetClonedObject(Dictionary<string, string> hashNewNames, WorkbookImpl book)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.String, System.String>	hashNewNames	Dictionary with update worksheet names.
WorkbookImpl	book	New workbook object.

Returns

Type	Description
Syncfusion.XlsIO.Interfaces.IInternalWorksheet	Object that is clone of the current worksheet.

GetColumnCount()

This API supports the .NET Framework infrastructure and is not intended to be used directly from your code

Declaration

public int GetColumnCount()

Returns

Type
System.Int32

GetColumnWidth(Int32)

Returns the width of the specified column in pixels.

Declaration

public double GetColumnWidth(int iColumnIndex)

Parameters

Type	Name	Description
System.Int32	iColumnIndex	One-based column index.

Returns

Type	Description
System.Double	Width in pixels of the specified column.

GetColumnWidthInPixels(Int32)

Returns width of the specified column in pixels.

Declaration

public int GetColumnWidthInPixels(int iColumnIndex)

Parameters

Type	Name	Description
System.Int32	iColumnIndex	One-based index of the column.

Returns

Type	Description
System.Int32	Width in pixels of the specified column.

Remarks

Otherwise it returns the StandardHeight

GetDefaultColumnStyle(Int32)

Returns the default column style for the specified column.

Declaration

public IStyle GetDefaultColumnStyle(int iColumnIndex)

Parameters

Type	Name	Description
System.Int32	iColumnIndex	One-based column index.

Returns

Type	Description
IStyle	Default column style for the specified column or null if style wasn't set.

GetDefaultRowStyle(Int32)

Returns default row style for the specified row.

Declaration

public IStyle GetDefaultRowStyle(int iRowIndex)

Parameters

Type	Name	Description
System.Int32	iRowIndex	One-based row index.

Returns

Type	Description
IStyle	Default row style for the specified row or null if style wasn't set.

GetError(Int32, Int32)

Returns error value from the specified row and column.

Declaration

public string GetError(int row, int column)

Parameters

Type	Name	Description
System.Int32	row	One-based row index.
System.Int32	column	One-based column index.

Returns

Type	Description
System.String	Returns error value or null.

GetExtendedFormat(Int64)

Returns extended format for specified cell.

Declaration

public ExtendedFormatImpl GetExtendedFormat(long cellIndex)

Parameters

Type	Name	Description
System.Int64	cellIndex	Cell index.

Returns

Type	Description
ExtendedFormatImpl	Extended format for specified cell.

GetFirstColumn()

Gets the first column index.

Declaration

public int GetFirstColumn()

Returns

Type	Description
System.Int32	Index of first column

GetFirstRow()

Get the idex of the first row in UsedRange

Declaration

public int GetFirstRow()

Returns

Type	Description
System.Int32	index of first row

GetFormula(Int32, Int32, Boolean)

Returns formula value from specified row and column.

Declaration

public string GetFormula(int row, int column, bool bR1C1)

Parameters

Type	Name	Description
System.Int32	row	One-based row index.
System.Int32	column	One-based column index.
System.Boolean	bR1C1	Indicates whether R1C1 notation should be used.

Returns

Type	Description
System.String	Returns formula string.

GetFormula(Int32, Int32, Boolean, FormulaUtil, Boolean)

Returns formula corresponding to the cell.

Declaration

public string GetFormula(int row, int column, bool bR1C1, FormulaUtil formulaUtil, bool isForSerialization)

Parameters

Type	Name	Description
System.Int32	row	One-based row index of the cell to get value from.
System.Int32	column	One-based column index of the cell to get value from.
System.Boolean	bR1C1	Indicates whether R1C1 notation should be used.
FormulaUtil	formulaUtil	Formula utilities to use for parsing.
System.Boolean	isForSerialization

Returns

Type	Description
System.String	Formula contained by the cell.

GetFormula(Int32, Int32, Boolean, Boolean)

Returns formula corresponding to the cell.

Declaration

public string GetFormula(int row, int column, bool bR1C1, bool isForSerialization)

Parameters

Type	Name	Description
System.Int32	row	One-based row index of the cell to get value from.
System.Int32	column	One-based column index of the cell to get value from.
System.Boolean	bR1C1	Indicates whether R1C1 notation should be used.
System.Boolean	isForSerialization

Returns

Type	Description
System.String	Formula contained by the cell.

GetFormulaBoolValue(Int32, Int32)

Returns formula bool value from the specified row and column.

Declaration

public bool GetFormulaBoolValue(int row, int column)

Parameters

Type	Name	Description
System.Int32	row	One-based row index.
System.Int32	column	One-based column index.

Returns

Type	Description
System.Boolean	True if bool value is found. otherwise False.

GetFormulaErrorValue(Int32, Int32)

Returns formula error value from the specified row and column.

Declaration

public string GetFormulaErrorValue(int row, int column)

Parameters

Type	Name	Description
System.Int32	row	One-based row index.
System.Int32	column	One-based column index.

Returns

Type	Description
System.String	Returns error value or null.

GetFormulaNumberValue(Int32, Int32)

Returns formula number value from the specified row and column.

Declaration

public double GetFormulaNumberValue(int row, int column)

Parameters

Type	Name	Description
System.Int32	row	One-based row index.
System.Int32	column	One-based column index.

Returns

Type	Description
System.Double	Number contained by the cell.

GetFormulaStringValue(Int32, Int32)

Returns formula string value from the specified row and column.

Declaration

public string GetFormulaStringValue(int row, int column)

Parameters

Type	Name	Description
System.Int32	row	One-based row index.
System.Int32	column	One-based column index.

Returns

Type	Description
System.String	String contained by the cell.

GetHiddenColumnWidthInPixels(Int32)

Returns width of the specified hidden column in pixels.

Declaration

public int GetHiddenColumnWidthInPixels(int iColumnIndex)

Parameters

Type	Name	Description
System.Int32	iColumnIndex	One-based index of the column.

Returns

Type	Description
System.Int32	Width of the specified hidden column in pixels.

GetHiddenRowHeightInPixels(Int32)

Returns height of the specified hidden row in pixels.

Declaration

public int GetHiddenRowHeightInPixels(int iRowIndex)

Parameters

Type	Name	Description
System.Int32	iRowIndex	One-based index of the row.

Returns

Type	Description
System.Int32	Height of the specified hidden row in pixels.

GetLastColumn()

Gets the last column index / column count.

Declaration

public int GetLastColumn()

Returns

Type	Description
System.Int32	Index of last column

GetLastRow()

get the index of the last row in UsedRange

Declaration

public int GetLastRow()

Returns

Type	Description
System.Int32	index of last row

GetNoteByObjectIndex(Int32)

Returns note record by object index.

Declaration

protected NoteRecord GetNoteByObjectIndex(int index)

Parameters

Type	Name	Description
System.Int32	index	Object index to find NoteRecord for.

Returns

Type	Description
NoteRecord	Corresponding NoteRecord, or Null if not found.

GetNumber(Int32, Int32)

Returns number value from the specified row and column.

Declaration

public double GetNumber(int row, int column)

Parameters

Type	Name	Description
System.Int32	row	One-based row index.
System.Int32	column	One-based column index.

Returns

Type	Description
System.Double	Number contained by the cell.

GetRangeByString(String, Boolean)

Gets range from string value.

Declaration

public IRange GetRangeByString(string strRangeValue, bool hasFormula)

Parameters

Type	Name	Description
System.String	strRangeValue	Range value represented in string.
System.Boolean	hasFormula	boolean value indicates whether the formula in the input

Returns

Type	Description
IRange	Extracted Range.

GetRecord(TBIFFRecord, Int32, Int32)

Creates record.

Declaration

public BiffRecordRaw GetRecord(TBIFFRecord recordCode, int iRow, int iColumn)

Parameters

Type	Name	Description
TBIFFRecord	recordCode	Record to create.
System.Int32	iRow	One-based row index.
System.Int32	iColumn	One-based column index.

Returns

Type	Description
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw	Created biff record.

GetRecord(Int32, Int32)

Returns record at specified cell index.

Declaration

protected ICellPositionFormat GetRecord(int iRow, int iColumn)

Parameters

Type	Name	Description
System.Int32	iRow	One-based row index.
System.Int32	iColumn	One-based column index.

Returns

Type	Description
ICellPositionFormat	Record at specified cell index.

GetRecord(Int64)

Returns record at specified cell index.

Declaration

protected ICellPositionFormat GetRecord(long cellIndex)

Parameters

Type	Name	Description
System.Int64	cellIndex	Record's cell index.

Returns

Type	Description
ICellPositionFormat	Record at specified cell index.

GetRowCount()

This API supports the .NET Framework infrastructure and is not intended to be used directly from your code

Declaration

public int GetRowCount()

Returns

Type
System.Int32

GetRowHeight(Int32)

Returns the height of the specified row.

Declaration

public double GetRowHeight(int iRow)

Parameters

Type	Name	Description
System.Int32	iRow	One-based row index.

Returns

Type	Description
System.Double	Returns height of the specified row. Otherwise returns StandardHeight.

Remarks

Otherwise it gets the StandardHeight

GetRowHeightInPixels(Int32)

Returns the height of the specified row in pixels.

Declaration

public int GetRowHeightInPixels(int iRowIndex)

Parameters

Type	Name	Description
System.Int32	iRowIndex	One-based row index.

Returns

Type	Description
System.Int32	Returns height of the specified row in pixels. Otherwise returns StandardHeight.

Remarks

Otherwise it gets the StandardHeight in pixels

GetStringIndex(Int64)

Returns string index of the specified cell.

Declaration

public int GetStringIndex(long cellIndex)

Parameters

Type	Name	Description
System.Int64	cellIndex	Cell index to locate.

Returns

Type	Description
System.Int32	String index of the specified cell.

GetStringPreservedValue(ICombinedRange)

Gets string preservation option for the range.

Declaration

public Nullable<bool> GetStringPreservedValue(ICombinedRange range)

Parameters

Type	Name	Description
ICombinedRange	range	Range to get value for.

Returns

Type	Description
System.Nullable<System.Boolean>	True if strings are preserved for all cells of the range, false - if it is not preserved, null - undefined or different cells have different values.

GetStringValue(Int64)

Returns string value corresponding to the cell.

Declaration

public string GetStringValue(long cellIndex)

Parameters

Type	Name	Description
System.Int64	cellIndex	Cell index to get value from.

Returns

Type	Description
System.String	String contained by the cell.

GetText(Int32, Int32)

Returns string value from the specified row and column.

Declaration

public string GetText(int row, int column)

Parameters

Type	Name	Description
System.Int32	row	One-based row index.
System.Int32	column	One-based column index.

Returns

Type	Description
System.String	String contained by the cell.

GetTextObject(Int64)

Returns TextWithFormat object corresponding to the specified cell.

Declaration

public object GetTextObject(long cellIndex)

Parameters

Type	Name	Description
System.Int64	cellIndex	Cell index.

Returns

Type	Description
System.Object	Object corresponding to the specified cell.

GetTextWithFormat(Int64)

Returns TextWithFormat object corresponding to the specified cell.

Declaration

public TextWithFormat GetTextWithFormat(long cellIndex)

Parameters

Type	Name	Description
System.Int64	cellIndex	Cell index.

Returns

Type	Description
TextWithFormat	TextWithFormat object corresponding to the specified cell.

GetValueRowCol(Int32, Int32)

Returns the formula string if the cell contains a formula, or the value if the cell cantains anything other than a formula.

Declaration

public object GetValueRowCol(int row, int col)

Parameters

Type	Name	Description
System.Int32	row	The row of the cell.
System.Int32	col	The column of the cell.

Returns

Type	Description
System.Object	The formula string or value.

HasArrayFormula(Ptg[])

Indicates whether tokens array contains array formula reference.

Declaration

public bool HasArrayFormula(Ptg[] arrTokens)

Parameters

Type	Name	Description
Ptg[]	arrTokens	Tokens to check.

Returns

Type	Description
System.Boolean	True if it refers to

HasArrayFormulaRecord(Int32, Int32)

Indicates is has array formula.

Declaration

public bool HasArrayFormulaRecord(int row, int column)

Parameters

Type	Name	Description
System.Int32	row	Represents row index.
System.Int32	column	Represents column index.

Returns

Type	Description
System.Boolean	Indicates is contain array formula record.

HideColumn(Int32)

Hides the specified column.

Declaration

public void HideColumn(int columnIndex)

Parameters

Type	Name	Description
System.Int32	columnIndex	One-based column index.

HideRow(Int32)

Hides the specified row.

Declaration

public void HideRow(int rowIndex)

Parameters

Type	Name	Description
System.Int32	rowIndex	One-based row index.

ImportArray(DateTime[], Int32, Int32, Boolean)

Imports an array of DateTime values into a worksheet.

Declaration

public int ImportArray(DateTime[] arrDateTime, int firstRow, int firstColumn, bool isVertical)

Parameters

Type	Name	Description
System.DateTime[]	arrDateTime	Array of datetime value.
System.Int32	firstRow	Row of the first cell where array should be imported.
System.Int32	firstColumn	Column of the first cell where array should be imported.
System.Boolean	isVertical	True if array should be imported vertically; False - horizontally.

Returns

Type	Description
System.Int32	Number of imported elements.

ImportArray(Double[], Int32, Int32, Boolean)

Imports an array of double values into a worksheet.

Declaration

public int ImportArray(double[] arrDouble, int firstRow, int firstColumn, bool isVertical)

Parameters

Type	Name	Description
System.Double[]	arrDouble	Array of double value.
System.Int32	firstRow	Row of the first cell where array should be imported.
System.Int32	firstColumn	Column of the first cell where array should be imported.
System.Boolean	isVertical	True if array should be imported vertically; False - horizontally.

Returns

Type	Description
System.Int32	Number of imported elements.

ImportArray(Int32[], Int32, Int32, Boolean)

Imports an array of integer values into a worksheet.

Declaration

public int ImportArray(int[] arrInt, int firstRow, int firstColumn, bool isVertical)

Parameters

Type	Name	Description
System.Int32[]	arrInt	Array of int value.
System.Int32	firstRow	Row of the first cell where array should be imported.
System.Int32	firstColumn	Column of the first cell where array should be imported.
System.Boolean	isVertical	True if array should be imported vertically; False - horizontally.

Returns

Type	Description
System.Int32	Number of imported elements.

ImportArray(Object[], Int32, Int32, Boolean)

Imports an array of objects into a worksheet with specified alignment.

Declaration

public int ImportArray(object[] arrObject, int firstRow, int firstColumn, bool isVertical)

Parameters

Type	Name	Description
System.Object[]	arrObject	Array of object.
System.Int32	firstRow	Row of the first cell where array should be imported.
System.Int32	firstColumn	Column of the first cell where array should be imported.
System.Boolean	isVertical	True if array should be imported vertically; False - horizontally.

Returns

Type	Description
System.Int32	Number of imported elements.

ImportArray(Object[,], Int32, Int32)

Imports an array of objects into a worksheet.

Declaration

public int ImportArray(object[, ] arrObject, int firstRow, int firstColumn)

Parameters

Type	Name	Description
System.Object[,]	arrObject	Array of object.
System.Int32	firstRow	Row of the first cell where array should be imported.
System.Int32	firstColumn	Column of the first cell where array should be imported.

Returns

Type	Description
System.Int32	Number of imported rows.

ImportArray(String[], Int32, Int32, Boolean)

Imports an array of string values into a worksheet.

Declaration

public int ImportArray(string[] arrString, int firstRow, int firstColumn, bool isVertical)

Parameters

Type	Name	Description
System.String[]	arrString	Array of string value.
System.Int32	firstRow	Row of the first cell where array should be imported.
System.Int32	firstColumn	Column of the first cell where array should be imported.
System.Boolean	isVertical	True if array should be imported vertically; False - horizontally.

Returns

Type	Description
System.Int32	Number of imported elements.

ImportData(IEnumerable, ExcelImportDataOptions)

Imports data from class objects into a worksheet with specified row and column along with import data options.

Declaration

public int ImportData(IEnumerable arrObject, ExcelImportDataOptions importDataOptions)

Parameters

Type	Name	Description
System.Collections.IEnumerable	arrObject	IEnumerable object with desired data.
ExcelImportDataOptions	importDataOptions	Import data options.

Returns

Type	Description
System.Int32	Number of imported rows.

ImportData(IEnumerable, Int32, Int32, Boolean)

Imports data from class objects into a worksheet with specified row and column.

Declaration

public int ImportData(IEnumerable arrObject, int firstRow, int firstColumn, bool includeHeader)

Parameters

Type	Name	Description
System.Collections.IEnumerable	arrObject	IEnumerable object with desired data.
System.Int32	firstRow	First row from where the data should be imported.
System.Int32	firstColumn	First column from where the data should be imported.
System.Boolean	includeHeader	TRUE if class properties names must be imported.

Returns

Type	Description
System.Int32	Number of imported rows.

ImportDataColumn(DataColumn, Boolean, Int32, Int32)

Imports data from a DataColumn into a worksheet.

Declaration

public int ImportDataColumn(DataColumn dataColumn, bool isFieldNameShown, int firstRow, int firstColumn)

Parameters

Type	Name	Description
System.Data.DataColumn	dataColumn	DataColumn with desired data.
System.Boolean	isFieldNameShown	TRUE if column name must be imported.
System.Int32	firstRow	First row from where the data should be imported.
System.Int32	firstColumn	First column from where the data should be imported.

Returns

Type	Description
System.Int32	Number of imported rows.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

ImportDataColumn(DataColumn, Boolean, Int32, Int32, Boolean)

Imports data from a DataColumn into a worksheet.

Declaration

public int ImportDataColumn(DataColumn dataColumn, bool isFieldNameShown, int firstRow, int firstColumn, bool preserveTypes)

Parameters

Type	Name	Description
System.Data.DataColumn	dataColumn	DataColumn with desired data.
System.Boolean	isFieldNameShown	TRUE if column name must be imported.
System.Int32	firstRow	First row from where the data should be imported.
System.Int32	firstColumn	First column from where the data should be imported.
System.Boolean	preserveTypes	Indicates whether XlsIO should preserve column types from DataTable. By default, preserve type is FALSE. i.e., Setting it to True will import data based on column type, otherwise will import based on value type.

Returns

Type	Description
System.Int32	Number of imported rows.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

ImportDataColumns(DataColumn[], Boolean, Int32, Int32)

Imports array of data columns.

Declaration

public int ImportDataColumns(DataColumn[] arrDataColumns, bool isFieldNameShown, int firstRow, int firstColumn)

Parameters

Type	Name	Description
System.Data.DataColumn[]	arrDataColumns	Data columns to import.
System.Boolean	isFieldNameShown	Indicates whether to import field names.
System.Int32	firstRow	Index to the first row.
System.Int32	firstColumn	Index to the first column.

Returns

Type	Description
System.Int32	Number of imported rows.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

ImportDataReader(IDataReader, IName, Boolean)

Imports data from DataReader into the specified NamedRange of current worksheet.

Declaration

public int ImportDataReader(IDataReader dataReader, IName namedRange, bool isFieldNameShown)

Parameters

Type	Name	Description
System.Data.IDataReader	dataReader	The or object which contains data.
IName	namedRange	Represents named range.
System.Boolean	isFieldNameShown	TRUE if column names must be imported.

Returns

Type	Description
System.Int32	Number of imported rows.

Remarks

This method is not supported in WinRT, Windows Phone, Portable, Universal and Silverlight platforms.

ImportDataReader(IDataReader, Boolean, Int32, Int32)

Imports data from DataReader into worksheet from the specified row and column.

Declaration

public int ImportDataReader(IDataReader dataReader, bool isFieldNameShown, int firstRow, int firstColumn)

Parameters

Type	Name	Description
System.Data.IDataReader	dataReader	The or object which contains data.
System.Boolean	isFieldNameShown	TRUE if column names must be imported.
System.Int32	firstRow	First row from where the data should be imported.
System.Int32	firstColumn	First column from where the data should be imported.

Returns

Type	Description
System.Int32	Number of imported rows.

Remarks

This method is not supported in WinRT, Windows Phone, Portable, Universal and Silverlight platforms.

ImportDataReader(IDataReader, Boolean, Int32, Int32, Boolean)

Imports data from DataReader into worksheet from the specified row and column along with the preserve type.

Declaration

public int ImportDataReader(IDataReader dataReader, bool isFieldNameShown, int firstRow, int firstColumn, bool preserveTypes)

Parameters

Type	Name	Description
System.Data.IDataReader	dataReader	The or object which contains data.
System.Boolean	isFieldNameShown	TRUE if column names must be imported.
System.Int32	firstRow	First row from where the data should be imported.
System.Int32	firstColumn	First column from where the data should be imported.
System.Boolean	preserveTypes	Indicates whether XlsIO should preserve column types from DataReader. By default, preserve type is FALSE. i.e., Setting it to True will import data based on column type, otherwise will import based on value type.

Returns

Type	Description
System.Int32	Number of imported rows.

Remarks

This method is not supported in WinRT, Windows Phone, Portable, Universal and Silverlight platforms.

ImportDataReader(IDataReader, Int32, Int32, Boolean)

Imports data from DataReader into worksheet from the specified row and column along with save option.

Declaration

public int ImportDataReader(IDataReader dataReader, int firstRow, int firstColumn, bool importOnSave)

Parameters

Type	Name	Description
System.Data.IDataReader	dataReader	The or object which contains data.
System.Int32	firstRow	First row from where the data should be imported.
System.Int32	firstColumn	First column from where the data should be imported.
System.Boolean	importOnSave	TRUE if data must be serialized directly on save.

Returns

Type	Description
System.Int32	Number of imported rows.

Remarks

This method is not supported in WinRT, Windows Phone, Portable, Universal and Silverlight platforms.

ImportDataTable(DataTable, IName, Boolean)

Imports data from DataTable into the specified NamedRange of current worksheet.

Declaration

public int ImportDataTable(DataTable dataTable, IName namedRange, bool isFieldNameShown)

Parameters

Type	Name	Description
System.Data.DataTable	dataTable	Data Table with desired data.
IName	namedRange	Represents named range.
System.Boolean	isFieldNameShown	TRUE if column names must be imported.

Returns

Type	Description
System.Int32	Number of imported rows.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

ImportDataTable(DataTable, IName, Boolean, Int32, Int32)

Imports data from DataTable into the specified NamedRange of current worksheet with row and column offset.

Declaration

public int ImportDataTable(DataTable dataTable, IName namedRange, bool isFieldNameShown, int rowOffset, int columnOffset)

Parameters

Type	Name	Description
System.Data.DataTable	dataTable	Data Table with desired data.
IName	namedRange	Represents named range.
System.Boolean	isFieldNameShown	TRUE if column names must also be imported.
System.Int32	rowOffset	Represents row offset into named range to import.
System.Int32	columnOffset	Represents column offset into named range to import.

Returns

Type	Description
System.Int32	Number of imported rows.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

ImportDataTable(DataTable, IName, Boolean, Int32, Int32, Int32, Int32)

Imports data from DataTable into the specified NamedRange of current worksheet with row and column offset.

Declaration

public int ImportDataTable(DataTable dataTable, IName namedRange, bool isFieldNameShown, int rowOffset, int columnOffset, int iMaxRow, int iMaxCol)

Parameters

Type	Name	Description
System.Data.DataTable	dataTable	DataTable with desired data.
IName	namedRange	Represents named range.
System.Boolean	isFieldNameShown	TRUE if column names must be imported.
System.Int32	rowOffset	Represents row offset into named range to import.
System.Int32	columnOffset	Represents column offset into named range to import.
System.Int32	iMaxRow	Maximum number of rows to import.
System.Int32	iMaxCol	Maximum number of columns to import.

Returns

Type	Description
System.Int32	Number of imported rows.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

ImportDataTable(DataTable, IName, Boolean, Int32, Int32, Int32, Int32, Boolean)

Imports data from DataTable into the specified NamedRange of current worksheet with row and column offset.

Declaration

public int ImportDataTable(DataTable dataTable, IName namedRange, bool isFieldNameShown, int rowOffset, int columnOffset, int iMaxRow, int iMaxCol, bool bPreserveTypes)

Parameters

Type	Name	Description
System.Data.DataTable	dataTable	DataTable with desired data.
IName	namedRange	Represents named range.
System.Boolean	isFieldNameShown	TRUE if column names must be imported.
System.Int32	rowOffset	Represents row offset into named range to import.
System.Int32	columnOffset	Represents column offset into named range to import.
System.Int32	iMaxRow	Maximum number of rows to import.
System.Int32	iMaxCol	Maximum number of columns to import.
System.Boolean	bPreserveTypes	Indicates whether to preserve column types.

Returns

Type	Description
System.Int32	Number of imported rows.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

ImportDataTable(DataTable, Boolean, Int32, Int32)

Imports data from a DataTable into a worksheet with specified row and column.

Declaration

public int ImportDataTable(DataTable dataTable, bool isFieldNameShown, int firstRow, int firstColumn)

Parameters

Type	Name	Description
System.Data.DataTable	dataTable	DataTable with desired data.
System.Boolean	isFieldNameShown	TRUE if column names must be imported.
System.Int32	firstRow	First row from where the data should be imported.
System.Int32	firstColumn	First column from where the data should be imported.

Returns

Type	Description
System.Int32	Number of imported rows.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

ImportDataTable(DataTable, Boolean, Int32, Int32, Boolean)

Imports data from a DataTable into a worksheet with specified row and column along with the preserve type.

Declaration

public int ImportDataTable(DataTable dataTable, bool isFieldNameShown, int firstRow, int firstColumn, bool preserveTypes)

Parameters

Type	Name	Description
System.Data.DataTable	dataTable	DataTable with desired data.
System.Boolean	isFieldNameShown	True if column names must be imported.
System.Int32	firstRow	First row from where the data should be imported.
System.Int32	firstColumn	First column from where the data should be imported.
System.Boolean	preserveTypes	Indicates whether XlsIO should preserve column types from DataTable. By default, preserve type is FALSE. i.e., Setting it to True will import data based on column type, otherwise will import based on value type.

Returns

Type	Description
System.Int32	Number of imported rows.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

ImportDataTable(DataTable, Boolean, Int32, Int32, Int32, Int32)

Imports data from a DataTable into a worksheet with the specified range.

Declaration

public int ImportDataTable(DataTable dataTable, bool isFieldNameShown, int firstRow, int firstColumn, int maxRows, int maxColumns)

Parameters

Type	Name	Description
System.Data.DataTable	dataTable	DataTable with desired data.
System.Boolean	isFieldNameShown	True if column names must be imported.
System.Int32	firstRow	First row from where the data should be imported.
System.Int32	firstColumn	First column from where the data should be imported.
System.Int32	maxRows	Maximum number of rows to import.
System.Int32	maxColumns	Maximum number of columns to import.

Returns

Type	Description
System.Int32	Number of imported rows.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

ImportDataTable(DataTable, Boolean, Int32, Int32, Int32, Int32, Boolean)

Imports data from a DataTable into a worksheet with specified range along with the specified preserve type.

Declaration

public int ImportDataTable(DataTable dataTable, bool isFieldNameShown, int firstRow, int firstColumn, int maxRows, int maxColumns, bool preserveTypes)

Parameters

Type	Name	Description
System.Data.DataTable	dataTable	DataTable with desired data.
System.Boolean	isFieldNameShown	True if column names must be imported.
System.Int32	firstRow	First row from where the data should be imported.
System.Int32	firstColumn	First column from where the data should be imported.
System.Int32	maxRows	Maximum number of rows to import.
System.Int32	maxColumns	Maximum number of columns to import.
System.Boolean	preserveTypes	Indicates whether XlsIO should preserve column types from DataTable. By default, preserve type is FALSE. i.e., Setting it to True will import data based on column type, otherwise will import based on value type.

Returns

Type	Description
System.Int32	Number of imported rows.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

ImportDataTable(DataTable, Boolean, Int32, Int32, Int32, Int32, DataColumn[], Boolean)

Imports data from a DataTable into worksheet

Declaration

public int ImportDataTable(DataTable dataTable, bool isFieldNameShown, int firstRow, int firstColumn, int maxRows, int maxColumns, DataColumn[] arrDataColumns, bool bPreserveTypes)

Parameters

Type	Name	Description
System.Data.DataTable	dataTable	DataTable with desired data
System.Boolean	isFieldNameShown	TRUE if column names must also be imported
System.Int32	firstRow	First row from where the data should be imported.
System.Int32	firstColumn	First column from where the data should be imported.
System.Int32	maxRows	Maximum number of rows to import
System.Int32	maxColumns	Maximum number of columns to import
System.Data.DataColumn[]	arrDataColumns	Array of columns to import.
System.Boolean	bPreserveTypes	Indicates whether XlsIO should preserve column types from DataTable. By default, preserve type is FALSE. i.e., Setting it to True will import data based on column type, otherwise will import based on value type.

Returns

Type	Description
System.Int32	Number of imported rows

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

ImportDataTable(DataTable, Boolean, Int32, Int32, Int32, Int32, DataColumn[], Boolean, Boolean)

Imports data from a DataTable into worksheet

Declaration

public int ImportDataTable(DataTable dataTable, bool isFieldNameShown, int firstRow, int firstColumn, int maxRows, int maxColumns, DataColumn[] arrDataColumns, bool bPreserveTypes, bool bImportOnSave)

Parameters

Type	Name	Description
System.Data.DataTable	dataTable	DataTable with desired data
System.Boolean	isFieldNameShown	TRUE if column names must also be imported
System.Int32	firstRow	First row from where the data should be imported.
System.Int32	firstColumn	First column from where the data should be imported.
System.Int32	maxRows	Maximum number of rows to import
System.Int32	maxColumns	Maximum number of columns to import
System.Data.DataColumn[]	arrDataColumns	Array of columns to import.
System.Boolean	bPreserveTypes	Indicates whether XlsIO should preserve column types from DataTable. By default, preserve type is FALSE. i.e., Setting it to True will import data based on column type, otherwise will import based on value type.
System.Boolean	bImportOnSave	Indicates whether to serialize the data table directly.

Returns

Type	Description
System.Int32	Number of imported rows

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

ImportDataTable(DataTable, Int32, Int32, Boolean)

Imports data from a DataTable into a worksheet with the specified row and column along with save option.

Declaration

public int ImportDataTable(DataTable dataTable, int firstRow, int firstColumn, bool importOnSave)

Parameters

Type	Name	Description
System.Data.DataTable	dataTable	Data Table with desired data.
System.Int32	firstRow	First row from where the data should be imported.
System.Int32	firstColumn	First column from where the data should be imported.
System.Boolean	importOnSave	TRUE if data table must be serialized directly on save.

Returns

Type	Description
System.Int32	Number of imported rows.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

ImportDataTable(DataTable, Int32, Int32, Boolean, Boolean)

Imports data from a DataTable into a worksheet with the specified row and column along with save option.

Declaration

public int ImportDataTable(DataTable dataTable, int firstRow, int firstColumn, bool importOnSave, bool includeheader)

Parameters

Type	Name	Description
System.Data.DataTable	dataTable	Data Table with desired data.
System.Int32	firstRow	First row from where the data should be imported.
System.Int32	firstColumn	First column from where the data should be imported.
System.Boolean	importOnSave	TRUE if data table must be serialized directly on save.
System.Boolean	includeheader	TRUE if column names must be imported.

Returns

Type	Description
System.Int32	Number of imported rows.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

ImportDataView(DataView, Boolean, Int32, Int32)

Declaration

public int ImportDataView(DataView dataView, bool isFieldNameShown, int firstRow, int firstColumn)

Parameters

Type	Name	Description
System.Data.DataView	dataView
System.Boolean	isFieldNameShown
System.Int32	firstRow
System.Int32	firstColumn

Returns

Type
System.Int32

ImportDataView(DataView, Boolean, Int32, Int32, Boolean)

Imports data from a DataView into a worksheet with the specified range and preserve type.

Declaration

public int ImportDataView(DataView dataView, bool isFieldNameShown, int firstRow, int firstColumn, bool bPreserveTypes)

Parameters

Type	Name	Description
System.Data.DataView	dataView	DataView with desired data.
System.Boolean	isFieldNameShown	TRUE if column names must be imported.
System.Int32	firstRow	Row of the first cell where DataView should be imported.
System.Int32	firstColumn	Column of the first cell where DataView should be imported.
System.Boolean	bPreserveTypes	Indicates whether to preserve column types.

Returns

Type	Description
System.Int32	Number of imported rows.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

ImportDataView(DataView, Boolean, Int32, Int32, Int32, Int32)

Imports data from a DataView into a worksheet with specified row, column and preserve type.

Declaration

public int ImportDataView(DataView dataView, bool isFieldNameShown, int firstRow, int firstColumn, int maxRows, int maxColumns)

Parameters

Type	Name	Description
System.Data.DataView	dataView	Data View with desired data.
System.Boolean	isFieldNameShown	TRUE if column names must be imported.
System.Int32	firstRow	Row of the first cell where DataView should be imported.
System.Int32	firstColumn	Column of the first cell where DataView should be imported.
System.Int32	maxRows	Maximum number of rows to import.
System.Int32	maxColumns	Maximum number of columns to import.

Returns

Type	Description
System.Int32	Number of imported rows.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

ImportDataView(DataView, Boolean, Int32, Int32, Int32, Int32, Boolean)

Imports data from a DataView into a worksheet with specified range and preserve type.

Declaration

public int ImportDataView(DataView dataView, bool isFieldNameShown, int firstRow, int firstColumn, int maxRows, int maxColumns, bool bPreserveTypes)

Parameters

Type	Name	Description
System.Data.DataView	dataView	DataView with desired data.
System.Boolean	isFieldNameShown	TRUE if column names must also be imported.
System.Int32	firstRow	Row of the first cell where DataView should be imported.
System.Int32	firstColumn	Column of the first cell where DataView should be imported.
System.Int32	maxRows	Maximum number of rows to import.
System.Int32	maxColumns	Maximum number of columns to import.
System.Boolean	bPreserveTypes	Indicates whether XlsIO should try to preserve types in Data Table, i.e. if it is set to False (default) and in Data Table we have in string column value that contains only numbers, it would be converted to number.

Returns

Type	Description
System.Int32	Number of imported rows.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

ImportExtendedFormat(Int32, WorkbookImpl, Dictionary<Int32, Int32>)

Imports extended format from anther worksheet.

Declaration

protected int ImportExtendedFormat(int iXFIndex, WorkbookImpl basedOn, Dictionary<int, int> hashExtFormatIndexes)

Parameters

Type	Name	Description
System.Int32	iXFIndex	Extended format to import.
WorkbookImpl	basedOn	Source workbook.
System.Collections.Generic.Dictionary<System.Int32, System.Int32>	hashExtFormatIndexes	Dictionary key - old xf index, value - new xf index.

Returns

Type	Description
System.Int32	Index of the new format.

ImportHtmlTable(Stream, Int32, Int32)

Imports HTML table of a file stream into worksheet from the specified row and column.

Declaration

public void ImportHtmlTable(Stream fileStream, int row, int column)

Parameters

Type	Name	Description
System.IO.Stream	fileStream	Specifies the HTML filestream.
System.Int32	row	Specifies the starting row index.
System.Int32	column	Specifies the starting column index.

Examples

The following code illustrates how to convert HTML table to Excel.

ExcelEngine excelEngine = new ExcelEngine();
IApplication application = excelEngine.Excel;
application.DefaultVersion = ExcelVersion.Excel2013;
IWorkbook workbook = application.Workbooks.Create(1);

IWorksheet sheet = workbook.Worksheets[0];
FileStream html = new FileStream("HTMLtable.html", FileMode.Open, FileAccess.ReadWrite);

sheet.ImportHtmlTable(html, 1, 1);

workbook.SaveAs("HTMLToExcel.xlsx");
workbook.Close();
excelEngine.Dispose();

ImportHtmlTable(Stream, Int32, Int32, HtmlImportOptions)

Imports HTML table of a file stream into worksheet from the specified row, column and html import options.

Declaration

public void ImportHtmlTable(Stream fileStream, int row, int column, HtmlImportOptions htmlImportOptions)

Parameters

Type	Name	Description
System.IO.Stream	fileStream	Specifies the HTML filestream.
System.Int32	row	Specifies the starting row index.
System.Int32	column	Specifies the starting column index.
HtmlImportOptions	htmlImportOptions	Specifies the html import options.

Examples

The following code illustrates how to convert HTML table to Excel.

ExcelEngine excelEngine = new ExcelEngine();
IApplication application = excelEngine.Excel;
application.DefaultVersion = ExcelVersion.Xlsx;
IWorkbook workbook = application.Workbooks.Create(1);

IWorksheet sheet = workbook.Worksheets[0];
FileStream html = new FileStream("HTMLtable.html", FileMode.Open, FileAccess.ReadWrite);

sheet.ImportHtmlTable(html, 1, 1, HtmlImportOptions.DetectFormulas);

workbook.SaveAs("HTMLToExcel.xlsx");
workbook.Close();
excelEngine.Dispose();

ImportHtmlTable(String, Int32, Int32)

Imports HTML table of a HTML file into worksheet from the specified row and column.

Declaration

public void ImportHtmlTable(string fileName, int row, int column)

Parameters

Type	Name	Description
System.String	fileName	Specifies the HTML file.
System.Int32	row	Specifies the starting row index.
System.Int32	column	Specifies the starting column index.

Examples

The following code illustrates how to convert HTML table to Excel.

ExcelEngine excelEngine = new ExcelEngine();
IApplication application = excelEngine.Excel;
application.DefaultVersion = ExcelVersion.Excel2013;
IWorkbook workbook = application.Workbooks.Create(1);

IWorksheet sheet = workbook.Worksheets[0];

sheet.ImportHtmlTable("HTMLtable.html", 1, 1);

workbook.SaveAs("HTMLToExcel.xlsx");
workbook.Close();
excelEngine.Dispose();

ImportHtmlTable(String, Int32, Int32, HtmlImportOptions)

Imports tables from HTML document into Excel worksheet from the specified row and column with HTML import options.

Declaration

public void ImportHtmlTable(string fileName, int row, int column, HtmlImportOptions htmlImportOptions)

Parameters

Type	Name	Description
System.String	fileName	Specifies the HTML file.
System.Int32	row	Specifies the starting row index.
System.Int32	column	Specifies the starting column index.
HtmlImportOptions	htmlImportOptions	Specifies the html import options.

Examples

The following code illustrates how to convert HTML table to Excel.

ExcelEngine excelEngine = new ExcelEngine();
IApplication application = excelEngine.Excel;
application.DefaultVersion = ExcelVersion.Xlsx;
IWorkbook workbook = application.Workbooks.Create(1);

IWorksheet sheet = workbook.Worksheets[0];

sheet.ImportHtmlTable("HTMLtable.html", 1, 1, HtmlImportOptions.DetectFormulas);

workbook.SaveAs("HTMLToExcel.xlsx");
workbook.Close();
excelEngine.Dispose();

ImportXml(Stream, Int32, Int32)

Imports XML data into a worksheet at the specified row and column from a given XML data stream.

Declaration

public void ImportXml(Stream stream, int row, int column)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream data of the xml file.
System.Int32	row	Row where the data to be imported.
System.Int32	column	Column where the data to be imported.

Remarks

The stream should be passed as file stream to bind the xml

InitializeCollections()

Initializes all inner data such as Comments collection, Page setup, etc.

Declaration

protected override void InitializeCollections()

Overrides

WorksheetBaseImpl.InitializeCollections()

InnerGetCell(Int32, Int32)

Returns Range which represents specified cell.

Declaration

protected IRange InnerGetCell(int column, int row)

Parameters

Type	Name	Description
System.Int32	column	Column index of the cell.
System.Int32	row	Row index of the cell.

Returns

Type	Description
IRange	Range which represents specified cell.

InnerGetCell(Int32, Int32, Int32)

Returns Range which represents specified cell.

Declaration

protected IRange InnerGetCell(int column, int row, int iXFIndex)

Parameters

Type	Name	Description
System.Int32	column	Column index of the cell.
System.Int32	row	Row index of the cell.
System.Int32	iXFIndex	Index to extended format for new range.

Returns

Type	Description
IRange	Range which represents specified cell.

InnerGetCellStyle(Int32, Int32, Int32, RangeImpl)

Returns Range which represents specified cell.

Declaration

protected IStyle InnerGetCellStyle(int column, int row, int iXFIndex, RangeImpl rangeImpl)

Parameters

Type	Name	Description
System.Int32	column	Column index of the cell.
System.Int32	row	Row index of the cell.
System.Int32	iXFIndex	Index to extended format for new range.
RangeImpl	rangeImpl

Returns

Type	Description
IStyle	Range which represents specified cell.

InnerGetColumnDimensions(Int32, out Int32, out Int32)

Calculates dimensions of the specified column.

Declaration

protected void InnerGetColumnDimensions(int column, out int top, out int bottom)

Parameters

Type	Name	Description
System.Int32	column	Column dimension of which will be calculated.
System.Int32	top	Variable that will receive first used row in the specified column.
System.Int32	bottom	Variable that will receive last used row in the specified column.

InnerGetColumnWidth(Int32)

Returns width from ColumnInfoRecord if there is corresponding ColumnInfoRecord or StandardWidth if not.

Declaration

public double InnerGetColumnWidth(int iColumn)

Parameters

Type	Name	Description
System.Int32	iColumn	One-based index of the column.

Returns

Type	Description
System.Double	Width of the specified column.

InnerGetDimensions(out Int32, out Int32, out Int32, out Int32)

Returns dimensions of the worksheet.

Declaration

protected void InnerGetDimensions(out int left, out int top, out int right, out int bottom)

Parameters

Type	Name	Description
System.Int32	left	Variable that receives index of the first used column.
System.Int32	top	Variable that receives index of the first used row.
System.Int32	right	Variable that receives index of the last used column.
System.Int32	bottom	Variable that receives index of the last used row.

InnerGetRowHeight(Int32, Boolean)

Returns height from RowRecord if there is a corresponding RowRecord. Otherwise returns StandardHeight.

Declaration

public double InnerGetRowHeight(int iRow, bool bRaiseEvents)

Parameters

Type	Name	Description
System.Int32	iRow	One-based index of the row
System.Boolean	bRaiseEvents	Indicates whether to raise events on row autofitting.

Returns

Type	Description
System.Double	Height from RowRecord if there is corresponding RowRecord. Otherwise returns StandardHeight.

InnerSetCell(Int32, Int32, RangeImpl)

Sets Range which represents specified cell.

Declaration

protected void InnerSetCell(int column, int row, RangeImpl range)

Parameters

Type	Name	Description
System.Int32	column	Column index of the cell.
System.Int32	row	Row index of the cell.
RangeImpl	range	Range which represents specified cell.

InnerSetCell(Int32, Int32, BiffRecordRaw)

Sets cell value.

Declaration

protected void InnerSetCell(int iColumn, int iRow, BiffRecordRaw record)

Parameters

Type	Name	Description
System.Int32	iColumn	One-based column index.
System.Int32	iRow	One-based row index.
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw	record	Record to set into cell.

InnerSetCell(Int64, BiffRecordRaw)

Sets cell value.

Declaration

protected void InnerSetCell(long cellIndex, BiffRecordRaw record)

Parameters

Type	Name	Description
System.Int64	cellIndex	Cell index.
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw	record	Record to set into cell.

InsertColumn(Int32)

Inserts an empty column for the specified column index.

Declaration

public void InsertColumn(int iColumnIndex)

Parameters

Type	Name	Description
System.Int32	iColumnIndex	Index at which new column should be inserted.

InsertColumn(Int32, Int32)

Inserts an empty column in the specified column index based on column count.

Declaration

public void InsertColumn(int iColumnIndex, int iColumnCount)

Parameters

Type	Name	Description
System.Int32	iColumnIndex	Index at which new column should be inserted.
System.Int32	iColumnCount	Number of columns to insert.

InsertColumn(Int32, Int32, ExcelInsertOptions)

Inserts an empty column with default formatting with specified Inserting options.

Declaration

public void InsertColumn(int iColumnIndex, int iColumnCount, ExcelInsertOptions insertOptions)

Parameters

Type	Name	Description
System.Int32	iColumnIndex	Index at which new column should be inserted
System.Int32	iColumnCount	Number of columns to insert.
ExcelInsertOptions	insertOptions	Insert options.

InsertRow(Int32)

Inserts an empty row in the specified row index.

Declaration

public void InsertRow(int iRowIndex)

Parameters

Type	Name	Description
System.Int32	iRowIndex

InsertRow(Int32, Int32)

Inserts an empty rows in the specified row index based on row count.

Declaration

public void InsertRow(int iRowIndex, int iRowCount)

Parameters

Type	Name	Description
System.Int32	iRowIndex	Index at which new row should be inserted.
System.Int32	iRowCount	Number of rows to insert.

InsertRow(Int32, Int32, ExcelInsertOptions)

Inserts an empty row in the specified row index with specified ExcelInsertOptions based on row count.

Declaration

public void InsertRow(int iRowIndex, int iRowCount, ExcelInsertOptions insertOptions)

Parameters

Type	Name	Description
System.Int32	iRowIndex	Index at which new row should be inserted.
System.Int32	iRowCount	Number of rows to insert.
ExcelInsertOptions	insertOptions	Insert options.

IntersectRanges(IRange, IRange)

Intersects two ranges.

Declaration

public IRange IntersectRanges(IRange range1, IRange range2)

Parameters

Type	Name	Description
IRange	range1	First range to intersect.
IRange	range2	Second range to intersect.

Returns

Type	Description
IRange	Intersection of two ranges or NULL if there is no range intersection.

Exceptions

Type	Condition
System.ArgumentNullException	When range1 or range2 is NULL.

IsArrayFormula(FormulaRecord)

Tells whether specific FormulaRecord is array-entered formula.

Declaration

public bool IsArrayFormula(FormulaRecord formula)

Parameters

Type	Name	Description
FormulaRecord	formula	FormulaRecord to check.

Returns

Type	Description
System.Boolean	True if it is array-entered formula.

IsArrayFormula(Int64)

Indicates whether cell contains array-entered formula.

Declaration

public bool IsArrayFormula(long cellIndex)

Parameters

Type	Name	Description
System.Int64	cellIndex	Cell index to check.

Returns

Type	Description
System.Boolean	True if cell contains array-entered formula.

IsColumnVisible(Int32)

Returns True if the specified column is visible to end user.

Declaration

public bool IsColumnVisible(int columnIndex)

Parameters

Type	Name	Description
System.Int32	columnIndex	One-based column index.

Returns

Type	Description
System.Boolean	True if column is visible; otherwise, False.

IsExternalFormula(Int32, Int32)

Indicates is formula in cell is formula to external workbook.

Declaration

public bool IsExternalFormula(int row, int column)

Parameters

Type	Name	Description
System.Int32	row	Represents row index.
System.Int32	column	Represents column index.

Returns

Type	Description
System.Boolean	If contain extern formula returns true; otherwise false.

IsRowVisible(Int32)

Returns True if the specified row is visible to end user.

Declaration

public bool IsRowVisible(int rowIndex)

Parameters

Type	Name	Description
System.Int32	rowIndex	One-based row index.

Returns

Type	Description
System.Boolean	True if row is visible; otherwise, False.

MarkUsedReferences(Boolean[])

Sets items with used reference indexes to true.

Declaration

public override void MarkUsedReferences(bool[] usedItems)

Parameters

Type	Name	Description
System.Boolean[]	usedItems	Array to mark used references in.

Overrides

WorksheetBaseImpl.MarkUsedReferences(Boolean[])

MergeRanges(IRange, IRange)

Merges two ranges.

Declaration

public IRange MergeRanges(IRange range1, IRange range2)

Parameters

Type	Name	Description
IRange	range1	First range to merge.
IRange	range2	Second range to merge.

Returns

Type	Description
IRange	Merged ranges or NULL if is not able to merge ranges.

Exceptions

Type	Condition
System.ArgumentNullException	When range1 or range2 is NULL.

Move(Int32)

Moves worksheet to the specified index.

Declaration

public void Move(int iNewIndex)

Parameters

Type	Name	Description
System.Int32	iNewIndex	New index of the worksheet.

MoveRange(IRange, IRange, ExcelCopyRangeOptions, Boolean)

Moves range to new position.

Declaration

public void MoveRange(IRange destination, IRange source, ExcelCopyRangeOptions options, bool bUpdateRowRecords)

Parameters

Type	Name	Description
IRange	destination	Destination range.
IRange	source	Source range.
ExcelCopyRangeOptions	options	Move options.
System.Boolean	bUpdateRowRecords	Indicates whether row information such as row height, default style, etc. must be copied from cache.

Exceptions

Type	Condition
System.ArgumentException	When source and destination ranges have different sizes.

OnDispose()

This method is called during dispose operation.

Declaration

protected override void OnDispose()

Overrides

CommonObject.OnDispose()

OnRealIndexChanged(Int32)

This method is called after RealIndex property change.

Declaration

protected override void OnRealIndexChanged(int iOldIndex)

Parameters

Type	Name	Description
System.Int32	iOldIndex	Old value.

Overrides

WorksheetBaseImpl.OnRealIndexChanged(Int32)

OnValueChanged(Int32, Int32, String)

Raises the ValueChanged event.

Declaration

public void OnValueChanged(int row, int col, string value)

Parameters

Type	Name	Description
System.Int32	row	The row of the change.
System.Int32	col	The column of the change.
System.String	value	The changed value.

Parse(BiffReader, IDecryptor)

Method extracts biff records belonging to the worksheet.

Declaration

protected void Parse(BiffReader reader, IDecryptor decryptor)

Parameters

Type	Name	Description
BiffReader	reader	BiffReader that contains worksheet's records.
IDecryptor	decryptor	Object used to decrypt encrypted records.

Parse(TextReader, String, Int32, Int32, Boolean)

Method opens excel file using separator.

Declaration

public void Parse(TextReader streamToRead, string separator, int row, int column, bool isValid)

Parameters

Type	Name	Description
System.IO.TextReader	streamToRead	Stream to reading.
System.String	separator	Denotes separator for the CSV file types.
System.Int32	row	First row to write.
System.Int32	column	First column to write.
System.Boolean	isValid	boolen value for the valid document

ParseAutoFilters()

Parses autofilters.

Declaration

public void ParseAutoFilters()

ParseCFFromExcel2007(FileDataHolder)

Parses Excel 2007 conditional formatting.

Declaration

public void ParseCFFromExcel2007(FileDataHolder dataHolder)

Parameters

Type	Name	Description
FileDataHolder	dataHolder	Workbook file data holder.

ParseData(Dictionary<Int32, Int32>)

Parses worksheet's data.

Declaration

protected override void ParseData(Dictionary<int, int> dictUpdatedSSTIndexes)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.Int32, System.Int32>	dictUpdatedSSTIndexes

Overrides

WorksheetBaseImpl.ParseData(Dictionary<Int32, Int32>)

ParseDimensions(DimensionsRecord)

Parses dimensions record.

Declaration

protected override void ParseDimensions(DimensionsRecord dimensions)

Parameters

Type	Name	Description
DimensionsRecord	dimensions	Record to parse.

Overrides

WorksheetBaseImpl.ParseDimensions(DimensionsRecord)

ParseNextRecord(BiffReader, Int32, ExcelParseOptions, Boolean, Dictionary<Int32, Int32>, IDecryptor)

Extracts next record from reader and parses it.

Declaration

protected override int ParseNextRecord(BiffReader reader, int iBOFCounter, ExcelParseOptions options, bool bSkipStyles, Dictionary<int, int> hashNewXFormatIndexes, IDecryptor decryptor)

Parameters

Type	Name	Description
BiffReader	reader	Reader to extract record from.
System.Int32	iBOFCounter	Number of BOF records without closing EOF record.
ExcelParseOptions	options	Parsing options.
System.Boolean	bSkipStyles	Indicates whether styles information must be skipped.
System.Collections.Generic.Dictionary<System.Int32, System.Int32>	hashNewXFormatIndexes	Dictionary with new extended format indexes for ignore styles mode.
IDecryptor	decryptor	Object that decrypts data if necessary.

Returns

Type	Description
System.Int32	Updated number of BOF records without closing EOF record.

Overrides

WorksheetBaseImpl.ParseNextRecord(BiffReader, Int32, ExcelParseOptions, Boolean, Dictionary<Int32, Int32>, IDecryptor)

ParseRecord(BiffRecordRaw, Boolean, Dictionary<Int32, Int32>)

Parses single record.

Declaration

protected override void ParseRecord(BiffRecordRaw raw, bool bIgnoreStyles, Dictionary<int, int> hashNewXFormatIndexes)

Parameters

Type	Name	Description
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw	raw	Record to parse.
System.Boolean	bIgnoreStyles	Indicates whether to ignore styles information.
System.Collections.Generic.Dictionary<System.Int32, System.Int32>	hashNewXFormatIndexes	Dictionary with new extended format index.

Overrides

WorksheetBaseImpl.ParseRecord(BiffRecordRaw, Boolean, Dictionary<Int32, Int32>)

ParseSheetCF()

Parses worksheet conditional formats in Excel2007 version.

Declaration

public void ParseSheetCF()

PEExportDataTable(IRange, ExcelExportDataTableOptions, PivotTableImpl)

Exports worksheet data into a Data Table.

Declaration

public DataTable PEExportDataTable(IRange range, ExcelExportDataTableOptions options, PivotTableImpl pivotTable)

Parameters

Type	Name	Description
IRange	range	Range to export.
ExcelExportDataTableOptions	options	Export options.
PivotTableImpl	pivotTable

Returns

Type	Description
System.Data.DataTable	Data Table with worksheet data.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

PixelsToColumnWidth(Int32)

Converts the specified column width from pixels to points.

Declaration

public double PixelsToColumnWidth(int pixels)

Parameters

Type	Name	Description
System.Int32	pixels	Width in pixels.

Returns

Type	Description
System.Double	Width in points.

PrepareProtectionOptions(ExcelSheetProtection)

Prepares protection options before setting protection.

Declaration

protected override ExcelSheetProtection PrepareProtectionOptions(ExcelSheetProtection options)

Parameters

Type	Name	Description
ExcelSheetProtection	options

Returns

Type
ExcelSheetProtection

Overrides

WorksheetBaseImpl.PrepareProtectionOptions(ExcelSheetProtection)

PrepareVariables(ExcelParseOptions, Boolean)

Prepares variables to worksheet parsing.

Declaration

protected override void PrepareVariables(ExcelParseOptions options, bool bSkipParsing)

Parameters

Type	Name	Description
ExcelParseOptions	options
System.Boolean	bSkipParsing

Overrides

WorksheetBaseImpl.PrepareVariables(ExcelParseOptions, Boolean)

RaiseColumnWidthChangedEvent(Int32, Double)

Raises ColumnWidthChanged event.

Declaration

protected void RaiseColumnWidthChangedEvent(int iColumn, double dNewValue)

Parameters

Type	Name	Description
System.Int32	iColumn	Zero-based column index.
System.Double	dNewValue	New width value.

RaiseRowHeightChangedEvent(Int32, Double)

Raises RowHeightChanged event.

Declaration

protected void RaiseRowHeightChangedEvent(int iRow, double dNewValue)

Parameters

Type	Name	Description
System.Int32	iRow	Zero-based row index.
System.Double	dNewValue	New height.

ReAddAllStrings()

Looks through all records and calls AddIncrease for each LabelSST record.

Declaration

public void ReAddAllStrings()

Remove()

Removes worksheet from parent worksheet collection.

Declaration

public void Remove()

remove_CellValueChanged(RangeImpl.CellValueChangedEventHandler)

Declaration

public void remove_CellValueChanged(RangeImpl.CellValueChangedEventHandler value)

Parameters

Type	Name	Description
RangeImpl.CellValueChangedEventHandler	value

remove_ColumnWidthChanged(ValueChangedEventHandler)

Declaration

public void remove_ColumnWidthChanged(ValueChangedEventHandler value)

Parameters

Type	Name	Description
Syncfusion.XlsIO.Implementation.ValueChangedEventHandler	value

remove_ExportDataTableEvent(WorksheetImpl.ExportDataTableEventHandler)

Declaration

public void remove_ExportDataTableEvent(WorksheetImpl.ExportDataTableEventHandler value)

Parameters

Type	Name	Description
WorksheetImpl.ExportDataTableEventHandler	value

remove_MissingFunction(MissingFunctionEventHandler)

Declaration

public void remove_MissingFunction(MissingFunctionEventHandler value)

Parameters

Type	Name	Description
MissingFunctionEventHandler	value

remove_RowHeightChanged(ValueChangedEventHandler)

Declaration

public void remove_RowHeightChanged(ValueChangedEventHandler value)

Parameters

Type	Name	Description
Syncfusion.XlsIO.Implementation.ValueChangedEventHandler	value

remove_ValueChanged(ValueChangedEventHandler)

Declaration

public void remove_ValueChanged(ValueChangedEventHandler value)

Parameters

Type	Name	Description
ValueChangedEventHandler	value

RemoveArrayFormula(ArrayRecord, Boolean)

Removes all formulas in colRemove from internal ArrayFormula collection.

Declaration

protected void RemoveArrayFormula(ArrayRecord record, bool bClearRange)

Parameters

Type	Name	Description
ArrayRecord	record	Formula to remove.
System.Boolean	bClearRange	Indicates whether to clear range before remove operation.

RemoveArrayFormulas(ICollection<ArrayRecord>, Boolean)

Removes all formulas in colRemove from internal ArrayFormula collection.

Declaration

public void RemoveArrayFormulas(ICollection<ArrayRecord> colRemove, bool bClearRange)

Parameters

Type	Name	Description
System.Collections.Generic.ICollection<ArrayRecord>	colRemove	Formulas to remove.
System.Boolean	bClearRange	Indicates whether to clear range before remove operation.

RemoveMergedCells(IRange)

Removes merged cells.

Declaration

public void RemoveMergedCells(IRange range)

Parameters

Type	Name	Description
IRange	range	Represent range of merged cells.

RemovePanes()

Removes panes from a worksheet.

Declaration

public void RemovePanes()

Replace(String, DataColumn, Boolean)

Replaces string with the specified datacolumn value.

Declaration

public void Replace(string oldValue, DataColumn column, bool isFieldNamesShown)

Parameters

Type	Name	Description
System.String	oldValue	The string to be replaced.
System.Data.DataColumn	column
System.Boolean	isFieldNamesShown	Indicates whether field name must be shown.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

Replace(String, DataTable, Boolean)

Replaces string with the specified datatable value.

Declaration

public void Replace(string oldValue, DataTable newValues, bool isFieldNamesShown)

Parameters

Type	Name	Description
System.String	oldValue	The string to be replaced.
System.Data.DataTable	newValues	Data table with new data.
System.Boolean	isFieldNamesShown	Indicates whether field name must be shown.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

Replace(String, DateTime)

Replaces string with the specified DateTime value.

Declaration

public void Replace(string oldValue, DateTime newValue)

Parameters

Type	Name	Description
System.String	oldValue	The string to be replaced.
System.DateTime	newValue	The DateTime to replace all occurrences of oldValue.

Replace(String, Double)

Replaces string with the specified double value.

Declaration

public void Replace(string oldValue, double newValue)

Parameters

Type	Name	Description
System.String	oldValue	The string to be replaced.
System.Double	newValue	The double value to replace all occurrences of oldValue.

Replace(String, Double[], Boolean)

Replaces specified string with the specified array of double values.

Declaration

public void Replace(string oldValue, double[] newValues, bool isVertical)

Parameters

Type	Name	Description
System.String	oldValue	The string to be replaced.
System.Double[]	newValues	Array of new values.
System.Boolean	isVertical	Indicates whether array should be inserted vertically.

Replace(String, Int32[], Boolean)

Replaces specified string with the specified array of int values.

Declaration

public void Replace(string oldValue, int[] newValues, bool isVertical)

Parameters

Type	Name	Description
System.String	oldValue	The string to be replaced.
System.Int32[]	newValues	Array of new values.
System.Boolean	isVertical	Indicates whether array should be inserted vertically.

Replace(String, String)

Replaces string with the specified another string value.

Declaration

public void Replace(string oldValue, string newValue)

Parameters

Type	Name	Description
System.String	oldValue	The string to be replaced.
System.String	newValue	The string to replace all occurrences of oldValue.

Replace(String, String, ExcelFindOptions)

Replaces string with the specified another string value based on the ExcelFindOptions.

Declaration

public void Replace(string oldValue, string newValue, ExcelFindOptions findOptions)

Parameters

Type	Name	Description
System.String	oldValue	The string to be replaced.
System.String	newValue	The string to replace all occurrences of oldValue.
ExcelFindOptions	findOptions	Specifies the find options for the oldValue.

Replace(String, String[], Boolean)

Replaces specified string with the specified array of string values.

Declaration

public void Replace(string oldValue, string[] newValues, bool isVertical)

Parameters

Type	Name	Description
System.String	oldValue	The string to be replaced.
System.String[]	newValues	Array of new values.
System.Boolean	isVertical	Indicates whether array should be inserted vertically.

SaveAs(Stream, String)

Saves worksheet as stream using separator. Used only for CSV files.

Declaration

public void SaveAs(Stream stream, string separator)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to save.
System.String	separator	Denotes separator for the CSV file types.

SaveAs(Stream, String, Encoding)

Saves worksheet as stream using separator with specified encoding. Used only for CSV files.

Declaration

public void SaveAs(Stream stream, string separator, Encoding encoding)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to save.
System.String	separator	Denotes separator for the CSV file types.
System.Text.Encoding	encoding	Encoding to use.

SaveAsHtml(Stream)

Saves worksheet as stream.

Declaration

public void SaveAsHtml(Stream stream)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to save.

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

SaveAsHtml(Stream, HtmlSaveOptions)

Saves worksheet as stream with the specified HtmlSaveOptions.

Declaration

public void SaveAsHtml(Stream stream, HtmlSaveOptions saveOption)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream to save.
HtmlSaveOptions	saveOption

Remarks

This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

Serialize(OffsetArrayList)

Saves worksheet into specified OffsetArrayList.

Declaration

public override void Serialize(OffsetArrayList records)

Parameters

Type	Name	Description
OffsetArrayList	records	OffsetArrayList that will receive all of the worksheet's records.

Overrides

WorksheetBaseImpl.Serialize(OffsetArrayList)

Exceptions

Type	Condition
System.ArgumentNullException	When records is null

SerializeColumnInfo(OffsetArrayList)

Saves ColumnInfoRecords into specified OffsetArrayList

Declaration

protected void SerializeColumnInfo(OffsetArrayList records)

Parameters

Type	Name	Description
OffsetArrayList	records	OffsetArrayList that will receive all ColumnInfoRecords

Exceptions

Type	Condition
System.ArgumentNullException	When records is null

SerializeConditionalFormatting(OffsetArrayList)

Serializes conditional formats.

Declaration

protected void SerializeConditionalFormatting(OffsetArrayList records)

Parameters

Type	Name	Description
OffsetArrayList	records	OffsetArrayList that will receive format records.

SerializeDataValidation(OffsetArrayList)

Serializes data validation table.

Declaration

protected void SerializeDataValidation(OffsetArrayList records)

Parameters

Type	Name	Description
OffsetArrayList	records	OffsetArrayList that will receive data validation records.

SerializeForClipboard(OffsetArrayList)

Saves worksheet into specified OffsetArrayList in Clipboard format

Declaration

public void SerializeForClipboard(OffsetArrayList records)

Parameters

Type	Name	Description
OffsetArrayList	records	OffsetArrayList that will receive all worksheet's records

Exceptions

Type	Condition
System.ArgumentNullException	When records is null

SerializeGroupColumnInfo(OffsetArrayList)

Saves specified ColumnInfoRecords into specified OffsetArrayList

Declaration

protected int SerializeGroupColumnInfo(OffsetArrayList records)

Parameters

Type	Name	Description
OffsetArrayList	records	OffsetArrayList that will receive all ColumnInfoRecords

Returns

Type	Description
System.Int32	Index of last column

Exceptions

Type	Condition
System.ArgumentNullException	When records or values is null

SerializeMsoDrawings(OffsetArrayList)

Saves all shapes.

Declaration

protected override void SerializeMsoDrawings(OffsetArrayList records)

Parameters

Type	Name	Description
OffsetArrayList	records	List to save records into.

Overrides

WorksheetBaseImpl.SerializeMsoDrawings(OffsetArrayList)

SetActiveCell(IRange)

Sets active cell

Declaration

public void SetActiveCell(IRange range)

Parameters

Type	Name	Description
IRange	range	Cell to activate.

SetActiveCell(IRange, Boolean)

Sets active cell

Declaration

public void SetActiveCell(IRange range, bool updateApplication)

Parameters

Type	Name	Description
IRange	range	Cell to activate.
System.Boolean	updateApplication

SetBlank(Int32, Int32)

Blanks the specified cell.

Declaration

public void SetBlank(int iRow, int iColumn)

Parameters

Type	Name	Description
System.Int32	iRow	One-based row index.
System.Int32	iColumn	One-based column index.

SetBoolean(Int32, Int32, Boolean)

Sets boolean value for the specified cell.

Declaration

public void SetBoolean(int iRow, int iColumn, bool value)

Parameters

Type	Name	Description
System.Int32	iRow	One-based row index.
System.Int32	iColumn	One-based column index.
System.Boolean	value	Value to set.

SetColumnWidth(Int32, Double)

Sets column width for the specified column.

Declaration

public void SetColumnWidth(int iColumn, double value)

Parameters

Type	Name	Description
System.Int32	iColumn
System.Double	value	Width to set.

SetColumnWidthInPixels(Int32, Int32)

Sets column width in pixels for the specified column.

Declaration

public void SetColumnWidthInPixels(int iColumn, int value)

Parameters

Type	Name	Description
System.Int32	iColumn	One-based column index.
System.Int32	value	Width in pixels to set.

SetColumnWidthInPixels(Int32, Int32, Int32)

Sets column width in pixels to the given number of columns from the specified column index.

Declaration

public void SetColumnWidthInPixels(int iStartColumnIndex, int iCount, int value)

Parameters

Type	Name	Description
System.Int32	iStartColumnIndex	Start Column index
System.Int32	iCount	No of Column to be set width
System.Int32	value	Value in pixel to set

SetDefaultColumnStyle(Int32, IStyle)

Sets the default column style for the specified column.

Declaration

public void SetDefaultColumnStyle(int iColumnIndex, IStyle defaultStyle)

Parameters

Type	Name	Description
System.Int32	iColumnIndex	One-based column index.
IStyle	defaultStyle	Default style.

SetDefaultColumnStyle(Int32, Int32, IStyle)

Sets the default column style for the specified starting and ending column.

Declaration

public void SetDefaultColumnStyle(int iStartColumnIndex, int iEndColumnIndex, IStyle defaultStyle)

Parameters

Type	Name	Description
System.Int32	iStartColumnIndex	Starting column index.
System.Int32	iEndColumnIndex	Ending column index.
IStyle	defaultStyle	Default style.

SetDefaultRowStyle(Int32, IStyle)

Sets the default row style for the specified row.

Declaration

public void SetDefaultRowStyle(int iRowIndex, IStyle defaultStyle)

Parameters

Type	Name	Description
System.Int32	iRowIndex	One-based row index.
IStyle	defaultStyle	Default style.

SetDefaultRowStyle(Int32, Int32, IStyle)

Sets the default row style for the specified starting and ending row.

Declaration

public void SetDefaultRowStyle(int iStartRowIndex, int iEndRowIndex, IStyle defaultStyle)

Parameters

Type	Name	Description
System.Int32	iStartRowIndex	Starting row index.
System.Int32	iEndRowIndex	Ending row index.
IStyle	defaultStyle	Default style.

SetError(Int32, Int32, String)

Sets error for the specified cell.

Declaration

public void SetError(int iRow, int iColumn, string value)

Parameters

Type	Name	Description
System.Int32	iRow	One-based row index.
System.Int32	iColumn	One-based column index.
System.String	value	Error to set.

SetError(Int32, Int32, String, Boolean)

Sets error value.

Declaration

public void SetError(int iRow, int iColumn, string value, bool isSetText)

Parameters

Type	Name	Description
System.Int32	iRow	Row index.
System.Int32	iColumn	Column index.
System.String	value	Value representing error name.
System.Boolean	isSetText	Indicates whether to set text.

SetFormula(Int32, Int32, String)

Sets formula for the specified cell.

Declaration

public void SetFormula(int iRow, int iColumn, string value)

Parameters

Type	Name	Description
System.Int32	iRow	One-based row index.
System.Int32	iColumn	One-based column index.
System.String	value	Formula to set.

SetFormula(Int32, Int32, String, Boolean)

Sets formula in the specified cell.

Declaration

public void SetFormula(int iRow, int iColumn, string value, bool bIsR1C1)

Parameters

Type	Name	Description
System.Int32	iRow	One-based row index of the cell to set value.
System.Int32	iColumn	One-based column index of the cell to set value.
System.String	value	Formula to set.
System.Boolean	bIsR1C1	Indicates is formula in R1C1 notation.

SetFormulaBoolValue(Int32, Int32, Boolean)

Sets formula bool value for the specified cell.

Declaration

public void SetFormulaBoolValue(int iRow, int iColumn, bool value)

Parameters

Type	Name	Description
System.Int32	iRow	One-based row index.
System.Int32	iColumn	One-based column index.
System.Boolean	value	Represents formula bool value.

SetFormulaErrorValue(Int32, Int32, String)

Sets formula error value for the specified cell.

Declaration

public void SetFormulaErrorValue(int iRow, int iColumn, string value)

Parameters

Type	Name	Description
System.Int32	iRow	One-based row index.
System.Int32	iColumn	One-based column index.
System.String	value	Represents formula error value.

SetFormulaNumberValue(Int32, Int32, Double)

Sets formula number value for the specified cell.

Declaration

public void SetFormulaNumberValue(int iRow, int iColumn, double value)

Parameters

Type	Name	Description
System.Int32	iRow	One-based row index.
System.Int32	iColumn	One-based column index.
System.Double	value	Represents formula number value.

SetFormulaStringValue(Int32, Int32, String)

Sets formula string value for the specified cell.

Declaration

public void SetFormulaStringValue(int iRow, int iColumn, string value)

Parameters

Type	Name	Description
System.Int32	iRow	One-based row index.
System.Int32	iColumn	One-based column index.
System.String	value	Represents formula string value.

SetFormulaValue(Int32, Int32, String)

Sets formula value in the specified cell.

Declaration

public void SetFormulaValue(int iRow, int iColumn, string value)

Parameters

Type	Name	Description
System.Int32	iRow	One-based row index of the cell to set value.
System.Int32	iColumn	One-based column index of the cell to set value.
System.String	value	Value to set.

SetLabelSSTIndex(Int64, Int32)

Sets string index in the specified cell.

Declaration

public void SetLabelSSTIndex(long cellIndex, int iSSTIndex)

Parameters

Type	Name	Description
System.Int64	cellIndex	Cell index to set sst index in.
System.Int32	iSSTIndex	SST index to set.

SetNumber(Int32, Int32, Double)

Sets number for the specified cell.

Declaration

public void SetNumber(int iRow, int iColumn, double value)

Parameters

Type	Name	Description
System.Int32	iRow	One-based row index.
System.Int32	iColumn	One-based column index.
System.Double	value	Value to set.

SetPaneCell(IRange)

Sets cell at which panes are frozen.

Declaration

public void SetPaneCell(IRange range)

Parameters

Type	Name	Description
IRange	range

SetRowHeight(Int32, Double)

Sets row height for the specified row.

Declaration

public void SetRowHeight(int iRow, double value)

Parameters

Type	Name	Description
System.Int32	iRow	One-based row index.
System.Double	value	Height to set.

SetRowHeightInPixels(Int32, Double)

Sets row height in pixels for the specified row.

Declaration

public void SetRowHeightInPixels(int iRowIndex, double value)

Parameters

Type	Name	Description
System.Int32	iRowIndex	One-based row index.
System.Double	value	Value in pixels to set.

SetRowHeightInPixels(Int32, Int32, Double)

Sets row height in pixels to the given number of rows from the specified row index.

Declaration

public void SetRowHeightInPixels(int iStartRowIndex, int iCount, double value)

Parameters

Type	Name	Description
System.Int32	iStartRowIndex	Starting row index.
System.Int32	iCount	No of Row to be set width.
System.Double	value	Value in pixels to set.

SetStringPreservedValue(ICombinedRange, Nullable<Boolean>)

Sets value indicating whether string should be preserved for range.

Declaration

public void SetStringPreservedValue(ICombinedRange range, Nullable<bool> value)

Parameters

Type	Name	Description
ICombinedRange	range	Range to set value for.
System.Nullable<System.Boolean>	value	Value to set.

SetText(Int32, Int32, String)

Sets text for the specified cell.

Declaration

public void SetText(int iRow, int iColumn, string value)

Parameters

Type	Name	Description
System.Int32	iRow	One-based row index.
System.Int32	iColumn	One-based column index.
System.String	value	Text to set.

SetValue(Int32, Int32, String)

Sets value for the specified cell.

Declaration

public void SetValue(int iRow, int iColumn, string value)

Parameters

Type	Name	Description
System.Int32	iRow	One-based row index.
System.Int32	iColumn	One-based column index.
System.String	value	Value to set.

SetValueRowCol(Object, Int32, Int32)

Sets the value of a cell.

Declaration

public void SetValueRowCol(object value, int row, int col)

Parameters

Type	Name	Description
System.Object	value	The value to be set.
System.Int32	row	The row of the cell.
System.Int32	col	The column of the cell.

ShowColumn(Int32, Boolean)

Shows the specified column.

Declaration

public void ShowColumn(int columnIndex, bool isVisible)

Parameters

Type	Name	Description
System.Int32	columnIndex	Index at which the column should be hidden.
System.Boolean	isVisible	True - Column is visible; False - hidden.

ShowRange(RangesCollection, Boolean)

Shows or Hides the collection of range.

Declaration

public void ShowRange(RangesCollection ranges, bool isVisible)

Parameters

Type	Name	Description
RangesCollection	ranges	Ranges specifies the range collection.
System.Boolean	isVisible	True - Row is visible; false - hidden.

ShowRange(IRange, Boolean)

Shows or Hides the specified range.

Declaration

public void ShowRange(IRange range, bool isVisible)

Parameters

Type	Name	Description
IRange	range	Range specifies the particular range to show / hide.
System.Boolean	isVisible	True - Row is visible; False - hidden.

ShowRange(IRange[], Boolean)

Shows or Hides an array of range.

Declaration

public void ShowRange(IRange[] ranges, bool isVisible)

Parameters

Type	Name	Description
IRange[]	ranges	Ranges specifies the range array.
System.Boolean	isVisible	True - Row is visible; False - hidden.

ShowRow(Int32, Boolean)

Shows or Hides the specified row.

Declaration

public void ShowRow(int rowIndex, bool isVisible)

Parameters

Type	Name	Description
System.Int32	rowIndex	Index at which the row should be hidden.
System.Boolean	isVisible	True - Row is visible; False - hidden.

TryCreateRkRecord(Int32, Int32, Double)

Tries to create Rk record from double value.

Declaration

protected RKRecord TryCreateRkRecord(int iRow, int iColumn, double value)

Parameters

Type	Name	Description
System.Int32	iRow	Row index.
System.Int32	iColumn	Column index.
System.Double	value	Double that should be converted to RkRecord.

Returns

Type	Description
RKRecord	Created RkRecord if succeeded, null otherwise.

TryCreateRkRecord(Int32, Int32, Double, Int32)

Tries to create Rk record from double value.

Declaration

protected RKRecord TryCreateRkRecord(int iRow, int iColumn, double value, int iXFIndex)

Parameters

Type	Name	Description
System.Int32	iRow	Row index.
System.Int32	iColumn	Column index.
System.Double	value	Double that should be converted to RkRecord.
System.Int32	iXFIndex	Represents xf index.

Returns

Type	Description
RKRecord	Created RkRecord if succeeded, null otherwise.

UpdateExtendedFormatIndex(Dictionary<Int32, Int32>)

This method should be called immediately after extended format removal.

Declaration

public override void UpdateExtendedFormatIndex(Dictionary<int, int> dictFormats)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.Int32, System.Int32>	dictFormats	Dictionary with updated extended formats.

Overrides

WorksheetBaseImpl.UpdateExtendedFormatIndex(Dictionary<Int32, Int32>)

UpdateExtendedFormatIndex(Int32)

This method updates indexes to the extended formats after version change.

Declaration

public void UpdateExtendedFormatIndex(int maxCount)

Parameters

Type	Name	Description
System.Int32	maxCount	New restriction for maximum possible XF index.

UpdateFirstLast(Int32, Int32)

Updates first cell and last cell if necessary.

Declaration

protected void UpdateFirstLast(int iRowIndex, int iColumnIndex)

Parameters

Type	Name	Description
System.Int32	iRowIndex	Row index.
System.Int32	iColumnIndex	Column index.

UpdateFormula(Ptg[], Int32, Int32)

Updates formulas after copy operation.

Declaration

public Ptg[] UpdateFormula(Ptg[] arrFormula, int iRowOffset, int iColOffset)

Parameters

Type	Name	Description
Ptg[]	arrFormula	Formula to update.
System.Int32	iRowOffset	Row offset.
System.Int32	iColOffset	Column offset.

Returns

Type
Ptg[]

UpdateFormula(Int32, Int32, Rectangle, Int32, Rectangle)

Updates formulas after copy operation.

Declaration

public override void UpdateFormula(int iCurIndex, int iSourceIndex, Rectangle sourceRect, int iDestIndex, Rectangle destRect)

Parameters

Type	Name	Description
System.Int32	iCurIndex	Current worksheet index.
System.Int32	iSourceIndex	Source worksheet index.
Rectangle	sourceRect	Source rectangle.
System.Int32	iDestIndex	Destination worksheet index.
Rectangle	destRect	Destination rectangle.

Overrides

WorksheetBaseImpl.UpdateFormula(Int32, Int32, Rectangle, Int32, Rectangle)

UpdateNamedRangeIndexes(IDictionary<Int32, Int32>)

Updates indexes to named ranges.

Declaration

public void UpdateNamedRangeIndexes(IDictionary<int, int> dicNewIndex)

Parameters

Type	Name	Description
System.Collections.Generic.IDictionary<System.Int32, System.Int32>	dicNewIndex	New indexes.

UpdateNamedRangeIndexes(Int32[])

Updates indexes to named ranges.

Declaration

public void UpdateNamedRangeIndexes(int[] arrNewIndex)

Parameters

Type	Name	Description
System.Int32[]	arrNewIndex	New indexes.

UpdateReferenceIndexes(Int32[])

Updates reference indexes.

Declaration

public override void UpdateReferenceIndexes(int[] arrUpdatedIndexes)

Parameters

Type	Name	Description
System.Int32[]	arrUpdatedIndexes	Array with updated indexes.

Overrides

WorksheetBaseImpl.UpdateReferenceIndexes(Int32[])

UpdateStringIndexes(List<Int32>)

Updates string indexes.

Declaration

public void UpdateStringIndexes(List<int> arrNewIndexes)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.Int32>	arrNewIndexes	List with new indexes.

UpdateStyleIndexes(Int32[])

Updates style indexes.

Declaration

protected override void UpdateStyleIndexes(int[] styleIndexes)

Parameters

Type	Name	Description
System.Int32[]	styleIndexes	Array with changed style indexes.

Overrides

WorksheetBaseImpl.UpdateStyleIndexes(Int32[])

WireParentObject()

Not implemented.

Declaration

public void WireParentObject()

Events

CellValueChanged

Occurs when the value of a cell changes.

Declaration

public event RangeImpl.CellValueChangedEventHandler CellValueChanged

Event Type

Type
RangeImpl.CellValueChangedEventHandler

ColumnWidthChanged

This event is raised after column width changed.

Declaration

public event ValueChangedEventHandler ColumnWidthChanged

Event Type

Type
Syncfusion.XlsIO.Implementation.ValueChangedEventHandler

ExportDataTableEvent

Event to choose an action while exporting data from Excel to data table.

Declaration

public event WorksheetImpl.ExportDataTableEventHandler ExportDataTableEvent

Event Type

Type
WorksheetImpl.ExportDataTableEventHandler

MissingFunction

Event raised when an unknown function is encountered.

Declaration

public event MissingFunctionEventHandler MissingFunction

Event Type

Type
MissingFunctionEventHandler

RowHeightChanged

This event is raised after column height changed.

Declaration

public event ValueChangedEventHandler RowHeightChanged

Event Type

Type
Syncfusion.XlsIO.Implementation.ValueChangedEventHandler

ValueChanged

An event raised on the IWorksheet whenever a value changes.

Declaration

public event ValueChangedEventHandler ValueChanged

Event Type

Type
ValueChangedEventHandler

Implements

System.IDisposable

ISerializableNamedObject

INamedObject

IParseable

ICloneParent

IWorksheet

ITabSheet

IParentApplication

ISheetData

ICalcData