WorksheetImpl Class

Represents a worksheet in a workbook.

Inheritance

Implements

Inherited Members

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

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

public WorksheetImpl(IApplication application, object parent)

Gets or sets index of the active pane.

public int ActivePane { get; set; }

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

public IAutoFilters AutoFilters { get; }

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

public CalcEngine CalcEngine { get; set; }

Returns collection of cell records. Read-only.

public CellRecordCollection CellRecords { get; }

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

public IRange[] Cells { get; }

Read-only. Access to column info records.

public ColumnInfoRecord[] ColumnInformation { get; }

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

public IRange[] Columns { get; }

Returns the columns outline level count

public int ColumnsOutlineLevel { get; }

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

public WorksheetConditionalFormats ConditionalFormats { get; }

Returns if contains protection

protected override bool ContainsProtection { get; }

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

public IWorksheetCustomProperties CustomProperties { get; }

Gets the DataSorter.

public IDataSort DataSorter { get; }

Gets default protection options for the worksheet.

protected override ExcelSheetProtection DefaultProtectionOptions { get; }

Return default row height in pixel.

public int DefaultRowHeight { get; set; }

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

public bool DisplayPageBreaks { get; set; }

Gets data validation collection.

public DataValidationTable DVTable { get; }

Represents error indicators.

public ErrorIndicatorsCollection ErrorIndicators { get; }

Gets or sets the first visible column index.

public int FirstVisibleColumn { get; set; }

Gets or sets the first visible row index.

public int FirstVisibleRow { get; set; }

Indicates whether worksheet has merged cells. Read-only.

public bool HasMergedCells { get; }

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

public bool HasOleObject { get; }

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

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

public int HorizontalSplit { get; set; }

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)

Gets a Syncfusion.XlsIO.Implementation.Collections.HPageBreaksCollection that represents the horizontal page breaks in the worksheet. Read-only.

public IHPageBreaks HPageBreaks { get; }

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

public IHyperLinks HyperLinks { get; }

Returns collection of the custom properties. Read-only.

public WorksheetCustomProperties InnerCustomProperties { get; }

Returns inner data validation table. Read-only.

public DataValidationTable InnerDVTable { get; }

Collection of all hyperlinks in the current worksheet.

public HyperLinksCollection InnerHyperLinks { get; }

Collection of all hyperlinks in the current worksheet.

public HyperLinksCollection InnerHyperLinksOrNull { get; }

Gets collection of all list objects in the worksheet.

public ListObjectCollection InnerListObjects { get; }

Returns inner names collection. Read-only.

public WorksheetNamesCollection InnerNames { get; }

Retruns internal pivot table collection. Read-only.

public PivotTableCollection InnerPivotTables { get; }

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

public bool IsDisplayZeros { get; set; }

Indicates whether worksheet is empty. Read-only.

public bool IsEmpty { get; }

Defines whether freezed panes are applied.

public bool IsFreezePanes { get; }

True if grid lines are visible. otherwise, False.

public bool IsGridLinesVisible { get; set; }

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

public bool IsRowColumnHeadersVisible { get; set; }

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

public bool IsStringsPreserved { get; set; }

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

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

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

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

Gets cell Range. Read-only.

public IRange this[string name] { get; }

Gets cell Range with R1C1Notation flag. Read-only.

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

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

public IListObjects ListObjects { get; }

Read-only. Access to merged cells.

public MergeCellsImpl MergeCells { get; }

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

public IRange[] MergedCells { get; }

Gets instance of migrant range. Read-only.

public IMigrantRange MigrantRange { get; }

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.

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

public INames Names { get; }

Gets a collection of OleObjects in the worksheet.

public IOleObjects OleObjects { get; }

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

Returns or sets the list of outline wrapper collection

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

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

public IPageSetup PageSetup { get; }

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

public override PageSetupBaseImpl PageSetupBase { get; }

Gets pain record or null. Read-only.

public PaneRecord Pane { get; }

Gets or sets range indicating first visible row and column.

public IRange PaneFirstVisible { get; set; }

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

public IPivotTables PivotTables { get; }

Worksheet's print area.

public IRange PrintArea { get; }

Indicates is current sheet is protected.

public override bool ProtectContents { get; }

Returns quoted name of the worksheet.

public string QuotedName { get; }

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

public IRange Range { get; }

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

public RecordExtractor RecordExtractor { get; }

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

public IRange[] Rows { get; }

Returns the rows outline level count

public int RowsOutlineLevel { get; }

Get the scenarios collection for the current worksheet.

public IScenarios Scenarios { get; }

Gets a value indicating selection count of pane.

public int SelectionCount { get; }

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

public List<SelectionRecord> Selections { get; }

Gets the Slicers.

public ISlicers Slicers { get; }

Gets the sparkline groups.

public ISparklineGroups SparklineGroups { get; }

Gets split cell range.

public IRange SplitCell { get; set; }

Gets or sets the standard (default) height of all the rows in the worksheet, in points.

public double StandardHeight { get; set; }

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

public bool StandardHeightFlag { get; set; }

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

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

public double StandardWidth { get; set; }

Gets the threaded comments collection for a current worksheet.

public IThreadedComments ThreadedComments { get; }

Gets top left cell of the worksheet.

public IRange TopLeftCell { get; set; }

Gets the worksheet type. Read-only ExcelSheetType.

public ExcelSheetType Type { get; set; }

Returns un protected options

protected override ExcelSheetProtection UnprotectedOptions { get; }

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

public IRange[] UsedCells { get; }

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.

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

public IRange UsedRange { get; }

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

public bool UsedRangeIncludesFormatting { get; set; }

There are two different algorithms to create UsedRange object:

1. 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).
2. This property = false. In this case XlsIO tries to remove empty rows and columns from all sides to make UsedRange smaller.

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

public bool UseRangesCache { get; set; }

Gets or sets excel version.

public ExcelVersion Version { get; set; }

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

public int VerticalSplit { get; set; }

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)

Gets or sets the view setting of the worksheet.

public SheetView View { get; set; }

Gets a Syncfusion.XlsIO.Implementation.Collections.VPageBreaksCollection that represents the vertical page breaks on the sheet. Read-only.

public IVPageBreaks VPageBreaks { get; }

public void add_CellValueChanged(RangeImpl.CellValueChangedEventHandler value)

public void add_ColumnWidthChanged(ValueChangedEventHandler value)

public void add_ExportDataTableEvent(WorksheetImpl.ExportDataTableEventHandler value)

public void add_MissingFunction(MissingFunctionEventHandler value)

public void add_RowHeightChanged(ValueChangedEventHandler value)

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

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

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

protected void AttachEvents()

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

public void AutofitColumn(int colIndex)

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

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

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

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

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

public void AutofitRow(int rowIndex)

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

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

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

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

Calculate all the formulas in worksheet.

public void Calculate()

Checks whether it is possible to insert column into iRowIndex.

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

Checks whether it is possible insert row into iRowIndex.

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

Indicates whether source range can be moved into new location.

public bool CanMove(ref IRange destination, IRange source)

Checks the source snd destination ranges

protected void CheckRangesSizes(IRange destination, IRange source)

Clears the worksheet data, formats and merged cells.

public void Clear()

Clear all internal collections.

protected void ClearAll()

Clear all internal collections but excluding mentioned flags.

protected override void ClearAll(ExcelWorksheetCopyFlags flags)

Clears the worksheet data.

public void ClearData()

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

public override object Clone(object parent, bool cloneShapes)

Converts the specified column width from points to pixels.

public int ColumnWidthToPixels(double widthInChars)

Checks whether the specified cell is initialized or accessed.

public bool Contains(int iRow, int iColumn)

Converts the specified range into image. Default image type is Bitmap.

public Image ConvertToImage(int firstRow, int firstColumn, int lastRow, int lastColumn)

Subscript/Superscript,RTF,Shrink to fit,Shapes (except TextBox shape and Image),Charts and Chart Worksheet and Complex conditional formatting features are not supported in Worksheet to image conversion. Gradient fill is partially supported. This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

Converts the specified range into image with the specified type.

public Image ConvertToImage(int firstRow, int firstColumn, int lastRow, int lastColumn, ImageType imageType, Stream outputStream)

Subscript/Superscript,RTF,Shrink to fit,Shapes (except TextBox shape and Image),Charts and Chart Worksheet and Complex conditional formatting features are not supported in Worksheet to image conversion. Gradient fill is partially supported. This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

Converts the specified range into image along with Metafile.

public Image ConvertToImage(int firstRow, int firstColumn, int lastRow, int lastColumn, ImageType imageType, Stream outputStream, EmfType emfType)

Subscript/Superscript,RTF,Shrink to fit,Shapes (except TextBox shape and Image),Charts and Chart Worksheet and Complex conditional formatting features are not supported in Worksheet to image conversion. Gradient fill is partially supported. This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

Converts the specified range into Metafile.

public Image ConvertToImage(int firstRow, int firstColumn, int lastRow, int lastColumn, EmfType emfType, Stream outputStream)

Subscript/Superscript,RTF,Shrink to fit,Shapes (except TextBox shape and Image),Charts and Chart Worksheet and Complex conditional formatting features are not supported in Worksheet to image conversion. Gradient fill is partially supported. This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only.

Copies autofilters.

protected void CopyAutoFilters(WorksheetImpl sourceSheet)

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

protected void CopyCell(IRange destCell, IRange sourceCell)

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

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

Copies column width.

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

Copies conditional formats.

protected void CopyConditionalFormats(WorksheetImpl sourceSheet)

Copies data validations.

protected void CopyDataValidations(WorksheetImpl sourceSheet)

Copies all data from another worksheet.

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

Copies all data from another worksheet.

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)

Copies all data from another worksheet.

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)

Copies merged regions.

protected void CopyMerges(WorksheetImpl sourceSheet)

Copies names from another worksheet.

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

Copies different sheet options.

protected override void CopyOptions(WorksheetBaseImpl sourceSheet)

Copies page setup from another worksheet.

protected void CopyPageSetup(WorksheetImpl sourceSheet)

Copies range from one range into another with formulas update.

public IRange CopyRange(IRange destination, IRange source)

Copies range from one range into another.

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

Copies range without checking range sizes.

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

Copies row height.

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

Creates default pane.

protected void CreateEmptyPane()

Creates Rtf string for LabelSST record.

public RangeRichTextString CreateLabelSSTRTFString(long cellIndex)

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

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

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

Creates a new instance of the IRanges.

public IRanges CreateRangesCollection()

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

public ITemplateMarkersProcessor CreateTemplateMarkersProcessor()

Removes the specified column.

public void DeleteColumn(int index)

Removes the specified number of columns from the given index.

public void DeleteColumn(int index, int count)

Removes specified row (with formula update).

public void DeleteRow(int index)

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

public void DeleteRow(int index, int count)

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

protected void DetachEvents()

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

public void DisableSheetCalculations()

Enables the calculation support.

public void EnableSheetCalculations()

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

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

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

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

public DataTable ExportDataTable(IRange range, ExcelExportDataTableOptions options)

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

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

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

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.

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

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

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

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

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

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.

Exports worksheet data into a DataTable.

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

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

Extracts calculation options.

protected int ExtractCalculationOptions()

Extracts conditional formats from biff records array

protected void ExtractConditionalFormats(int iCondFmtPos)

Extracts custom properties from the records array.

protected void ExtractCustomProperties(int iCustomPropertyPos)

Extracts data validation data from internal records array.

protected void ExtractDataValidation(int iDValPos)

Extracts hyperlinks from internal array of biff records.

protected void ExtractHyperLinks(int iLinkIndex)

Extracts page setup from biff records array

protected void ExtractPageSetup(int iStartIndex)

Extracts pivot tables from records array.

protected void ExtractPivotTables(int iStartIndex)

Returns found values or null.

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

Returns found values or null.

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

Returns found values or null.

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

Returns found values or null.

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

Returns the cells of the specified bool value.

public IRange[] FindAll(bool findValue)

Returns the cells of the specified DateTime value.

public IRange[] FindAll(DateTime findValue)

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

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

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

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

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

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

Returns the cells of the specified TimeSpan value.

public IRange[] FindAll(TimeSpan findValue)

Returns the first occurrence of the specified bool value.

public IRange FindFirst(bool findValue)

Returns the first occurrence of the specified DateTime value.

public IRange FindFirst(DateTime findValue)

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

public IRange FindFirst(double findValue, ExcelFindType flags)

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

public IRange FindFirst(string findValue, ExcelFindType flags)

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

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

Returns the first occurrence of the specified TimeSpan value.

public IRange FindFirst(TimeSpan findValue)

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

public IRange FindStringEndsWith(string findValue, ExcelFindType flags)

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

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

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

public IRange FindStringStartsWith(string findValue, ExcelFindType flags)

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

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

Frees range object.

public void FreeRange(IRange range)

Frees range object for the specified row and column.

public void FreeRange(int iRow, int iColumn)

Returns active cell.

public IRange GetActiveCell()

Returns bool value from the specified row and column.

public bool GetBoolean(int row, int column)

Gets cell type from current column.

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

Get the cell value from the specific row and column index of the worksheet.

public string GetCellValue(int rowIndex, int columnIndex, bool computeFormula)

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

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

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

public int GetColumnCount()

Returns the width of the specified column in pixels.

public double GetColumnWidth(int iColumnIndex)

Returns width of the specified column in pixels.

public int GetColumnWidthInPixels(int iColumnIndex)

Otherwise it returns the StandardHeight

Returns the default column style for the specified column.

public IStyle GetDefaultColumnStyle(int iColumnIndex)

Returns default row style for the specified row.

public IStyle GetDefaultRowStyle(int iRowIndex)

Returns error value from the specified row and column.

public string GetError(int row, int column)

Returns extended format for specified cell.

public ExtendedFormatImpl GetExtendedFormat(long cellIndex)

Gets the first column index.

public int GetFirstColumn()

Get the idex of the first row in UsedRange

public int GetFirstRow()

Returns formula value from specified row and column.

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

Returns formula corresponding to the cell.

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

Returns formula corresponding to the cell.

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

Returns formula bool value from the specified row and column.

public bool GetFormulaBoolValue(int row, int column)

Returns formula error value from the specified row and column.

public string GetFormulaErrorValue(int row, int column)

Returns formula number value from the specified row and column.

public double GetFormulaNumberValue(int row, int column)

Returns formula string value from the specified row and column.

public string GetFormulaStringValue(int row, int column)

Returns width of the specified hidden column in pixels.

public int GetHiddenColumnWidthInPixels(int iColumnIndex)

Returns height of the specified hidden row in pixels.

public int GetHiddenRowHeightInPixels(int iRowIndex)

Gets the last column index / column count.

public int GetLastColumn()

get the index of the last row in UsedRange

public int GetLastRow()

Returns note record by object index.

protected NoteRecord GetNoteByObjectIndex(int index)

Returns number value from the specified row and column.

public double GetNumber(int row, int column)

Gets range from string value.

public IRange GetRangeByString(string strRangeValue, bool hasFormula)

Returns record at specified cell index.

protected ICellPositionFormat GetRecord(int iRow, int iColumn)

Returns record at specified cell index.

protected ICellPositionFormat GetRecord(long cellIndex)

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

public int GetRowCount()

Returns the height of the specified row.

public double GetRowHeight(int iRow)

Otherwise it gets the StandardHeight

Returns the height of the specified row in pixels.

public int GetRowHeightInPixels(int iRowIndex)

Otherwise it gets the StandardHeight in pixels

Returns string index of the specified cell.

public int GetStringIndex(long cellIndex)

Gets string preservation option for the range.

public Nullable<bool> GetStringPreservedValue(ICombinedRange range)

Returns string value corresponding to the cell.

public string GetStringValue(long cellIndex)

Returns string value from the specified row and column.

public string GetText(int row, int column)

Returns TextWithFormat object corresponding to the specified cell.

public object GetTextObject(long cellIndex)

Returns TextWithFormat object corresponding to the specified cell.

public TextWithFormat GetTextWithFormat(long cellIndex)

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

public object GetValueRowCol(int row, int col)

Indicates is has array formula.

public bool HasArrayFormulaRecord(int row, int column)

Hides the specified column.

public void HideColumn(int columnIndex)

Hides the specified row.

public void HideRow(int rowIndex)

Imports an array of DateTime values into a worksheet.

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

Imports an array of double values into a worksheet.

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

Imports an array of integer values into a worksheet.

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

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

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

Imports an array of objects into a worksheet.

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

Imports an array of string values into a worksheet.

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

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

public int ImportData(IEnumerable arrObject, ExcelImportDataOptions importDataOptions)

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

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

Imports data from a DataColumn into a worksheet.

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

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

Imports data from a DataColumn into a worksheet.

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

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

Imports array of data columns.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Imports data from a DataTable into worksheet

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