Skip to main content

PrintableControlLink Members

A link to print DevExpress controls and the base class for links to print other data.

Constructors

Name Description
PrintableControlLink(IPrintableControl, String) Initializes a new instance of the PrintableControlLink class with the specified control and document name.
PrintableControlLink(IPrintableControl) Initializes a new instance of the PrintableControlLink class with the specified control.

Fields

Name Description
BottomMarginDataProperty static Identifies the TemplatedLink.BottomMarginData dependency property. Inherited from TemplatedLink.
PageFooterDataProperty static Identifies the TemplatedLink.PageFooterData dependency property. Inherited from TemplatedLink.
PageHeaderDataProperty static Identifies the TemplatedLink.PageHeaderData dependency property. Inherited from TemplatedLink.
ReportFooterDataProperty static Identifies the TemplatedLink.ReportFooterData dependency property. Inherited from TemplatedLink.
ReportHeaderDataProperty static Identifies the TemplatedLink.ReportHeaderData dependency property. Inherited from TemplatedLink.
TopMarginDataProperty static Identifies the TemplatedLink.TopMarginData dependency property. Inherited from TemplatedLink.

Properties

Name Description
BottomMarginData Specifies the content for the document’s bottom margin. This is a dependency property. Inherited from TemplatedLink.
BottomMarginTemplate Specifies the bottom margin template for the document. Inherited from TemplatedLink.
ColumnLayout Gets or sets the column layout. Inherited from TemplatedLink.
ColumnWidth Gets or sets the width of a single column. Inherited from TemplatedLink.
CustomPaperSize Gets or sets a size of custom paper (measured in hundredths of an inch). Inherited from LinkBase.
DependencyObjectType Gets the DependencyObjectType that wraps the CLR type of this instance. Inherited from DependencyObject.
Dispatcher Gets the Dispatcher this DispatcherObject is associated with. Inherited from DispatcherObject.
DocumentName Gets or sets the name of the document. Inherited from LinkBase.
IsSealed Gets a value that indicates whether this instance is currently sealed (read-only). Inherited from DependencyObject.
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.
PageFooterData Specifies the content for the document’s page footer. This is a dependency property. Inherited from TemplatedLink.
PageFooterTemplate Specifies the page footer template for the document. Inherited from TemplatedLink.
PageHeaderData Specifies the content for the document’s page header. This is a dependency property. Inherited from TemplatedLink.
PageHeaderTemplate Specifies the page header template for the document. Inherited from TemplatedLink.
PaperKind Gets or sets the type of paper for the document. Inherited from LinkBase.
PrintingSystem Gets the Printing System used to create and print a document for this link. Inherited from LinkBase.
PrintReportFooterAtBottom Specifies whether the report footer is printed at the bottom of the page, or immediately after the report content. Inherited from TemplatedLink.
ReportFooterData Specifies the content for the document’s report footer. This is a dependency property. Inherited from TemplatedLink.
ReportFooterTemplate Specifies the report footer template for the document. Inherited from TemplatedLink.
ReportHeaderData Specifies the content for the document’s report header. This is a dependency property. Inherited from TemplatedLink.
ReportHeaderTemplate Specifies the report header template for the document. Inherited from TemplatedLink.
SuppressAutoRebuildOnPageSettingsChange Gets or sets a value indicating whether it is necessary to suppress rebuilding the document every time a link’s page settings are changed. Inherited from LinkBase.
TopMarginData Specifies the content for the document’s top margin. This is a dependency property. Inherited from TemplatedLink.
TopMarginTemplate Specifies the top margin template for the document. Inherited from TemplatedLink.
VerticalContentSplitting Specifies 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
CancelPrintAsync() Obsolete. Stops asynchronous printing. Inherited from LinkBase.
CheckAccess() Determines whether the calling thread has access to this DispatcherObject. Inherited from DispatcherObject.
ClearValue(DependencyProperty) Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. Inherited from DependencyObject.
ClearValue(DependencyPropertyKey) Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. Inherited from DependencyObject.
CoerceValue(DependencyProperty) Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. Inherited from DependencyObject.
CreateDocument() Creates a document from the link, so it can be displayed or printed. Inherited from LinkBase.
CreateDocument(Boolean) Creates a document from the link, so it can be displayed or printed. Optionally, the document pages can be generated progressively and accessed as soon as they are created. Document creation is always synchronous and does not occur in a background thread. Inherited from LinkBase.
Dispose() Disposes the LinkBase object. Inherited from LinkBase.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether a provided DependencyObject is equivalent to the current DependencyObject. Inherited from DependencyObject.
ExportToCsv(Stream, CsvExportOptions) Exports a report to the specified stream in CSV format using the specified CSV-specific options. Inherited from LinkBase.
ExportToCsv(Stream) Exports a report to the specified stream in CSV format. Inherited from LinkBase.
ExportToCsv(String, CsvExportOptions) Exports a report to the specified file path in CSV format using the specified CSV-specific options. Inherited from LinkBase.
ExportToCsv(String) Exports a report 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 report to the specified stream in HTML format using the specified HTML-specific options. Inherited from LinkBase.
ExportToHtml(Stream) Exports a report to the specified stream in HTML format. Inherited from LinkBase.
ExportToHtml(String, HtmlExportOptions) Exports a report to the specified file path in HTML format using the specified HTML-specific options. Inherited from LinkBase.
ExportToHtml(String) Exports a report to the specified file path in HTML format. Inherited from LinkBase.
ExportToImage(Stream, DXImageFormat) Inherited from LinkBase.
ExportToImage(Stream, ImageExportOptions) Exports a report to the specified stream in image format using the specified image-specific options. Inherited from LinkBase.
ExportToImage(Stream) Exports a report to the specified stream as an image. Inherited from LinkBase.
ExportToImage(String, DXImageFormat) Inherited from LinkBase.
ExportToImage(String, ImageExportOptions) Exports a report to the specified file path in image format using the specified image-specific options. Inherited from LinkBase.
ExportToImage(String) Exports a report to the specified file path in image format. Inherited from LinkBase.
ExportToMht(Stream, MhtExportOptions) Exports a report to the specified stream in MHT format using the specified MHT-specific options. Inherited from LinkBase.
ExportToMht(Stream) Exports a report to the specified stream in MHT format. Inherited from LinkBase.
ExportToMht(String, MhtExportOptions) Exports a report to the specified file path in MHT format using the specified MHT-specific options. Inherited from LinkBase.
ExportToMht(String) Exports a report to the specified file path in MHT format. Inherited from LinkBase.
ExportToPdf(Stream, PdfExportOptions) Exports a report to the specified stream in PDF format using the specified PDF-specific options. Inherited from LinkBase.
ExportToPdf(Stream) Exports a report to the specified stream in PDF format. Inherited from LinkBase.
ExportToPdf(String, PdfExportOptions) Exports a report to the specified file path in PDF format, using the specified PDF-specific options. Inherited from LinkBase.
ExportToPdf(String) Exports a report to the specified file path in PDF format. Inherited from LinkBase.
ExportToRtf(Stream, RtfExportOptions) Exports a report to the specified stream in RTF format using the specified RTF-specific options. Inherited from LinkBase.
ExportToRtf(Stream) Exports a report to the specified stream in RTF format. Inherited from LinkBase.
ExportToRtf(String, RtfExportOptions) Exports a report to the specified file path in RTF format using the specified RTF-specific options. Inherited from LinkBase.
ExportToRtf(String) Exports a report to the specified file path in RTF format. Inherited from LinkBase.
ExportToText(Stream, TextExportOptions) Exports a report to the specified stream in text format using the specified TXT-specific options. Inherited from LinkBase.
ExportToText(Stream) Exports a report to the specified stream in Text format. Inherited from LinkBase.
ExportToText(String, TextExportOptions) Exports a report to the specified file path in text format using the specified TXT-specific options. Inherited from LinkBase.
ExportToText(String) Exports a report 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 specified 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 specified 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 specified 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 specified XLSX-specific options. Inherited from LinkBase.
ExportToXlsx(String) Exports a report to the specified file path in XLSX format. Inherited from LinkBase.
ExportToXps(Stream, XpsExportOptions) Exports a report to the specified stream in XPS format using the specified XPS-specific options. Inherited from LinkBase.
ExportToXps(String, XpsExportOptions) Exports a report to the specified file path in XPS format using the specified XPS-specific options. Inherited from LinkBase.
GetHashCode() Gets a hash code for this DependencyObject. Inherited from DependencyObject.
GetLocalValueEnumerator() Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. Inherited from DependencyObject.
GetType() Gets the Type of the current instance. Inherited from Object.
GetValue(DependencyProperty) Returns the current effective value of a dependency property on this instance of a DependencyObject. Inherited from DependencyObject.
InvalidateProperty(DependencyProperty) Re-evaluates the effective value for the specified dependency property. Inherited from DependencyObject.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
OnPropertyChanged(DependencyPropertyChangedEventArgs) protected Invoked whenever the effective value of any dependency property on this DependencyObject has been updated. The specific dependency property that changed is reported in the event data. Inherited from DependencyObject.
Print() Opens the Print dialog that allows printing the current document. Inherited from LinkBase.
PrintAsync() Obsolete. Starts asynchronous printing. Inherited from LinkBase.
PrintDirect() Prints the current document to a default printer. Inherited from LinkBase.
PrintDirect(PrintQueue) Obsolete. Prints the current document to the printer specified by the print queue. Inherited from LinkBase.
PrintDirect(String) Prints the current document to the specified printer. Inherited from LinkBase.
PrintDirectAsync() Obsolete. Starts asynchronous printing using the default system printer. Inherited from LinkBase.
PrintDirectAsync(PrintQueue) Obsolete. Starts asynchronous printing using the default system printer with the specified printing queue. Inherited from LinkBase.
ReadLocalValue(DependencyProperty) Returns the local value of a dependency property, if it exists. Inherited from DependencyObject.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
SetCurrentValue(DependencyProperty, Object) Sets the value of a dependency property without changing its value source. Inherited from DependencyObject.
SetValue(DependencyProperty, Object) Sets the local value of a dependency property, specified by its dependency property identifier. Inherited from DependencyObject.
SetValue(DependencyPropertyKey, Object) Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. Inherited from DependencyObject.
ShouldSerializeProperty(DependencyProperty) protected Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. Inherited from DependencyObject.
ShowPrintPreview(FrameworkElement, String) Displays the Print Preview of the link’s document using the specified owner and title. Inherited from LinkBase.
ShowPrintPreview(FrameworkElement) Displays the Print Preview of the link’s document using the specified owner. Inherited from LinkBase.
ShowPrintPreviewDialog(Window, String) Displays the modal Print Preview of the link’s document using the specified owner and title. Inherited from LinkBase.
ShowPrintPreviewDialog(Window) Displays the modal Print Preview of the link’s document using the specified owner. Inherited from LinkBase.
ShowRibbonPrintPreview(FrameworkElement, String) Invokes the Ribbon Print Preview form which shows the print preview of the document for this link. Inherited from LinkBase.
ShowRibbonPrintPreview(FrameworkElement) Invokes the Ribbon Print Preview form which shows the print preview of the document for this link. Inherited from LinkBase.
ShowRibbonPrintPreviewDialog(Window, String) Invokes the Ribbon Print Preview form which modally shows the print preview of the document for this link. Inherited from LinkBase.
ShowRibbonPrintPreviewDialog(Window) Invokes the Ribbon Print Preview form which modally shows the print preview of the document for this link. Inherited from LinkBase.
StopPageBuilding() Interrupts the process of document creation. Inherited from LinkBase.
ToString() Returns a string that represents the current object. Inherited from Object.
VerifyAccess() Enforces that the calling thread has access to this DispatcherObject. Inherited from DispatcherObject.

Events

Name Description
CreateDocumentFinished Occurs when the document creation has been finished. Inherited from LinkBase.
CreateDocumentStarted Occurs when the document creation has been started. Inherited from LinkBase.
PrintCompleted Obsolete. Occurs when the document printing has been finished. Inherited from LinkBase.
See Also