GemBox.Spreadsheet Help

Class Library

GemBox.Spreadsheet

AbstractRange Class

AnchorCell Class

AutoFilter Class

BuiltInCellStyleName Enumeration

BuiltInDocumentProperties Enumeration

CellBorder Class

CellBorders Class

CellRange Class

CellRangeCollection Class

CellRangeEnumerator Class

CellStyle Class

CellStyleCollection Class

CellValueType Enumeration

ClearOptions Enumeration

ColorName Enumeration

ColumnTypeResolution Enumeration

ComHelper Class

CreateDataTableOptions Class

DataTableCellToExcelCellConvertingEventArgs Class

DataValidation Class

DataValidationCollection Class

DataValidationErrorStyle Enumeration

DataValidationOperator Enumeration

DataValidationType Enumeration

DateTimeGroup Structure

DateTimeGroupLevel Enumeration

DefinedName Class

DefinedNameCollection Class

DigitalSignatureSaveOptions Class

DocumentProperties Class

DynamicFilter Class

DynamicFilterType Enumeration

ExcelCell Class

ExcelCellCollection Class

ExcelCellToDataTableCellConvertingEventArgs Class

ExcelColumn Class

ExcelColumnCollection Class

ExcelColumnRowBase Class

ExcelComment Class

ExcelCommentCollection Class

ExcelDrawing Class

ExcelDrawingCollection(T) Class

ExcelDrawingMetadata Class

ExcelDrawingPosition Class

ExcelEmbeddedObject Class

ExcelEmbeddedObjectCollection Class

ExcelFile Class

ExcelFilePage Class

ExcelFilePaginator Class

ExcelFileStore Class

ExcelFillPattern Class

ExcelFont Class

ExcelObjectSourceType Enumeration

ExcelPicture Class

ExcelPictureCollection Class

ExcelPictureFormat Enumeration

ExcelPrintOptions Class

ExcelRow Class

ExcelRowCollection Class

ExcelRowColumnCellCollectionBase Class

ExcelRowColumnCollectionBase Class

ExcelRowColumnCollectionBase(T) Class

ExcelShape Class

ExcelShapeCollection Class

ExcelViewOptions Class

ExcelWorksheet Class

ExcelWorksheet.ExtractDataEventHandler Delegate

ExcelWorksheetCollection Class

ExtractDataDelegateEventArgs Class

ExtractDataError Enumeration

ExtractDataEventAction Enumeration

ExtractDataOptions Enumeration

ExtractToDataTableOptions Class

FileFormatLimitations Class

FillPatternStyle Enumeration

Filter Class

FilterColumn Class

FilterColumnCollection Class

FilterOperator Enumeration

FilterType Enumeration

FixedWidthColumn Class

FixedWidthLoadOptions Class

FixedWidthSaveOptions Class

FontSettings Class

FormattedCharacterRange Class

FormattedExcelDrawing Class

FreeLimitEventArgs Class

FreeLimitReachedAction Enumeration

FreeLimitReachedException Class

GradientShadingStyle Enumeration

HeaderFooter Class

HeaderFooterFieldType Enumeration

HeaderFooterPage Class

HeaderFooterSection Class

HorizontalAlignmentStyle Enumeration

HorizontalPageBreak Class

HorizontalPageBreakCollection Class

HtmlLoadOptions Class

HtmlSaveOptions Class

HtmlType Enumeration

IgnoredError Class

IgnoredErrorCollection Class

IgnoredErrorTypes Enumeration

ImageSaveFormat Enumeration

ImageSaveOptions Class

IndividualBorder Enumeration

InsertDataTableOptions Class

InsertShiftDirection Enumeration

IoOperation Enumeration

IoWarningEventArgs Class

IoWarningEventHandler Delegate

LengthUnit Enumeration

LengthUnitConverter Class

LimitEventArgs Class

LimitEventHandler Delegate

LineStyle Enumeration

LoadOptions Class

MultipleBorders Enumeration

NamedRange Class

NamedRangeCollection Class

NumberFormatBuilder Class

OdsLoadOptions Class

OdsOptions Enumeration

OdsSaveOptions Class

OperationProgressChangedEventArgs Class

PageBreak Class

PageBreakCollection Class

PageBreakCollection(T) Class

PaginatorOptions Class

PanePosition Enumeration

PanesState Enumeration

PaperType Enumeration

PdfDigitalSignatureSaveOptions Class

PdfPermissions Enumeration

PdfSaveOptions Class

PixelFormat Enumeration

PositioningMode Enumeration

PrintOptions Class

ProtectedRange Class

ProtectedRangeCollection Class

RangeIndexingMode Enumeration

RemoveShiftDirection Enumeration

RowColumnResolutionMethod Enumeration

SaveOptions Class

ScriptPosition Enumeration

SelectionType Enumeration

SheetHeaderFooter Class

SheetType Enumeration

SheetVisibility Enumeration

SortDescription Class

SortLevel Class

SortLevelCollection Class

SortState Class

SpreadsheetColor Structure

SpreadsheetException Class

SpreadsheetHyperlink Class

SpreadsheetHyperlinkCollection Class

SpreadsheetIcon Structure

SpreadsheetIconStyle Enumeration

SpreadsheetInfo Class

Style Class

TextDirection Enumeration

TiffCompression Enumeration

Top10Filter Class

UnderlineStyle Enumeration

ValuesFilter Class

VerticalAlignmentStyle Enumeration

VerticalPageBreak Class

VerticalPageBreakCollection Class

ViewType Enumeration

WorkbookProtection Class

WorksheetPanes Class

WorksheetProtection Class

XlsLoadOptions Class

XlsSaveOptions Class

XlsxLoadOptions Class

XlsxOptions Enumeration

XlsxSaveOptions Class

XlsxType Enumeration

XpsSaveOptions Class

FreeLimitReachedAction Enumeration

Type of action that can be chosen when free limit is reached.

Namespace: GemBox.Spreadsheet
Assembly: GemBox.Spreadsheet (in GemBox.Spreadsheet.dll) Version: 45.0.35.1187

Syntax

Copy

public enum FreeLimitReachedAction

Public Enumeration FreeLimitReachedAction

Members

Member name	Value	Description
ThrowException	0	Throw FreeLimitReachedException.
Stop	1	Stop reading/writing.
ContinueAsTrial	2	Continue reading/writing using trial mode.

Examples

Following code demonstrates one way of testing performances of GemBox.Spreadsheet.

Copy

SpreadsheetInfo.SetLicense("FREE-LIMITED-KEY");

SpreadsheetInfo.FreeLimitReached += (sender, e) => e.FreeLimitReachedAction = FreeLimitReachedAction.ContinueAsTrial;

Stopwatch sw = new Stopwatch();

sw.Start();
ExcelFile ef = ExcelFile.Load(fileName);
sw.Stop();
Console.WriteLine("Load time: " + sw.Elapsed.TotalSeconds + " seconds.");

sw.Reset();
sw.Start();
int cellWithValueCount = 0;
foreach (var sheet in ef.Worksheets)
    foreach (var row in sheet.Rows)
        foreach (var cell in row.AllocatedCells)
            if (cell.Value != null)
                ++cellWithValueCount;
sw.Stop();
Console.WriteLine("Iterate through all used cells time: " + sw.Elapsed.TotalSeconds + " seconds. Cells with value: " + cellWithValueCount);

sw.Reset();
sw.Start();
ef.Save(fileName);
sw.Stop();
Console.WriteLine("Save time: " + sw.Elapsed.TotalSeconds + " seconds.");

SpreadsheetInfo.SetLicense("FREE-LIMITED-KEY")

AddHandler SpreadsheetInfo.FreeLimitReached, Function(sender As Object, e As FreeLimitEventArgs) e.FreeLimitReachedAction = FreeLimitReachedAction.ContinueAsTrial

Dim sw = New Stopwatch()

sw.Start()
Dim ef = ExcelFile.Load(fileName)
sw.Stop()
Console.WriteLine("Load time: " & sw.Elapsed.TotalSeconds & " seconds.")

sw.Reset()
sw.Start()
Dim cellWithValueCount = 0
For Each sheet In ef.Worksheets
    For Each row In sheet.Rows
        For Each cell In row.AllocatedCells
            If Not (cell.Value Is Nothing) Then
                cellWithValueCount += 1
            End If
        Next
    Next
Next
sw.Stop()
Console.WriteLine("Iterate through all used cells time: " & sw.Elapsed.TotalSeconds & " seconds. Cells with value: " & cellWithValueCount)

sw.Reset()
sw.Start()
ef.Save(fileName)
sw.Stop()

Console.WriteLine("Save time: " & sw.Elapsed.TotalSeconds & " seconds.")

Reference

GemBox.Spreadsheet Namespace