Reports for WinForms | ComponentOne
C1.C1Report.4 Assembly / C1.C1Preview.Export Namespace / C1ReportHtmlExporter Class
Fields Properties Methods Events


In This Topic
    C1ReportHtmlExporter Class Members
    In This Topic

    The following tables list the members exposed by C1ReportHtmlExporter.

    Public Constructors
     NameDescription
    Public ConstructorC1ReportHtmlExporter ConstructorInitializes a new instance of the C1ReportHtmlExporter class.  
    Top
    Protected Fields
     NameDescription
    Protected Field_printDocument (Inherited from C1.C1Preview.Export.Exporter)
    Top
    Public Properties
     NameDescription
    Public PropertyBaseFileFormatGets the base export file format supported by the current exporter. The actual format (FileFormat) may either be the same, or may be a specific variant of that format. E.g. if this property is C1.C1Report.FileFormatEnum.HTML, FileFormat may be C1.C1Report.FileFormatEnum.HTMLPaged. (Inherited from C1.C1Preview.Export.C1ReportExporter)
    Public PropertyDocumentGets or sets the object representing the document that will be exported by the current exporter's Exporter.Export or Exporter.Export methods. (Inherited from C1.C1Preview.Export.Exporter)
    Public PropertyDocumentInfoGets or sets the Exporter.DocumentInfo object associated with the Exporter.Document assigned to the current exporter. (Inherited from C1.C1Preview.Export.Exporter)
    Public PropertyDocumentInfoFormClassGets 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. (Inherited from C1.C1Preview.Export.Exporter)
    Public PropertyDrillDownGets or sets a value indicating whether to create drill-down HTML (see C1.C1Report.FileFormatEnum.HTMLDrillDown).

    If both this and Paged are true, Paged takes precedence.

     
    Public PropertyExportProviderGets an instance of C1ReportExportProvider that describes the BaseFileFormat supported by the current exporter. (Inherited from C1.C1Preview.Export.C1ReportExporter)
    Public PropertyFileFormatOverridden. Overridden. Gets a C1.C1Report.FileFormatEnum value determining the format of the export file produced by the current export provider. Depending on Paged and DrillDown properties, returns C1.C1Report.FileFormatEnum.HTML, C1.C1Report.FileFormatEnum.HTMLPaged or C1.C1Report.FileFormatEnum.HTMLDrillDown.  
    Public PropertyOptionsFormClassGets 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. (Inherited from C1.C1Preview.Export.Exporter)
    Public PropertyOptionsFormClassNameGets 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. (Inherited from C1.C1Preview.Export.Exporter)
    Public PropertyOutputFilesGets 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. (Inherited from C1.C1Preview.Export.Exporter)
    Public PropertyPagedGets or sets a value indicating whether to create paged HTML (see C1.C1Report.FileFormatEnum.HTMLPaged).

    If both this and DrillDown are true, this property takes precedence.

     
    Public PropertyPreviewGets 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. (Inherited from C1.C1Preview.Export.Exporter)
    Public PropertyRangeGets or sets the range of pages that is to be exported. (Inherited from C1.C1Preview.Export.Exporter)
    Public PropertyRangeFormClassGets 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. (Inherited from C1.C1Preview.Export.Exporter)
    Public PropertyReferenceGraphicsSpecifies 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. (Inherited from C1.C1Preview.Export.Exporter)
    Public PropertyShowOptionsGets or sets a value indicating whether the options dialog should be shown to the user before exporting the document. (Inherited from C1.C1Preview.Export.Exporter)
    Public PropertyTableBasedGets or sets a value indicating whether to create table-based HTML (see C1.C1Report.FileFormatEnum.HTMLTableBased).

    If this property is true, Paged and DrillDown are ignored.

     
    Top
    Protected Properties
     NameDescription
    Protected PropertyOutputFileNameGets the output file name. This property is set when the Exporter.Export method is called. (Inherited from C1.C1Preview.Export.Exporter)
    Protected PropertyOutputStreamGets the output stream. This property is set when the Exporter.Export method is called. (Inherited from C1.C1Preview.Export.Exporter)
    Top
    Public Methods
     NameDescription
    Public MethodExportOverloaded. Exports the object specified by the Exporter.Document property on the current exporter to the specified file. (Inherited from C1.C1Preview.Export.Exporter)
    Public MethodShowOptionsDialogDisplays a dialog that allows the user to edit the export options. (Inherited from C1.C1Preview.Export.Exporter)
    Top
    Protected Methods
     NameDescription
    Protected MethodCanPreviewOutputFileTests 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.

    (Inherited from C1.C1Preview.Export.Exporter)
    Protected MethodClearResets the internal state of the exporter and all its public properties. (Inherited from C1.C1Preview.Export.C1ReportExporter)
    Protected MethodConvertEmfPlusToEmfOnlyIndicates 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. This implementation returns false. (Inherited from C1.C1Preview.Export.C1ReportExporter)
    Protected MethodEnsureGeneratedDocumentMakes sure the Exporter.Document has been generated if it is an instance of the C1.C1Preview.C1PrintDocument or of the C1.C1Report.C1Report class. (Inherited from C1.C1Preview.Export.Exporter)
    Protected MethodEnumeratePagesProcesses (exports) all pages in the range to be exported. (Inherited from C1.C1Preview.Export.Exporter)
    Protected MethodGetPageFileNameGets 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). (Inherited from C1.C1Preview.Export.Exporter)
    Protected MethodMakeFilterCreates an instance of C1.C1Report.ExportFilter determined by FileFormat. (Inherited from C1.C1Preview.Export.C1ReportExporter)
    Protected MethodOnDocumentChangedCalled after the Exporter.Document property has been changed. If you override this, make sure this base method also gets called. (Inherited from C1.C1Preview.Export.Exporter)
    Protected MethodPreparePageDrawParams (Inherited from C1.C1Preview.Export.Exporter)
    Protected MethodPreviewOutputFilePreviews Exporter.OutputFileName. This (base) implementation uses System.Diagnostics.Process.Start() to open the output file.

    Override this if you override Exporter.CanPreviewOutputFile.

    (Inherited from C1.C1Preview.Export.Exporter)
    Protected MethodResetResets the internal state of the exporter. (Inherited from C1.C1Preview.Export.C1ReportExporter)
    Top
    Public Events
     NameDescription
    Public EventLongOperationOccurs periodically during export. Allows to show progress and give the end user the ability to cancel the operation. (Inherited from C1.C1Preview.Export.Exporter)
    Top
    See Also

    Reference

    C1ReportHtmlExporter Class
    C1.C1Preview.Export Namespace