Back to Devexpress

TdxComponentPrinter Members

vcl-dxpscore-dot-tdxcomponentprinter-dot-underscore-members.md

latest49.3 KB
Original Source

TdxComponentPrinter Members

A component printer.

Constructors

NameDescription
Create(TComponent)Inherited from TComponent.

Properties

NameDescription
AbortBuildingSpecifies that the building of a report should be cancelled. Inherited from TCustomdxComponentPrinter.
AbortPrintingIndicates whether to stop report printing. Inherited from TCustomdxComponentPrinter.
AutoUpdateDateTimeSpecifies whether date and time values in a report are updated automatically. Inherited from TCustomdxComponentPrinter.
BeepAfterLongOperationsSpecifies whether a beep is generated for a long operation. Inherited from TCustomdxComponentPrinter.
ComObjectInherited from TComponent.
ComponentCountInherited from TComponent.
ComponentIndexInherited from TComponent.
ComponentsInherited from TComponent.
ComponentStateInherited from TComponent.
ComponentStyleInherited from TComponent.
CurrentLinkSpecifies the active report link. Inherited from TCustomdxComponentPrinter.
CurrentLinkIndexSpecifies the index of a current report link. Inherited from TCustomdxComponentPrinter.
CustomizeDlgOptionsSpecifies which options of the Edit Reports dialog window are enabled.
DateFormatSpecifies date presentation format. Inherited from TCustomdxComponentPrinter.
DesignInfoInherited from TComponent.
ExplorerSpecifies the component that provides report exploring capabilities for the component printer. Inherited from TCustomdxComponentPrinter.
ExplorerRealStubLinkInherited from TCustomdxComponentPrinter.
ExplorerStubLinkSpecifies the report link whose content is displayed within the preview window when none of the explored reports are loaded. Inherited from TCustomdxComponentPrinter.
FakeComponentLink1Inherited from TcxComponent.
FakeComponentLink2Inherited from TcxComponent.
FakeComponentLink3Inherited from TcxComponent.
IsDesigningInherited from TcxComponent.
IsDestroyingInherited from TcxComponent.
IsExplorerModeInherited from TCustomdxComponentPrinter.
IsLoadingInherited from TcxComponent.
LinkCountReturns the number of report links that are created within the current component printer. Inherited from TCustomdxComponentPrinter.
LongOperationTimeSpecifies the threshold time interval (in milliseconds) for operations. Inherited from TCustomdxComponentPrinter.
NameInherited from TComponent.
ObserversInherited from TComponent.
OptionsSpecifies component printer behavior flags.
OverWriteExistingFilesSpecifies whether to overwrite files when saving new files to disk.
OwnerInherited from TComponent.
PageNumberFormatSpecifies page number formatting in a report. Inherited from TCustomdxComponentPrinter.
PixelsPerInch protectedReturns the DPI value corresponding to the component’s current scaling factor. Inherited from TcxScalableComponent.
PreviewOptionsProvides access to the look & feel settings of the Print Preview dialog. Inherited from TCustomdxComponentPrinter.
PreviewWindowProvides access to the Print Preview window embedded into the Print Preview dialog. Inherited from TCustomdxComponentPrinter.
PreviewWindowDesignerProvides access to the preview window designer at design time. Inherited from TCustomdxComponentPrinter.
PreviewWindowFormProvides access to the Print Preview dialog. Inherited from TCustomdxComponentPrinter.
PrintFileListSpecifies the list of files to which a report has been printed. Inherited from TCustomdxComponentPrinter.
PrintTitleSpecifies the name of a print job. Inherited from TCustomdxComponentPrinter.
ReportLinkProvides indexed access to report links that are created within the current component printer. Inherited from TCustomdxComponentPrinter.
ReportLinkDesignerProvides access to the Report link designer window at design time. Inherited from TCustomdxComponentPrinter.
Scalable protectedSpecifies if the component’s content should be scaled. Inherited from TcxScalableComponent.
ScaleFactor protectedReturns the component’s scale factor. Inherited from TcxScalableComponent.
StateDescribes the current state of the component printer. Inherited from TCustomdxComponentPrinter.
TagInherited from TComponent.
TimeFormatSpecifies time formatting options. Inherited from TCustomdxComponentPrinter.
VCLComObjectInherited from TComponent.
VersionThis property is used to restore the previously applied changes made by a developer. Inherited from TCustomdxComponentPrinter.

Methods

NameDescription
AddCompositionInherited from TCustomdxComponentPrinter.
AddEmptyLink(TdxReportLinkClass)Adds a new empty link to the list of links. Inherited from TCustomdxComponentPrinter.
AddEmptyLinkEx(TdxReportLinkClass,TComponent)Creates a new report link and adds it to the collection. Inherited from TCustomdxComponentPrinter.
AddLink(TComponent)Creates a new print link for the specified component and adds the created link to the collection. Inherited from TCustomdxComponentPrinter.
AddLinkEx(TComponent,TComponent)Creates a new print link for the specified component and adds the created link to the collection. Inherited from TCustomdxComponentPrinter.
Assign(TPersistent)Inherited from TPersistent.
AssignReportLinks(TCustomdxComponentPrinter)Copies report links. Inherited from TCustomdxComponentPrinter.
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) protectedScales the component and the associated controls and/or UI elements using the specified numerator and denominator values. Inherited from TcxScalableComponent.
CreateLinkFromFile(string)Inherited from TCustomdxComponentPrinter.
CreateLinkFromStream(TStream)Inherited from TCustomdxComponentPrinter.
CurrentCompositionByLink(TBasedxReportLink)Returns a composition report link according to a specific report link. Inherited from TCustomdxComponentPrinter.
DeleteAllLinksDeletes all links. Inherited from TCustomdxComponentPrinter.
DeleteLink(Integer)Deletes a specific report link. Inherited from TCustomdxComponentPrinter.
DesignerExists(TBasedxReportLink)Identifies if a print link has a registered Report Designer dialog form. Inherited from TCustomdxComponentPrinter.
DesignerExistsByComponent(TComponent)Identifies if the Report Designer dialog is available for the specified component’s print link. Inherited from TCustomdxComponentPrinter.
DesignReport(TBasedxReportLink)Opens the Report Designer dialog. Inherited from TCustomdxComponentPrinter.
DestroyComponentsInherited from TComponent.
DestroyingInherited from TComponent.
DestroyReport(TBasedxReportLink)Destroys the current report. Inherited from TCustomdxComponentPrinter.
DoAddReportLink(TBasedxReportLink) protectedGenerates the OnAddReportLink event. Inherited from TCustomdxComponentPrinter.
DoAfterPreview(TBasedxReportLink) protectedGenerates the OnAfterPreview event. Inherited from TCustomdxComponentPrinter.
DoBeforeDesignReport(TBasedxReportLink) protectedRaises the OnBeforeDesignReport event. Inherited from TCustomdxComponentPrinter.
DoBeforeExportToPDF(TBasedxReportLink,string,TdxPSPDFReportExportOptions) protectedFires the OnBeforeExportToPDF event. Inherited from TCustomdxComponentPrinter.
DoBeforePreview(TBasedxReportLink) protectedGenerates the OnBeforePreview event. Inherited from TCustomdxComponentPrinter.
DoChangeComponent(TBasedxReportLink) protectedGenerates the OnChangeComponent event. Inherited from TCustomdxComponentPrinter.
DoCustomDrawReportTitle(TBasedxReportLink,TCanvas,TRect,TcxTextAlignX,TcxTextAlignY,TColor,TFont,Boolean,Integer) protectedGenerates the OnCustomDrawReportTitle event. Inherited from TCustomdxComponentPrinter.
DoDeleteReportLink(TBasedxReportLink) protectedGenerates the OnDeleteReportLink event. Inherited from TCustomdxComponentPrinter.
DoDesignReport(TBasedxReportLink,Boolean) protectedGenerates the OnDesignReport event. Inherited from TCustomdxComponentPrinter.
DoEndPrint(TBasedxReportLink) protectedGenerates the OnEndPrint event. Inherited from TCustomdxComponentPrinter.
DoEndUpdateReport(TBasedxReportLink) protectedGenerates the OnEndGenerateReport event. Inherited from TCustomdxComponentPrinter.
DoNewPage(TBasedxReportLink,Integer) protectedGenerates the OnNewPage event. Inherited from TCustomdxComponentPrinter.
DoPageSetup(TBasedxReportLink,Boolean) protectedGenerates the OnPageSetUp event. Inherited from TCustomdxComponentPrinter.
DoPrintDeviceBusy protectedGenerates the OnPrintDeviceBusy event. Inherited from TCustomdxComponentPrinter.
DoPrintDeviceError protectedGenerates the OnPrintDeviceError event. Inherited from TCustomdxComponentPrinter.
DoProgress(TBasedxReportLink,Double) protectedGenerates the OnGenerateReportProgress event. Inherited from TCustomdxComponentPrinter.
DoStartPrint(TBasedxReportLink,Integer) protectedGenerates the OnStartPrint event. Inherited from TCustomdxComponentPrinter.
DoStartUpdateReport(TBasedxReportLink) protectedGenerates the OnStartGenerateReport event. Inherited from TCustomdxComponentPrinter.
DrawPageFooter(TBasedxReportLink,Integer,TRect,TdxPageTitleParts,Boolean)Draws a report page footer. Inherited from TCustomdxComponentPrinter.
DrawPageHeader(TBasedxReportLink,Integer,TRect,TdxPageTitleParts,Boolean)Draws a report page header. Inherited from TCustomdxComponentPrinter.
EndFunctionInvoke(IAsyncResult)Inherited from TComponent.
EndInvoke(IAsyncResult)Inherited from TComponent.
EndInvoke<TResult>(IAsyncResult)Inherited from TComponent.
EnumPagesAsImages(Integer[],TGraphicClass,Boolean,TdxEnumPagesAsImagesProc,Pointer,Pointer,Pointer,TBasedxReportLink)Converts report pages to graphic images.
Equals(TObject)Inherited from TObject.
ExecuteAction(TBasicAction)Inherited from TComponent.
ExploreInvokes the print preview in report explorer mode. Inherited from TCustomdxComponentPrinter.
ExportToPDF(TBasedxReportLink)Inherited from TCustomdxComponentPrinter.
ExportToPDF(string,Boolean,TdxPSPDFReportExportOptions,TBasedxReportLink)Exports a report generated by a specific report link to a PDF file. Inherited from TCustomdxComponentPrinter.
FindComponent(String)Inherited from TComponent.
FindLinkByComponent(TComponent,Boolean)Returns the report link by the assigned component. Inherited from TCustomdxComponentPrinter.
FreeNotification(TComponent)Inherited from TComponent.
FreeOnReleaseInherited from TComponent.
GetChildren(TGetChildProc,TComponent)Inherited from TComponent.
GetCompositionsByLink(TBasedxReportLink,TList)Returns a list of composition report links. Inherited from TCustomdxComponentPrinter.
GetHashCodeInherited from TObject.
GetItems(TdxCompositionReportLink,TStrings,Boolean)Returns all report links except for composition report links. Inherited from TCustomdxComponentPrinter.
GetLinks(TList)Inherited from TCustomdxComponentPrinter.
GetNamePathInherited from TPersistent.
GetNewLinkName(TBasedxReportLink)Returns the name of a new link, namely the TBasedxReportLink object. Inherited from TCustomdxComponentPrinter.
GetOwnerInherited from TPersistent.
GetPageColRowCount(Integer,Integer,TBasedxReportLink)Specifies the number of pages taken by the report image horizontally and vertically. Inherited from TCustomdxComponentPrinter.
GetPageCount(TBasedxReportLink)Determines the number of pages in a report. Inherited from TCustomdxComponentPrinter.
GetParentComponentInherited from TComponent.
GetPrintTitle(TBasedxReportLink) protectedReturns the name of a print job. Inherited from TCustomdxComponentPrinter.
HasParentInherited from TComponent.
IndexOfLink(TBasedxReportLink)Inherited from TCustomdxComponentPrinter.
IndexOfLink(string)Returns the zero-based index of a specified report link. Inherited from TCustomdxComponentPrinter.
IndexOfLinkByName(string)Returns the index of a link. Inherited from TCustomdxComponentPrinter.
InsertComponent(TComponent)Inherited from TComponent.
IsGenerateReportProgressEvent protectedDetermines the manner in which a report is generated. Inherited from TCustomdxComponentPrinter.
IsImplementorOf(IInterface)Inherited from TComponent.
IsLinkInComposition(TBasedxReportLink,TdxCompositionReportLink)Determines whether a specified report link belongs to a certain composition report link. Inherited from TCustomdxComponentPrinter.
IsLinkInCurrentComposition(TBasedxReportLink)Determines whether a specified report link belongs to a composition report link. Inherited from TCustomdxComponentPrinter.
IsRebuildBeforePreview protectedIdentifies whether the report is automatically rebuilt prior to displaying the Print Preview dialog. Inherited from TCustomdxComponentPrinter.
IsRebuildBeforePrint protectedIdentifies whether the report is automatically rebuilt prior to printing. Inherited from TCustomdxComponentPrinter.
IsShowHourGlass protectedIdentifies if the Hourglass cursor is shown during time-consuming report operations. Inherited from TCustomdxComponentPrinter.
IsSupportedCompClass(TClass)Inherited from TCustomdxComponentPrinter.
IsSupportedCompClass(TObject)Inherited from TCustomdxComponentPrinter.
LinkByName(string)Returns a report link by its name. Inherited from TCustomdxComponentPrinter.
Loaded protectedInitializes the component following the application form loading. Inherited from TcxScalableComponent.
LoadFromFile(string)Loads all component printer settings from the specified file. Inherited from TCustomdxComponentPrinter.
LoadFromIniFile(TCustomIniFile,string)
LoadFromIniFile(string)Loads the component printer’s format settings from an INI file.
LoadFromRegistry(string)Loads the component printer’s format settings from the registry.
LoadFromStream(TStream)Reads all component printer settings from a stream and stores the contents within TdxComponentPrinter. Inherited from TCustomdxComponentPrinter.
Notification(TComponent,TOperation)Inherited from TComponent.
PageSetup(TBasedxReportLink)Invokes the Page Setup dialog. Inherited from TCustomdxComponentPrinter.
PageSetupEx(Integer,Boolean,Boolean,Boolean,Boolean,TBasedxReportLink)Invokes the Page Setup dialog. Inherited from TCustomdxComponentPrinter.
PaintPage(TCanvas,Integer,TRect,TRect,TBasedxReportLink)Paints a single page of a report. Inherited from TCustomdxComponentPrinter.
PrepareReport(TBasedxReportLink) protectedPrepares a report for printing. Inherited from TCustomdxComponentPrinter.
Preview(Boolean,TBasedxReportLink)Activates the Print Preview dialog. Inherited from TCustomdxComponentPrinter.
PreviewExistsDetermines whether the Print Preview dialog is displayed. Inherited from TCustomdxComponentPrinter.
Print(Boolean,PdxPrintDlgData,TBasedxReportLink)Prints a report on the default printer. Inherited from TCustomdxComponentPrinter.
PrintEx(TdxPageNumbers,Integer,Boolean,TBasedxReportLink)Prints report pages. Inherited from TCustomdxComponentPrinter.
PrintPage(TBasedxReportLink,Integer) protectedPrints a specific report page. Inherited from TCustomdxComponentPrinter.
PrintPages(TdxPSPageIndexes,TBasedxReportLink)Prints specified report pages. Inherited from TCustomdxComponentPrinter.
PrintPagesEx(TdxPSPageIndexes,TdxPageNumbers,Integer,Boolean,TBasedxReportLink)Prints specified report pages. Inherited from TCustomdxComponentPrinter.
RebuildReport(TBasedxReportLink)Rebuilds a report. Inherited from TCustomdxComponentPrinter.
ReferenceInterface(IInterface,TOperation)Inherited from TComponent.
RemoveComponent(TComponent)Inherited from TComponent.
RemoveFreeNotification(TComponent)Inherited from TComponent.
SavePagesAsImagesToDisk(Integer[],TGraphicClass,Boolean,string,Pointer,Pointer,TBasedxReportLink)Saves report pages to graphic images on disk.
SaveToFile(string)Saves all component printer settings to a file. Inherited from TCustomdxComponentPrinter.
SaveToIniFile(TCustomIniFile,string)
SaveToIniFile(string)Saves the component printer’s format settings to an INI file.
SaveToRegistry(string)Saves the component printer’s format settings to the registry.
SaveToStream(TStream)Saves all component printer settings to a stream. Inherited from TCustomdxComponentPrinter.
ScaleForPPI(Integer)Scales the component according to the specified DPI value. Inherited from TcxScalableComponent.
SetParentComponent(TComponent)Inherited from TComponent.
SetSubComponent(Boolean)Inherited from TComponent.
ShowCustomizeDlgInvokes the “Edit Reports” dialog.
ToStringInherited from TObject.
UnprepareReport(TBasedxReportLink) protectedInherited from TCustomdxComponentPrinter.
UpdateAction(TBasicAction)Inherited from TComponent.

Events

NameDescription
OnAddReportLinkOccurs when adding a new report link. Inherited from TCustomdxComponentPrinter.
OnAfterPreviewOccurs after closing the preview form. Inherited from TCustomdxComponentPrinter.
OnBeforeDesignReportOccurs before the report designer window is activated. Inherited from TCustomdxComponentPrinter.
OnBeforeExportToPDFEnables you to adjust PDF export settings before a specific link’s report is exported to a PDF file or optionally cancel the export. Inherited from TCustomdxComponentPrinter.
OnBeforePreviewOccurs before the preview window is to be activated. Inherited from TCustomdxComponentPrinter.
OnChangeComponentOccurs when the Component property changes. Inherited from TCustomdxComponentPrinter.
OnChangeCurrentLinkOccurs when changing a report link. Inherited from TCustomdxComponentPrinter.
OnCustomDrawPageOccurs when drawing individual report pages. Inherited from TCustomdxComponentPrinter.
OnCustomDrawPageFooterOccurs when drawing a page footer. Inherited from TCustomdxComponentPrinter.
OnCustomDrawPageHeaderOccurs when drawing a page header. Inherited from TCustomdxComponentPrinter.
OnCustomDrawReportTitleOccurs when drawing the report title. Inherited from TCustomdxComponentPrinter.
OnDeleteReportLinkOccurs when a report link is to be deleted. Inherited from TCustomdxComponentPrinter.
OnDesignReportOccurs when the report link designer is closed. Inherited from TCustomdxComponentPrinter.
OnEndGenerateReportOccurs when a report has just been built. Inherited from TCustomdxComponentPrinter.
OnEndPrintOccurs after printing a report. Inherited from TCustomdxComponentPrinter.
OnExportGetPageFileNameOccurs when saving a page to disk.
OnExportPrepareGraphicOccurs when exporting a page to graphics.
OnExportProgressOccurs when exporting a report to graphic images or to disk.
OnFilterComponent
OnFinalizePrintDlgDataEnables you to respond to end-user choices made within a printer dialog after it’s been closed. Inherited from TCustomdxComponentPrinter.
OnGenerateReportProgressOccurs during report building. Inherited from TCustomdxComponentPrinter.
OnGetPrintTitleOccurs when a printing component starts printing. Inherited from TCustomdxComponentPrinter.
OnGetSupportedComponents
OnInitializePrintDlgDataAllows you to customize Print dialog appearance before it is displayed. Inherited from TCustomdxComponentPrinter.
OnMeasureReportTitleOccurs when drawing the report title before the OnCustomDrawReportTitle event. Inherited from TCustomdxComponentPrinter.
OnNewPageOccurs before sending a regular page of a multi-page document to printer. Inherited from TCustomdxComponentPrinter.
OnPageSetupOccurs when closing the Page Setup dialog window. Inherited from TCustomdxComponentPrinter.
OnPrintDeviceBusyOccurs when the printing device is busy. Inherited from TCustomdxComponentPrinter.
OnPrintDeviceErrorOccurs when the printing device is not available (for example, disconnected). Inherited from TCustomdxComponentPrinter.
OnStartGenerateReportOccurs when the printing component is about to build a report. Inherited from TCustomdxComponentPrinter.
OnStartPrintOccurs before the printing component prints the report. Inherited from TCustomdxComponentPrinter.

See Also

TdxComponentPrinter Class

dxPSCore Unit