Skip to main content
BuyLog In
VCL
Search in…
Docs > VCL Controls > ExpressPrinting System > API Reference > dxPSCore > TBasedxReportLink > Members
All docs
V24.1
VCL Controls
Express Cross Platform Library
ExpressQuantumGrid Suite
ExpressEditors Library
ExpressBars Suite
ExpressCharts Suite
ExpressRichEditControl Suite
ExpressSkins Library
ExpressScheduler Suite
ExpressSpreadSheet Suite
ExpressQuantumTreeList Suite
ExpressPDFViewer Suite
ExpressPrinting System
Installation Notes
TeeChart Notes
Quick Start
Concepts
How To...
Examples
API Reference
dxBase
dxBkGnd
dxPSBaseGridLnk
dxPSChLbxLnk
dxPSContainerLnk
dxPSCore
EdxComponentPrinter
EdxInvalidStorageVersion
EdxPSExplorer
EdxPrintEngine
EdxReportLink
FReduceMemoryUse
FSmoothlyStretchImages
IdxComponentPrinterListener
IdxPSExplorerContextCommandBuilder
IdxPSExplorerContextCommands
IdxPSExplorerContextCommands2
IdxPSExplorerTreeContainerHost
IdxPSNativeWin32ControlHandleSupport
IdxReportLinkController
TAbstractdxPreviewWindowDesigner
TAbstractdxReportCellData
TAbstractdxReportLinkDesignWindow
TAbstractdxReportLinkDesigner
TBasedxReportLink
Members
Constructors
Properties
Methods
Events
TCustomdxComponentPrinter
TCustomdxPSExplorer
TCustomdxPSExplorerContextCommand
TCustomdxPSExplorerItem
TCustomdxPSExplorerItemPropertySheets
TCustomdxPSExplorerItemPropertySheetsClass
TCustomdxPSExplorerTreeContainer
TCustomdxReportCellImageContainer
TdxAssignedFormatValue
TdxAssignedFormatValues
TdxBasePreviewOptions
TdxBeforeDesignReportEvent
TdxCPCustomizeDlgOption
TdxCPCustomizeDlgOptions
TdxCPOption
TdxCPOptions
TdxCPState
TdxCPStates
TdxCellEdgeMode
TdxCellEdgeStyle
TdxCellImageActualBuffering
TdxCellImageBuffering
TdxCellSide
TdxCellSides
TdxCellSortOrder
TdxCheckButtonEdgeStyle
TdxComponentPrinter
TdxComponentPrinterThumbnailsOptions
TdxCompositionLinkItem
TdxCompositionLinkItems
TdxCompositionOption
TdxCompositionOptions
TdxCompositionReportLink
TdxCompositionReportLinkEvent
TdxCompositionState
TdxCompositionStates
TdxContinuedIndexPair
TdxCustomDrawPageEvent
TdxCustomDrawPageHFEvent
TdxCustomDrawReportLinkHFEvent
TdxCustomDrawReportLinkTitleEvent
TdxCustomDrawReportTitleEvent
TdxDesignReportEvent
TdxEnumPagesAsImagesProc
TdxExportGetPageFileNameEvent
TdxExportPrepareGraphicEvent
TdxExportProgressEvent
TdxFilterStyleEvent
TdxGenerateReportProgressEvent
TdxGetPrintTitleEvent
TdxGraphicDrawMode
TdxImageLayout
TdxMeasureReportLinkTitleEvent
TdxMeasureReportTitleEvent
TdxNewPageEvent
TdxOnFilterComponentEvent
TdxOnGetSupportedComponentsEvent
TdxPSBackgroundBitmapPool
TdxPSCellBorderClass
TdxPSCellBorderPainter
TdxPSCellBorderPainterClass
TdxPSCellBorderSalientType
TdxPSCompositionReportRenderRowInfo
TdxPSCustomCellBorder
TdxPSCustomPreviewWindow
TdxPSDataReader
TdxPSDataStorageInfo
TdxPSDataStorageOffsetTable
TdxPSDataWriter
TdxPSExplorerChangeNotifier
TdxPSExplorerFolder
TdxPSExplorerItem
TdxPSExplorerItemDataLoadErrorEvent
TdxPSExplorerState
TdxPSExplorerStates
TdxPSGetNewReportStorageNameEvent
TdxPSPDFReportExportOptions
TdxPSPageRenderInfo
TdxPSPreviewDialogManager
TdxPSPreviewDialogStyleInfo
TdxPSPreviewDialogStyleInfoClass
TdxPSPreviewState
TdxPSPrintPageRangeInfo
TdxPSPrintStyle
TdxPSRenderStage
TdxPSRenderStages
TdxPSReportCompositionDocument
TdxPSReportDocument
TdxPSReportGroupLookAndFeel
TdxPSReportGroupLookAndFeelClass
TdxPSReportGroupLookAndFeelPainter
TdxPSReportGroupLookAndFeelPainterClass
TdxPSReportRenderInfo
TdxPSReportRenderer
TdxPSStreamMode
TdxPSThumbnailsSize
TdxPSTreeLineMode
TdxPSTreeLineStyle
TdxPageOverlayIndexes
TdxPageSetupEvent
TdxPreviewEnableOption
TdxPreviewEnableOptions
TdxPreviewEvent
TdxPreviewOptions
TdxPreviewVisibleOption
TdxPreviewVisibleOptions
TdxPreviewWindowOptions
TdxPreviewWindowThumbnailsOptions
TdxPrintDeviceProblemEvent
TdxPrintDlgDataEvent
TdxReportCell
TdxReportCellDataClass
TdxReportCellExpandButton
TdxReportCellExpandButtonAlignHorz
TdxReportCellExpandButtonAlignVert
TdxReportCellGraphic
TdxReportCellImage
TdxReportCellImageContainer
TdxReportCellString
TdxReportCellText
TdxReportCells
TdxReportFootnoteMode
TdxReportFootnotes
TdxReportGroup
TdxReportItem
TdxReportItemClass
TdxReportLinkBeforeExportToPDFEvent
TdxReportLinkCapabilities
TdxReportLinkCapability
TdxReportLinkClass
TdxReportLinkDataSource
TdxReportLinkDesignWindowState
TdxReportLinkDesignWindowStates
TdxReportLinkNotifyEvent
TdxReportLinkPrinterPage
TdxReportNote
TdxReportTitle
TdxReportTitleMode
TdxReportVisualItem
TdxStartPrintEvent
TdxWindowScalePair
dxDefaultPreviewEnableOptions
dxDefaultPreviewVisibleOptions
dxPSPreviewDialogManager
dxPrintComponent(TComponent,Boolean,Boolean,string,string)
dxPSDBBasedXplorer
dxPSDBTCLnk
dxPSEngn
dxPSFileBasedXplorer
dxPSFillPatterns
dxPSForm
dxPSGlbl
dxPSGrLnks
dxPSGraphicLnk
dxPSImgLnk
dxPSLbxLnk
dxPSPDFExport
dxPSPDFExportCore
dxPSPrVw
dxPSRELnk
dxPSReportLinkDesignWindow
dxPSReportRenderCanvas
dxPSRichEditControlLnk
dxPSRichEditControlLnk.Bricks
dxPSSngltn
dxPSStdGrLnk
dxPSTCLnk
dxPSTVLnk
dxPSTextLnk
dxPSTrueTypeFont
dxPScxCommon
dxPScxDBEditorLnks
dxPScxEditorLnks
dxPScxGridLnk
dxPScxMCListBoxLnk
dxPScxSchedulerLnk
dxPScxTLLnk
dxPScxVGridLnk
dxPSdxChartControlLnk
dxPSdxDBOCLnk
dxPSdxDBTVLnk
dxPSdxFCLnk
dxPSdxLCLnk
dxPSdxOCLnk
dxPSdxPDFViewerLnk
dxPSdxSpreadSheetDocumentBasedLnk
dxPSdxSpreadSheetLnk
dxPSdxSpreadSheetLnkCore
dxPSrxRELnk
dxPgsDlg
dxPreVw
dxPrnDev
dxPrnDlg
dxPrnPg
dxWrap
ExpressLayoutControl Suite
ExpressNavBar Suite
ExpressPivotGrid Suite
ExpressVerticalGrid Suite
ExpressDocking Library
ExpressMemData
ExpressDataController
ExpressSpellChecker Suite
ExpressMapControl Suite
ExpressGanttControl Suite
ExpressGaugeControl Suite
ExpressTileControl Suite
ExpressFlowChart Suite
ExpressFlowChart Editor
ExpressOrgChart Suite
ExpressPageControl Suite
ExpressWizardControl Suite

TBasedxReportLink Members

The base class for all classes that implement report links for DevExpress VCL controls.

Constructors

Name Description
Create(TComponent) Inherited from TComponent.

Properties

Name Description
AbortBuilding Specifies that the building of a report should be cancelled.
Active Creates a report.
AssignedFormatValues Indicates which formats have been assigned to a report link.
BuiltIn Determines whether the current link item is created at design- or runtime.
Capabilities
Caption Defines a text string that identifies a link for a user.
Color protected Specifies the background color of report cells.
ComObject Inherited from TComponent.
Component Specifies the target component to print.
ComponentCount Inherited from TComponent.
ComponentIndex Inherited from TComponent.
ComponentPrinter Specifies the component printer to which the report link belongs.
Components Inherited from TComponent.
ComponentState Inherited from TComponent.
ComponentStyle Inherited from TComponent.
ContinuousPageIndexes protected
Controller
CurrentPage Specifies the current report page.
CurrentPrintStyle Determines the current print style.
Data Specifies additional arbitrary data.
DataSource Specifies if the report link’s report is loaded from an external storage (file, stream, or explorer item) or built using the data displayed by a linked component.
DateFormat Specifies date representation format.
DateTime Determines date and time of a specific report link.
Description Describes a report link.
DesignerCaption Specifies the Report Designer dialog’s caption.
DesignerHelpContext Provides the designer context number for use when calling context-sensitive online Help.
DesignInfo Inherited from TComponent.
DesignWindow
FakeComponentLink1 Inherited from TcxComponent.
FakeComponentLink2 Inherited from TcxComponent.
FakeComponentLink3 Inherited from TcxComponent.
Font protected Specifies report font.
FootersOnEveryPage protected Specifies whether footers are printed on every page of a report.
HasDesignWindow Indicates whether the current report link has a designer associated with it.
HasPreviewWindow
HeadersOnEveryPage protected Specifies whether headers are printed on every page of a report.
Index Determines the index of a link.
IsAggregated
IsCurrentLink Determines if the report link is active (also called current).
IsDesigning Inherited from TcxComponent.
IsDestroying Inherited from TcxComponent.
IsLoading Inherited from TcxComponent.
Name Inherited from TComponent.
Observers Inherited from TComponent.
Owner Inherited from TComponent.
PageCount Returns the number of report pages.
PageHeight protected Returns the absolute height (in pixels) of a printed page.
PageNumberFormat Specifies page number format in a report.
PageWidth protected Returns the absolute width (in pixels) of a printed page.
PDFExportOptions Provides access to settings that define how the report link exports its content to a PDF file.
PixelsPerInch protected Returns the DPI value corresponding to the component’s current scaling factor. Inherited from TcxScalableComponent.
PreviewWindow
PrinterPage Determines report page properties.
RealPrinterPage Provides access to settings of a printout page layout.
RealScaleFactor Returns the scale factor used to preview a report page.
RebuildNeeded Identifies if the built report is up to date.
Renderer Provides access to the report painter.
RenderStage
ReportCells
ReportDocument Provides access to the report document settings.
ReportFootnotes
ReportHeight Determines the height of a report.
ReportTitle Determines report title properties.
ReportTitleMode Specifies the manner in which a report title is displayed.
ReportTitleText Determines a report’s title.
ReportWidth Determines the width of a report.
Scalable protected Specifies if the component’s content should be scaled. Inherited from TcxScalableComponent.
ScaleFactor protected Returns the component’s scale factor. Inherited from TcxScalableComponent.
ScaleFonts protected Specifies whether to rescale report fonts.
ShowDesigner Displays the Report Designer window.
ShowPageFooter Determines whether to add page footer to the report.
ShowPageHeader Determines whether to add a page header to a report.
ShowPageRowHeader
ShrinkToPageWidth Specifies if the report’s content shrinks to fit into a single paper sheet horizontally.
StartPageIndex Determines the index of the first report page.
StorageName Specifies the full path to the file from which the report is loaded.
StyleManager Determines the style manager for a report link.
Tag Inherited from TComponent.
TimeFormat Specifies the manner in which time information is formatted within a report.
Transparent protected Determines whether cells are filled with the default color.
UseHorzDelimiters protected Specifies whether to prevent a row from breaking across multiple pages.
UseVertDelimiters protected Specifies whether to prevent a column from breaking across multiple pages.
VCLComObject Inherited from TComponent.

Methods

Name Description
AddBackgroundBitmapToPool(TGraphic)
AddFontToPool(string,TColor,TFontPitch,TFontStyles,Integer)
AddFontToPool(TFont)
Aggregable
Assign(TPersistent) Inherited from TPersistent.
AssignTo(TPersistent) Inherited from TPersistent.
BeginInvoke(TAsyncConstArrayFunctionEvent,Untyped[],TObject) Inherited from TComponent.
BeginInvoke(TAsyncConstArrayProc,Untyped[],TObject) Inherited from TComponent.
BeginInvoke(TAsyncConstArrayProcedureEvent,Untyped[],TObject) Inherited from TComponent.
BeginInvoke(TAsyncFunctionEvent,TObject) Inherited from TComponent.
BeginInvoke(TAsyncProcedureEvent,TObject) Inherited from TComponent.
BeginInvoke(TProc,TObject) Inherited from TComponent.
BeginInvoke<TResult>(TAsyncConstArrayFunc<TResult>,Untyped[],TObject) Inherited from TComponent.
BeginInvoke<TResult>(TFunc<TResult>,TObject) Inherited from TComponent.
BuildPageSetupMenu(TComponent,Pointer,Boolean) Builds a page setup menu in an application.
CanBeUsedAsStub
CanChangeFootnotes
CanChangeTitle
CanExportToPDF
CanLoadData
CanSaveData
CanUnloadData
ChangeScale(Integer,Integer) protected Scales the component and the associated controls and/or UI elements using the specified numerator and denominator values. Inherited from TcxScalableComponent.
CheckToDesign Checks whether to display the Report Design window.
ConstructReport(TdxReportCells) protected Builds a report.
CreateGroupLookAndFeel(TdxPSReportGroupLookAndFeelClass,Boolean)
DataProviderPresent Determines whether a report link is associated with any TComponent.
DefaultDateFormat Returns the default date format.
DefaultDesignerCaption
DefaultFont
DefaultPageNumberFormat Returns the default page number format in a report.
DefaultTimeFormat Returns the default time format.
DefinePrintStylesDlg Displays the Define Print Styles dialog window.
DesignerExists(TComponentClass) Determines whether a specific component class includes a designer.
DesignReport Displays the Report Designer window.
DestroyComponents Inherited from TComponent.
Destroying Inherited from TComponent.
DestroyReport Destroys the report link’s report.
DoChangeComponent protected Generates the OnChangeComponent event.
DoProgress(Double) protected Tracks the progress of report creation.
DrawCheckBox(TCanvas,TRect,Boolean,Boolean,Boolean,TdxCheckButtonEdgeStyle,TColor) Draws a check box item in a report.
DrawCheckBox(TCanvas,TRect,Boolean,Boolean,Boolean,Boolean)
drawEdge(TCanvas,TRect,TdxCellEdgeMode,TdxCellEdgeStyle,TdxCellEdgeStyle,TdxCellSides,Boolean) Draws an edge object in a report.
DrawEllipse(TCanvas,TRect,TColor,TColor,TdxPSFillPatternClass,TColor,Integer)
DrawExpandButton(TCanvas,TRect,Boolean,Boolean,Boolean,Boolean,Boolean,Boolean,TColor,TColor)
DrawGlyph(HDC,TRect,Byte)
DrawGraphic(TCanvas,TRect,TRect,TCustomImageList,Integer,TGraphic,Boolean,Boolean,TColor) Draws a graphic object in a report.
DrawGraphicEx(TCanvas,TRect,TRect,TCustomImageList,Integer,TGraphic,Boolean,Boolean,TColor,TColor,TdxPSFillPatternClass,TdxCellImageActualBuffering)
DrawPageFooter(Integer,TRect,TdxPageTitleParts,Boolean) Draws a page footer in a report.
DrawPageHeader(Integer,TRect,TdxPageTitleParts,Boolean) Draws a page header in a report.
DrawRectangle(TCanvas,TRect,TColor,TColor,TdxPSFillPatternClass,TColor,Integer)
DrawRoundRect(TCanvas,TRect,Integer,Integer,TColor,TColor,TdxPSFillPatternClass,TColor,Integer)
DrawSortMark(TCanvas,TRect,TdxCellSortOrder,Boolean) Draws a sorting mark (arrow) in a report.
drawText(TCanvas,TRect,Integer,string,TFont,TColor,TcxTextAlignX,TcxTextAlignY,Boolean,Boolean,Boolean) Draws text in a report.
drawTextEx(TCanvas,TRect,Integer,Integer,Integer,string,TFont,TColor,TcxTextAlignX,TcxTextAlignY,Boolean,Boolean,Boolean,Boolean,Boolean)
EndFunctionInvoke(IAsyncResult) Inherited from TComponent.
EndInvoke(IAsyncResult) Inherited from TComponent.
EndInvoke<TResult>(IAsyncResult) Inherited from TComponent.
Equals(TObject) Inherited from TObject.
ExecuteAction(TBasicAction) Inherited from TComponent.
ExportToPDF
ExportToPDF(string,Boolean,TdxPSPDFReportExportOptions) Exports a report to a PDF file.
ExtractComponentClass(TStream,Boolean)
ExtractComponentClassName(TStream,Boolean)
ExtractLinkClass(TStream,Boolean)
ExtractOffsetTable(TStream,Boolean)
ExtractReportDocument(TStream,Boolean)
ExtractStorageInfo(TStream,Boolean)
ExtractStorageVersion(TStream,Boolean)
FillEllipse(TCanvas,TRect,TColor)
FillEllipseEx(TCanvas,TRect,TColor,TColor,TdxPSFillPatternClass)
FillRectEx(TCanvas,TRect,TColor,TColor,TdxPSFillPatternClass)
FillRgnEx(TCanvas,TcxRegionHandle,TColor,TColor,TdxPSFillPatternClass)
FillRoundRect(TCanvas,TRect,Integer,Integer,TColor)
FillRoundRectEx(TCanvas,TRect,Integer,Integer,TColor,TColor,TdxPSFillPatternClass)
FinalizeStorageInfo(TdxPSDataStorageInfo)
FindComponent(String) Inherited from TComponent.
FindGroupLookAndFeelByClass(TdxPSReportGroupLookAndFeelClass)
FrameEllipse(TCanvas,TRect,TColor,Integer)
frameRect(TCanvas,TRect,TColor,TdxCellSides,Integer)
FrameRoundRect(TCanvas,TRect,Integer,Integer,TColor,Integer)
FreeNotification(TComponent) Inherited from TComponent.
FreeOnRelease Inherited from TComponent.
GetChildren(TGetChildProc,TComponent) Inherited from TComponent.
GetControlPainter
GetControlScaleFactor
GetFilteredStyles(TStrings) Retrieves a list of print styles that can be applied to a report.
GetHashCode Inherited from TObject.
GetNamePath Inherited from TPersistent.
GetNewReportStorageName
GetOwner Inherited from TPersistent.
GetPageColRowCount(Integer,Integer) Determines the number of pages used by a report image, both horizontally and vertically.
GetParentComponent Inherited from TComponent.
GetSupportedComponentList(TdxClassList) Returns a list of all classes supported by the link.
HasParent Inherited from TComponent.
IndexOfReportGroupLookAndFeel(TdxPSReportGroupLookAndFeel)
Initialize
InsertComponent(TComponent) Inherited from TComponent.
InternalRestoreDefaults protected Restores default settings for a report.
InternalRestoreFromOriginal protected Restores original component settings for a report.
IsApplyBackgroundToEntirePage protected
IsEmptyPage(Integer) Determines whether a specified report page is empty.
IsEmptyReport Ascertain whether a report is empty.
IsImplementorOf(IInterface) Inherited from TComponent.
IsSupportedCompClass(TClass) Determines whether a specific component class is supported by a given report link.
LinkClass Returns the class-reference to the report link’s actual type.
LinkModified(Boolean) protected Determines whether a link was modified.
LoadDataFromFile(string) Loads a report from a specified file into the Print Preview window.
LoadDataFromStream(TStream) Loads a report from a specified stream into the Print Preview window.
Loaded protected Initializes the component following the application form loading. Inherited from TcxScalableComponent.
LoadFromIniFile(TCustomIniFile,string)
LoadFromIniFile(string) Loads the report link’s format settings and start page from an INI file.
LoadFromRegistry(string) Loads the report link’s format settings and start page from the registry.
MakeDelimiters(TdxReportCells,TList,TList) protected Creates delimiters for report pages.
MakeHardDelimiters(TdxReportCells,TList,TList) protected Creates report page breaks.
Notification(TComponent,TOperation) Inherited from TComponent.
PageReady(Integer) protected Indicates whether report pages have been generated.
PageSetup Invokes the Page Setup dialog.
PageSetupEx(Integer,Boolean,Boolean,Boolean,Boolean) Invokes the Page Setup dialog.
PossibleDataStorage(TStream,Boolean)
PossibleDataStorage(string,Boolean)
Preview(Boolean) Invokes the Print Preview dialog.
PreviewExists Identifies if the Print Preview dialog is displayed.
Print(Boolean,PdxPrintDlgData) Prints the report link’s report on the default printer.
Print(Boolean)
PrintEx(TdxPageNumbers,Integer,Boolean) Prints report pages.
PrintPages(TdxPSPageIndexes) Prints the specified report pages.
PrintPagesEx(TdxPSPageIndexes,TdxPageNumbers,Integer,Boolean) Prints the specified report pages.
RebuildReport Rebuilds the report.
ReferenceInterface(IInterface,TOperation) Inherited from TComponent.
RemoveComponent(TComponent) Inherited from TComponent.
RemoveFreeNotification(TComponent) Inherited from TComponent.
RestoreDefaults Restores predefined values for report link properties.
RestoreFromOriginal Restores original component values for report link properties.
SaveDataToFile(string) Saves the built report to the specified file.
SaveDataToStream(TStream) Saves the built report to the specified stream.
SaveToIniFile(TCustomIniFile,string)
SaveToIniFile(string) Saves the report link’s format settings and start page to an INI file.
SaveToRegistry(string) Saves the report link’s format settings and start page to the registry.
ScaleForPPI(Integer) Scales the component according to the specified DPI value. Inherited from TcxScalableComponent.
Serializable
SetActive(Boolean) protected Initiates report generation.
SetComponentUnconditionally(TComponent)
SetParentComponent(TComponent) Inherited from TComponent.
SetSubComponent(Boolean) Inherited from TComponent.
ShowDateTimeFormatsDlg Displays the Change Date and Time Formats dialog window.
ShowFootnotesPropertiesDlg Opens the Report Footnotes dialog.
ShowPageNumberFormatsDlg Displays the Change Page Numbering Format dialog window.
ShowTitlePropertiesDlg Displays the Report Title dialog window.
Supports(TClass)
Supports(TObject)
SupportsScaling
ToString Inherited from TObject.
UpdateAction(TBasicAction) Inherited from TComponent.

Events

Name Description
OnChangeComponent Occurs when the Component property changes.
OnCustomDrawPageFooter Enables you to custom paint page footers for the report link.
OnCustomDrawPageHeader Enables you to custom paint page headers for the report link.
OnCustomDrawReportLinkFootnotes Enables you to custom paint footnotes.
OnCustomDrawReportLinkTitle Occurs when drawing the report title.
OnDataSourceChanged Enables you to respond to an impending change in the report link’s report source.
OnDestroy Occurs when a report link is being destroyed.
OnFilterStyle Occurs when retrieving the list of available print styles.
OnGetNewReportStorageName Enables you to customize the report storage’s default name.
OnMeasureReportLinkFootnotes Enables you to customize a footnote’s height.
OnMeasureReportLinkTitle Occurs when drawing the report title before the OnCustomDrawReportLinkTitle event.
See Also