skip navigation
  • Product Bundles

    DevCraft

    All Telerik .NET tools and Kendo UI JavaScript components in one package. Now enhanced with:

    • NEW: Design Kits for Figma
    • Online Training
    • Document Processing Library
    • Embedded Reporting for web and desktop

    Web

    Kendo UI UI for jQuery UI for Angular UI for React UI for Vue UI for Blazor UI for ASP.NET Core UI for ASP.NET MVC UI for ASP.NET AJAX

    Mobile

    UI for .NET MAUI

    Document Management

    Telerik Document Processing

    Desktop

    UI for .NET MAUI UI for WinUI UI for WinForms UI for WPF

    Reporting

    Telerik Reporting Telerik Report Server

    Testing & Mocking

    Test Studio Test Studio Dev Edition Telerik JustMock

    CMS

    Sitefinity

    UI/UX Tools

    ThemeBuilder Design System Kit Templates and Building Blocks

    Debugging

    Fiddler Fiddler Everywhere Fiddler Classic Fiddler Everywhere Reporter FiddlerCore

    Free Tools

    VB.NET to C# Converter Testing Framework
    View all products
  • Overview
  • Demos
  • Docs & Support
  • Pricing
  • Shopping cart
    • Account Overview
    • Your Licenses
    • Downloads
    • Support Center
    • Forum Profile
    • Payment Methods
    • Edit Profile
    • Log out
  • Login
  • Contact Us
  • Try now

Class WorkbookFormatProviderBase

Provides the base class from which the classes that represent workbook format providers are derived.

Inheritance
System.Object
WorkbookFormatProviderBase
BinaryWorkbookFormatProviderBase
TextBasedWorkbookFormatProviderBase
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.FormatProviders
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public abstract class WorkbookFormatProviderBase : IWorkbookFormatProvider

Constructors

WorkbookFormatProviderBase()

Declaration
protected WorkbookFormatProviderBase()

Properties

CanExport

Gets a value indicating whether can export.

Declaration
public abstract bool CanExport { get; }
Property Value
System.Boolean

The value indicating whether can export.

Implements
IWorkbookFormatProvider.CanExport

CanImport

Gets a value indicating whether can import.

Declaration
public abstract bool CanImport { get; }
Property Value
System.Boolean

The value indicating whether can import.

Implements
IWorkbookFormatProvider.CanImport

FilesDescription

Gets the files description.

Declaration
public virtual string FilesDescription { get; }
Property Value
System.String

The files description.

Implements
IWorkbookFormatProvider.FilesDescription

Name

Gets the name.

Declaration
public abstract string Name { get; }
Property Value
System.String

The name of the provider.

Implements
IWorkbookFormatProvider.Name

SupportedExtensions

Gets the supported extensions.

Declaration
public abstract IEnumerable<string> SupportedExtensions { get; }
Property Value
System.Collections.Generic.IEnumerable<System.String>

The supported extensions.

Implements
IWorkbookFormatProvider.SupportedExtensions

Methods

Export(Workbook, Stream)

Exports the specified workbook.

Declaration
[Obsolete("This method is obsolete. Please use Export(Workbook workbook, Stream output, TimeSpan? timeout) instead.")]
public void Export(Workbook workbook, Stream output)
Parameters
Workbook workbook

The workbook.

System.IO.Stream output

The output.

Implements
IWorkbookFormatProvider.Export(Workbook, Stream)

Export(Workbook, Stream, Nullable<TimeSpan>)

Exports the specified workbook.

Declaration
public void Export(Workbook workbook, Stream output, TimeSpan? timeout)
Parameters
Workbook workbook

The workbook.

System.IO.Stream output

The output.

System.Nullable<System.TimeSpan> timeout

The timeout after which the operation will be cancelled.

Implements
IWorkbookFormatProvider.Export(Workbook, Stream, Nullable<TimeSpan>)

ExportOverride(Workbook, Stream)

Exports the specified workbook.

Declaration
[Obsolete("Use ExportOverride(Workbook workbook, Stream output, CancellationToken cancellationToken) instead.")]
protected virtual void ExportOverride(Workbook workbook, Stream output)
Parameters
Workbook workbook

The workbook.

System.IO.Stream output

The output.

ExportOverride(Workbook, Stream, CancellationToken)

Exports the specified workbook.

Declaration
protected virtual void ExportOverride(Workbook workbook, Stream output, CancellationToken cancellationToken)
Parameters
Workbook workbook

The workbook.

System.IO.Stream output

The output.

System.Threading.CancellationToken cancellationToken

The token used to cancel the operation.

Import(Stream)

Imports the specified input.

Declaration
[Obsolete("This method is obsolete. Please use Import(Stream input, TimeSpan? timeout) instead.")]
public Workbook Import(Stream input)
Parameters
System.IO.Stream input

The input.

Returns
Workbook

The imported workbook.

Implements
IWorkbookFormatProvider.Import(Stream)

Import(Stream, Nullable<TimeSpan>)

Imports the specified input.

Declaration
public Workbook Import(Stream input, TimeSpan? timeout)
Parameters
System.IO.Stream input

The input.

System.Nullable<System.TimeSpan> timeout

The timeout after which the operation will be cancelled.

Returns
Workbook

The imported workbook.

Implements
IWorkbookFormatProvider.Import(Stream, Nullable<TimeSpan>)

ImportOverride(Stream)

Imports the specified input.

Declaration
[Obsolete("Use ImportOverride(Stream input, CancellationToken cancellationToken) instead.")]
protected virtual Workbook ImportOverride(Stream input)
Parameters
System.IO.Stream input

The input.

Returns
Workbook

The imported workbook.

ImportOverride(Stream, CancellationToken)

Imports the specified input.

Declaration
protected virtual Workbook ImportOverride(Stream input, CancellationToken cancellationToken)
Parameters
System.IO.Stream input

The input.

System.Threading.CancellationToken cancellationToken

The token used to cancel the operation.

Returns
Workbook

The imported workbook.

Getting Started
  • Getting Started
Support Resources
  • Documentation
Community
  • Forums
  • Blogs
  • Document Processing Feedback Portal

Copyright © 2018 Progress Software Corporation and/or its subsidiaries or affiliates.
All Rights Reserved.

Progress, Telerik, and certain product names used herein are trademarks or registered trademarks of Progress Software Corporation and/or one of its subsidiaries or affiliates in the U.S. and/or other countries. See Trademarks for appropriate markings.