Back to Devexpress

DevExpress.XtraPrinting Namespace

corelibraries-devexpress-6d7f01a6.md

latest36.0 KB
Original Source

DevExpress.XtraPrinting Namespace

Contains classes that provide the basic functionality for the XtraPrinting library (bricks, pages, document).

Assemblies : DevExpress.Data.v25.2.dll, DevExpress.Printing.v25.2.Core.dll

NuGet Packages : DevExpress.Data, DevExpress.Printing.Core

Classes

NameDescription
AccessorThis class supports the .NET Framework infrastructure and is not intended to be used directly from your code.
BarCodeBrickA visual brick that contains a barcode.
BookmarkInfoContains information about a bookmark that is related to a printing brick.
BookmarkNodeRepresents a bookmark shown in the report’s document map.
BookmarkNodeCollectionRepresents a document map which contains a collection of all the bookmarks in a document.
BrickThe base for all visual brick classes.
BrickBaseThis class is the basic class for all brick classes.
BrickCollectionBaseServes as the base class for classes that represent collections of bricks.
BrickEventArgsBaseRepresents the base for all classes that provide data for the brick-related events.
BrickGraphicsImplements report drawing functions.
BrickPagePairFor internal use. An association of a brick and a page.
BrickSelector staticSelects bricks from a document or document page(s).
BrickStringFormatEncapsulates text layout information (such as alignment, orientation and tab stops) and display manipulations (such as ellipsis insertion and national digit substitution).
BrickStyleRepresents a report drawing style.
ChangeEventArgsProvides data for the BeforeChange and AfterChange events of the PrintingSystem class and the IPrintingSystem interface.
CharacterCombBrickA visual brick containing text whose characters are displayed in individual cells.
CheckBoxBrickA visual brick containing a check box.
CheckBoxGlyphCollectionStores a custom glyph image for each checkbox state (Checked/Unchecked/Indeterminate).
CheckEditingFieldAn editing field for changing the state of a check box in Print Preview.
CompositeBrickUnites multiple visual bricks and defines how to render contained bricks on a document page.
CreateAreaEventArgsProvides data for all area creation events.
CsvExportOptionsContains options which define how a document is exported to CSV format.
CsvExportOptionsExContains options that define how a control is exported to CSV format in data-aware export mode.
DocumentThe rendered and ready-to-print report document.
DocxDocumentOptionsProvides options that specify the Document Properties of the resulting DOCX file.
DocxExportOptionsContains options which define how a document is exported to DOCX format.
EditingFieldProvides the base functionality for fields whose content can be edited in Print Preview.
EditingFieldCollectionThe collection of fields whose content can be edited in Print Preview.
EditingFieldEditorNames staticSpecifies editors that can be used for changing control content in Print Preview.
EditingFieldEventArgsProvides data for the PrintingSystemBase.EditingFieldChanged event.
EmailOptionsRepresents different settings used to specify exporting parameters when a document is exported and sent via e-mail from the Print Preview.
EmptyBrickFor internal use. Intended to create indivisible brick groups.
ExceptionEventArgsProvides data for the ExceptionEventArgs.Exception event.
ExportOptionsStores the document export options for different export formats.
ExportOptionsBaseRepresents the base class for objects which define specific export options.
FormattedTextExportOptionsThe base for classes that provide options for export to RTF and DOCX formats.
GraphicsDpiEnables you to calculate the DPI values associated with specific units of measure (and vice versa).
GraphicsUnitConverterEnables you to convert values that are calculated in some measure units to different measure units.
HtmlExportOptionsContains options which define how a document is exported to HTML format.
HtmlExportOptionsBaseRepresents the base class for objects which define export options specific to HTML and MHT formats.
ImageBrickA visual brick containing an image.
ImageEditingFieldAn editing field that allows end-users to change an image content in Print Preview.
ImageExportOptionsContains options which define how a document is exported to an image.
LabelBrickA visual brick that contains a rotated text.
LineBrickA visual brick containing a line.
LinkBaseThe base class for all printing links.
LinkCollectionA collection of Link objects.
MailMessageExportOptionsContains options which define how a document is exported to a mail message.
MarginsChangeEventArgsProvides data for the PrintingSystemBase.BeforeMarginsChange event.
MhtExportOptionsContains options which define how a document is exported to MHT format.
NativeFormatOptionsContains options which define how a document is exported to the native Printing System file format.
PageA single document page.
PageAreaServes as the base for classes that specify information to be displayed in page header and page footer areas.
PageByPageExportOptionsBaseRepresents the base class for objects which define specific export options for those export formats which support page-by-page export (HTML, MHT and PDF).
PageEventArgsFor Internal use. Provides data for the PrintingSystemBase.AfterPagePrint event.
PageFooterAreaRepresents the object that specifies information to be displayed in a page footer area.
PageHeaderAreaRepresents the object that specifies information to be displayed in a page header area.
PageHeaderFooterRepresents the object, containing information about the page header and page footer areas.
PageImageBrickA visual brick within the page header or page footer section, containing an image.
PageInfoBrickA visual brick which is displayed in the page header or page footer sections, and contains information specific to the current page.
PageInfoDataProviderBaseA service that allows the XRPageInfo control to display custom information.
PageInfoTextBrickThe base for the PageInfoBrick class.
PageInfoTextBrickBaseThe base for the PageInfoBrick and PageInfoTextBrick classes.
PageListA collection of Page objects.
PagePaintEventArgsProvides data for the PrintingSystemBase.BeforePagePaint and PrintingSystemBase.AfterPagePaint events.
PageSettingsHelperEnables you to override the default printer settings in your application.
PageTableBrickA visual brick comprised of rows and columns.
PanelBrickA visual brick containing other bricks.
PdfAttachmentRepresents a file attached to a PDF document.
PdfDocumentOptionsContains options which specify the Document Properties of the created PDF file.
PdfExportOptionsContains options that define how a document is exported to PDF format.
PdfPasswordSecurityOptionsDefines the security access options for the exported PDF document.
PdfPasswordSecurityOptions.PdfPasswordSecurityOptionsTypeConverter
PdfPermissionsOptionsDefines the security permission options for the exported PDF document.
PdfPrintingOptionsContains options that specify how to print PDF content.
PdfSignatureOptionsContains the settings to apply an X.509 certificate to the resulting PDF file to digitally sign the document.
PdfSignatureOptions.PdfSignatureOptionsTypeConverter
PrintDocumentEventArgsProvides data for the PrintingSystemBase.StartPrint event.
PrinterSettingsUsingRepresents options that specify which of the default printer’s settings should be used when printing a document.
PrintingOptions staticA static class that contains a set of options that specify how to print visual elements.
PrintingSystemBaseThe base for classes that provide the basic printing functionality in different environments.
PrintPreviewOptionsRepresents different settings used to specify how a document is exported from the Print Preview.
PrintProgressEventArgsProvides data for the PrintingSystemBase.PrintProgress and XtraReport.PrintProgress events.
PrintToolBaseThe base class for the PrintTool class.
ProgressBarBrickA visual brick containing a progress bar.
ProgressReflectorReflects the current state of document printing or exporting.
RecipientDefines the recipient settings.
RecipientCollectionA collection of Recipient objects, specifying the list of recipients who are to receive an exported document via email.
RtfExportOptionsContains options which define how a document is exported to RTF format.
ShapeBrickA visual brick containing a shape.
TableRowRepresents a row in the PageTableBrick.
TableRowCollectionRepresents a collection of rows owned by the PageTableBrick.
TextBrickA visual brick that contains text.
TextBrickBaseRepresents the base class for brick classes which contain text.
TextEditingFieldAn editing field for changing the content of text controls in Print Preview.
TextExportOptionsContains options which define how a document is exported to text.
TextExportOptionsBaseRepresents the base class for objects which define export options specific for Text and CSV formats.
UserPageBrickAn object implementing the IBrick interface that is drawn using the IBrickGraphics.DrawBrick method.
UserVisualBrickA visual brick that is drawn on a page by an object implementing the IBrick interface.
VisualBrickA visual brick that is rendered on a page as a simple rectangle and the base for all other visual bricks.
XlDocumentOptionsProvides options that specify the Document Properties of the resulting Excel file.
XlEncryptionOptionsProvides the options to encrypt XLS and XLSX files.
XlExportOptionsBaseRepresents the base class for objects which define export options specific to XLS and XLSX formats.
XlsExportOptionsContains options which define how a document is exported to XLS format.
XlsExportOptionsExContains options that define how a document is exported to XLS format in the data-aware export mode.
XlSheetCreatedEventArgsProvides data for the PrintingSystemBase.XlSheetCreated event.
XlsxExportOptionsContains options which define how a document is exported to XLSX format.
XlsxExportOptionsExContains options that define how a document is exported to XLSX format in the data-aware export mode.
XpsDocumentOptionsContains options which specify the Document Properties of the created XPS file.
XpsExportOptionsContains options which define how a document is exported to XPS format.
XtraPageSettingsBaseThe base for classes that provide functionality to print reports.
ZipCodeBrickA visual brick that contains a zip code.

Interfaces

NameDescription
IBasePrintableThis member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
IBrickProvides the basic functionality to draw visual bricks and specify their properties.
IBrickGraphicsProvides basic report drawing functions.
IBrickOwner
ICommandHandlerIf implemented by a class, provides methods for handling commands in Print Preview.
IDocumentSourceFor internal use.
IGraphicsProvides the essential functionality for document printing.
ILinkProvides the basic functionality to create documents that are ready to print.
IPrintControlProvides the basic functionality for the PrintControl component.
IPrintingSystemProvides the base functionality of the XtraPrinting Library.
IPrintingSystemContextFor internal use. Provides information about the Printing System.

Structs

NameDescription
PaddingInfoContains padding or margin information associated with a control or a brick.

Delegates

NameDescription
BrickEventHandlerBaseRepresents the base method for all brick-related events.
ChangeEventHandlerA method that will handle the BeforeChange and AfterChange events of the PrintingSystem class and the IPrintingSystem interface.
CreateAreaEventHandlerA method that will handle all creation events of the Link class.
ExceptionEventHandlerA method that will handle the ExceptionEventArgs.Exception event.
MarginsChangeEventHandlerA method that will handle the PrintingSystemBase.BeforeMarginsChange event of the PrintingSystem class.
PageEventHandlerA method that handles all page events within the XtraPrinting Library.
PagePaintEventHandlerRepresents a method that will handle the PrintingSystemBase.BeforePagePaint and PrintingSystemBase.AfterPagePaint events.
PrintDocumentEventHandlerRepresents the method that will handle the PrintingSystemBase.StartPrint event.
PrintProgressEventHandlerRepresents the method that will handle the PrintingSystemBase.PrintProgress event.

Enums

NameDescription
ActionAfterExportSpecifies whether the resulting file should be automatically opened in the default program, after exporting a document which is currently displayed in the Print Preview.
BorderDashStyleLists the values used to specify the border’s dash style for an XRControl.
BorderSideSpecifies the borders displayed around a brick.
BrickAlignmentSpecifies brick alignment relative to its layout rectangle.
BrickBorderStyleSpecifies the border style for a brick.
BrickModifierSpecifies the report section’s modifiers.
BrickStringFormatPrototypeKindSpecifies the prototype string format for the BrickStringFormat.
CanPublishToFormatsLists values that specify brick visibility on printouts and documents exported to specific formats.
ChangingPermissionsSpecifies the document changing permissions.
CheckBoxStateSpecifies the visual state of a check box.
ColumnLayoutLists the values used to specify the column layout direction for a multi-column report.
CommandVisibilitySpecifies the visibility levels for the printing system commands.
DocxExportModeLists the available DOCX export modes.
EncodingTypeLists the types of encoding to be used when a document is exported to a Text-based format.
ExportFormatLists the values that specify the available export formats.
ExportOptionKindSpecifies the export options items which are displayed when an end-user exports a document from its Print Preview.
ExportTargetLists the available export formats.
GlyphStyleThe checkbox glyph styles enumeration.
HorizontalContentSplittingLists the available horizontal content splitting modes.
HtmlExportModeLists the available HTML export modes.
HtmlLineDirectionLists the acceptable line directions for HTML export.
ImageAlignmentSpecifies the alignment of a displayed image in relation to the container control’s boundaries.
ImageExportModeLists the available image export modes.
ImageSizeModeSpecifies how an image is positioned within a Picture Box.
MarginSideSpecifies page margin(s).
PageInfoContains the values that define what kind of information is displayed in the current PageInfoBrick.
PageViewModesLists the available page view modes.
PdfACompatibilityLists the values specifying the PDF/A compatibility mode of a document.
PdfAttachmentRelationshipLists the values used to specify the type of relationship between the document and the attachment file.
PdfEncryptionLevelLists the algorithms that can be used to encrypt PDF data.
PdfHashAlgorithmLists values used to specify the secure hash algorithm (SHA) type for a signature.
PdfJpegImageQualitySpecifies how images are exported to PDF format.
PdfUACompatibilityLists values that specify whether a document conforms to the PDF/UA specification.
PrintingPermissionsSpecifies the document printing permissions.
PrintingSystemActivityLists the available activity modes that relate to a link’s LinkBase.Activity property.
PrintingSystemCommandSpecifies the commands which can be executed in the printing system’s document preview.
RecipientFieldTypeLists the values used to specify the field type to which the current recipient belongs.
RtfExportModeLists the available RTF export modes.
SaveModeSpecifies how the file path to export a document is obtained, when exporting a document which is currently displayed in the Print Preview.
SignatureImageDisplayModeContains settings that specify whether an XRPdfSignature control should show the signature image.
SizeModeLists the cell size modes supported by the XRCharacterComb control.
TextAlignmentSpecifies the positioning of text within a control.
TextExportModeSpecifies whether to use the formatting of the data fields in the bound dataset for the cells in the exported XLS (or XLSX) document.
TextRenderingModeLists the values indicating the available text rendering modes.
VerticalContentSplittingSpecifies how content bricks are split if they are partially positioned outside the right page margin.
WorkbookColorPaletteComplianceLists the available modes for color palette compatibility with different workbooks versions.
XlEncryptionTypeLists the supported encryption types.
XlIgnoreErrorsLists the document errors that should be ignored by Excel.
XlsExportModeLists the available XLS export modes.
XlsxExportModeLists the available XLSX export modes.
XpsCompressionOptionLists the values used to specify the compression level of the XPS document.
XRPdfRenderingEngineSpecifies the engine that renders PDF content.