Back to Devexpress

PrintableComponentLinkBase Members

corelibraries-devexpress-dot-xtraprintinglinks-dot-printablecomponentlinkbase-dot-underscore-members.md

latest30.0 KB
Original Source

PrintableComponentLinkBase Members

Provides the general functionality to print controls that implement the IPrintable interface.

Constructors

NameDescription
PrintableComponentLinkBase()Initializes a new instance of the PrintableComponentLinkBase class with the default settings.
PrintableComponentLinkBase(PrintingSystemBase)Initializes a new instance of the PrintableComponentLinkBase class with the specified printing system.
PrintableComponentLinkBase(IContainer)Initializes a new instance of the PrintableComponentLinkBase class with the specified container.

Properties

NameDescription
ActivityGets the current document creation status. Inherited from LinkBase.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
ComponentGets or sets a IPrintable user implementation printed via the current link.
ContainerGets the IContainer that contains the Component. Inherited from Component.
CustomPaperSizeGets or sets the paper size (measured in hundredths of an inch). Inherited from LinkBase.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
EnablePageDialogEnables the Header and Footer dialog used for editing a document page’s headers and footers. Inherited from LinkBase.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
LandscapeGets or sets a value indicating whether the page orientation is landscape. Inherited from LinkBase.
MarginsGets or sets the margins of a report page (measured in hundredths of an inch). Inherited from LinkBase.
MinMarginsSpecifies the minimum printer margin values. Inherited from LinkBase.
OwnerFor internal use. Inherited from LinkBase.
PageHeaderFooterGets or sets the object used to fill the document’s area that is occupied by the page header and page footer. Inherited from LinkBase.
PaperKindGets or sets the type of paper for the document. Inherited from LinkBase.
PaperNameGets 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.
PrintableObjectTypeGets the type of the object to be printed by the link.
PrintingSystemBaseGets or sets the Printing System used to create and print a document for this link. Inherited from LinkBase.
RightToLeftLayoutSpecifies the orientation of the document’s content. Inherited from LinkBase.
RtfReportFooterGets or sets the RTF text, which will be printed as a Report Footer. Inherited from LinkBase.
RtfReportHeaderGets or sets the RTF text, which will be printed as a Report Header. Inherited from LinkBase.
SiteGets or sets the ISite of the Component. Inherited from Component.
SkipAreaGets or sets report areas that should be skipped. Inherited from LinkBase.
VerticalContentSplittingGets 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

NameDescription
AddSubreport(PrintingSystemBase, DocumentBand, PointF)Adds a subreport to the specified band in the current report. Inherited from LinkBase.
AddSubreport(PointF)
CanHandleCommand(PrintingSystemCommand, IPrintControl)Indicates whether or not the specified Printing System command can be handled. Inherited from LinkBase.
ClearDocument()Removes all pages from the current document. Inherited from LinkBase.
CreateDocument()Creates a report using the current PrintingSystem. Inherited from LinkBase.
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) staticDetermines 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) protectedReturns 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. Inherited from LinkBase.
InitializeLifetimeService()Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ReferenceEquals(Object, Object) staticDetermines 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.
ToString()Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.

Events

NameDescription
AfterCreateAreasOccurs after all sections of the document have been generated. Inherited from LinkBase.
BeforeCreateAreasOccurs before any section of the document is generated. Inherited from LinkBase.
CreateDetailArea
CreateDetailFooterArea
CreateDetailHeaderArea
CreateInnerPageFooterArea
CreateInnerPageHeaderArea
CreateMarginalFooterAreaOccurs when a marginal page footer section of the document is being generated. Inherited from LinkBase.
CreateMarginalHeaderAreaOccurs when a marginal page header section of the document is being generated. Inherited from LinkBase.
CreateReportFooterAreaOccurs when a report footer section of the document is being generated. Inherited from LinkBase.
CreateReportHeaderAreaOccurs when a report header section of the document is being generated. Inherited from LinkBase.
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.

See Also

PrintableComponentLinkBase Class

DevExpress.XtraPrintingLinks Namespace