Back to Devexpress

TdxCompositionReportLink Members

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

latest54.3 KB
Original Source

TdxCompositionReportLink Members

A report link used to print several components supported by the ExpressPrinting System at once.

Constructors

NameDescription
Create(TComponent)Inherited from TComponent.

Properties

NameDescription
AbortBuildingSpecifies that the building of a report should be cancelled. Inherited from TBasedxReportLink.
ActiveCreates a report. Inherited from TBasedxReportLink.
AssignedFormatValuesIndicates which formats have been assigned to a report link. Inherited from TBasedxReportLink.
BuiltInDetermines whether the current link item is created at design- or runtime. Inherited from TBasedxReportLink.
CapabilitiesInherited from TBasedxReportLink.
CaptionDefines a text string that identifies a link for a user. Inherited from TBasedxReportLink.
Color protectedSpecifies the background color of report cells. Inherited from TBasedxReportLink.
ComObjectInherited from TComponent.
ComponentSpecifies the target source control. Inherited from TBasedxReportLink.
ComponentCountInherited from TComponent.
ComponentIndexInherited from TComponent.
ComponentPrinterSpecifies the component printer to which the report link belongs. Inherited from TBasedxReportLink.
ComponentsInherited from TComponent.
ComponentStateInherited from TComponent.
ComponentStyleInherited from TComponent.
CompositionStateIndicates the state of a composition report link.
ContinuousPageIndexesSpecifies whether page numbering in a composition report is continuous.
ControllerInherited from TBasedxReportLink.
CurrentPageSpecifies the current report page. Inherited from TBasedxReportLink.
CurrentPrintStyleDetermines the current print style. Inherited from TBasedxReportLink.
DataSpecifies additional arbitrary data. Inherited from TBasedxReportLink.
DataSourceSpecifies 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. Inherited from TBasedxReportLink.
DateFormatSpecifies date representation format. Inherited from TBasedxReportLink.
DateTimeDetermines date and time of a specific report link. Inherited from TBasedxReportLink.
DescriptionDescribes a report link. Inherited from TBasedxReportLink.
DesignerCaptionSpecifies the Report Designer dialog’s caption. Inherited from TBasedxReportLink.
DesignerHelpContextProvides the designer context number for use when calling context-sensitive online Help. Inherited from TBasedxReportLink.
DesignerOptionsSpecifies which options of the Composition Editor window are enabled.
DesignInfoInherited from TComponent.
DesignWindowInherited from TBasedxReportLink.
FakeComponentLink1Inherited from TcxComponent.
FakeComponentLink2Inherited from TcxComponent.
FakeComponentLink3Inherited from TcxComponent.
Font protectedSpecifies report font. Inherited from TBasedxReportLink.
FootersOnEveryPage protectedSpecifies whether footers are printed on every page of a report. Inherited from TBasedxReportLink.
HasDesignWindowIndicates whether the current report link has a designer associated with it. Inherited from TBasedxReportLink.
HasPreviewWindowInherited from TBasedxReportLink.
HeadersOnEveryPage protectedSpecifies whether headers are printed on every page of a report. Inherited from TBasedxReportLink.
IndexDetermines the index of a link. Inherited from TBasedxReportLink.
IsAggregatedInherited from TBasedxReportLink.
IsCurrentLinkDetermines if the report link is active (also called current). Inherited from TBasedxReportLink.
IsDesigningInherited from TcxComponent.
IsDestroyingInherited from TcxComponent.
IsLoadingInherited from TcxComponent.
ItemsSupports a collection of TdxCompositionLinkItem objects which identify specific standard report links of a composition report link.
NameInherited from TComponent.
ObserversInherited from TComponent.
OwnerInherited from TComponent.
PageCountReturns the number of report pages. Inherited from TBasedxReportLink.
PageHeight protectedReturns the absolute height (in pixels) of a printed page. Inherited from TBasedxReportLink.
PageNumberFormatSpecifies page number format in a report. Inherited from TBasedxReportLink.
PageWidth protectedReturns the absolute width (in pixels) of a printed page. Inherited from TBasedxReportLink.
PDFExportOptionsProvides access to settings that define how the report link exports its content to a PDF file. Inherited from TBasedxReportLink.
PixelsPerInch protectedReturns the DPI value corresponding to the component’s current scaling factor. Inherited from TcxScalableComponent.
PreviewWindowInherited from TBasedxReportLink.
PrinterPageDetermines report page properties. Inherited from TBasedxReportLink.
RealPrinterPageProvides access to settings of a printout page layout. Inherited from TBasedxReportLink.
RealScaleFactorReturns the scale factor used to preview a report page. Inherited from TBasedxReportLink.
RebuildNeededIdentifies if the built report is up to date. Inherited from TBasedxReportLink.
RendererProvides access to the report painter. Inherited from TBasedxReportLink.
RenderStageInherited from TBasedxReportLink.
ReportCellsInherited from TBasedxReportLink.
ReportDocumentProvides access to the composition report document settings.
ReportFootnotesInherited from TBasedxReportLink.
ReportHeightDetermines the height of a report. Inherited from TBasedxReportLink.
ReportTitleDetermines report title properties. Inherited from TBasedxReportLink.
ReportTitleModeSpecifies the manner in which a report title is displayed. Inherited from TBasedxReportLink.
ReportTitleTextDetermines a report’s title. Inherited from TBasedxReportLink.
ReportWidthDetermines the width of a report. Inherited from TBasedxReportLink.
Scalable protectedSpecifies if the component’s content should be scaled. Inherited from TcxScalableComponent.
ScaleFactor protectedReturns the component’s scale factor. Inherited from TcxScalableComponent.
ScaleFonts protectedSpecifies whether to rescale report fonts. Inherited from TBasedxReportLink.
ShowDesignerDisplays the Report Designer window. Inherited from TBasedxReportLink.
ShowPageFooterDetermines whether to add page footer to the report. Inherited from TBasedxReportLink.
ShowPageHeaderDetermines whether to add a page header to a report. Inherited from TBasedxReportLink.
ShowPageRowHeaderInherited from TBasedxReportLink.
ShrinkToPageWidthDeprecated. This property exists for backward compatibility only. Use PrinterPage.FitToPagesHorizontally and PrinterPage.FitToPagesVertically properties instead. Inherited from TBasedxReportLink.
StartEachItemFromNewPageSpecifies if each report link contained within the composition report link’s Items collection starts a new page when printed.
StartPageIndexDetermines the index of the first report page. Inherited from TBasedxReportLink.
StorageNameSpecifies the full path to the file from which the report is loaded. Inherited from TBasedxReportLink.
StyleManagerDetermines the style manager for a report link. Inherited from TBasedxReportLink.
TagInherited from TComponent.
TimeFormatSpecifies the manner in which time information is formatted within a report. Inherited from TBasedxReportLink.
Transparent protectedDetermines whether cells are filled with the default color. Inherited from TBasedxReportLink.
UseHorzDelimiters protectedSpecifies whether to prevent a row from breaking across multiple pages. Inherited from TBasedxReportLink.
UseVertDelimiters protectedSpecifies whether to prevent a column from breaking across multiple pages. Inherited from TBasedxReportLink.
VCLComObjectInherited from TComponent.

Methods

NameDescription
AddBackgroundBitmapToPool(TGraphic)Inherited from TBasedxReportLink.
AddFontToPool(string,TColor,TFontPitch,TFontStyles,Integer)Inherited from TBasedxReportLink.
AddFontToPool(TFont)Inherited from TBasedxReportLink.
AggregableInherited from TBasedxReportLink.
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. Inherited from TBasedxReportLink.
CanBeUsedAsStubInherited from TBasedxReportLink.
CanChangeFootnotesInherited from TBasedxReportLink.
CanChangeTitleInherited from TBasedxReportLink.
CanExportToPDFInherited from TBasedxReportLink.
CanLoadDataInherited from TBasedxReportLink.
CanSaveDataInherited from TBasedxReportLink.
CanUnloadDataInherited from TBasedxReportLink.
ChangeScale(Integer,Integer) protectedScales the component and the associated controls and/or UI elements using the specified numerator and denominator values. Inherited from TcxScalableComponent.
CheckToDesignChecks whether to display the Report Design window. Inherited from TBasedxReportLink.
ConstructReport(TdxReportCells) protectedBuilds a report. Inherited from TBasedxReportLink.
CreateGroupLookAndFeel(TdxPSReportGroupLookAndFeelClass,Boolean)Inherited from TBasedxReportLink.
DataProviderPresentDetermines whether a report link is associated with any TComponent. Inherited from TBasedxReportLink.
DefaultDateFormatReturns the default date format. Inherited from TBasedxReportLink.
DefaultDesignerCaptionInherited from TBasedxReportLink.
DefaultFontInherited from TBasedxReportLink.
DefaultPageNumberFormatReturns the default page number format in a report. Inherited from TBasedxReportLink.
DefaultTimeFormatReturns the default time format. Inherited from TBasedxReportLink.
DefinePrintStylesDlgDisplays the Define Print Styles dialog window. Inherited from TBasedxReportLink.
DesignerExists(TComponentClass)Determines whether a specific component class includes a designer. Inherited from TBasedxReportLink.
DesignReportDisplays the Report Designer window. Inherited from TBasedxReportLink.
DestroyComponentsInherited from TComponent.
DestroyingInherited from TComponent.
DestroyReportDestroys the report link’s report. Inherited from TBasedxReportLink.
DoChangeComponent protectedGenerates the OnChangeComponent event. Inherited from TBasedxReportLink.
DoProgress(Double) protectedTracks the progress of report creation. Inherited from TBasedxReportLink.
DrawCheckBox(TCanvas,TRect,Boolean,Boolean,Boolean,TdxCheckButtonEdgeStyle,TColor)Draws a check box item in a report. Inherited from TBasedxReportLink.
DrawCheckBox(TCanvas,TRect,Boolean,Boolean,Boolean,Boolean)Inherited from TBasedxReportLink.
drawEdge(TCanvas,TRect,TdxCellEdgeMode,TdxCellEdgeStyle,TdxCellEdgeStyle,TdxCellSides,Boolean)Draws an edge object in a report. Inherited from TBasedxReportLink.
DrawEllipse(TCanvas,TRect,TColor,TColor,TdxPSFillPatternClass,TColor,Integer)Inherited from TBasedxReportLink.
DrawExpandButton(TCanvas,TRect,Boolean,Boolean,Boolean,Boolean,Boolean,Boolean,TColor,TColor)Inherited from TBasedxReportLink.
DrawGlyph(HDC,TRect,Byte)Inherited from TBasedxReportLink.
DrawGraphic(TCanvas,TRect,TRect,TCustomImageList,Integer,TGraphic,Boolean,Boolean,TColor)Draws a graphic object in a report. Inherited from TBasedxReportLink.
DrawGraphicEx(TCanvas,TRect,TRect,TCustomImageList,Integer,TGraphic,Boolean,Boolean,TColor,TColor,TdxPSFillPatternClass,TdxCellImageActualBuffering)Inherited from TBasedxReportLink.
DrawPageFooter(Integer,TRect,TdxPageTitleParts,Boolean)Draws a page footer in a report. Inherited from TBasedxReportLink.
DrawPageHeader(Integer,TRect,TdxPageTitleParts,Boolean)Draws a page header in a report. Inherited from TBasedxReportLink.
DrawRectangle(TCanvas,TRect,TColor,TColor,TdxPSFillPatternClass,TColor,Integer)Inherited from TBasedxReportLink.
DrawRoundRect(TCanvas,TRect,Integer,Integer,TColor,TColor,TdxPSFillPatternClass,TColor,Integer)Inherited from TBasedxReportLink.
DrawSortMark(TCanvas,TRect,TdxCellSortOrder,Boolean)Draws a sorting mark (arrow) in a report. Inherited from TBasedxReportLink.
drawText(TCanvas,TRect,Integer,string,TFont,TColor,TcxTextAlignX,TcxTextAlignY,Boolean,Boolean,Boolean)Draws text in a report. Inherited from TBasedxReportLink.
drawTextEx(TCanvas,TRect,Integer,Integer,Integer,string,TFont,TColor,TcxTextAlignX,TcxTextAlignY,Boolean,Boolean,Boolean,Boolean,Boolean)Inherited from TBasedxReportLink.
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.
ExportToPDFInherited from TBasedxReportLink.
ExportToPDF(string,Boolean,TdxPSPDFReportExportOptions)Exports a report to a PDF file. Inherited from TBasedxReportLink.
ExtractComponentClass(TStream,Boolean)Inherited from TBasedxReportLink.
ExtractComponentClassName(TStream,Boolean)Inherited from TBasedxReportLink.
ExtractLinkClass(TStream,Boolean)Inherited from TBasedxReportLink.
ExtractOffsetTable(TStream,Boolean)Inherited from TBasedxReportLink.
ExtractReportDocument(TStream,Boolean)Inherited from TBasedxReportLink.
ExtractStorageInfo(TStream,Boolean)Inherited from TBasedxReportLink.
ExtractStorageVersion(TStream,Boolean)Inherited from TBasedxReportLink.
FillEllipse(TCanvas,TRect,TColor)Inherited from TBasedxReportLink.
FillEllipseEx(TCanvas,TRect,TColor,TColor,TdxPSFillPatternClass)Inherited from TBasedxReportLink.
FillRectEx(TCanvas,TRect,TColor,TColor,TdxPSFillPatternClass)Inherited from TBasedxReportLink.
FillRgnEx(TCanvas,TcxRegionHandle,TColor,TColor,TdxPSFillPatternClass)Inherited from TBasedxReportLink.
FillRoundRect(TCanvas,TRect,Integer,Integer,TColor)Inherited from TBasedxReportLink.
FillRoundRectEx(TCanvas,TRect,Integer,Integer,TColor,TColor,TdxPSFillPatternClass)Inherited from TBasedxReportLink.
FinalizeStorageInfo(TdxPSDataStorageInfo)Inherited from TBasedxReportLink.
FindComponent(String)Inherited from TComponent.
FindGroupLookAndFeelByClass(TdxPSReportGroupLookAndFeelClass)Inherited from TBasedxReportLink.
FrameEllipse(TCanvas,TRect,TColor,Integer)Inherited from TBasedxReportLink.
frameRect(TCanvas,TRect,TColor,TdxCellSides,Integer)Inherited from TBasedxReportLink.
FrameRoundRect(TCanvas,TRect,Integer,Integer,TColor,Integer)Inherited from TBasedxReportLink.
FreeNotification(TComponent)Inherited from TComponent.
FreeOnReleaseInherited from TComponent.
GetChildren(TGetChildProc,TComponent)Inherited from TComponent.
GetControlPainterInherited from TBasedxReportLink.
GetControlScaleFactorInherited from TBasedxReportLink.
GetFilteredStyles(TStrings)Retrieves a list of print styles that can be applied to a report. Inherited from TBasedxReportLink.
GetHashCodeInherited from TObject.
GetItems(TStrings,Boolean)Retrieves a list of link captions.
GetNamePathInherited from TPersistent.
GetNewReportStorageNameInherited from TBasedxReportLink.
GetOwnerInherited from TPersistent.
GetPageColRowCount(Integer,Integer)Determines the number of pages used by a report image, both horizontally and vertically. Inherited from TBasedxReportLink.
GetParentComponentInherited from TComponent.
GetSupportedComponentList(TdxClassList)Returns a list of all classes supported by the link. Inherited from TBasedxReportLink.
HasParentInherited from TComponent.
IndexOfReportGroupLookAndFeel(TdxPSReportGroupLookAndFeel)Inherited from TBasedxReportLink.
InitializeInherited from TBasedxReportLink.
InsertComponent(TComponent)Inherited from TComponent.
InternalRestoreDefaults protectedRestores default settings for a report. Inherited from TBasedxReportLink.
InternalRestoreFromOriginal protectedRestores original component settings for a report. Inherited from TBasedxReportLink.
IsApplyBackgroundToEntirePage protectedInherited from TBasedxReportLink.
IsEmptyPage(Integer)Determines whether a specified report page is empty. Inherited from TBasedxReportLink.
IsEmptyReportAscertain whether a report is empty. Inherited from TBasedxReportLink.
IsImplementorOf(IInterface)Inherited from TComponent.
IsSupportedCompClass(TClass)Determines whether a specific component class is supported by a given report link. Inherited from TBasedxReportLink.
LinkClassReturns the class-reference to the report link’s actual type. Inherited from TBasedxReportLink.
LinkModified(Boolean) protectedDetermines whether a link was modified. Inherited from TBasedxReportLink.
LoadDataFromFile(string)Loads a report from a specified file into the Print Preview window. Inherited from TBasedxReportLink.
LoadDataFromStream(TStream)Loads a report from a specified stream into the Print Preview window. Inherited from TBasedxReportLink.
Loaded protectedInitializes the component following the application form loading. Inherited from TcxScalableComponent.
LoadFromIniFile(TCustomIniFile,string)Inherited from TBasedxReportLink.
LoadFromIniFile(string)Loads the report link’s format settings and start page from an INI file. Inherited from TBasedxReportLink.
LoadFromRegistry(string)Loads the report link’s format settings and start page from the registry. Inherited from TBasedxReportLink.
MakeDelimiters(TdxReportCells,TList,TList) protectedCreates delimiters for report pages. Inherited from TBasedxReportLink.
MakeHardDelimiters(TdxReportCells,TList,TList) protectedCreates report page breaks. Inherited from TBasedxReportLink.
Notification(TComponent,TOperation)Inherited from TComponent.
PageReady(Integer) protectedIndicates whether report pages have been generated. Inherited from TBasedxReportLink.
PageSetupInvokes the Page Setup dialog. Inherited from TBasedxReportLink.
PageSetupEx(Integer,Boolean,Boolean,Boolean,Boolean)Invokes the Page Setup dialog. Inherited from TBasedxReportLink.
PossibleDataStorage(TStream,Boolean)Inherited from TBasedxReportLink.
PossibleDataStorage(string,Boolean)Inherited from TBasedxReportLink.
Preview(Boolean)Invokes the Print Preview dialog. Inherited from TBasedxReportLink.
PreviewExistsIdentifies if the Print Preview dialog is displayed. Inherited from TBasedxReportLink.
Print(Boolean,PdxPrintDlgData)Prints the report link’s report on the default printer. Inherited from TBasedxReportLink.
Print(Boolean)Inherited from TBasedxReportLink.
PrintEx(TdxPageNumbers,Integer,Boolean)Prints report pages. Inherited from TBasedxReportLink.
PrintPages(TdxPSPageIndexes)Prints the specified report pages. Inherited from TBasedxReportLink.
PrintPagesEx(TdxPSPageIndexes,TdxPageNumbers,Integer,Boolean)Prints the specified report pages. Inherited from TBasedxReportLink.
RebuildReportRebuilds the report. Inherited from TBasedxReportLink.
ReferenceInterface(IInterface,TOperation)Inherited from TComponent.
RemoveComponent(TComponent)Inherited from TComponent.
RemoveFreeNotification(TComponent)Inherited from TComponent.
RestoreDefaultsRestores predefined values for report link properties. Inherited from TBasedxReportLink.
RestoreFromOriginalRestores original component values for report link properties. Inherited from TBasedxReportLink.
SaveDataToFile(string)Saves the built report to the specified file. Inherited from TBasedxReportLink.
SaveDataToStream(TStream)Saves the built report to the specified stream. Inherited from TBasedxReportLink.
SaveToIniFile(TCustomIniFile,string)Inherited from TBasedxReportLink.
SaveToIniFile(string)Saves the report link’s format settings and start page to an INI file. Inherited from TBasedxReportLink.
SaveToRegistry(string)Saves the report link’s format settings and start page to the registry. Inherited from TBasedxReportLink.
ScaleForPPI(Integer)Scales the component according to the specified DPI value. Inherited from TcxScalableComponent.
SerializableInherited from TBasedxReportLink.
SetActive(Boolean) protectedInitiates report generation. Inherited from TBasedxReportLink.
SetComponentUnconditionally(TComponent)Inherited from TBasedxReportLink.
SetParentComponent(TComponent)Inherited from TComponent.
SetSubComponent(Boolean)Inherited from TComponent.
ShowDateTimeFormatsDlgDisplays the Change Date and Time Formats dialog window. Inherited from TBasedxReportLink.
ShowFootnotesPropertiesDlgOpens the Report Footnotes dialog. Inherited from TBasedxReportLink.
ShowPageNumberFormatsDlgDisplays the Change Page Numbering Format dialog window. Inherited from TBasedxReportLink.
ShowTitlePropertiesDlgDisplays the Report Title dialog window. Inherited from TBasedxReportLink.
Supports(TClass)Inherited from TBasedxReportLink.
Supports(TObject)Inherited from TBasedxReportLink.
SupportsScalingInherited from TBasedxReportLink.
ToStringInherited from TObject.
UpdateAction(TBasicAction)Inherited from TComponent.

Events

NameDescription
OnAfterBuildReportOccurs after the report has been built for a specific report link.
OnBeforeBuildReportOccurs before building the report for a specific report link.
OnChangeComponentOccurs when the Component property changes. Inherited from TBasedxReportLink.
OnCustomDrawPageFooterEnables you to custom paint page footers for the report link. Inherited from TBasedxReportLink.
OnCustomDrawPageHeaderEnables you to custom paint page headers for the report link. Inherited from TBasedxReportLink.
OnCustomDrawReportLinkFootnotesEnables you to custom paint footnotes. Inherited from TBasedxReportLink.
OnCustomDrawReportLinkTitleOccurs when drawing the report title. Inherited from TBasedxReportLink.
OnDataSourceChangedEnables you to respond to an impending change in the report link’s report source. Inherited from TBasedxReportLink.
OnDestroyOccurs when a report link is being destroyed. Inherited from TBasedxReportLink.
OnFilterStyleOccurs when retrieving the list of available print styles. Inherited from TBasedxReportLink.
OnGetNewReportStorageNameEnables you to customize the report storage’s default name. Inherited from TBasedxReportLink.
OnMeasureReportLinkFootnotesEnables you to customize a footnote’s height. Inherited from TBasedxReportLink.
OnMeasureReportLinkTitleOccurs when drawing the report title before the OnCustomDrawReportLinkTitle event. Inherited from TBasedxReportLink.

See Also

TdxCompositionReportLink Class

dxPSCore Unit