Document Library for WinForms | ComponentOne
C1.Win.Document.8 Assembly / C1.Win.Document.Export Namespace / ExportFilter Class
Fields Properties Methods


In This Topic
    ExportFilter Class Members
    In This Topic

    The following tables list the members exposed by ExportFilter.

    Protected Fields
     NameDescription
    Protected Fieldm_MultiFileA value indicating whether multiple files were generated during export.  
    Top
    Public Properties
     NameDescription
    Public PropertyDocumentInfoGets or sets the DocumentInfo object associated with the document assigned to the current exporter.  
    Public PropertyExportProviderGets an instance of a class derived from ExportProvider describing the export format associated with the current exporter. That instance can be used to retrieve static information about the current export format such as format description or default extension.  
    Public PropertyFileNameGets or sets the name of the output file.  
    Public PropertyMultiFileGets a value indicating whether multiple files were generated during export. If multiple files were generated, and the UseZipForMultipleFiles property is true, the output (stream or file) will be a zipped archive containing the generated files. The list of actual files can be retrieved via OutputFiles property.  
    Public PropertyOutputFilesGets the list of files which were generated by the call to Export. Typically exporters produce a single file (e.g. RTF, XLS exporters), but some (like HTML, EMF exporters) may produce several files all of which can be then accessed through this property.  
    Public PropertyPageSettingsGets or sets the C1.Win.Document.C1PageSettings providing exporting content.  
    Public PropertyPreviewGets or sets a value indicating whether the exported document should be opened after exporting it to a disk file. The application used to open the file is determined by the OS shell.  
    Public PropertyRangeGets or sets the range of pages that is to be exported.  
    Public PropertyShowOptionsGets or sets a value indicating whether the options dialog should be shown to the user before exporting the document.  
    Public PropertyStreamGets or sets the output stream.  
    Public PropertyUseZipForMultipleFilesGets or sets a value indicating whether the output (stream or file) should be a zipped archive with the generated files, if multiple files are created during export.  
    Top
    Public Methods
     NameDescription
    Public MethodCanExportRangeTests whether the ExportFilter can handle the specified type of document pages' range. The default implementation of this method returns true if the specified range type is C1.Win.Document.OutputRangeType.All, false otherwise.  
    Public MethodDisposeOverloaded. Disposes the ExportFilter object.  
    Public MethodShowOptionsDialogDisplays a dialog that allows the user to edit the export options.  
    Top
    Protected Methods
     NameDescription
    Protected MethodCopyPropertiesFromOptionsFormCopies the options from the specified export options form to corresponding properties on the current exporter. Can be overridden in a derived class to handle format-specific options.  
    Protected MethodCopyPropertiesToOptionsFormCopies the properties of the current exporter to corresponding user-editable options of the specified export options form. Can be overridden in a derived class to handle format-specific options.  
    Protected MethodFinalizeDisposes the ExportFilter object.  
    Top
    See Also

    Reference

    ExportFilter Class
    C1.Win.Document.Export Namespace