PrintingSystemBase Members

The base for classes that provide the basic printing functionality in different environments.

Constructors

Name Description
PrintingSystemBase() Initializes a new instance of the PrintingSystemBase class with the default settings.
PrintingSystemBase(IContainer) Initializes a new PrintingSystemBase class instance and adds it to the form's container.

Properties

Name Description
CancelPending For internal use.
CanRaiseEvents protected Gets a value indicating whether the component can raise an event.
(Inherited from Component)
Container Gets the IContainer that contains the Component.
(Inherited from Component)
ContinuousPageNumbering Gets or sets a value indicating whether pages should be renumbered following reordering in the PrintingSystemBase.Pages collection.
Culture Specifies the culture that is used to display date-time values by the XRPageInfo control.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode.
(Inherited from Component)
Document Gets the current document.
EditingFields Provides access to the collection of fields whose content can be edited in Print Preview.
Events protected Gets the list of event handlers that are attached to this Component.
(Inherited from Component)
ExportOptions Gets the settings used to specify export parameters when exporting a printing system's document.
Graph Gets a BrickGraphics object used for drawing in the current report.
ImageResources
Landscape Gets the orientation of a report page.
PageBounds Gets the bounds of a report page.
PageCount Gets the number of document pages.
PageMargins Gets the current page margin settings.
Pages Provides access to a collection of pages generated for this printing system.
PageSettings Gets the current page settings.
PrintingDocument For internal use.
ProgressReflector Provides access to the object that reflects the current state of a document's generating or exporting.
ShowMarginsWarning Gets or sets a value which specifies whether an error message is shown when the page margins are set outside the printable area.
ShowPrintStatusDialog Specifies whether or not to show a print status dialog when printing a document.
Site Gets or sets the ISite of the Component.
(Inherited from Component)
UserName static Specifies the name of the user that created the document.
Watermark Gets the document's watermark.

Methods

Name Description
AddCommandHandler(ICommandHandler) Adds the specified command handler to the command handlers list for one or several of the printing system commands (listed in the PrintingSystemCommand enumeration).
AddService(Type, ServiceCreatorCallback) Adds the specified service to the service container.
AddService(Type, ServiceCreatorCallback, Boolean) Adds the specified service to the service container.
AddService(Type, Object) Adds the specified service to the service container.
AddService(Type, Object, Boolean) Adds the specified service to the service container.
Begin() Indicates that report generation has started.
BeginSubreport(PointF) Must be called before subreport creation.
Cancel() For internal use.
ClearContent() Clears the current document.
CreateBrick(String) Creates a specific brick type.
CreateObjRef(Type) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject)
CreatePage() Creates a new empty page using the current printing system's page settings.
Dispose() Releases all resources used by the Component.
(Inherited from Component)
End() Finishes a report's generation.
End(Boolean) Finishes a report's generation.
EndSubreport() Signals that subreport creation is completed.
Equals(Object) Determines whether the specified object is equal to the current object.
(Inherited from Object)
Equals(Object, Object) static Determines whether the specified object instances are considered equal.
(Inherited from Object)
ExecCommand(PrintingSystemCommand) Executes the specified printing system command.
ExecCommand(PrintingSystemCommand, Object[]) Executes the specified printing system command and passes the specified parameters.
ExportToCsv(Stream) Exports a document to the specified stream in CSV format.
ExportToCsv(Stream, CsvExportOptions) Exports a document to the specified stream in CSV format using the defined CSV-specific options.
ExportToCsv(String) Exports a document to the specified file path in CSV format.
ExportToCsv(String, CsvExportOptions) Exports a document to the specified file path in CSV format using the defined CSV-specific options.
ExportToDocx(Stream) Exports a document to the specified stream in DOCX format.
ExportToDocx(Stream, DocxExportOptions) Exports a document to the specified stream in DOCX format using the specified DOCX-specific options.
ExportToDocx(String) Exports a document to the specified file path in DOCX format.
ExportToDocx(String, DocxExportOptions) Exports a document to the specified file path in DOCX format using the specified DOCX-specific options.
ExportToHtml(Stream) Exports a document to the specified stream in HTML format.
ExportToHtml(Stream, HtmlExportOptions) Exports a document to the specified stream in HTML format using the defined HTML-specific options.
ExportToHtml(String) Exports a document to the specified file path in HTML format.
ExportToHtml(String, HtmlExportOptions) Exports a document to the specified file path in HTML format using the defined HTML-specific options.
ExportToImage(Stream) Exports a document to the specified stream in Image format.
ExportToImage(Stream, ImageExportOptions) Exports a document to the specified stream in Image format using the defined Image-specific options.
ExportToImage(Stream, ImageFormat) Exports a document to the specified stream in the specified Image format.
ExportToImage(String) Exports a document to the specified file path in Image format.
ExportToImage(String, ImageExportOptions) Exports a document to the specified file path in Image format using the defined Image-specific options.
ExportToImage(String, ImageFormat) Exports a document to the specified file path using the specified image format.
ExportToMail() Exports a document to HTML and then inserts it into a specified e-mail.
ExportToMail(MailMessageExportOptions) Exports a document to HTML and then inserts it into a specified e-mail.
ExportToMail(MailMessageExportOptions, String, String, String) Exports a document to HTML and then inserts it into a specified e-mail.
ExportToMail(String, String, String) Exports a document to HTML and then inserts it into a specified e-mail.
ExportToMht(Stream) Exports a document to the specified stream in MHT format.
ExportToMht(Stream, MhtExportOptions) Exports a document to the specified stream in MHT format using the defined MHT-specific options.
ExportToMht(String) Exports a document to the specified file path in MHT format.
ExportToMht(String, MhtExportOptions) Exports a document to the specified file path in MHT format using the defined MHT-specific options.
ExportToPdf(Stream) Exports a document to the specified stream in PDF format.
ExportToPdf(Stream, PdfExportOptions) Exports a document to the specified stream in PDF format using the defined PDF-specific options.
ExportToPdf(String) Exports a document to the specified file path in PDF format.
ExportToPdf(String, PdfExportOptions) Exports a document to the specified file path in PDF format using the defined PDF-specific options.
ExportToRtf(Stream) Exports a document to the specified stream in RTF format.
ExportToRtf(Stream, RtfExportOptions) Exports a document to the specified stream in RTF format using the defined RTF-specific options.
ExportToRtf(String) Exports a document to the specified file path in RTF format.
ExportToRtf(String, RtfExportOptions) Exports a document to the specified file path in RTF format using the defined RTF-specific options.
ExportToText(Stream) Exports a document to the specified stream in Text format.
ExportToText(Stream, TextExportOptions) Exports a document to the specified stream in Text format using the defined Text-specific options.
ExportToText(String) Exports a document to the specified file path in Text format.
ExportToText(String, TextExportOptions) Exports a document to the specified file path in Text format using the defined Text-specific options.
ExportToXls(Stream) Exports a report to the specified stream in XLS format.
ExportToXls(Stream, XlsExportOptions) Exports a report to the specified stream in XLS format using the defined XLS-specific options.
ExportToXls(String) Exports a report to the specified file path in XLS format.
ExportToXls(String, XlsExportOptions) Exports a report to the specified file path in XLS format using the defined XLS-specific options.
ExportToXlsx(Stream) Exports a report to the specified stream in XLSX format.
ExportToXlsx(Stream, XlsxExportOptions) Exports a report to the specified stream in XLSX format using the defined XLSX-specific options.
ExportToXlsx(String) Exports a report to the specified file path in XLSX format.
ExportToXlsx(String, XlsxExportOptions) Exports a report to the specified file path in XLSX format using the defined XLSX-specific options.
ExportToXps(Stream, XpsExportOptions) Exports a document to the specified stream in XPS format using the specified XPS-specific options.
ExportToXps(String, XpsExportOptions) Exports a report to the specified file path in XPS format using the specified XPS-specific options.
GetBrickExporter(Type) static For internal use.
GetCommandVisibility(PrintingSystemCommand) Gets the current visibility of the specified printing system command.
GetHashCode() Serves as the default hash function.
(Inherited from Object)
GetIntersectedBricks() Gets the intersecting bricks within the document.
GetLifetimeService() Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
GetService(Type) protected Returns an object that represents a service provided by the Component or by its Container.
(Inherited from Component)
GetType() Gets the Type of the current instance.
(Inherited from Object)
HighlightIntersectedBricks(Color) Highlights the intersecting bricks within the document.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
InsertPageBreak(Single) Inserts a page break at a specified position.
InsertPageBreak(Single, Margins, Nullable<PaperKind>, Size, Nullable<Boolean>) Inserts a page break at a specified position, with the specified settings for the subsequent page.
LoadDocument(Stream) Loads a document from a Stream object, containing data in a native XML format (PRNX).
LoadDocument(String) Loads a document from a file in a native XML format (PRNX).
Lock() Prevents the document from being modified.
MarkBrick(Brick, Page) Draws a selection rectangle around the specified brick located on the specified page.
MemberwiseClone() protected Creates a shallow copy of the current Object.
(Inherited from Object)
MemberwiseClone(Boolean) protected Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject)
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance.
(Inherited from Object)
RemoveCommandHandler(ICommandHandler) Removes the existing command handler for one or several of the printing system commands (listed in the PrintingSystemCommand enumeration).
RemoveService(Type) Removes the specified service type from the service container.
RemoveService(Type, Boolean) Removes the specified service type from the service container.
ResetProgressReflector() Resets all settings of the printing system's PrintingSystemBase.ProgressReflector.
SaveDocument(Stream) Saves a document to a Stream object in a native XML format (PRNX).
SaveDocument(Stream, NativeFormatOptions) Saves a document to a Stream object in a native XML format (PRNX) using the specified PRNX-specific options.
SaveDocument(String) Saves a document to the specified file path in a native XML format (PRNX).
SaveDocument(String, NativeFormatOptions) Saves a document to the specified file path in a native XML format (PRNX) using the specified PRNX-specific options.
SetBrickExporter(Type, Type) static For internal use.
SetCommandVisibility(PrintingSystemCommand, CommandVisibility) Changes the visibility of the specified printing system command.
SetCommandVisibility(PrintingSystemCommand[], CommandVisibility) Changes the visibility of the specified printing system command.
ToString() Returns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component)
Unlock() Unlocks a previously locked document.
UnmarkBrick(Brick, Page) Removes a selection rectangle which was previously drawn around the specified brick using the PrintingSystemBase.MarkBrick method.

Events

Name Description
AfterBandPrint Occurs after a band has been printed on a page.
AfterBuildPages For internal use. Occurs after all document pages have been created.
AfterChange Occurs on raising any PrintingSystem event that does not have the "Before" prefix in its name.
AfterMarginsChange Occurs when page margins change.
AfterPagePaint Occurs after a specific page has been painted in a Print Preview.
AfterPagePrint For internal use. Occurs after every time any page of the printing system's Document is printed.
BeforeBuildPages For internal use. Occurs before document pages are created.
BeforeChange Occurs on raising any PrintingSystem event that has the "Before" prefix in its name.
BeforeMarginsChange Occurs when page margins are about to change.
BeforePagePaint Occurs before a specific page has been painted in a Print Preview.
CreateDocumentException Occurs when an exception is raised during document creation.
Disposed Occurs when the component is disposed by a call to the Dispose() method.
(Inherited from Component)
EditingFieldChanged Occurs each time a value of an editing field changes.
EndPrint Occurs after the printing system's document is set to the selected printer's printing queue. Does not indicate the success of the actual printing process.
FillEmptySpace Fires after page rendering if a gap remains between the rendered areas.
PageInsertComplete For internal use.
PageSettingsChanged Occurs when page settings change.
PrintProgress Occurs before sending every document page to a printer to indicate the current printing progress.
ScaleFactorChanged Occurs when a scale factor of the current document has been changed.
StartPrint Occurs before the printing system's document is printed.
XlSheetCreated Occurs after creation of an XLS or XLSX document worksheet has finished.
See Also