Skip to main content
BuyLog In
WinForms Controls
Search in…
Docs > API Reference > DevExpress.XtraPrintingLinks > DataGridLink > Members
All docs
V24.1
WinForms Controls
.NET/.NET Core Support
Prerequisites
What's Installed
Build an Application
Controls and Libraries
Common Features
Security Considerations
UI Templates
Desktop & Web App UI Framework (Powered by EF Core)
Get More Help
API Reference
DevExpress.Accessibility
DevExpress.DataAccess.UI
DevExpress.DataAccess.UI.Design
DevExpress.DataAccess.UI.EntityFramework
DevExpress.DataAccess.UI.Excel
DevExpress.DataAccess.UI.MongoDB
DevExpress.DataAccess.UI.ObjectBinding
DevExpress.DataAccess.UI.Sql
DevExpress.DataAccess.UI.Wizard
DevExpress.DataAccess.UI.Wizard.Services
DevExpress.DataAccess.UI.Wizard.Views
DevExpress.DocumentView
DevExpress.DocumentView.Controls
DevExpress.LookAndFeel
DevExpress.LookAndFeel.Helpers
DevExpress.Skins
DevExpress.Utils
DevExpress.Utils.Animation
DevExpress.Utils.Behaviors
DevExpress.Utils.Controls
DevExpress.Utils.DragDrop
DevExpress.Utils.Drawing
DevExpress.Utils.Filtering
DevExpress.Utils.Html
DevExpress.Utils.Layout
DevExpress.Utils.Menu
DevExpress.Utils.MVVM
DevExpress.Utils.Taskbar
DevExpress.Utils.Taskbar.Core
DevExpress.Utils.UI.Localization
DevExpress.Utils.VisualEffects
DevExpress.Utils.Win
DevExpress.XtraBars
DevExpress.XtraBars.Alerter
DevExpress.XtraBars.Docking
DevExpress.XtraBars.Docking2010
DevExpress.XtraBars.Docking2010.Base
DevExpress.XtraBars.Docking2010.Customization
DevExpress.XtraBars.Docking2010.Views
DevExpress.XtraBars.Docking2010.Views.NativeMdi
DevExpress.XtraBars.Docking2010.Views.Tabbed
DevExpress.XtraBars.Docking2010.Views.Widget
DevExpress.XtraBars.Docking2010.Views.WindowsUI
DevExpress.XtraBars.FluentDesignSystem
DevExpress.XtraBars.Localization
DevExpress.XtraBars.Navigation
DevExpress.XtraBars.Ribbon
DevExpress.XtraBars.Ribbon.Gallery
DevExpress.XtraBars.Ribbon.ViewInfo
DevExpress.XtraBars.ToastNotifications
DevExpress.XtraBars.ToolbarForm
DevExpress.XtraBars.Utils
DevExpress.XtraCharts
DevExpress.XtraCharts.Accessibility
DevExpress.XtraCharts.Designer
DevExpress.XtraCharts.Heatmap
DevExpress.XtraCharts.Sankey
DevExpress.XtraCharts.Wizard
DevExpress.XtraDataLayout
DevExpress.XtraDiagram
DevExpress.XtraDiagram.Docking
DevExpress.XtraDiagram.Extensions
DevExpress.XtraDiagram.Options
DevExpress.XtraDialogs
DevExpress.XtraEditors
DevExpress.XtraEditors.Base
DevExpress.XtraEditors.ButtonPanel
DevExpress.XtraEditors.Calendar
DevExpress.XtraEditors.Camera
DevExpress.XtraEditors.Container
DevExpress.XtraEditors.Controls
DevExpress.XtraEditors.Controls.StepProgressBar
DevExpress.XtraEditors.CustomEditor
DevExpress.XtraEditors.DXErrorProvider
DevExpress.XtraEditors.Filtering
DevExpress.XtraEditors.Mask
DevExpress.XtraEditors.Repository
DevExpress.XtraEditors.TableLayout
DevExpress.XtraEditors.ViewInfo
DevExpress.XtraGantt
DevExpress.XtraGantt.Base.Scheduling
DevExpress.XtraGantt.Exceptions
DevExpress.XtraGantt.Localization
DevExpress.XtraGantt.Options
DevExpress.XtraGantt.Printing
DevExpress.XtraGantt.Scheduling
DevExpress.XtraGantt.TimeLine
DevExpress.XtraGauges.Presets.Styles
DevExpress.XtraGauges.Win
DevExpress.XtraGauges.Win.Base
DevExpress.XtraGauges.Win.Gauges.Circular
DevExpress.XtraGauges.Win.Gauges.Digital
DevExpress.XtraGauges.Win.Gauges.Linear
DevExpress.XtraGauges.Win.Gauges.State
DevExpress.XtraGrid
DevExpress.XtraGrid.Columns
DevExpress.XtraGrid.Controls
DevExpress.XtraGrid.EditForm
DevExpress.XtraGrid.FilterEditor
DevExpress.XtraGrid.Localization
DevExpress.XtraGrid.Views.BandedGrid
DevExpress.XtraGrid.Views.BandedGrid.ViewInfo
DevExpress.XtraGrid.Views.Base
DevExpress.XtraGrid.Views.Base.ViewInfo
DevExpress.XtraGrid.Views.Card
DevExpress.XtraGrid.Views.Card.ViewInfo
DevExpress.XtraGrid.Views.Grid
DevExpress.XtraGrid.Views.Grid.ViewInfo
DevExpress.XtraGrid.Views.Items
DevExpress.XtraGrid.Views.Layout
DevExpress.XtraGrid.Views.Layout.Events
DevExpress.XtraGrid.Views.Layout.ViewInfo
DevExpress.XtraGrid.Views.Printing
DevExpress.XtraGrid.Views.Tile
DevExpress.XtraGrid.Views.WinExplorer
DevExpress.XtraGrid.WinExplorer
DevExpress.XtraLayout
DevExpress.XtraLayout.Converter
DevExpress.XtraLayout.Custom
DevExpress.XtraLayout.Customization
DevExpress.XtraLayout.HitInfo
DevExpress.XtraLayout.Localization
DevExpress.XtraLayout.Utils
DevExpress.XtraMap
DevExpress.XtraMap.Printing
DevExpress.XtraNavBar
DevExpress.XtraNavBar.ViewInfo
DevExpress.XtraPdfViewer
DevExpress.XtraPdfViewer.Commands
DevExpress.XtraPdfViewer.Extensions
DevExpress.XtraPdfViewer.Localization
DevExpress.XtraPivotGrid
DevExpress.XtraPivotGrid.Data
DevExpress.XtraPrinting
DevExpress.XtraPrinting.Control
DevExpress.XtraPrinting.Links
DevExpress.XtraPrinting.Preview
DevExpress.XtraPrintingLinks
CompositeLink
DataGridLink
Members
Constructors
Properties
Methods
Events
DataGridLinkBase
DataGridPrintStyle
ListViewLink
ListViewLinkBase
RichTextBoxLink
RichTextBoxLinkBase
RichTextPrintFormat
TreeViewLink
TreeViewLinkBase
DevExpress.XtraReports.UI
DevExpress.XtraRichEdit
DevExpress.XtraRichEdit.Commands
DevExpress.XtraRichEdit.Export
DevExpress.XtraRichEdit.Import
DevExpress.XtraRichEdit.Menu
DevExpress.XtraScheduler
DevExpress.XtraScheduler.Drawing
DevExpress.XtraScheduler.GoogleCalendar
DevExpress.XtraScheduler.Microsoft365Calendar
DevExpress.XtraScheduler.Printing
DevExpress.XtraScheduler.Reporting
DevExpress.XtraScheduler.Reporting.UI
DevExpress.XtraScheduler.Services
DevExpress.XtraScheduler.Services.Implementation
DevExpress.XtraScheduler.UI
DevExpress.XtraSpellChecker
DevExpress.XtraSpellChecker.Localization
DevExpress.XtraSplashForm
DevExpress.XtraSplashScreen
DevExpress.XtraSpreadsheet
DevExpress.XtraSpreadsheet.Services
DevExpress.XtraTab
DevExpress.XtraTab.Buttons
DevExpress.XtraTab.ViewInfo
DevExpress.XtraTabbedMdi
DevExpress.XtraToolbox
DevExpress.XtraTreeList
DevExpress.XtraTreeList.Columns
DevExpress.XtraTreeList.Data
DevExpress.XtraTreeList.Localization
DevExpress.XtraTreeList.Menu
DevExpress.XtraTreeList.Nodes
DevExpress.XtraTreeList.Nodes.Operations
DevExpress.XtraTreeList.Printing
DevExpress.XtraTreeList.StyleFormatConditions
DevExpress.XtraTreeMap
DevExpress.XtraTreeMap.Printing
DevExpress.XtraVerticalGrid
DevExpress.XtraVerticalGrid.Events
DevExpress.XtraVerticalGrid.Localization
DevExpress.XtraVerticalGrid.Rows
DevExpress.XtraVerticalGrid.StyleFormatConditions
DevExpress.XtraWaitForm
DevExpress.XtraWizard
Download CHM

DataGridLink Members

A link to print the DataGrid control.

Constructors

Name Description
DataGridLink() Initializes a new instance of the DataGridLink class with default settings.
DataGridLink(PrintingSystem) Initializes a new instance of the DataGridLink class with the specified printing system.
DataGridLink(IContainer) Initializes a new instance of the DataGridLink class with the specified container.

Properties

Name Description
Activity Gets the current document creation status. Inherited from LinkBase.
AutoHeight Gets or sets a value indicating whether the height of the DataGrid to be printed should be calculated automatically. Inherited from DataGridLinkBase.
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.
CustomPaperSize Gets or sets the paper size (measured in hundredths of an inch). Inherited from LinkBase.
DataGrid Gets or sets a DataGrid object to be printed via the current link. Inherited from DataGridLinkBase.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
EnablePageDialog Enables the Header and Footer dialog used for editing a document page’s headers and footers. Inherited from LinkBase.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
ImageCollection Provides access to the link’s collection of images.
Images A collection of images which can be added to the page’s headers and footers.
ImageStream For internal use. Specifies a stream which contains images to display in the link’s Page Header and Footer.
Landscape Gets or sets a value indicating whether the page orientation is landscape. Inherited from LinkBase.
Margins Gets or sets the margins of a report page (measured in hundredths of an inch). Inherited from LinkBase.
MinMargins Specifies the minimum printer margin values. Inherited from LinkBase.
Owner For internal use. Inherited from LinkBase.
PageHeaderFooter Gets or sets the object used to fill the document’s area that is occupied by the page header and page footer. Inherited from LinkBase.
PaperKind Gets or sets the type of paper for the document. Inherited from LinkBase.
PaperName Gets or sets the name of the custom paper which is used in the printer that the document is going to be printed on. Inherited from LinkBase.
PrintableObjectType Gets the type of the object to be printed by the link. Inherited from DataGridLinkBase.
PrintingSystem Gets or sets the Printing System used to create and print a document for this link.
PrintingSystemBase Gets or sets the Printing System used to create and print a document for this link. Inherited from LinkBase.
PrintStyle Gets or sets the data grid’s printing style. Inherited from DataGridLinkBase.
RightToLeftLayout Specifies the orientation of the document’s content. Inherited from LinkBase.
RtfReportFooter Gets or sets the RTF text, which will be printed as a Report Footer. Inherited from LinkBase.
RtfReportHeader Gets or sets the RTF text, which will be printed as a Report Header. Inherited from LinkBase.
Site Gets or sets the ISite of the Component. Inherited from Component.
SkipArea Gets or sets report areas that should be skipped. Inherited from LinkBase.
UseDataGridView Gets or sets a value indicating whether this DataGridLinkBase class descendant should use the visual style of the DataGrid it prints. Inherited from DataGridLinkBase.
VerticalContentSplitting Gets or sets a value indicating whether content bricks, which are outside the right page margin, should be split across pages, or moved in their entirety to the next page. Inherited from LinkBase.

Methods

Name Description
AddSubreport(PrintingSystemBase, DocumentBand, PointF) Adds a subreport to the specified band in the current report. Inherited from LinkBase.
AddSubreport(PointF) Adds a subreport to the current report. Inherited from DataGridLinkBase.
CanHandleCommand(PrintingSystemCommand, IPrintControl) Indicates whether or not the specified Printing System command can be handled.
ClearDocument() Removes all pages from the current document. Inherited from LinkBase.
CreateDocument() Creates a report using the current PrintingSystem. Inherited from LinkBase.
CreateDocument(PrintingSystem) Creates a document using the specified Printing System, so the document can be displayed or printed.
CreateDocument(PrintingSystemBase) Creates a document from the link using the specified Printing System. Inherited from LinkBase.
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.
Dispose() Releases all resources used by the Component. Inherited from Component.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
ExportToCsv(Stream, CsvExportOptions) Exports a document to the specified stream in CSV format using the defined CSV-specific options. Inherited from LinkBase.
ExportToCsv(Stream) Exports a document to the specified stream in CSV format. Inherited from LinkBase.
ExportToCsv(String, CsvExportOptions) Exports a document to the specified file path in CSV format using the defined CSV-specific options. Inherited from LinkBase.
ExportToCsv(String) Exports a document to the specified file path in CSV format. Inherited from LinkBase.
ExportToDocx(Stream, DocxExportOptions) Exports a document to the specified stream in DOCX format using the defined DOCX-specific options. Inherited from LinkBase.
ExportToDocx(Stream) Exports a document to the specified stream in DOCX format. Inherited from LinkBase.
ExportToDocx(String, DocxExportOptions) Exports a document to the specified file path in DOCX format using the specified DOCX-specific options. Inherited from LinkBase.
ExportToDocx(String) Exports a document to the specified file path in DOCX format. Inherited from LinkBase.
ExportToHtml(Stream, HtmlExportOptions) Exports a document to the specified stream in HTML format using the defined HTML-specific options. Inherited from LinkBase.
ExportToHtml(Stream) Exports a document to the specified stream in HTML format. Inherited from LinkBase.
ExportToHtml(String, HtmlExportOptions) Exports a document to the specified file path in HTML format using the defined HTML-specific options. Inherited from LinkBase.
ExportToHtml(String) Exports a document to the specified file path in HTML format. Inherited from LinkBase.
ExportToImage(Stream, ImageExportOptions) Exports a document to the specified stream in Image format using the defined Image-specific options. Inherited from LinkBase.
ExportToImage(Stream) Exports a document to the specified stream in Image format. Inherited from LinkBase.
ExportToImage(String, ImageExportOptions) Exports a document to the specified file path in Image format using the defined Image-specific options. Inherited from LinkBase.
ExportToImage(String) Exports a document to the specified file path in Image format. Inherited from LinkBase.
ExportToMht(Stream, MhtExportOptions) Exports a document to the specified stream in MHT format using the defined MHT-specific options. Inherited from LinkBase.
ExportToMht(Stream) Exports a document to the specified stream in MHT format. Inherited from LinkBase.
ExportToMht(String, MhtExportOptions) Exports a document to the specified file path in MHT format using the defined MHT-specific options. Inherited from LinkBase.
ExportToMht(String) Exports a document to the specified file path in MHT format. Inherited from LinkBase.
ExportToPdf(Stream, PdfExportOptions) Exports a document to the specified stream in PDF format using the defined PDF-specific options. Inherited from LinkBase.
ExportToPdf(Stream) Exports a document to the specified stream in PDF format. Inherited from LinkBase.
ExportToPdf(String, PdfExportOptions) Exports a document to the specified file path in PDF format using the defined PDF-specific options. Inherited from LinkBase.
ExportToPdf(String) Exports a document to the specified file path in PDF format. Inherited from LinkBase.
ExportToRtf(Stream, RtfExportOptions) Exports a document to the specified stream in RTF format using the defined RTF-specific options. Inherited from LinkBase.
ExportToRtf(Stream) Exports a document to the specified stream in RTF format. Inherited from LinkBase.
ExportToRtf(String, RtfExportOptions) Exports a document to the specified file path in RTF format using the defined RTF-specific options. Inherited from LinkBase.
ExportToRtf(String) Exports a document to the specified file path in RTF format. Inherited from LinkBase.
ExportToText(Stream, TextExportOptions) Exports a document to the specified stream in Text format using the defined Text-specific options. Inherited from LinkBase.
ExportToText(Stream) Exports a document to the specified stream in Text format. Inherited from LinkBase.
ExportToText(String, TextExportOptions) Exports a document to the specified file path in Text format using the defined Text-specific options. Inherited from LinkBase.
ExportToText(String) Exports a document to the specified file path in Text format. Inherited from LinkBase.
ExportToXls(Stream, XlsExportOptions) Exports a report to the specified stream in XLS format using the defined XLS-specific options. Inherited from LinkBase.
ExportToXls(Stream) Exports a report to the specified stream in XLS format. Inherited from LinkBase.
ExportToXls(String, XlsExportOptions) Exports a report to the specified file path in XLS format using the defined XLS-specific options. Inherited from LinkBase.
ExportToXls(String) Exports a report to the specified file path in XLS format. Inherited from LinkBase.
ExportToXlsx(Stream, XlsxExportOptions) Exports a report to the specified stream in XLSX format using the defined XLSX-specific options. Inherited from LinkBase.
ExportToXlsx(Stream) Exports a report to the specified stream in XLSX format. Inherited from LinkBase.
ExportToXlsx(String, XlsxExportOptions) Exports a report to the specified file path in XLSX format using the defined XLSX-specific options. Inherited from LinkBase.
ExportToXlsx(String) Exports a report to the specified file path in XLSX format. Inherited from LinkBase.
GetHashCode() Serves as the default hash function. Inherited from Object.
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.
HandleCommand(PrintingSystemCommand, Object[], IPrintControl, ref Boolean) Handles the specified Printing System command.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
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.
Print() Prints the current document using the system default printer.
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.
RestorePageHeaderFooterFromStream(Stream) Loads a Page Header/Footer dialog’s settings from the specified stream. Inherited from LinkBase.
RestorePageHeaderFooterFromXml(String) Loads a Page Header/Footer dialog’s settings from the specified XML file. Inherited from LinkBase.
SavePageHeaderFooterToStream(Stream) Saves the Page Header/Footer dialog’s settings to the specified stream. Inherited from LinkBase.
SavePageHeaderFooterToXml(String) Saves the Page Header/Footer dialog’s settings to an XML file. Inherited from LinkBase.
SetDataObject(Object) Sets the object to be printed by this link. Inherited from DataGridLinkBase.
ShowPreview() Invokes the Print Preview Form which shows the print preview of the document for this link.
ShowPreview(UserLookAndFeel) Invokes the Print Preview Form which shows the print preview of the document for this link using the specified look and feel settings.
ShowPreview(IWin32Window, UserLookAndFeel) Invokes the Print Preview Form that shows the print preview of the document for this link as a child of the specified parent window, using the specified look and feel settings.
ShowPreviewDialog() Invokes the Print Preview Form which modally shows the print preview of the document for this link.
ShowPreviewDialog(IWin32Window, UserLookAndFeel) Invokes the Print Preview Form which modally shows the print preview of the document for this link as a child of the specified parent window, using the specified look and feel settings.
ShowPreviewDialog(IWin32Window) Invokes the Print Preview Form, which modally shows the print preview of the document for this link as a child of the specified parent window.
ShowRibbonPreview(UserLookAndFeel) Invokes the Ribbon Print Preview form with the document created from this link, using the specified look and feel settings.
ShowRibbonPreviewDialog(UserLookAndFeel) Invokes the modal Ribbon Print Preview form with the document created from this link, using the specified look and feel settings.
ToString() Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.

Events

Name Description
AfterCreateAreas Occurs after all sections of the document have been generated. Inherited from LinkBase.
BeforeCreateAreas Occurs before any section of the document is generated. Inherited from LinkBase.
CreateDetailArea Occurs when a detail section of the document is being generated. Inherited from LinkBase.
CreateDetailFooterArea Occurs when a detail footer section of the document is being generated. Inherited from LinkBase.
CreateDetailHeaderArea Occurs when a detail header section of the document is being generated. Inherited from LinkBase.
CreateInnerPageFooterArea Occurs when an inner page footer section of the document is being generated. Inherited from LinkBase.
CreateInnerPageHeaderArea Occurs when an inner page header section of the document is being generated. Inherited from LinkBase.
CreateMarginalFooterArea Occurs when a marginal page footer section of the document is being generated. Inherited from LinkBase.
CreateMarginalHeaderArea Occurs when a marginal page header section of the document is being generated. Inherited from LinkBase.
CreateReportFooterArea Occurs when a report footer section of the document is being generated. Inherited from LinkBase.
CreateReportHeaderArea Occurs when a report header section of the document is being generated. Inherited from LinkBase.
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
See Also