Class WorkbookFormatProvidersManager

Represents workbook format providers manager.

Inheritance
System.Object
WorkbookFormatProvidersManager
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 class WorkbookFormatProvidersManager

Properties

FormatProviders

Gets the application-wide registered format providers.

Declaration
public static IEnumerable<IWorkbookFormatProvider> FormatProviders { get; }
Property Value
System.Collections.Generic.IEnumerable<IWorkbookFormatProvider>

The format providers.

Methods

Export(Workbook, String, Stream)

Exports the specified workbook.

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

The workbook.
System.String extension

The file extension.
System.IO.Stream output

The output stream.

Export(Workbook, String, Stream, IEnumerable<IWorkbookFormatProvider>)

Exports the specified workbook.

Declaration
[Obsolete("The method is obsolete. Please use Export(Workbook workbook, string extension, Stream output, IEnumerable<IWorkbookFormatProvider> formatProviders, TimeSpan? timeout) instead.")]
public static void Export(Workbook workbook, string extension, Stream output, IEnumerable<IWorkbookFormatProvider> formatProviders)
Parameters
Workbook workbook

The workbook.
System.String extension

The file extension.
System.IO.Stream output

The output stream.
System.Collections.Generic.IEnumerable<IWorkbookFormatProvider> formatProviders

The format providers to be used.
Exceptions
UnsupportedFileFormatException

Export(Workbook, String, Stream, IEnumerable<IWorkbookFormatProvider>, Nullable<TimeSpan>)

Exports the specified workbook.

Declaration
public static void Export(Workbook workbook, string extension, Stream output, IEnumerable<IWorkbookFormatProvider> formatProviders, TimeSpan? timeout)
Parameters
Workbook workbook

The workbook.
System.String extension

The file extension.
System.IO.Stream output

The output stream.
System.Collections.Generic.IEnumerable<IWorkbookFormatProvider> formatProviders

The format providers to be used.
System.Nullable<System.TimeSpan> timeout

The timeout after which the operation will be cancelled.
Exceptions
UnsupportedFileFormatException

Export(Workbook, String, Stream, Nullable<TimeSpan>)

Exports the specified workbook.

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

The workbook.
System.String extension

The file extension.
System.IO.Stream output

The output stream.
System.Nullable<System.TimeSpan> timeout

The timeout after which the operation will be cancelled.

GetProviderByExtension(String)

Gets format provider by extension.

Declaration
public static IWorkbookFormatProvider GetProviderByExtension(string extension)
Parameters
System.String extension

The extension.
Returns
IWorkbookFormatProvider

The format provider.

GetProviderByName(String)

Gets format provider by name.

Declaration
public static IWorkbookFormatProvider GetProviderByName(string providerName)
Parameters
System.String providerName

Name of the provider.
Returns
IWorkbookFormatProvider

The format provider.

GetSupportedExtensions()

Gets the supported file extensions.

Declaration
public static IEnumerable<string> GetSupportedExtensions()
Returns
System.Collections.Generic.IEnumerable<System.String>

The supported file extensions.

Import(String, Stream)

Imports a workbook from stream.

Declaration
[Obsolete("The method is obsolete. Please use Import(string extension, Stream input, TimeSpan? timeout) instead.")]
public static Workbook Import(string extension, Stream input)
Parameters
System.String extension

The file extension.
System.IO.Stream input

The input stream.
Returns
Workbook

The workbook.

Import(String, Stream, IEnumerable<IWorkbookFormatProvider>)

Imports a workbook from stream.

Declaration
[Obsolete("The method is obsolete. Please use Import(string extension, Stream input, IEnumerable<IWorkbookFormatProvider> formatProviders, TimeSpan? timeout) instead.")]
public static Workbook Import(string extension, Stream input, IEnumerable<IWorkbookFormatProvider> formatProviders)
Parameters
System.String extension

The file extension.
System.IO.Stream input

The input stream.
System.Collections.Generic.IEnumerable<IWorkbookFormatProvider> formatProviders

The format providers to be used.
Returns
Workbook

The workbook.
Exceptions
UnsupportedFileFormatException

Import(String, Stream, IEnumerable<IWorkbookFormatProvider>, Nullable<TimeSpan>)

Imports a workbook from stream.

Declaration
public static Workbook Import(string extension, Stream input, IEnumerable<IWorkbookFormatProvider> formatProviders, TimeSpan? timeout)
Parameters
System.String extension

The file extension.
System.IO.Stream input

The input stream.
System.Collections.Generic.IEnumerable<IWorkbookFormatProvider> formatProviders

The format providers to be used.
System.Nullable<System.TimeSpan> timeout

The timeout after which the operation will be cancelled.
Returns
Workbook

The workbook.
Exceptions
UnsupportedFileFormatException

Import(String, Stream, Nullable<TimeSpan>)

Imports a workbook from stream.

Declaration
public static Workbook Import(string extension, Stream input, TimeSpan? timeout)
Parameters
System.String extension

The file extension.
System.IO.Stream input

The input stream.
System.Nullable<System.TimeSpan> timeout

The timeout after which the operation will be cancelled.
Returns
Workbook

The workbook.

RegisterFormatProvider(IWorkbookFormatProvider)

Registers the format provider.

Declaration
public static void RegisterFormatProvider(IWorkbookFormatProvider provider)
Parameters
IWorkbookFormatProvider provider

The provider.

UnregisterFormatProvider(IWorkbookFormatProvider)

Unregisters the format provider.

Declaration
public static void UnregisterFormatProvider(IWorkbookFormatProvider provider)
Parameters
IWorkbookFormatProvider provider

The provider.

Extension Methods