DevExpress.XtraPrinting Namespace
In This Article
Contains classes that provide the basic functionality for the XtraPrinting library (bricks, pages, document).
Assemblies: DevExpress.Data.v24.2.dll, DevExpress.Printing.v24.2.Core.dll
NuGet Packages: DevExpress.Data, DevExpress.Printing.Core
#Classes
Name | Description |
---|---|
Accessor | This class supports the .NET Framework infrastructure and is not intended to be used directly from your code. |
Bar |
A visual brick that contains a barcode. |
Bookmark |
Contains information about a bookmark that is related to a printing brick. |
Bookmark |
Represents a bookmark shown in the report’s document map. |
Bookmark |
Represents a document map which contains a collection of all the bookmarks in a document. |
Brick | The base for all visual brick classes. |
Brick |
This class is the basic class for all brick classes. |
Brick |
Serves as the base class for classes that represent collections of bricks. |
Brick |
Represents the base for all classes that provide data for the brick-related events. |
Brick |
Implements report drawing functions. |
Brick |
For internal use. An association of a brick and a page. |
Brick |
Selects bricks from a document or document page |
Brick |
Encapsulates text layout information (such as alignment, orientation and tab stops) and display manipulations (such as ellipsis insertion and national digit substitution). |
Brick |
Represents a report drawing style. |
Change |
Provides data for the Before |
Character |
A visual brick containing text whose characters are displayed in individual cells. |
Check |
A visual brick containing a check box. |
Check |
Stores a custom glyph image for each checkbox state (Checked/Unchecked/Indeterminate). |
Check |
An editing field for changing the state of a check box in Print Preview. |
Composite |
Unites multiple visual bricks and defines how to render contained bricks on a document page. |
Create |
Provides data for all area creation events. |
Csv |
Contains options which define how a document is exported to CSV format. |
Csv |
Contains options that define how a control is exported to CSV format in data-aware export mode. |
Document | The rendered and ready-to-print report document. |
Docx |
Provides options that specify the Document Properties of the resulting DOCX file. |
Docx |
Contains options which define how a document is exported to DOCX format. |
Editing |
Provides the base functionality for fields whose content can be edited in Print Preview. |
Editing |
The collection of fields whose content can be edited in Print Preview. |
Editing |
Specifies editors that can be used for changing control content in Print Preview. |
Editing |
Provides data for the Printing |
Email |
Represents different settings used to specify exporting parameters when a document is exported and sent via e-mail from the Print Preview. |
Empty |
For internal use. Intended to create indivisible brick groups. |
Exception |
Provides data for the Exception |
Export |
Stores the document export options for different export formats. |
Export |
Represents the base class for objects which define specific export options. |
Formatted |
The base for classes that provide options for export to RTF and DOCX formats. |
Graphics |
Enables you to calculate the DPI values associated with specific units of measure (and vice versa). |
Graphics |
Enables you to convert values that are calculated in some measure units to different measure units. |
Html |
Contains options which define how a document is exported to HTML format. |
Html |
Represents the base class for objects which define export options specific to HTML and MHT formats. |
Image |
A visual brick containing an image. |
Image |
An editing field that allows end-users to change an image content in Print Preview. |
Image |
Contains options which define how a document is exported to an image. |
Label |
A visual brick that contains a rotated text. |
Line |
A visual brick containing a line. |
Link |
The base class for all printing links. |
Link |
A collection of Link objects. |
Mail |
Contains options which define how a document is exported to a mail message. |
Margins |
Provides data for the Printing |
Mht |
Contains options which define how a document is exported to MHT format. |
Native |
Contains options which define how a document is exported to the native Printing System file format. |
Page | A single document page. |
Page |
Serves as the base for classes that specify information to be displayed in page header and page footer areas. |
Page |
Represents the base class for objects which define specific export options for those export formats which support page-by-page export (HTML, MHT and PDF). |
Page |
For Internal use. Provides data for the Printing |
Page |
Represents the object that specifies information to be displayed in a page footer area. |
Page |
Represents the object that specifies information to be displayed in a page header area. |
Page |
Represents the object, containing information about the page header and page footer areas. |
Page |
A visual brick within the page header or page footer section, containing an image. |
Page |
A visual brick which is displayed in the page header or page footer sections, and contains information specific to the current page. |
Page |
A service that allows the XRPage |
Page |
The base for the Page |
Page |
The base for the Page |
Page |
A collection of Page objects. |
Page |
Provides data for the Printing |
Page |
Enables you to override the default printer settings in your application. |
Page |
A visual brick comprised of rows and columns. |
Panel |
A visual brick containing other bricks. |
Pdf |
Represents a file attached to a PDF document. |
Pdf |
Contains options which specify the Document Properties of the created PDF file. |
Pdf |
Contains options that define how a document is exported to PDF format. |
Pdf |
Defines the security access options for the exported PDF document. |
Pdf |
|
Pdf |
Defines the security permission options for the exported PDF document. |
Pdf |
Contains options that specify how to print PDF content. |
Pdf |
Contains the settings to apply an X. |
Pdf |
|
Print |
Provides data for the Printing |
Printer |
Represents options that specify which of the default printer’s settings should be used when printing a document. |
Printing |
A static class that contains a set of options that specify how to print visual elements. |
Printing |
The base for classes that provide the basic printing functionality in different environments. |
Print |
Represents different settings used to specify how a document is exported from the Print Preview. |
Print |
Provides data for the Printing |
Print |
The base class for the Print |
Progress |
A visual brick containing a progress bar. |
Progress |
Reflects the current state of document printing or exporting. |
Recipient | Defines the recipient settings. |
Recipient |
A collection of Recipient objects, specifying the list of recipients who are to receive an exported document via email. |
Rtf |
Contains options which define how a document is exported to RTF format. |
Shape |
A visual brick containing a shape. |
Table |
Represents a row in the Page |
Table |
Represents a collection of rows owned by the Page |
Text |
A visual brick that contains text. |
Text |
Represents the base class for brick classes which contain text. |
Text |
An editing field for changing the content of text controls in Print Preview. |
Text |
Contains options which define how a document is exported to text. |
Text |
Represents the base class for objects which define export options specific for Text and CSV formats. |
User |
An object implementing the IBrick interface that is drawn using the IBrick |
User |
A visual brick that is drawn on a page by an object implementing the IBrick interface. |
Visual |
A visual brick that is rendered on a page as a simple rectangle and the base for all other visual bricks. |
Xl |
Provides options that specify the Document Properties of the resulting Excel file. |
Xl |
Provides the options to encrypt XLS and XLSX files. |
Xl |
Represents the base class for objects which define export options specific to XLS and XLSX formats. |
Xls |
Contains options which define how a document is exported to XLS format. |
Xls |
Contains options that define how a document is exported to XLS format in the data-aware export mode. |
Xl |
Provides data for the Printing |
Xlsx |
Contains options which define how a document is exported to XLSX format. |
Xlsx |
Contains options that define how a document is exported to XLSX format in the data-aware export mode. |
Xps |
Contains options which specify the Document Properties of the created XPS file. |
Xps |
Contains options which define how a document is exported to XPS format. |
Xtra |
The base for classes that provide functionality to print reports. |
Zip |
A visual brick that contains a zip code. |
#Interfaces
Name | Description |
---|---|
IBase |
This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. |
IBrick | Provides the basic functionality to draw visual bricks and specify their properties. |
IBrick |
Provides basic report drawing functions. |
IBrick |
|
ICommand |
If implemented by a class, provides methods for handling commands in Print Preview. |
IDocument |
For internal use. |
IGraphics | Provides the essential functionality for document printing. |
ILink | Provides the basic functionality to create documents that are ready to print. |
IPrint |
Provides the basic functionality for the Print |
IPrinting |
Provides the base functionality of the Xtra |
IPrinting |
For internal use. Provides information about the Printing System. |
#Structs
Name | Description |
---|---|
Padding |
Contains padding or margin information associated with a control or a brick. |
#Delegates
Name | Description |
---|---|
Brick |
Represents the base method for all brick-related events. |
Change |
A method that will handle the Before |
Create |
A method that will handle all creation events of the Link class. |
Exception |
A method that will handle the Exception |
Margins |
A method that will handle the Printing |
Page |
A method that handles all page events within the Xtra |
Page |
Represents a method that will handle the Printing |
Print |
Represents the method that will handle the Printing |
Print |
Represents the method that will handle the Printing |
#Enums
Name | Description |
---|---|
Action |
Specifies whether the resulting file should be automatically opened in the default program, after exporting a document which is currently displayed in the Print Preview. |
Border |
Lists the values used to specify the border’s dash style for an XRControl. |
Border |
Specifies the borders displayed around a brick. |
Brick |
Specifies brick alignment relative to its layout rectangle. |
Brick |
Specifies the border style for a brick. |
Brick |
Specifies the report section’s modifiers. |
Brick |
Specifies the prototype string format for the Brick |
Changing |
Specifies the document changing permissions. |
Check |
Specifies the visual state of a check box. |
Column |
Lists the values used to specify the column layout direction for a multi-column report. |
Command |
Specifies the visibility levels for the printing system commands. |
Docx |
Lists the available DOCX export modes. |
Encoding |
Lists the types of encoding to be used when a document is exported to a Text-based format. |
Export |
Lists the values that specify the available export formats. |
Export |
Specifies the export options items which are displayed when an end-user exports a document from its Print Preview. |
Export |
Lists the available export formats. |
Glyph |
The checkbox glyph styles enumeration. |
Horizontal |
Lists the available horizontal content splitting modes. |
Html |
Lists the available HTML export modes. |
Html |
Lists the acceptable line directions for HTML export. |
Image |
Specifies the alignment of a displayed image in relation to the container control’s boundaries. |
Image |
Lists the available image export modes. |
Image |
Specifies how an image is positioned within a Picture Box. |
Margin |
Specifies page margin |
Page |
Contains the values that define what kind of information is displayed in the current Page |
Page |
Lists the available page view modes. |
Pdf |
Lists the values specifying the PDF/A compatibility mode of a document. |
Pdf |
Lists the values used to specify the type of relationship between the document and the attachment file. |
Pdf |
Lists the algorithms that can be used to encrypt PDF data. |
Pdf |
|
Pdf |
Specifies how images are exported to PDF format. |
Pdf |
Lists values that specify whether a document conforms to the PDF/UA specification. |
Printing |
Specifies the document printing permissions. |
Printing |
Lists the available activity modes that relate to a link’s Link |
Printing |
Specifies the commands which can be executed in the printing system’s document preview. |
Recipient |
Lists the values used to specify the field type to which the current recipient belongs. |
Rtf |
Lists the available RTF export modes. |
Save |
Specifies how the file path to export a document is obtained, when exporting a document which is currently displayed in the Print Preview. |
Signature |
Contains settings that specify whether an XRPdf |
Size |
Lists the cell size modes supported by the XRCharacter |
Text |
Specifies the positioning of text within a control. |
Text |
Specifies whether to use the formatting of the data fields in the bound dataset for the cells in the exported XLS (or XLSX) document. |
Text |
Lists the values indicating the available text rendering modes. |
Vertical |
Specifies how content bricks are split if they are partially positioned outside the right page margin. |
Workbook |
Lists the available modes for color palette compatibility with different workbooks versions. |
Xl |
Lists the supported encryption types. |
Xl |
Lists the document errors that should be ignored by Excel. |
Xls |
Lists the available XLS export modes. |
Xlsx |
Lists the available XLSX export modes. |
Xps |
Lists the values used to specify the compression level of the XPS document. |
XRPdf |
Specifies the engine that renders PDF content. |