ExportProvider Class

The abstract base class describing a supported export format. All export providers describing specific formats (such as PDF or HTML) derive from this class. For the list of all available export providers, see RegisteredProviders.

Inheritance

object

ExportProvider

ComplexExportProvider

PagesExportProvider

XpsExportProvider

Namespace: C1.C1Preview.Export

Assembly: C1.PrintDocument.4.8.dll

Syntax

public abstract class ExportProvider

Public MustInherit Class ExportProvider

Constructors

Name	Description
ExportProvider()

Properties

Name	Description
CanExportToStream	Gets a value indicating whether export to stream is supported by the current format.
CanShowOptions	Gets a value indicating whether the associated Exporter can show a dialog allowing the user to edit the export options.
DefaultExtension	Gets the default filename extension for the current export format.
DefaultOptionsFormClass	Gets the type of form which is used to edit the export options by default.
FormatKey	Gets the format key, which is an arbitrary string that should uniquely identify the current export provider/format. The default implementation returns the current ExportProvider's type name.
FormatName	Gets a short description of the current export format.
ShouldEnsureGeneratedDocument	When overridden in a derived class, should return a value indicating whether, if a C1PrintDocument is to be exported, it should be generated before exporting. Exporters that do not need the document to be generated, or might require custom generation, should return false.
SupportedDocumentInfoFields	Gets the combination of flags indicating which fields of the DocumentInfo class are supported by the current export format.

Methods

Name	Description
CanExportObject(object)	Tests whether the specified object represents a document that can be exported by an Exporter associated with the current export provider (see NewExporter()). The default implementation of this method returns false.
CanExportRange(OutputRangeTypeEnum)	Tests whether the Exporter associated with the current export provider can handle the specified type of document pages' range. The default implementation of this method returns true if the specified range type is All, false otherwise.
CanExportType(Type)	Tests whether documents of the specified type can be exported by an Exporter associated with the current export provider (see NewExporter()). Note that if just the type is not enough to determine whether a document of that type can be exported (e.g. an array of objects can be exported by some exporters only if all objects in that array are images), this method returns false. Use CanExportObject(object) method to get a definitive value.
NewExporter()	Creates a new Exporter object. When overridden in a derived class, returns an instance of a specialized class derived from Exporter.