Back to Devexpress

TCustomdxComponentPrinter Members

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

latest36.5 KB
Original Source

TCustomdxComponentPrinter Members

The base class for the component printer.

Constructors

NameDescription
Create(TComponent)Inherited from TComponent.

Properties

NameDescription
AbortBuildingSpecifies that the building of a report should be cancelled.
AbortPrintingIndicates whether to stop report printing.
AutoUpdateDateTimeSpecifies whether date and time values in a report are updated automatically.
BeepAfterLongOperationsSpecifies whether a beep is generated for a long operation.
ComObjectInherited from TComponent.
ComponentCountInherited from TComponent.
ComponentIndexInherited from TComponent.
ComponentsInherited from TComponent.
ComponentStateInherited from TComponent.
ComponentStyleInherited from TComponent.
CurrentLinkSpecifies the active report link.
CurrentLinkIndexSpecifies the index of a current report link.
DateFormatSpecifies date presentation format.
DesignInfoInherited from TComponent.
ExplorerSpecifies the component that provides report exploring capabilities for the component printer.
ExplorerRealStubLink
ExplorerStubLinkSpecifies the report link whose content is displayed within the preview window when none of the explored reports are loaded.
FakeComponentLink1Inherited from TcxComponent.
FakeComponentLink2Inherited from TcxComponent.
FakeComponentLink3Inherited from TcxComponent.
IsDesigningInherited from TcxComponent.
IsDestroyingInherited from TcxComponent.
IsExplorerMode
IsLoadingInherited from TcxComponent.
LinkCountReturns the number of report links that are created within the current component printer.
LongOperationTimeSpecifies the threshold time interval (in milliseconds) for operations.
NameInherited from TComponent.
ObserversInherited from TComponent.
OptionsSpecifies component printer behavior flags.
OwnerInherited from TComponent.
PageNumberFormatSpecifies page number formatting in a report.
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.
PreviewWindowProvides access to the Print Preview window embedded into the Print Preview dialog.
PreviewWindowDesignerProvides access to the preview window designer at design time.
PreviewWindowFormProvides access to the Print Preview dialog.
PrintFileListSpecifies the list of files to which a report has been printed.
PrintTitleSpecifies the name of a print job.
ReportLinkProvides indexed access to report links that are created within the current component printer.
ReportLinkDesignerProvides access to the Report link designer window at design time.
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.
TagInherited from TComponent.
TimeFormatSpecifies time formatting options.
VCLComObjectInherited from TComponent.
VersionThis property is used to restore the previously applied changes made by a developer.

Methods

NameDescription
AddComposition
AddEmptyLink(TdxReportLinkClass)Adds a new empty link to the list of links.
AddEmptyLinkEx(TdxReportLinkClass,TComponent)Creates a new report link and adds it to the collection.
AddLink(TComponent)Creates a new print link for the specified component and adds the created link to the collection.
AddLinkEx(TComponent,TComponent)Creates a new print link for the specified component and adds the created link to the collection.
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) protectedScales 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.
DeleteAllLinksDeletes all links.
DeleteLink(Integer)Deletes a specific report link.
DesignerExists(TBasedxReportLink)Identifies if a print link has a registered Report Designer dialog form.
DesignerExistsByComponent(TComponent)Identifies if the Report Designer dialog is available for the specified component’s print link.
DesignReport(TBasedxReportLink)Opens the Report Designer dialog.
DestroyComponentsInherited from TComponent.
DestroyingInherited from TComponent.
DestroyReport(TBasedxReportLink)Destroys the current report.
DoAddReportLink(TBasedxReportLink) protectedGenerates the OnAddReportLink event.
DoAfterPreview(TBasedxReportLink) protectedGenerates the OnAfterPreview event.
DoBeforeDesignReport(TBasedxReportLink) protectedRaises the OnBeforeDesignReport event.
DoBeforeExportToPDF(TBasedxReportLink,string,TdxPSPDFReportExportOptions) protectedFires the OnBeforeExportToPDF event.
DoBeforePreview(TBasedxReportLink) protectedGenerates the OnBeforePreview event.
DoChangeComponent(TBasedxReportLink) protectedGenerates the OnChangeComponent event.
DoCustomDrawReportTitle(TBasedxReportLink,TCanvas,TRect,TcxTextAlignX,TcxTextAlignY,TColor,TFont,Boolean,Integer) protectedGenerates the OnCustomDrawReportTitle event.
DoDeleteReportLink(TBasedxReportLink) protectedGenerates the OnDeleteReportLink event.
DoDesignReport(TBasedxReportLink,Boolean) protectedGenerates the OnDesignReport event.
DoEndPrint(TBasedxReportLink) protectedGenerates the OnEndPrint event.
DoEndUpdateReport(TBasedxReportLink) protectedGenerates the OnEndGenerateReport event.
DoNewPage(TBasedxReportLink,Integer) protectedGenerates the OnNewPage event.
DoPageSetup(TBasedxReportLink,Boolean) protectedGenerates the OnPageSetUp event.
DoPrintDeviceBusy protectedGenerates the OnPrintDeviceBusy event.
DoPrintDeviceError protectedGenerates the OnPrintDeviceError event.
DoProgress(TBasedxReportLink,Double) protectedGenerates the OnGenerateReportProgress event.
DoStartPrint(TBasedxReportLink,Integer) protectedGenerates the OnStartPrint event.
DoStartUpdateReport(TBasedxReportLink) protectedGenerates 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.
ExploreInvokes 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.
FreeOnReleaseInherited from TComponent.
GetChildren(TGetChildProc,TComponent)Inherited from TComponent.
GetCompositionsByLink(TBasedxReportLink,TList)Returns a list of composition report links.
GetHashCodeInherited from TObject.
GetItems(TdxCompositionReportLink,TStrings,Boolean)Returns all report links except for composition report links.
GetLinks(TList)
GetNamePathInherited from TPersistent.
GetNewLinkName(TBasedxReportLink)Returns the name of a new link, namely the TBasedxReportLink object.
GetOwnerInherited 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.
GetParentComponentInherited from TComponent.
GetPrintTitle(TBasedxReportLink) protectedReturns the name of a print job.
HasParentInherited 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 protectedDetermines 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 protectedIdentifies whether the report is automatically rebuilt prior to displaying the Print Preview dialog.
IsRebuildBeforePrint protectedIdentifies whether the report is automatically rebuilt prior to printing.
IsShowHourGlass protectedIdentifies 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 protectedInitializes 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) protectedPrepares a report for printing.
Preview(Boolean,TBasedxReportLink)Activates the Print Preview dialog.
PreviewExistsDetermines 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) protectedPrints 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.
ToStringInherited from TObject.
UnprepareReport(TBasedxReportLink) protected
UpdateAction(TBasicAction)Inherited from TComponent.

Events

NameDescription
OnAddReportLinkOccurs when adding a new report link.
OnAfterPreview protectedOccurs after closing the preview form.
OnBeforeDesignReport protectedOccurs before the report designer window is activated.
OnBeforeExportToPDF protectedEnables you to adjust PDF export settings before a specific link’s report is exported to a PDF file or optionally cancel the export.
OnBeforePreview protectedOccurs before the preview window is to be activated.
OnChangeComponent protectedOccurs when the Component property changes.
OnChangeCurrentLink protectedOccurs when changing a report link.
OnCustomDrawPageOccurs when drawing individual report pages.
OnCustomDrawPageFooter protectedOccurs when drawing a page footer.
OnCustomDrawPageHeader protectedOccurs when drawing a page header.
OnCustomDrawReportTitle protectedOccurs when drawing the report title.
OnDeleteReportLinkOccurs when a report link is to be deleted.
OnDesignReport protectedOccurs when the report link designer is closed.
OnEndGenerateReportOccurs when a report has just been built.
OnEndPrintOccurs after printing a report.
OnFinalizePrintDlgDataEnables you to respond to end-user choices made within a printer dialog after it’s been closed.
OnGenerateReportProgressOccurs during report building.
OnGetPrintTitleOccurs when a printing component starts printing.
OnInitializePrintDlgDataAllows you to customize Print dialog appearance before it is displayed.
OnMeasureReportTitle protectedOccurs when drawing the report title before the OnCustomDrawReportTitle event.
OnNewPageOccurs before sending a regular page of a multi-page document to printer.
OnPageSetupOccurs when closing the Page Setup dialog window.
OnPrintDeviceBusyOccurs when the printing device is busy.
OnPrintDeviceErrorOccurs when the printing device is not available (for example, disconnected).
OnStartGenerateReportOccurs when the printing component is about to build a report.
OnStartPrintOccurs before the printing component prints the report.

Constants

NameDescription
DefaultOptionsSpecifies the default setting flags for the component printer.

See Also

TCustomdxComponentPrinter Class

dxPSCore Unit