Skip to main content
BuyLog In
VCL
Search in…
Docs > VCL Controls > ExpressPrinting System > API Reference > dxPSCore > TCustomdxComponentPrinter > 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
TCustomdxComponentPrinter
Members
DefaultOptions
Constructors
Properties
Methods
Events
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

TCustomdxComponentPrinter Members

The base class for the component printer.

Constructors

Name Description
Create(TComponent) Inherited from TComponent.

Properties

Name Description
AbortBuilding Specifies that the building of a report should be cancelled.
AbortPrinting Indicates whether to stop report printing.
AutoUpdateDateTime Specifies whether date and time values in a report are updated automatically.
BeepAfterLongOperations Specifies whether a beep is generated for a long operation.
ComObject Inherited from TComponent.
ComponentCount Inherited from TComponent.
ComponentIndex Inherited from TComponent.
Components Inherited from TComponent.
ComponentState Inherited from TComponent.
ComponentStyle Inherited from TComponent.
CurrentLink Specifies the active report link.
CurrentLinkIndex Specifies the index of a current report link.
DateFormat Specifies date presentation format.
DesignInfo Inherited from TComponent.
Explorer Specifies the component that provides report exploring capabilities for the component printer.
ExplorerRealStubLink
ExplorerStubLink Specifies the report link whose content is displayed within the preview window when none of the explored reports are loaded.
FakeComponentLink1 Inherited from TcxComponent.
FakeComponentLink2 Inherited from TcxComponent.
FakeComponentLink3 Inherited from TcxComponent.
IsDesigning Inherited from TcxComponent.
IsDestroying Inherited from TcxComponent.
IsExplorerMode
IsLoading Inherited from TcxComponent.
LinkCount Returns the number of report links that are created within the current component printer.
LongOperationTime Specifies the threshold time interval (in milliseconds) for operations.
Name Inherited from TComponent.
Observers Inherited from TComponent.
Options Specifies component printer behavior flags.
Owner Inherited from TComponent.
PageNumberFormat Specifies page number formatting in a report.
PixelsPerInch protected Returns the DPI value corresponding to the component’s current scaling factor. Inherited from TcxScalableComponent.
PreviewOptions Provides access to the look & feel settings of the Print Preview dialog.
PreviewWindow Provides access to the Print Preview window embedded into the Print Preview dialog.
PreviewWindowDesigner Provides access to the preview window designer at design time.
PreviewWindowForm Provides access to the Print Preview dialog.
PrintFileList Specifies the list of files to which a report has been printed.
PrintTitle Specifies the name of a print job.
ReportLink Provides indexed access to report links that are created within the current component printer.
ReportLinkDesigner Provides access to the Report link designer window at design time.
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.
State Describes the current state of the component printer.
Tag Inherited from TComponent.
TimeFormat Specifies time formatting options.
VCLComObject Inherited from TComponent.
Version This property is used to restore the previously applied changes made by a developer.

Methods

Name Description
AddComposition
AddEmptyLink(TdxReportLinkClass) Adds a new empty link to the list of links.
AddEmptyLinkEx(TdxReportLinkClass,TComponent) Adds a new link to the list of links.
AddLink(TComponent) Adds a new link to the list of links.
AddLinkEx(TComponent,TComponent) Adds a new link to the list of links.
Assign(TPersistent) Inherited from TPersistent.
AssignReportLinks(TCustomdxComponentPrinter) Copies report links.
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.
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.
CreateLinkFromFile(string)
CreateLinkFromStream(TStream)
CurrentCompositionByLink(TBasedxReportLink) Returns a composition report link according to a specific report link.
DeleteAllLinks Deletes all links.
DeleteLink(Integer) Deletes a specific report link.
DesignerExists(TBasedxReportLink) Identifies if a report link has a registered Report Designer dialog form.
DesignerExistsByComponent(TComponent) Identifies if the Report Designer dialog is available for the specified component’s report link.
DesignReport(TBasedxReportLink) Invokes the Report Designer dialog.
DestroyComponents Inherited from TComponent.
Destroying Inherited from TComponent.
DestroyReport(TBasedxReportLink) Destroys the current report.
DoAddReportLink(TBasedxReportLink) protected Generates the OnAddReportLink event.
DoAfterPreview(TBasedxReportLink) protected Generates the OnAfterPreview event.
DoBeforeDesignReport(TBasedxReportLink) protected Fires the OnBeforeDesignReport event.
DoBeforeExportToPDF(TBasedxReportLink,string,TdxPSPDFReportExportOptions) protected Fires the OnBeforeExportToPDF event.
DoBeforePreview(TBasedxReportLink) protected Generates the OnBeforePreview event.
DoChangeComponent(TBasedxReportLink) protected Generates the OnChangeComponent event.
DoCustomDrawReportTitle(TBasedxReportLink,TCanvas,TRect,TcxTextAlignX,TcxTextAlignY,TColor,TFont,Boolean,Integer) protected Generates the OnCustomDrawReportTitle event.
DoDeleteReportLink(TBasedxReportLink) protected Generates the OnDeleteReportLink event.
DoDesignReport(TBasedxReportLink,Boolean) protected Generates the OnDesignReport event.
DoEndPrint(TBasedxReportLink) protected Generates the OnEndPrint event.
DoEndUpdateReport(TBasedxReportLink) protected Generates the OnEndGenerateReport event.
DoNewPage(TBasedxReportLink,Integer) protected Generates the OnNewPage event.
DoPageSetup(TBasedxReportLink,Boolean) protected Generates the OnPageSetUp event.
DoPrintDeviceBusy protected Generates the OnPrintDeviceBusy event.
DoPrintDeviceError protected Generates the OnPrintDeviceError event.
DoProgress(TBasedxReportLink,Double) protected Generates the OnGenerateReportProgress event.
DoStartPrint(TBasedxReportLink,Integer) protected Generates the OnStartPrint event.
DoStartUpdateReport(TBasedxReportLink) protected Generates the OnStartGenerateReport event.
DrawPageFooter(TBasedxReportLink,Integer,TRect,TdxPageTitleParts,Boolean) Draws a report page footer.
DrawPageHeader(TBasedxReportLink,Integer,TRect,TdxPageTitleParts,Boolean) Draws a report page header.
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.
Explore Invokes the print preview in report explorer mode.
ExportToPDF(TBasedxReportLink)
ExportToPDF(string,Boolean,TdxPSPDFReportExportOptions,TBasedxReportLink) Exports a report generated by a specific report link to a PDF file.
FindComponent(String) Inherited from TComponent.
FindLinkByComponent(TComponent,Boolean) Returns the report link by the assigned component.
FreeNotification(TComponent) Inherited from TComponent.
FreeOnRelease Inherited from TComponent.
GetChildren(TGetChildProc,TComponent) Inherited from TComponent.
GetCompositionsByLink(TBasedxReportLink,TList) Returns a list of composition report links.
GetHashCode Inherited from TObject.
GetItems(TdxCompositionReportLink,TStrings,Boolean) Returns all report links except for composition report links.
GetLinks(TList)
GetNamePath Inherited from TPersistent.
GetNewLinkName(TBasedxReportLink) Returns the name of a new link, namely the TBasedxReportLink object.
GetOwner Inherited from TPersistent.
GetPageColRowCount(Integer,Integer,TBasedxReportLink) Specifies the number of pages taken by the report image horizontally and vertically.
GetPageCount(TBasedxReportLink) Determines the number of pages in a report.
GetParentComponent Inherited from TComponent.
GetPrintTitle(TBasedxReportLink) protected Returns the name of a print job.
HasParent Inherited from TComponent.
IndexOfLink(TBasedxReportLink)
IndexOfLink(string) Returns the zero-based index of a specified report link.
IndexOfLinkByName(string) Returns the index of a link.
InsertComponent(TComponent) Inherited from TComponent.
IsGenerateReportProgressEvent protected Determines the manner in which a report is generated.
IsImplementorOf(IInterface) Inherited from TComponent.
IsLinkInComposition(TBasedxReportLink,TdxCompositionReportLink) Determines whether a specified report link belongs to a certain composition report link.
IsLinkInCurrentComposition(TBasedxReportLink) Determines whether a specified report link belongs to a composition report link.
IsRebuildBeforePreview protected Identifies whether the report is automatically rebuilt prior to displaying the Print Preview dialog.
IsRebuildBeforePrint protected Identifies whether the report is automatically rebuilt prior to printing.
IsShowHourGlass protected Identifies if the Hourglass cursor is shown during time-consuming report operations.
IsSupportedCompClass(TClass)
IsSupportedCompClass(TObject)
LinkByName(string) Returns a report link by its name.
Loaded protected Initializes the component following the application form loading. Inherited from TcxScalableComponent.
LoadFromFile(string) Loads all component printer settings from the specified file.
LoadFromStream(TStream) Reads all component printer settings from a stream and stores the contents within TdxComponentPrinter.
Notification(TComponent,TOperation) Inherited from TComponent.
PageSetup(TBasedxReportLink) Invokes the Page Setup dialog.
PageSetupEx(Integer,Boolean,Boolean,Boolean,Boolean,TBasedxReportLink) Invokes the Page Setup dialog.
PaintPage(TCanvas,Integer,TRect,TRect,TBasedxReportLink) Paints a single page of a report.
PrepareReport(TBasedxReportLink) protected Prepares a report for printing.
Preview(Boolean,TBasedxReportLink) Activates the Print Preview dialog.
PreviewExists Determines whether the Print Preview dialog is displayed.
Print(Boolean,PdxPrintDlgData,TBasedxReportLink) Prints a report on the default printer.
PrintEx(TdxPageNumbers,Integer,Boolean,TBasedxReportLink) Prints report pages.
PrintPage(TBasedxReportLink,Integer) protected Prints a specific report page.
PrintPages(TdxPSPageIndexes,TBasedxReportLink) Prints specified report pages.
PrintPagesEx(TdxPSPageIndexes,TdxPageNumbers,Integer,Boolean,TBasedxReportLink) Prints specified report pages.
RebuildReport(TBasedxReportLink) Rebuilds a report.
ReferenceInterface(IInterface,TOperation) Inherited from TComponent.
RemoveComponent(TComponent) Inherited from TComponent.
RemoveFreeNotification(TComponent) Inherited from TComponent.
SaveToFile(string) Saves all component printer settings to a file.
SaveToStream(TStream) Saves all component printer settings to a stream.
ScaleForPPI(Integer) Scales the component according to the specified DPI value. Inherited from TcxScalableComponent.
SetParentComponent(TComponent) Inherited from TComponent.
SetSubComponent(Boolean) Inherited from TComponent.
ToString Inherited from TObject.
UnprepareReport(TBasedxReportLink) protected
UpdateAction(TBasicAction) Inherited from TComponent.

Events

Name Description
OnAddReportLink Occurs when adding a new report link.
OnAfterPreview protected Occurs after closing the preview form.
OnBeforeDesignReport protected Occurs before the report designer window is activated.
OnBeforeExportToPDF protected Enables you to adjust PDF export settings before a specific link’s report is exported to a PDF file or optionally cancel the export.
OnBeforePreview protected Occurs before the preview window is to be activated.
OnChangeComponent protected Occurs when the Component property changes.
OnChangeCurrentLink protected Occurs when changing a report link.
OnCustomDrawPage Occurs when drawing individual report pages.
OnCustomDrawPageFooter protected Occurs when drawing a page footer.
OnCustomDrawPageHeader protected Occurs when drawing a page header.
OnCustomDrawReportTitle protected Occurs when drawing the report title.
OnDeleteReportLink Occurs when a report link is to be deleted.
OnDesignReport protected Occurs when the report link designer is closed.
OnEndGenerateReport Occurs when a report has just been built.
OnEndPrint Occurs after printing a report.
OnFinalizePrintDlgData Enables you to respond to end-user choices made within a printer dialog after it’s been closed.
OnGenerateReportProgress Occurs during report building.
OnGetPrintTitle Occurs when a printing component starts printing.
OnInitializePrintDlgData Enables you to customize the Print dialog‘s appearance and specify event handlers notifying about dialog visibility changes and end-user actions performed within this dialog.
OnMeasureReportTitle protected Occurs when drawing the report title before the OnCustomDrawReportTitle event.
OnNewPage Occurs before sending a regular page of a multi-page document to printer.
OnPageSetup Occurs when closing the Page Setup dialog window.
OnPrintDeviceBusy Occurs when the printing device is busy.
OnPrintDeviceError Occurs when the printing device is not available (for example, disconnected).
OnStartGenerateReport Occurs when the printing component is about to build a report.
OnStartPrint Occurs before the printing component prints the report.

Constants

Name Description
DefaultOptions Specifies the default setting flags for the component printer.
See Also