The PdfExporter type exposes the following members.
Methods
Name | Description | |
---|---|---|
CanPreviewOutputFile |
Tests 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.
(Inherited from Exporter.)If you override this, you must also override PreviewOutputFile()()()(). |
|
Clear |
Resets the internal state of the exporter and all its public properties.
(Inherited from Exporter.) |
|
ConvertEmfPlusToEmfOnly |
Indicates whether page metafiles of types EmfPlusDual and EmfPlusOnly
should be converted to EmfOnly type before exporting.
The base implementation returns false.
(Inherited from Exporter.) |
|
CopyPropertiesFromOptionsForm |
Copies the options from the specified export options form
to corresponding properties on the current exporter.
(Overrides Exporter..::..CopyPropertiesFromOptionsForm(ExportOptionsFormBase).) |
|
CopyPropertiesToOptionsForm |
Copies the properties of the current exporter to corresponding
user-editable options of the specified export options form.
(Overrides Exporter..::..CopyPropertiesToOptionsForm(ExportOptionsFormBase).) |
|
EnsureGeneratedDocument |
Makes sure the Document has been generated if it is an instance
of the C1PrintDocument or of the C1Report class.
(Inherited from Exporter.) |
|
EnumeratePages |
Processes (exports) all pages in the range to be exported.
(Inherited from Exporter.) |
|
Export(Stream) |
Exports the object specified by the Document property on the current exporter
to the specified Stream.
(Inherited from Exporter.)Note that some export formats do not support exporting to streams. Test the value returned by the CanExportToStream property on ExportProvider prior to calling this method. |
|
Export(String) |
Exports the object specified by the Document property on the current exporter
to the specified file.
(Inherited from Exporter.) |
|
GetPageFileName |
Gets 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 Exporter.) |
|
InternalExport |
Performs export to a disk file or to a stream.
The destination (file or stream) is determined by which of the properties
(OutputFileName()()()() or OutputStream()()()()) is non-null
when this method executes.
(Overrides PagesExporterInternalExport()()()().) |
|
OnDocumentChanged |
Called after the Document property has been changed.
If you override this, make sure this base method also gets called.
(Inherited from Exporter.) |
|
PreviewOutputFile |
Previews OutputFileName()()()().
This (base) implementation uses System.Diagnostics.Process.Start()
to open the output file.
(Inherited from Exporter.)Override this if you override CanPreviewOutputFile()()()(). |
|
ProcessPage |
Exports a page of a document represented by a Metafile.
(Overrides Exporter..::..ProcessPage(Metafile, C1MetafileInfo, Int32, Boolean).) |
|
Reset |
Resets the internal state of the exporter.
(Inherited from Exporter.) |
|
ShowOptionsDialog |
Displays a dialog that allows the user to edit the export options.
(Inherited from Exporter.) |
Properties
Name | Description | |
---|---|---|
Document |
Gets or sets the object representing the document that will be exported
by the current exporter's Export(String) or Export(Stream) methods.
(Inherited from Exporter.) |
|
DocumentInfo |
Gets or sets the DocumentInfo object associated with the Document
assigned to the current exporter.
(Inherited from Exporter.) |
|
DocumentInfoFormClass |
Gets 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 DocumentInfoForm.
(Inherited from Exporter.) |
|
EmbedTrueTypeFonts |
Gets or sets a value indicating whether to embed TrueType fonts used in the source document, in the produced PDF document.
The default is true.
|
|
ExportProvider |
Gets PdfExportProvider.
(Overrides Exporter..::..ExportProvider.) |
|
FormFields |
Gets or sets a value indicating whether to export input fields as Acrobat Form fields.
The default is true.
|
|
OptionsFormClass |
Gets 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 DefaultOptionsFormClass
property.
(Inherited from Exporter.) |
|
OptionsFormClassName |
Gets 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 DefaultOptionsFormClass
property.
(Inherited from Exporter.) |
|
OutputFiles |
Gets 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 Exporter.) |
|
PdfViewerPreferencesFormClass |
Gets or sets the type of form that is used to edit the ViewerPreferences
associated with the PDF documents that is exported.
The form type must be PdfViewerPreferencesForm or derived from it.
That form is invoked from the export options form.
|
|
Preview |
Gets 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 Exporter.) |
|
Range |
Gets or sets the range of pages that is to be exported.
(Inherited from Exporter.) |
|
RangeFormClass |
Gets 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 OutputRangeForm.
(Inherited from Exporter.) |
|
ReferenceGraphics |
Specifies the Graphics object used by export.
For example, that Graphics can be used to convert
EmfPlusDual or EmfPlusOnly
metafiles to EmfOnly.
If this property is null, the screen device context is used.
(Inherited from Exporter.) |
|
Security |
Gets the PdfSecurity object describing security properties of the produced PDF document.
|
|
ShowOptions |
Gets or sets a value indicating whether the options dialog should be shown to the user
before exporting the document.
(Inherited from Exporter.) |
|
UseCompression |
Gets or sets a value indicating whether to use compression in the produced PDF document.
The default is true.
|
|
ViewerPreferences |
Gets the PdfViewerPreferences object describing viewer preferences to be used
when the produced PDF document is opened.
|
Events
Name | Description | |
---|---|---|
LongOperation |
Occurs periodically during export.
Allows to show progress and give the end user the ability to cancel the operation.
(Inherited from Exporter.) |