Link Class

A printing link.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.XtraPrinting.v18.1.dll

Declaration

C#

public class Link :
    LinkBase,
    IWinLink

VB.NET

Public Class Link
    Inherits LinkBase
    Implements IWinLink

Remarks

The XtraPrinting Library provides a unified approach to print components using its printing links technology, designed to create a ready-to-print document out of a given component.

To print a component, you can use descendants of the Link class. The following standard printing links are provided for the most popular Windows Forms controls.

• ListViewLink;
• TreeViewLink;
• RichTextBoxLink;
• DataGridLink.

DevExpress components that implement the IPrintable interface can be printed using the PrintableComponentLink.

To combine several components into one printing link, use the CompositeLink.

You can also create your own custom links. For a code example, see How to: Create a Custom Link to Print a ListView Control.

To fine tune a link’s printout, you can handle the following link events.

• LinkBase.CreateMarginalHeaderArea;
• LinkBase.CreateMarginalFooterArea;
• LinkBase.CreateInnerPageHeaderArea;
• LinkBase.CreateInnerPageFooterArea;
• LinkBase.CreateReportHeaderArea;
• LinkBase.CreateDetailHeaderArea;
• LinkBase.CreateDetailArea;
• LinkBase.CreateDetailFooterArea;
• LinkBase.CreateReportFooterArea.

These events can also be used to create a document from scratch, by adding the necessary bricks to it. Within every document section, brick creation must start with the zero vertical coordinate.

To generate a document that is ready to print, call the Link.CreateDocument method.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Link 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-combine-links-via-the-compositelink-e15/CS/Form1.cs#L27

PrintableComponentLink pcLink2 = new PrintableComponentLink();
Link linkMainReport = new Link();
linkMainReport.CreateDetailArea += new CreateAreaEventHandler(linkMainReport_CreateDetailArea);

Reporting_runtime-report-merging-e20058/CS/reportMerging/Form1.cs#L27

List<XtraReport> reports;
Link link;
public PrintHelper(List<XtraReport> reports) {

how-to-export-grouped-grid-with-page-breaks-between-groups-e1597/CS/WebApplication211/Default.aspx.cs#L35

PrintingSystem ps = new PrintingSystem();
Link clink = new Link(ps);
clink.CreateDetailArea += new CreateAreaEventHandler(delegate(object sender2, CreateAreaEventArgs e2)

how-to-enhance-the-output-quality-of-a-chart-in-its-print-preview-e869/CS/Form1.cs#L22

Link l = new Link(new PrintingSystem());
l.CreateDetailArea += new CreateAreaEventHandler(l_CreateDetailArea);

export-aspxpivotgrid-with-additional-text-captions-in-header-or-footer-e1188/CS/Default.aspx.cs#L21

Link link2 = new Link();
link2.CreateDetailArea += new CreateAreaEventHandler(link2_CreateDetailArea);

VB.NET

Reporting_how-to-combine-links-via-the-compositelink-e15/VB/Form1.vb#L29

Dim pcLink2 As New PrintableComponentLink()
Dim linkMainReport As New Link()
AddHandler linkMainReport.CreateDetailArea, AddressOf linkMainReport_CreateDetailArea

Reporting_runtime-report-merging-e20058/VB/reportMerging/Form1.vb#L29

Private reports As List(Of XtraReport)
Private link As Link
Public Sub New(ByVal reports As List(Of XtraReport))

how-to-export-grouped-grid-with-page-breaks-between-groups-e1597/VB/WebApplication211/Default.aspx.vb#L30

Dim ps As New PrintingSystem()
Dim clink As New Link(ps)
AddHandler clink.CreateDetailArea, AddressOf clink_CreateDetailArea

how-to-enhance-the-output-quality-of-a-chart-in-its-print-preview-e869/VB/Form1.vb#L25

Dim l As Link = New Link(New PrintingSystem())
AddHandler l.CreateDetailArea, AddressOf l_CreateDetailArea

export-aspxpivotgrid-with-additional-text-captions-in-header-or-footer-e1188/VB/Default.aspx.vb#L23

Dim link2 As New Link()
AddHandler link2.CreateDetailArea, AddressOf link2_CreateDetailArea

Inheritance

Object

MarshalByRefObject

Component

LinkBase

Link