PrintingSystem Members

Implements the basic printing functionality of the XtraPrinting Library.

Constructors

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

Properties

Name Description
CancelPending For internal use. Inherited from PrintingSystemBase.
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. Inherited from PrintingSystemBase.
Culture Specifies the culture used for date and time values in the XRPageInfo control. Inherited from PrintingSystemBase.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Document Gets the current document. Inherited from PrintingSystemBase.
EditingFields Provides access to the collection of fields whose content can be edited in Print Preview. Inherited from PrintingSystemBase.
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. Inherited from PrintingSystemBase.
Graph Gets a BrickGraphics object used for drawing in the current report. Inherited from PrintingSystemBase.
ImageResources Inherited from PrintingSystemBase.
Landscape Gets the orientation of a report page. Inherited from PrintingSystemBase.
Links Gets the collection of links, defined for the current PrintingSystem object.
PageBounds Gets the bounds of a report page. Inherited from PrintingSystemBase.
PageCount Gets the number of document pages. Inherited from PrintingSystemBase.
PageMargins Gets the current page margin settings. Inherited from PrintingSystemBase.
Pages Provides access to a collection of pages generated for this printing system. Inherited from PrintingSystemBase.
PageSettings Gets the current page settings.
PreviewFormEx Gets the form used to display the document preview.
PreviewRibbonFormEx Gets the Ribbon form used to display the document preview.
PrintingDocument For internal use. Inherited from PrintingSystemBase.
ProgressReflector Provides access to the object that reflects the current state of a document's generating or exporting. Inherited from PrintingSystemBase.
ShowMarginsWarning Gets or sets a value which specifies whether an error message is shown when the page margins are set outside the printable area. Inherited from PrintingSystemBase.
ShowPrintStatusDialog Specifies whether or not to show a print status dialog when printing a document. Inherited from PrintingSystemBase.
Site Gets or sets the ISite of the Component. Inherited from Component.
UserName static Specifies the name of the user that created the document. Inherited from PrintingSystemBase.
Watermark Provides access to watermark settings of the printing system's document.

Methods

Name Description
About() static Activates the About dialog.
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). Inherited from PrintingSystemBase.
AddService(Type, ServiceCreatorCallback) Adds the specified service to the service container. Inherited from PrintingSystemBase.
AddService(Type, ServiceCreatorCallback, Boolean) Adds the specified service to the service container. Inherited from PrintingSystemBase.
AddService(Type, Object) Adds the specified service to the service container. Inherited from PrintingSystemBase.
AddService(Type, Object, Boolean) Adds the specified service to the service container. Inherited from PrintingSystemBase.
Begin() Indicates that report generation has started. Inherited from PrintingSystemBase.
BeginSubreport(PointF) Must be called before subreport creation. Inherited from PrintingSystemBase.
Cancel() For internal use. Inherited from PrintingSystemBase.
ClearContent() Clears the current document. Inherited from PrintingSystemBase.
CompleteWorkingAsync(Boolean) Inherited from PrintingSystemBase.
CreateBrick(String) Creates a specific brick type. Inherited from PrintingSystemBase.
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. Inherited from PrintingSystemBase.
Dispose() Releases all resources used by the Component. Inherited from Component.
End() Finishes a report's generation. Inherited from PrintingSystemBase.
End(Boolean) Finishes a report's generation. Inherited from PrintingSystemBase.
EndSubreport() Signals that subreport creation is completed. Inherited from PrintingSystemBase.
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. Inherited from PrintingSystemBase.
ExecCommand(PrintingSystemCommand, Object[]) Executes the specified printing system command and passes the specified parameters. Inherited from PrintingSystemBase.
ExportToCsv(Stream) Exports a document to the specified stream in CSV format. Inherited from PrintingSystemBase.
ExportToCsv(Stream, CsvExportOptions) Exports a document to the specified stream in CSV format using the defined CSV-specific options. Inherited from PrintingSystemBase.
ExportToCsv(String) Exports a document to the specified file path in CSV format. Inherited from PrintingSystemBase.
ExportToCsv(String, CsvExportOptions) Exports a document to the specified file path in CSV format using the defined CSV-specific options. Inherited from PrintingSystemBase.
ExportToDocx(Stream) Exports a document to the specified stream in DOCX format. Inherited from PrintingSystemBase.
ExportToDocx(Stream, DocxExportOptions) Exports a document to the specified stream in DOCX format using the specified DOCX-specific options. Inherited from PrintingSystemBase.
ExportToDocx(String) Exports a document to the specified file path in DOCX format. Inherited from PrintingSystemBase.
ExportToDocx(String, DocxExportOptions) Exports a document to the specified file path in DOCX format using the specified DOCX-specific options. Inherited from PrintingSystemBase.
ExportToHtml(Stream) Exports a document to the specified stream in HTML format. Inherited from PrintingSystemBase.
ExportToHtml(Stream, HtmlExportOptions) Exports a document to the specified stream in HTML format using the defined HTML-specific options. Inherited from PrintingSystemBase.
ExportToHtml(String) Exports a document to the specified file path in HTML format. Inherited from PrintingSystemBase.
ExportToHtml(String, HtmlExportOptions) Exports a document to the specified file path in HTML format using the defined HTML-specific options. Inherited from PrintingSystemBase.
ExportToImage(Stream) Exports a document to the specified stream in Image format. Inherited from PrintingSystemBase.
ExportToImage(Stream, ImageExportOptions) Exports a document to the specified stream in Image format using the defined Image-specific options. Inherited from PrintingSystemBase.
ExportToImage(Stream, ImageFormat) Exports a document to the specified stream in the specified Image format. Inherited from PrintingSystemBase.
ExportToImage(String) Exports a document to the specified file path in Image format. Inherited from PrintingSystemBase.
ExportToImage(String, ImageExportOptions) Exports a document to the specified file path in Image format using the defined Image-specific options. Inherited from PrintingSystemBase.
ExportToImage(String, ImageFormat) Exports a document to the specified file path using the specified image format. Inherited from PrintingSystemBase.
ExportToMail() Exports a document to HTML and then inserts it into a specified e-mail. Inherited from PrintingSystemBase.
ExportToMail(MailMessageExportOptions) Exports a document to HTML and then inserts it into a specified e-mail. Inherited from PrintingSystemBase.
ExportToMail(MailMessageExportOptions, String, String, String) Exports a document to HTML and then inserts it into a specified e-mail. Inherited from PrintingSystemBase.
ExportToMail(String, String, String) Exports a document to HTML and then inserts it into a specified e-mail. Inherited from PrintingSystemBase.
ExportToMht(Stream) Exports a document to the specified stream in MHT format. Inherited from PrintingSystemBase.
ExportToMht(Stream, MhtExportOptions) Exports a document to the specified stream in MHT format using the defined MHT-specific options. Inherited from PrintingSystemBase.
ExportToMht(String) Exports a document to the specified file path in MHT format. Inherited from PrintingSystemBase.
ExportToMht(String, MhtExportOptions) Exports a document to the specified file path in MHT format using the defined MHT-specific options. Inherited from PrintingSystemBase.
ExportToPdf(Stream) Exports a document to the specified stream in PDF format. Inherited from PrintingSystemBase.
ExportToPdf(Stream, PdfExportOptions) Exports a document to the specified stream in PDF format using the defined PDF-specific options. Inherited from PrintingSystemBase.
ExportToPdf(String) Exports a document to the specified file path in PDF format. Inherited from PrintingSystemBase.
ExportToPdf(String, PdfExportOptions) Exports a document to the specified file path in PDF format using the defined PDF-specific options. Inherited from PrintingSystemBase.
ExportToRtf(Stream) Exports a document to the specified stream in RTF format. Inherited from PrintingSystemBase.
ExportToRtf(Stream, RtfExportOptions) Exports a document to the specified stream in RTF format using the defined RTF-specific options. Inherited from PrintingSystemBase.
ExportToRtf(String) Exports a document to the specified file path in RTF format. Inherited from PrintingSystemBase.
ExportToRtf(String, RtfExportOptions) Exports a document to the specified file path in RTF format using the defined RTF-specific options. Inherited from PrintingSystemBase.
ExportToText(Stream) Exports a document to the specified stream in Text format. Inherited from PrintingSystemBase.
ExportToText(Stream, TextExportOptions) Exports a document to the specified stream in Text format using the defined Text-specific options. Inherited from PrintingSystemBase.
ExportToText(String) Exports a document to the specified file path in Text format. Inherited from PrintingSystemBase.
ExportToText(String, TextExportOptions) Exports a document to the specified file path in Text format using the defined Text-specific options. Inherited from PrintingSystemBase.
ExportToXls(Stream) Exports a report to the specified stream in XLS format. Inherited from PrintingSystemBase.
ExportToXls(Stream, XlsExportOptions) Exports a report to the specified stream in XLS format using the defined XLS-specific options. Inherited from PrintingSystemBase.
ExportToXls(String) Exports a report to the specified file path in XLS format. Inherited from PrintingSystemBase.
ExportToXls(String, XlsExportOptions) Exports a report to the specified file path in XLS format using the defined XLS-specific options. Inherited from PrintingSystemBase.
ExportToXlsx(Stream) Exports a report to the specified stream in XLSX format. Inherited from PrintingSystemBase.
ExportToXlsx(Stream, XlsxExportOptions) Exports a report to the specified stream in XLSX format using the defined XLSX-specific options. Inherited from PrintingSystemBase.
ExportToXlsx(String) Exports a report to the specified file path in XLSX format. Inherited from PrintingSystemBase.
ExportToXlsx(String, XlsxExportOptions) Exports a report to the specified file path in XLSX format using the defined XLSX-specific options. Inherited from PrintingSystemBase.
ExportToXps(Stream, XpsExportOptions) Exports a document to the specified stream in XPS format using the specified XPS-specific options. Inherited from PrintingSystemBase.
ExportToXps(String, XpsExportOptions) Exports a report to the specified file path in XPS format using the specified XPS-specific options. Inherited from PrintingSystemBase.
GetBrickExporter(Type) static For internal use. Inherited from PrintingSystemBase.
GetCommandVisibility(PrintingSystemCommand) Gets the current visibility of the specified printing system command. Inherited from PrintingSystemBase.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetIntersectedBricks() Gets the intersecting bricks within the document. Inherited from PrintingSystemBase.
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. Inherited from PrintingSystemBase.
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. Inherited from PrintingSystemBase.
InsertPageBreak(Single, Margins, Nullable<PaperKind>, Size, Nullable<Boolean>) Inserts a page break at a specified position, with the specified settings for the subsequent page. Inherited from PrintingSystemBase.
LoadDocument(Stream) Loads a document from a Stream object, containing data in a native XML format (PRNX). Inherited from PrintingSystemBase.
LoadDocument(String) Loads a document from a file in a native XML format (PRNX). Inherited from PrintingSystemBase.
Lock() Prevents the document from being modified. Inherited from PrintingSystemBase.
MarkBrick(Brick, Page) Draws a selection rectangle around the specified brick located on the specified page. Inherited from PrintingSystemBase.
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.
PageSetup() Displays the PageSetup dialog.
Print() Prints the current document.
Print(String) Prints the current document to the specified printer.
PrintDlg() Displays the standard Print dialog and prints the current document.
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). Inherited from PrintingSystemBase.
RemoveService(Type) Removes the specified service type from the service container. Inherited from PrintingSystemBase.
RemoveService(Type, Boolean) Removes the specified service type from the service container. Inherited from PrintingSystemBase.
ResetProgressReflector() Resets all settings of the printing system's PrintingSystemBase.ProgressReflector. Inherited from PrintingSystemBase.
SaveDocument(Stream) Saves a document to a Stream object in a native XML format (PRNX). Inherited from PrintingSystemBase.
SaveDocument(Stream, NativeFormatOptions) Saves a document to a Stream object in a native XML format (PRNX) using the specified PRNX-specific options. Inherited from PrintingSystemBase.
SaveDocument(String) Saves a document to the specified file path in a native XML format (PRNX). Inherited from PrintingSystemBase.
SaveDocument(String, NativeFormatOptions) Saves a document to the specified file path in a native XML format (PRNX) using the specified PRNX-specific options. Inherited from PrintingSystemBase.
SetBrickExporter(Type, Type) static For internal use. Inherited from PrintingSystemBase.
SetCommandVisibility(PrintingSystemCommand, CommandVisibility) Changes the visibility of the specified printing system command. Inherited from PrintingSystemBase.
SetCommandVisibility(PrintingSystemCommand[], CommandVisibility) Changes the visibility of the specified printing system command. Inherited from PrintingSystemBase.
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. Inherited from PrintingSystemBase.
UnmarkBrick(Brick, Page) Removes a selection rectangle which was previously drawn around the specified brick using the PrintingSystemBase.MarkBrick method. Inherited from PrintingSystemBase.

Events

Name Description
AfterBandPrint Occurs after a band has been printed on a page. Inherited from PrintingSystemBase.
AfterBuildPages For internal use. Occurs after all document pages have been created. Inherited from PrintingSystemBase.
AfterChange Occurs on raising any PrintingSystem event that does not have the "Before" prefix in its name. Inherited from PrintingSystemBase.
AfterMarginsChange Occurs when page margins change. Inherited from PrintingSystemBase.
AfterPagePaint Occurs after a specific page has been painted in a Print Preview. Inherited from PrintingSystemBase.
AfterPagePrint For internal use. Occurs after every time any page of the printing system's Document is printed. Inherited from PrintingSystemBase.
BeforeBuildPages For internal use. Occurs before document pages are created. Inherited from PrintingSystemBase.
BeforeChange Occurs on raising any PrintingSystem event that has the "Before" prefix in its name. Inherited from PrintingSystemBase.
BeforeMarginsChange Occurs when page margins are about to change. Inherited from PrintingSystemBase.
BeforePagePaint Occurs before a specific page has been painted in a Print Preview. Inherited from PrintingSystemBase.
CreateDocumentException Occurs when an exception is raised during document creation. Inherited from PrintingSystemBase.
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. Inherited from PrintingSystemBase.
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. Inherited from PrintingSystemBase.
FillEmptySpace Fires after page rendering if a gap remains between the rendered areas. Inherited from PrintingSystemBase.
PageInsertComplete For internal use. Inherited from PrintingSystemBase.
PageSettingsChanged Occurs when page settings change. Inherited from PrintingSystemBase.
PrintProgress Occurs before sending every document page to a printer to indicate the current printing progress. Inherited from PrintingSystemBase.
ScaleFactorChanged Occurs when a scale factor of the current document has been changed. Inherited from PrintingSystemBase.
StartPrint Occurs before the printing system's document is printed. Inherited from PrintingSystemBase.
XlSheetCreated Occurs after creation of an XLS or XLSX document worksheet has finished. Inherited from PrintingSystemBase.
See Also