PrintableComponentLink Class

A link to print and export components that implement the IPrintable interface.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.XtraPrinting.v20.2.dll

NuGet Package: DevExpress.Win.Printing

Declaration

C#

public class PrintableComponentLink :
    PrintableComponentLinkBase,
    IWinLink

VB.NET

Public Class PrintableComponentLink
    Inherits PrintableComponentLinkBase
    Implements IWinLink

Remarks

PrintableComponentLink is a link to print/export any component that supports the IPrintable interface. This component is specified by the link’s PrintableComponentLinkBase.Component property.

A control’s export using a PrintableComponentLink is performed in WYSIWYG export mode. Certain controls (e.g., GridControl) can be exported to XLS-XLSX formats in data-aware export mode. In data-aware mode, optimized for subsequent analysis of grid data within Microsoft Excel, various data shaping options that are applied within a source control are retained in output XLS-XLSX documents. See Export to XLS and XLSX Formats to learn more.

Afterwards, you can create a document and either show its Print Preview (by calling the PrintableComponentLink.ShowPreview or PrintableComponentLink.ShowPreviewDialog method), or print it (by calling the PrintableComponentLink.Print or PrintableComponentLink.PrintDlg method).

The following DevExpress controls support the IPrintable interface.

• ChartControl;
• GridControl;
• LayoutControl;
• PivotGridControl;
• RichEditControl;
• SchedulerControl;
• SpreadsheetControl;
• TreeList.

Some controls (like RichEditControl) will ignore the page options provided by the corresponding printing links and use their own page options, instead.

For code samples, see the following resources:

• How to: Use the PrintableComponentLink to Print DevExpress Controls

• How to: Create a Printable ListView Descendant Implementing the IPrintable Interface

  (An implementation of the IPrintable interface for a custom control, to print and export it using the PrintableComponentLink class.)

• How to print DevExpress ASP.NET controls via XtraReports

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PrintableComponentLink class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

Reporting_how-to-save-load-a-documents-watermark-in-print-preview-e1909/CS/Form1.cs#L78

private void RestoreWatermark(PrintableComponentLink pcl, WatermarkStorage storage) {
    switch (storage) {

how-to-use-the-print-preview-dialog-to-adjust-margins-in-the-richeditcontrol-document-e3384/CS/Form1.cs#L17

public partial class Form1 : Form {
    PrintableComponentLink link;
    public Form1() {

VB.NET

Reporting_how-to-save-load-a-documents-watermark-in-print-preview-e1909/VB/Form1.vb#L80

Private Sub RestoreWatermark(ByVal pcl As PrintableComponentLink, ByVal storage As WatermarkStorage)
    Select Case storage

how-to-use-the-print-preview-dialog-to-adjust-margins-in-the-richeditcontrol-document-e3384/VB/Form1.vb#L19

Private link As PrintableComponentLink
Public Sub New()

Inheritance

Object

MarshalByRefObject

Component

LinkBase

PrintableComponentLinkBase

PrintableComponentLink