Click or drag to resize
Obsolete Members

GemBox.Spreadsheet changes over time. Each new version adds new types and type members that provide new functionality. Existing types and their members also change over time. For example, some methods are superseded by newer methods that are either more convenient or more full-featured.

GemBox.Spreadsheet strives to support backward compatibility (allowing applications that were developed with one version of GemBox.Spreadsheet to run on the next version of GemBox.Spreadsheet). This makes it difficult to simply remove a type or a type member. Instead, GemBox.Spreadsheet indicates that a type or a type member should no longer be used by marking it as obsolete or deprecated. Deprecating a type or a member involves marking it so that developers are aware it will go away and have time to respond to its removal. However, existing code that uses the type or member continues to run in the new version of GemBox.Spreadsheet.

The tables in this article list GemBox.Spreadsheet types and type members that are obsolete.

Obsolete Types in GemBox.Spreadsheet Assembly

The following table lists the types that have been declared obsolete in GemBox.Spreadsheet assembly and the recommended alternatives. Because these types are obsolete, all their members are also obsolete. For a list of additional obsolete members in GemBox.Spreadsheet class library, see Obsolete Members in GemBox.Spreadsheet.

Obsolete Types in GemBox.Spreadsheet Assembly

Type

Message

ExcelWorksheetExtractDataEventHandler

Used in obsolete ExcelWorksheetExtractDataEvent event.

This delegate is obsolete and will be removed in a future version.

ExtractDataDelegateEventArgs

Used in obsolete ExcelWorksheetExtractDataEvent event.

This type is obsolete and will be removed in a future version.

ExtractDataError

Used in obsolete ExtractDataDelegateEventArgs type.

This enumeration is obsolete and will be removed in a future version.

IoOperation

Used in obsolete IoWarningEventArgs and LimitEventArgs types.

This enumeration is obsolete and will be removed in a future version.

IoWarningEventArgs

Used in obsolete ExcelFileIoWarning event.

This type is obsolete and will be removed in a future version.

IoWarningEventHandler

Used in obsolete ExcelFileIoWarning event.

This delegate is obsolete and will be removed in a future version.

LimitEventArgs

Used in obsolete ExcelFileLimitReached event.

This type is obsolete and will be removed in a future version.

LimitEventHandler

Used in obsolete ExcelFileLimitReached event.

This delegate is obsolete and will be removed in a future version.

OdsOptions

Use OdsLoadOptionsPreserveUnsupportedFeatures and OdsLoadOptionsReadDisplayValues properties instead.

This enumeration is obsolete and will be removed in a future version.

RowColumnResolutionMethod

This enumeration is not relevant anymore. Cell will use formatting which was last set, just like MS Excel. For example, if you set column formatting, then all cells from that column will use that formatting. If you later set row formatting, then all cells from that row will use that formatting (including cells contained in the previously formatted column).

This enumeration is obsolete and will be removed in a future version.

SortDescription

Use SortLevel type with CellRangeSort(Boolean), SortStateLevels and SortLevelCollectionAdd(Int32) members instead.

This type is obsolete and will be removed in a future version.

XlsxOptions

Use XlsxLoadOptionsPreserveUnsupportedFeatures property instead.

This enumeration is obsolete and will be removed in a future version.

Obsolete Members in GemBox.Spreadsheet Assembly

The following table lists the type members that have been declared obsolete in GemBox.Spreadsheet assembly and the recommended alternatives. This table doesn't list the members of obsolete types. For a list of obsolete types, see Obsolete Types in GemBox.Spreadsheet.

Obsolete Members in GemBox.Spreadsheet Assembly

Type

Member

Message

AbstractRange

IsStyleDefault

Use AbstractRangeStyle.IsDefault property instead.

AbstractRange

SetBorders(MultipleBorders, Color, LineStyle)

Use AbstractRangeStyle.Borders.SetBorders(MultipleBorders, SpreadsheetColor, LineStyle) method instead.

CellRange

Sort(SortDescription)

Use CellRangeSort(Boolean), SortStateBy and SortStateApply methods instead.

CellRange

Sort(IEnumerableSortDescription)

Use CellRangeSort(Boolean), SortStateBy and SortStateApply methods instead.

CellRangeEnumerator

CurrentCell

Use CellRangeEnumeratorCurrent property instead.

DataTableCellToExcelCellConvertingEventArgs

ExcelColumnIndex

Use DataTableCellToExcelCellConvertingEventArgsExcelCell.Column.Index property instead.

DataTableCellToExcelCellConvertingEventArgs

ExcelRowIndex

Use DataTableCellToExcelCellConvertingEventArgsExcelCell.Row.Index property instead.

DataTableCellToExcelCellConvertingEventArgs

ExcelWorksheet

Use DataTableCellToExcelCellConvertingEventArgsExcelCell.Worksheet property instead.

ExcelCell

HasComment

Use ExcelCellComment.Exists property instead.

ExcelCell

Use AbstractRangeHyperlink.Exists property instead.

ExcelCellToDataTableCellConvertingEventArgs

ExcelCellValue

Use ExcelCellToDataTableCellConvertingEventArgsExcelCell.Value property instead.

ExcelCellToDataTableCellConvertingEventArgs

ExcelColumnIndex

Use ExcelCellToDataTableCellConvertingEventArgsExcelCell.Column.Index property instead.

ExcelCellToDataTableCellConvertingEventArgs

ExcelRowIndex

Use ExcelCellToDataTableCellConvertingEventArgsExcelCell.Row.Index property instead.

ExcelCellToDataTableCellConvertingEventArgs

ExcelWorksheet

Use ExcelCellToDataTableCellConvertingEventArgsExcelCell.Worksheet property instead.

ExcelColumn

AutoFitAdvanced(Single)

Use ExcelColumnAutoFit(Double) method instead.

ExcelColumn

AutoFitAdvanced(Single, ExcelRow, ExcelRow)

Use ExcelColumnAutoFit(Double, ExcelRow, ExcelRow) method instead.

ExcelColumn

Delete

Use ExcelColumnCollectionRemove(Int32) method with ExcelColumnRowBaseIndex as parameter instead.

ExcelColumn

InsertCopy(Int32, ExcelColumn)

Use ExcelColumnCollectionInsertCopy(Int32, Int32, ExcelColumn) method with ExcelColumnRowBaseIndex as first parameter instead.

ExcelColumn

InsertEmpty(Int32)

Use ExcelColumnCollectionInsertEmpty(Int32, Int32) method with ExcelColumnRowBaseIndex as first parameter instead.

ExcelColumnRowBase

IsStyleDefault

Use ExcelColumnRowBaseStyle.IsDefault property instead.

ExcelDrawing

Use ExcelDrawingHyperlink.Exists property instead.

ExcelFile

MaxColumns

Use SaveOptionsLimitations.MaxColumns property instead.

ExcelFile

MaxRows

Use SaveOptionsLimitations.MaxRows property instead.

ExcelFile

MaxXlsCellStyles

Use XlsSaveOptionsLimitations.MaxCellStyles property instead.

ExcelFile

MaxXlsColors

Use XlsSaveOptionsLimitations.MaxColors property instead.

ExcelFile

MaxXlsColumns

Use XlsSaveOptionsLimitations.MaxColumns property instead.

ExcelFile

MaxXlsRows

Use XlsSaveOptionsLimitations.MaxRows property instead.

ExcelFile

CsvAllowNewlineInQuotes

Use CsvLoadOptionsAllowNewLineInQuotes property instead.

ExcelFile

CsvAlwaysQuoteValues

Use CsvSaveOptionsAlwaysQuoteValues property instead.

ExcelFile

CsvParseNumbersDuringLoad

Use CsvLoadOptionsParseNumbers property instead.

ExcelFile

DefaultFontName

Use ExcelFileStyles.Normal.Font.Name property instead.

ExcelFile

DefaultFontSize

Use ExcelFileStyles.Normal.Font.Size property instead.

ExcelFile

RowColumnResolutionMethod

This property is not relevant anymore. Cell will use formatting which was last set, just like MS Excel. For example, if you set column formatting, then all cells from that column will use that formatting. If you later set row formatting, then all cells from that row will use that formatting (including cells contained in the previously formatted column).

This property is obsolete and will be removed in a future version.

ExcelFile

IoWarning

This event is not raised anymore.

This event is obsolete and will be removed in a future version.

ExcelFile

LimitNear

This event is not raised anymore.

This event is obsolete and will be removed in a future version.

ExcelFile

LimitReached

Use SpreadsheetInfoFreeLimitReached event instead.

This event is obsolete and will be removed in a future version.

ExcelFile

ClosePreservedXlsx

This method does nothing, since XlsxOptionsPreserveKeepOpen behaves exactly the same as XlsxOptionsPreserveMakeCopy.

ExcelFile

LoadCsv(Stream, CsvType)

Use ExcelFileLoad(Stream, LoadOptions) static method with CsvLoadOptions instance as parameter instead.

Important note Important

Following note applies to all obsolete ExcelFileLoadCsv methods.

Obsolete member used CultureInfoCurrentCulture when parsing strings to numbers.

Alternative member uses CultureInfoInvariantCulture so that parsing code works the same, regardless of regional settings of the computer on which the code is executing.

To change the culture used for formatting, use CsvLoadOptionsParseFormatProvider property.

ExcelFile

LoadCsv(Stream, Char)

Use ExcelFileLoad(Stream, LoadOptions) static method with CsvLoadOptions instance as parameter instead.

ExcelFile

LoadCsv(StreamReader, CsvType)

Use ExcelFileLoad(TextReader, CsvLoadOptions) static method instead.

ExcelFile

LoadCsv(StreamReader, Char)

Use ExcelFileLoad(TextReader, CsvLoadOptions) static method instead.

ExcelFile

LoadCsv(String, CsvType)

Use ExcelFileLoad(String, LoadOptions) static method with CsvLoadOptions instance as parameter instead.

ExcelFile

LoadCsv(String, Char)

Use ExcelFileLoad(String, LoadOptions) static method with CsvLoadOptions instance as parameter instead.

ExcelFile

LoadOds(Stream, OdsOptions)

Use ExcelFileLoad(Stream, LoadOptions) static method with OdsLoadOptions instance as parameter instead.

ExcelFile

LoadOds(String, OdsOptions)

Use ExcelFileLoad(String, LoadOptions) static method with OdsLoadOptions instance as parameter instead.

ExcelFile

LoadOdsFromDirectory(String, OdsOptions)

Use ExcelFileLoadFromDirectory(String, OdsLoadOptions) static method instead.

ExcelFile

LoadXls(Stream)

Use ExcelFileLoad(Stream, LoadOptions) static method with XlsLoadOptions instance as parameter instead.

ExcelFile

LoadXls(Stream, XlsOptions)

Use ExcelFileLoad(String, LoadOptions) static method with XlsLoadOptions instance as parameter instead.

ExcelFile

LoadXls(String)

Use ExcelFileLoad(Stream, LoadOptions) static method with XlsLoadOptions instance as parameter instead.

ExcelFile

LoadXls(String, XlsOptions)

Use ExcelFileLoad(String, LoadOptions) static method with XlsLoadOptions instance as parameter instead.

ExcelFile

LoadXlsx(Stream, XlsxOptions)

Use ExcelFileLoad(Stream, LoadOptions) static method with XlsxLoadOptions instance as parameter instead.

ExcelFile

LoadXlsx(String, XlsxOptions)

Use ExcelFileLoad(String, LoadOptions) static method with XlsxLoadOptions instance as parameter instead.

ExcelFile

LoadXlsxFromDirectory(String, XlsxOptions)

Use ExcelFileLoadFromDirectory(String, XlsxLoadOptions) static method instead.

ExcelFile

SaveCsv(Stream, CsvType)

Use ExcelFileSave(Stream, SaveOptions) method with CsvSaveOptions instance as parameter instead.

Important note Important

Following note applies to all obsolete ExcelFileSaveCsv methods.

Obsolete member used:

Alternative member uses:

ExcelFile

SaveCsv(Stream, Char)

Use ExcelFileSave(Stream, SaveOptions) method with CsvSaveOptions instance as parameter instead.

ExcelFile

SaveCsv(TextWriter, CsvType)

Use ExcelFileSave(TextWriter, CsvSaveOptions) method instead.

ExcelFile

SaveCsv(TextWriter, Char)

Use ExcelFileSave(TextWriter, CsvSaveOptions) method instead.

ExcelFile

SaveCsv(String, CsvType)

Use ExcelFileSave(String, SaveOptions) method with CsvSaveOptions instance as parameter instead.

ExcelFile

SaveCsv(String, Char)

Use ExcelFileSave(String, SaveOptions) method with CsvSaveOptions instance as parameter instead.

ExcelFile

SaveOds(Stream)

Use ExcelFileSave(Stream, SaveOptions) method with OdsSaveOptions instance as parameter instead.

ExcelFile

SaveOds(String)

Use ExcelFileSave(String, SaveOptions) method with OdsSaveOptions instance as parameter instead.

ExcelFile

SaveOdsToDirectory(String)

Use ExcelFileSaveToDirectory(String, OdsSaveOptions) method instead.

ExcelFile

SaveToHttpResponse(Object, String, Object)

Use ExcelFileSave(Object, String) method with the specified file extension or ExcelFileSave(Object, String, SaveOptions) method instead.

ExcelFile

SaveXls(Stream)

Use ExcelFileSave(Stream, SaveOptions) method with XlsSaveOptions instance as parameter instead.

ExcelFile

SaveXls(String)

Use ExcelFileSave(String, SaveOptions) method with XlsSaveOptions instance as parameter instead.

ExcelFile

SaveXlsx(Stream)

Use ExcelFileSave(Stream, SaveOptions) method with XlsxSaveOptions instance as parameter instead.

ExcelFile

SaveXlsx(Stream, XlsxSaveOptions)

Use ExcelFileSave(String, SaveOptions) method with XlsxSaveOptions instance as parameter instead.

ExcelFile

SaveXlsx(String)

Use ExcelFileSave(Stream, SaveOptions) method with XlsxSaveOptions instance as parameter instead.

ExcelFile

SaveXlsx(String, XlsxSaveOptions)

Use ExcelFileSave(String, SaveOptions) method with XlsxSaveOptions instance as parameter instead.

ExcelFile

SaveXlsxToDirectory(String)

Use ExcelFileSaveToDirectory(String, XlsxSaveOptions) method instead.

ExcelFile

SaveXlsxToDirectory(String, XlsxSaveOptions)

Use ExcelFileSaveToDirectory(String, XlsxSaveOptions) method instead.

ExcelPicture

BottomRightCell

Use ExcelDrawingPosition.To property instead.

ExcelPicture

BoundingRectangle

Use methods ExcelDrawingPosition.GetLeft(LengthUnit), ExcelDrawingPosition.GetTop(LengthUnit), ExcelDrawingPosition.GetWidth(LengthUnit) and ExcelDrawingPosition.GetHeight(LengthUnit) with parameter value LengthUnitPixel instead.

ExcelPicture

Image

Use ExcelPictureToImage method instead.

ExcelPicture

ImageStream

Use ExcelPicturePictureStream property instead.

ExcelPicture

Positioning

Use ExcelDrawingPosition.Mode property instead.

ExcelPicture

TopLeftCell

Use ExcelDrawingPosition.From property instead.

ExcelPictureCollection

Add(MemoryStream, PositioningMode, AnchorCell, AnchorCell, ExcelPictureFormat)

Use ExcelPictureCollectionAdd(String, Double, Double, Double, Double, LengthUnit) method instead.

ExcelPictureCollection

Add(MemoryStream, PositioningMode, AnchorCell, ExcelPictureFormat)

Use ExcelPictureCollectionAdd(MemoryStream, ExcelPictureFormat, Double, Double, Double, Double, LengthUnit) method instead.

ExcelPictureCollection

Add(MemoryStream, PositioningMode, AnchorCell, Int32, Int32, ExcelPictureFormat)

Use ExcelPictureCollectionAdd(String, AnchorCell) method and ExcelDrawingPosition.Mode property instead.

ExcelPictureCollection

Add(MemoryStream, PositioningMode, Rectangle, ExcelPictureFormat)

Use ExcelPictureCollectionAdd(String, Double, Double, Double, Double, LengthUnit) method and ExcelDrawingPosition.Mode property instead.

ExcelPictureCollection

Add(MemoryStream, Rectangle, ExcelPictureFormat)

Use ExcelPictureCollectionAdd(MemoryStream, ExcelPictureFormat, AnchorCell, Double, Double, LengthUnit) method and ExcelDrawingPosition.Mode property instead. Parameters width and height can, for example, be retrieved by using Image.FromStream(Stream) method and Image.Size property. Note that Image instance must be disposed.

ExcelPictureCollection

Add(String, PositioningMode, AnchorCell)

Use ExcelPictureCollectionAdd(MemoryStream, ExcelPictureFormat, Double, Double, Double, Double, LengthUnit) method and ExcelDrawingPosition.Mode property instead.

ExcelPictureCollection

Add(String, PositioningMode, AnchorCell, AnchorCell)

Use ExcelPictureCollectionAdd(String, AnchorCell, AnchorCell) method and ExcelDrawingPosition.Mode property instead.

ExcelPictureCollection

Add(String, PositioningMode, AnchorCell, Int32, Int32)

Use ExcelPictureCollectionAdd(MemoryStream, ExcelPictureFormat, AnchorCell, AnchorCell) method and ExcelDrawingPosition.Mode property instead.

ExcelPictureCollection

Add(String, PositioningMode, Rectangle)

Use ExcelPictureCollectionAdd(String, AnchorCell, Double, Double, LengthUnit) method and ExcelDrawingPosition.Mode property instead.

ExcelPictureCollection

Add(String, Rectangle)

Use ExcelPictureCollectionAdd(MemoryStream, ExcelPictureFormat, AnchorCell, Double, Double, LengthUnit) method and ExcelDrawingPosition.Mode property instead.

ExcelPrintOptions

PaperSize

Use ExcelPrintOptionsPaperType property instead.

ExcelRow

Delete

Use ExcelRowCollectionRemove(Int32) method with ExcelColumnRowBaseIndex as parameter instead.

ExcelRow

InsertCopy(Int32, ExcelRow)

Use ExcelRowCollectionInsertCopy(Int32, Int32, ExcelRow) method with ExcelColumnRowBaseIndex as first parameter instead.

ExcelRow

InsertEmpty(Int32)

Use ExcelRowCollectionInsertEmpty(Int32, Int32) method with ExcelColumnRowBaseIndex as first parameter instead.

ExcelWorksheet

PasswordHash

Use WorksheetProtectionPasswordHash property instead.

ExcelWorksheet

ExtractDataEvent

Use ExtractToDataTableOptionsExcelCellToDataTableCellConverting event instead.

ExcelWorksheet

CreateDataTable(CellRange, ColumnTypeResolution, ExtractDataOptions, Boolean)

Use ExcelWorksheetCreateDataTable(CreateDataTableOptions) method instead.

ExcelWorksheet

CreateDataTable(ColumnTypeResolution)

Use ExcelWorksheetCreateDataTable(CreateDataTableOptions) method instead.

ExcelWorksheet

CreateDataTable(ColumnTypeResolution, ExcelRow, Int32, ExtractDataOptions, ExcelColumn)

Use ExcelWorksheetCreateDataTable(CreateDataTableOptions) method instead.

ExcelWorksheet

CreateDataTable(ColumnTypeResolution, ExcelRow, Int32, ExtractDataOptions, Boolean, ExcelColumn)

Use ExcelWorksheetCreateDataTable(CreateDataTableOptions) method instead.

ExcelWorksheet

CreateDataTable(ColumnTypeResolution, ExcelRow, Int32, ExtractDataOptions, Boolean, IEnumerableExcelColumn)

Use ExcelWorksheetCreateDataTable(CreateDataTableOptions) method instead.

ExcelWorksheet

CreateDataTable(ColumnTypeResolution, ExcelRow, Int32, ExtractDataOptions, IEnumerableExcelColumn)

Use ExcelWorksheetCreateDataTable(CreateDataTableOptions) method instead.

ExcelWorksheet

Delete

Use ExcelWorksheetCollectionRemove(Int32) method with ExcelWorksheetIndex as parameter instead.

ExcelWorksheet

ExtractToDataTable(DataTable, Int32, ExtractDataOptions, ExcelRow, ExcelColumn)

Use ExcelWorksheetExtractToDataTable(DataTable, ExtractToDataTableOptions) method instead.

ExcelWorksheet

ExtractToDataTable(DataTable, Int32, ExtractDataOptions, DataColumnMappingCollection, ExcelRow)

Use ExcelWorksheetExtractToDataTable(DataTable, ExtractToDataTableOptions) method instead.

ExcelWorksheet

ExtractUsedRangeToDataTable(ExtractDataOptions)

Use ExcelWorksheetCreateDataTable(CreateDataTableOptions) method instead.

ExcelWorksheet

GetUsedCellRange

Use ExcelWorksheetGetUsedCellRange(Boolean) method instead.

ExcelWorksheet

InsertCopy(String, ExcelWorksheet)

Use ExcelWorksheetCollectionInsertCopy(Int32, String, ExcelWorksheet) method with ExcelWorksheetIndex as first parameter instead.

ExcelWorksheet

InsertDataTable(DataTable, Int32, Int32, Boolean)

Use ExcelWorksheetInsertDataTable(DataTable, InsertDataTableOptions) method instead.

ExcelWorksheet

InsertDataTable(DataTable, String, Boolean)

Use ExcelWorksheetInsertDataTable(DataTable, InsertDataTableOptions) method instead.

ExcelWorksheet

InsertEmpty(String)

Use ExcelWorksheetCollectionInsertEmpty(Int32, String) method with ExcelWorksheetIndex as first parameter instead.

ExcelWorksheet

ResolveCellStyle(Int32, Int32)

Use AbstractRangeStyle property instead.

ExtractDataEventAction

ThrowException

This field is obsolete and will be removed in a future version.

HtmlSaveOptions

PicturesDirectoryImgSrcPath

Use HtmlSaveOptionsFilesDirectorySrcPath property instead.

HtmlSaveOptions

PicturesDirectoryPath

Use HtmlSaveOptionsFilesDirectoryPath property instead.

LineStyle

DoubleLine

Use LineStyleDouble field instead.

This field is obsolete and will be removed in a future version.

LineStyle

SlantedDashDot

Use LineStyleSlantDashDot field instead.

This field is obsolete and will be removed in a future version.

OdsOptions

PreserveKeepOpen

Use OdsLoadOptionsPreserveUnsupportedFeatures property.

This field is obsolete and will be removed in a future version.

SheetHeaderFooter

DifferentFirst

Use SheetHeaderFooterFirstPage property instead.

SheetHeaderFooter

DifferentOddEven

Use SheetHeaderFooterEvenPage property instead.

SheetHeaderFooter

EvenFooter

Use SheetHeaderFooterEvenPage.Footer property instead.

SheetHeaderFooter

EvenHeader

Use SheetHeaderFooterEvenPage.Header property instead.

SheetHeaderFooter

FirstFooter

Use SheetHeaderFooterFirstPage.Footer property instead.

SheetHeaderFooter

FirstHeader

Use SheetHeaderFooterFirstPage.Header property instead.

SheetHeaderFooter

Footer

Use SheetHeaderFooterDefaultPage.Footer property instead.

SheetHeaderFooter

Header

Use SheetHeaderFooterDefaultPage.Header property instead.

XlsxOptions

PreserveKeepOpen

Use XlsxLoadOptionsPreserveUnsupportedFeatures property instead.

This field is obsolete and will be removed in a future version.

Obsolete Lists for Previous Versions