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


In This Topic
    HtmlExporter Class Members
    In This Topic

    The following tables list the members exposed by HtmlExporter.

    Public Constructors
     NameDescription
    Public ConstructorHtmlExporter ConstructorInitializes a new instance of the HtmlExporter class.  
    Top
    Protected Fields
     NameDescription
    Protected Field_printDocumentRepresents a document for export. (Inherited from C1.C1Preview.Export.Exporter)
    Top
    Public Properties
     NameDescription
    Public PropertyDocumentGets or sets the object representing the document that will be exported by the current exporter's Export(String) or Export(Stream) methods. (Inherited from C1.C1Preview.Export.Exporter)
    Public PropertyDocumentInfoGets or sets the DocumentInfo object associated with the 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 DocumentInfo class. That form can be invoked from the export options form (OptionsFormClass). The form's type must be assignable to C1.C1Preview.Forms.DocumentInfoForm. (Inherited from C1.C1Preview.Export.Exporter)
    Public PropertyExportNavBarGets or sets a template used to create a navigation bar with page numbers. (Note: both ComplexExporter.Paginated and GeneratePageLinks must be set to true for this to work).

    The format of the string is as follows: up to four "%s" strings are replaced with links to the first, previous, next and last pages, correspondingly. Up to two "%d" strings are replaced with the current and total page numbers.

    For instance:

    "<a %s>first</a> <a %s>prev</a> Page %d of %d <a %s>next</a> <a %s>last</a>"

     
    Public PropertyExportProviderOverridden. Gets ExportProviders.HtmlExportProvider.  
    Public PropertyFixedPositioningGets or sets a value indicating whether the exported document should exactly match the appearance of the original document. Usually this can only be achieved at the cost of preserving the logical structure and/or ease of editing of the exported document. (Inherited from C1.C1Preview.Export.ComplexExporter)
    Public PropertyGenerateOutlineGets or sets a value indicating whether to create a frame containing the document's outline.  
    Public PropertyGeneratePageLinksGets or sets a value indicating whether to generate hyperlinks to individual pages. Note that this only works if ComplexExporter.Paginated is also true.  
    Public PropertyGeneratePageSeparatorsGets or sets a value indicating whether to delimit individual pages of the original document with horizontal lines.  
    Public PropertyImageFolderGets or sets the path name of the folder where images are to be saved.  
    Public PropertyLinksLocationGets or sets the location of hyperlinks on the generated page(s) (the hyperlinks can contain outline entries or page numbers).  
    Public PropertyMaxHorzPageLinksGets or sets the maximum number of page hyperlinks in a row.  
    Public PropertyOpenXmlDocumentGets or sets a value indicating whether the document should be saved in Office12 Open XML format. (Inherited from C1.C1Preview.Export.ComplexExporter)
    Public PropertyOptionsFormClassGets or sets the type of form that is used to edit export options. That form is shown when the Export(String) or the Export(Stream) method is called if 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 Export(String) or the Export(Stream) method is called if 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 Export(String). 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 PropertyPagePerFileGets or sets a value indicating whether to export each page of the document into a separate file.  
    Public PropertyPaginatedGets or sets a value indicating whether the exported document should preserve the pagination of the original document. (Inherited from C1.C1Preview.Export.ComplexExporter)
    Public PropertyPreserveExactHeightGets or sets a value indicating whether export should try to preserve the exact original height of all elements. Generally, setting this property to false makes the resulting HTML document more flexible.  
    Public PropertyPreviewGets or sets a value indicating whether the exported document should be opened after exporting it to a disk file (using the Export(String) 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 (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 PropertyScalingGets or sets the scaling factor applied to all elements of the resulting HTML document, in percent.  
    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)
    Top
    Protected Properties
     NameDescription
    Protected PropertyOutputFileNameGets the output file name. This property is set when the Export(String) method is called. (Inherited from C1.C1Preview.Export.Exporter)
    Protected PropertyOutputStreamGets the output stream. This property is set when the Export(Stream) method is called. (Inherited from C1.C1Preview.Export.Exporter)
    Top
    Public Methods
     NameDescription
    Public MethodExportOverloaded. Exports the object specified by the 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 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 PreviewOutputFile.

    (Inherited from C1.C1Preview.Export.Exporter)
    Protected MethodClearOverridden. Resets the internal state of the exporter and all its public properties.  
    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. The base implementation returns false. (Inherited from C1.C1Preview.Export.Exporter)
    Protected MethodCopyPropertiesFromOptionsFormOverridden. Copies the options from the specified export options form to corresponding properties on the current exporter.  
    Protected MethodCopyPropertiesToOptionsFormOverridden. Copies the properties of the current exporter to corresponding user-editable options of the specified export options form.  
    Protected MethodEnsureGeneratedDocumentMakes sure the Document has been generated if it is an instance of the C1.C1Preview.C1PrintDocument 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 MethodInternalExportOverridden. Performs export to a disk file. If OutputFileName has not been set, this method returns immediately.  
    Protected MethodOnDocumentChangedCalled after the Document property has been changed. If you override this, make sure this base method also gets called. (Inherited from C1.C1Preview.Export.Exporter)
    Protected MethodPreparePageDrawParamsSet page draw parameters. (Inherited from C1.C1Preview.Export.Exporter)
    Protected MethodPreviewOutputFilePreviews OutputFileName. This (base) implementation uses System.Diagnostics.Process.Start() to open the output file.

    Override this if you override CanPreviewOutputFile.

    (Inherited from C1.C1Preview.Export.Exporter)
    Protected MethodProcessPageOverridden. Not supported for this class.  
    Protected MethodResetOverridden. Resets the internal state of the exporter.  
    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

    HtmlExporter Class
    C1.C1Preview.Export Namespace
    HtmlExportProvider Class