Back to Devexpress

LinkBase Members

corelibraries-devexpress-dot-xtraprinting-dot-linkbase-dot-underscore-members.md

latest24.3 KB
Original Source

LinkBase Members

The base class for all printing links.

Constructors

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

Properties

NameDescription
ActivityGets the current document creation status.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
ContainerGets the IContainer that contains the Component. Inherited from Component.
CustomPaperSizeGets or sets the paper size (measured in hundredths of an inch).
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.
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.
MarginsGets or sets the margins of a report page (measured in hundredths of an inch).
MinMarginsSpecifies the minimum printer margin values.
OwnerFor internal use.
PageHeaderFooterGets or sets the object used to fill the document’s area that is occupied by the page header and page footer.
PaperKindGets or sets the type of paper for the document.
PaperNameGets or sets the name of the custom paper which is used in the printer that the document is going to be printed on.
PrintableObjectTypeGets the type of the object to be printed.
PrintingSystemBaseGets or sets the Printing System used to create and print a document for this link.
RightToLeftLayoutSpecifies the orientation of the document’s content.
RtfReportFooterGets or sets the RTF text, which will be printed as a Report Footer.
RtfReportHeaderGets or sets the RTF text, which will be printed as a Report Header.
SiteGets or sets the ISite of the Component. Inherited from Component.
SkipAreaGets or sets report areas that should be skipped.
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.

Methods

NameDescription
AddSubreport(PrintingSystemBase, DocumentBand, PointF)Adds a subreport to the specified band in the current report.
AddSubreport(PointF)Adds a subreport to the current report.
CanHandleCommand(PrintingSystemCommand, IPrintControl)Indicates whether or not the specified Printing System command can be handled.
ClearDocument()Removes all pages from the current document.
CreateDocument()Creates a report using the current PrintingSystem.
CreateDocument(PrintingSystemBase)Creates a document from the link using the specified Printing System.
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.
ExportToCsv(Stream)Exports a document to the specified stream in CSV format.
ExportToCsv(String, CsvExportOptions)Exports a document to the specified file path in CSV format using the defined CSV-specific options.
ExportToCsv(String)Exports a document to the specified file path in CSV format.
ExportToDocx(Stream, DocxExportOptions)Exports a document to the specified stream in DOCX format using the defined DOCX-specific options.
ExportToDocx(Stream)Exports a document to the specified stream in DOCX format.
ExportToDocx(String, DocxExportOptions)Exports a document to the specified file path in DOCX format using the specified DOCX-specific options.
ExportToDocx(String)Exports a document to the specified file path in DOCX format.
ExportToHtml(Stream, HtmlExportOptions)Exports a document to the specified stream in HTML format using the defined HTML-specific options.
ExportToHtml(Stream)Exports a document to the specified stream in HTML format.
ExportToHtml(String, HtmlExportOptions)Exports a document to the specified file path in HTML format using the defined HTML-specific options.
ExportToHtml(String)Exports a document to the specified file path in HTML format.
ExportToImage(Stream, ImageExportOptions)Exports a document to the specified stream in Image format using the defined Image-specific options.
ExportToImage(Stream)Exports a document to the specified stream in Image format.
ExportToImage(String, ImageExportOptions)Exports a document to the specified file path in Image format using the defined Image-specific options.
ExportToImage(String)Exports a document to the specified file path in Image format.
ExportToMht(Stream, MhtExportOptions)Exports a document to the specified stream in MHT format using the defined MHT-specific options.
ExportToMht(Stream)Exports a document to the specified stream in MHT format.
ExportToMht(String, MhtExportOptions)Exports a document to the specified file path in MHT format using the defined MHT-specific options.
ExportToMht(String)Exports a document to the specified file path in MHT format.
ExportToPdf(Stream, PdfExportOptions)Exports a document to the specified stream in PDF format using the defined PDF-specific options.
ExportToPdf(Stream)Exports a document to the specified stream in PDF format.
ExportToPdf(String, PdfExportOptions)Exports a document to the specified file path in PDF format using the defined PDF-specific options.
ExportToPdf(String)Exports a document to the specified file path in PDF format.
ExportToRtf(Stream, RtfExportOptions)Exports a document to the specified stream in RTF format using the defined RTF-specific options.
ExportToRtf(Stream)Exports a document to the specified stream in RTF format.
ExportToRtf(String, RtfExportOptions)Exports a document to the specified file path in RTF format using the defined RTF-specific options.
ExportToRtf(String)Exports a document to the specified file path in RTF format.
ExportToText(Stream, TextExportOptions)Exports a document to the specified stream in Text format using the defined Text-specific options.
ExportToText(Stream)Exports a document to the specified stream in Text format.
ExportToText(String, TextExportOptions)Exports a document to the specified file path in Text format using the defined Text-specific options.
ExportToText(String)Exports a document to the specified file path in Text format.
ExportToXls(Stream, XlsExportOptions)Exports a report to the specified stream in XLS format using the defined XLS-specific options.
ExportToXls(Stream)Exports a report to the specified stream in XLS format.
ExportToXls(String, XlsExportOptions)Exports a report to the specified file path in XLS format using the defined XLS-specific options.
ExportToXls(String)Exports a report to the specified file path in XLS format.
ExportToXlsx(Stream, XlsxExportOptions)Exports a report to the specified stream in XLSX format using the defined XLSX-specific options.
ExportToXlsx(Stream)Exports a report to the specified stream in XLSX format.
ExportToXlsx(String, XlsxExportOptions)Exports a report to the specified file path in XLSX format using the defined XLSX-specific options.
ExportToXlsx(String)Exports a report to the specified file path in XLSX format.
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.
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.
RestorePageHeaderFooterFromXml(String)Loads a Page Header/Footer dialog’s settings from the specified XML file.
SavePageHeaderFooterToStream(Stream)Saves the Page Header/Footer dialog’s settings to the specified stream.
SavePageHeaderFooterToXml(String)Saves the Page Header/Footer dialog’s settings to an XML file.
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.
BeforeCreateAreasOccurs before any section of the document is generated.
CreateDetailAreaOccurs when a detail section of the document is being generated.
CreateDetailFooterAreaOccurs when a detail footer section of the document is being generated.
CreateDetailHeaderAreaOccurs when a detail header section of the document is being generated.
CreateInnerPageFooterAreaOccurs when an inner page footer section of the document is being generated.
CreateInnerPageHeaderAreaOccurs when an inner page header section of the document is being generated.
CreateMarginalFooterAreaOccurs when a marginal page footer section of the document is being generated.
CreateMarginalHeaderAreaOccurs when a marginal page header section of the document is being generated.
CreateReportFooterAreaOccurs when a report footer section of the document is being generated.
CreateReportHeaderAreaOccurs when a report header section of the document is being generated.
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.

See Also

LinkBase Class

DevExpress.XtraPrinting Namespace