PrintDocument for WinForms | ComponentOne
C1.PrintDocument.6 Assembly / C1.C1Preview.Export Namespace / Exporter Class
Fields Properties Methods Events


In This Topic
    Exporter Class Members
    In This Topic

    The following tables list the members exposed by Exporter.

    Protected Fields
     NameDescription
    Protected Field  
    Top
    Public Properties
     NameDescription
    Public PropertyGets or sets the object representing the document that will be exported by the current exporter's Exporter.Export or Exporter.Export methods.  
    Public PropertyGets or sets the Exporter.DocumentInfo object associated with the Exporter.Document assigned to the current exporter.  
    Public PropertyGets or sets the type of form that is used to edit the fields of Exporter.DocumentInfo class. That form can be invoked from the export options form (Exporter.OptionsFormClass). The form's type must be assignable to C1.C1Preview.Forms.DocumentInfoForm.  
    Public PropertyGets an instance of a class derived from Exporter.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 PropertyGets or sets the type of form that is used to edit export options. That form is shown when the Exporter.Export or the Exporter.Export method is called if Exporter.ShowOptions is true. The form's type must be assignable to the type specified by the ExportProvider.DefaultOptionsFormClass property.  
    Public PropertyGets or sets the type name of form that is used to edit export options. That form is shown when the Exporter.Export or the Exporter.Export method is called if Exporter.ShowOptions is true. The form's type must be assignable to the type specified by the ExportProvider.DefaultOptionsFormClass property.  
    Public PropertyGets the list of files which were generated by the call to Exporter.Export. Typically exporters produce a single file (e.g. RtfExporter, XlsExporter), but some (like HtmlExporter and EmfExporter) may produce several files all of which can be then accessed through this property.  
    Public PropertyGets or sets a value indicating whether the exported document should be opened after exporting it to a disk file (using the Exporter.Export method). The application used to open the file is determined by the OS shell.  
    Public PropertyGets or sets the range of pages that is to be exported.  
    Public PropertyGets or sets the type of form that is used to enter the export output range. That form can be invoked from the export options form (Exporter.OptionsFormClass). The form's type must be assignable to C1.C1Preview.Forms.OutputRangeForm.  
    Public PropertySpecifies the System.Drawing.Graphics object used by export. For example, that System.Drawing.Graphics can be used to convert System.Drawing.Imaging.EmfType.EmfPlusDual or System.Drawing.Imaging.EmfType.EmfPlusOnly metafiles to System.Drawing.Imaging.EmfType.EmfOnly. If this property is null, the screen device context is used.  
    Public PropertyGets or sets a value indicating whether the options dialog should be shown to the user before exporting the document.  
    Top
    Protected Properties
     NameDescription
    Protected PropertyGets the output file name. This property is set when the Exporter.Export method is called.  
    Protected PropertyGets the output stream. This property is set when the Exporter.Export method is called.  
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Exports the object specified by the Exporter.Document property on the current exporter to the specified file.  
    Public MethodDisplays a dialog that allows the user to edit the export options.  
    Top
    Protected Methods
     NameDescription
    Protected MethodTests whether Exporter.OutputFileName can be previewed. This (base) implementation uses FindExecutable API to find an appropriate executable, and returns a value indicating whether it has been found or not.

    If you override this, you must also override Exporter.PreviewOutputFile.

     
    Protected MethodResets the internal state of the exporter and all its public properties.  
    Protected MethodIndicates whether page metafiles of types System.Drawing.Imaging.EmfType.EmfPlusDual and System.Drawing.Imaging.EmfType.EmfPlusOnly should be converted to System.Drawing.Imaging.EmfType.EmfOnly type before exporting. The base implementation returns false.  
    Protected MethodCopies 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 MethodCopies 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 MethodMakes sure the Exporter.Document has been generated if it is an instance of the C1.C1Preview.C1PrintDocument class.  
    Protected MethodProcesses (exports) all pages in the range to be exported.  
    Protected MethodGets the file name (with path) for the file containing the specified page. Used only for export formats that save a page per file (e.g. TIFF).  
    Protected MethodPerforms export to a disk file or to a stream. The destination (file or stream) is determined by which of the properties (Exporter.OutputFileName or Exporter.OutputStream) is non-null when this method executes.  
    Protected MethodCalled after the Exporter.Document property has been changed. If you override this, make sure this base method also gets called.  
    Protected Method  
    Protected MethodPreviews Exporter.OutputFileName. This (base) implementation uses System.Diagnostics.Process.Start() to open the output file.

    Override this if you override Exporter.CanPreviewOutputFile.

     
    Protected MethodExports a page of a document represented by a System.Drawing.Imaging.Metafile.  
    Protected MethodResets the internal state of the exporter.  
    Top
    Public Events
     NameDescription
    Public EventOccurs periodically during export. Allows to show progress and give the end user the ability to cancel the operation.  
    Top
    See Also