Introduction Class TWPCustomRTFControl Class TWPRichText Class TWPCustomRichText Class TDBWPRichText Class TWPCustomRtfEdit Class TWPPreview Class TWPRichTextLabel
Class TWPToolbar Class TWPToolButton Class TWPToolPanel Class TWPVertRuler Class TWPRuler Class TWPGutter
Class TTextHeader Class TWPRTFSectionProps Class TWPOwnedCharAttrInterface Class TWPStoredCharAttrInterface Class TWPAbstractCharAttrInterface Class TWPAbstractCharParAttrInterface Class TWPCursorCharAttrInterface Class TWPFoundTextAttrInterface Class TWPCurrentWritingmodeAttrInterface
Class TWPRTFReaderEx Class TWPRTFReader Class TWPRTFWriter Class TWPRTFWriterEx Class TWPToolsReaderWriter Class TWPTextWriter Class TWPHTMLWriter Class TWPTOOLSWriter Class TWPUNITextWriter Class TWPCustomTextWriter Class TWPTextReader Class TWPHTMLReader Class TWPTOOLSReader Class TWPUNITextReader Class TWPCustomTextReader
Class TWPRTFDataCollectionBase Class TWPRTFDataCollection Class TWPRTFDataBlock Class TWPRTFDataBlockEd Class TParagraph Class TWPTextStyle Class TWPORTFTextBox Class TWPObjectField Class TWPObject Class TWPRTFEngineBasis Class TWPRTFEngineEdit
Class TWPManageHeaderFooterDlg Class TWPPagePropDlg Class TWPParagraphBorderDlgEx Class TWPParagraphBorderDlg Class TWPTabDlgPrp Class TWPOneStyleDlg Class TWPBulletDlg Class TWPSymbolDlg Class TWPSymbolDlgEx Class TWPSpellCheckDlg Class TWPStringDlg Class TWPStyleDlg Class TWPCustomAttrDlg Class TWPSearchReplaceDlg Class TWPParagraphPropDlg Class TWPPreviewDlg Class TWPReportBandsDialog Class TWPTableDlg
Class TWPSuperMerge Class TDBWPEvalEngine Class TWPEvalEngine Class TWPTableProducer Class TWPBand Class TWPDataSetAbstractAdapter
Class TWPSvgXMLNode Class TWPXMLOneLevel Class TWPCustomXMLInterface Class TWPXMLInterface Class TWPLanguageControl Class TWPXMLTree Class TWPSVGXMLTree Class TWPCustomXMLTree
Main Website Buy WPCubed VCL Components Contact/License

WPTools Manual



Search


(press enter to search)

Class TWPBlockTemplate

Hierarchy

System.TObject | System.Classes.TPersistent | System.Classes.TCollectionItem | WPRTEDefs.TWPCollectionItem | TWPBlockTemplate

Subclasses

WPCTRTextProducerDB.TWPBlockTemplateDB

Description for Class TWPCollectionItem

Add Interface support to TCollectionItems - this helps for property editors. Unlike with interface objects the object is NOT destroyed when the interface refcount reaches 0.

Properties

Property ClientName : string

Property CollapsedInitially : Boolean

Property Columns : TWPColumnTemplates

Property ColumnsInRow : Integer

Property InsideDataGroup : Integer

Property LabelCellWidthPC : Integer

Property MasterIDField : string

Property MaxRowCount : Integer

Property Mode : TWPBlockTemplateMode

Property Name : string

Property NextName : string

Property RowCount : Integer

Property RowHeight : Integer

Property Styles : TWPTemplateStyles

Property SummaryRows : Integer

Property TableOptions : TWPTableAddOptions

Property TableTemplates : TWPBlockTemplates

Property TemplateText : TWPRTFBlobContents

Property TemplateTextOptions : TWPTemplateTextOptions

Methods

Function AddColumn(aFieldName:string; style:TWPTextStyle) : TWPColTemplate

Procedure Assign(Source:TPersistent)

Procedure BeforeFirstRow(Group:TWPBlockTemplateGroupObj)

Procedure BeforeNextRow(Group:TWPBlockTemplateGroupObj)

Function CheckRecursion(Value:string) : Boolean

Procedure Clear

Function ColumnByName(aName:string) : TWPColTemplate

Create(Collection:TCollection)

Destroy

Procedure DoMergeGetText(Sender:TObject; inspname:string; Contents:TWPMMInsertTextContents)

Procedure EnterGroup(MasterID:string; CurrentGroup:TWPBlockTemplateGroupObj)

Procedure ExitGroup(CurrentGroup:TWPBlockTemplateGroupObj)

Function FindColumn(aName:string) : TWPColTemplate

Function GetDisplayName : string

Function GetFirstRow(Group:TWPBlockTemplateGroupObj) : Boolean

Function GetMasterID : string

Function GetNextRow(Group:TWPBlockTemplateGroupObj; CurrRowNr:Integer) : Boolean

Function GetRowCount(Group:TWPBlockTemplateGroupObj) : Integer

Function GetRowID : string

Function GotoRow(KeyValue:string) : Boolean

Function Insert(AEditBox:TWPCustomRtfEdit; UseCurrentDocument:Boolean) : TParagraph

Function InsertColumn(Index:Integer) : TWPColTemplate

Function MasterField : string

Function NameAndKey : string

Procedure PrepareRow(Group:TWPBlockTemplateGroupObj)

Procedure SetRowCount(Value:Integer)

Function Update(AEditBox:TWPCustomRtfEdit) : TParagraph

Procedure UpdateColumnProperties

Function UpdateFieldData(AEditBox:TWPCustomRtfEdit; UID:string; TableName:string; UpdateMode:TWPBlockTemplateUpdateModes) : Boolean

Events

OnCustomGetFirstRow : TWPBlockTemplateGetFirstRowEvent= TWPBlockTemplateGetFirstRowEvent

Use this event to customize the behavior when the first data record should be selected

OnCustomGetNextRow : TWPBlockTemplateGetNextRowEvent= TWPBlockTemplateGetNextRowEvent

Use this event to customize the behavior when the next data record should be selected

OnEnterGroup : TWPBlockTemplateEnterGroupEvent= TWPBlockTemplateEnterGroupEvent

This event is triggered when a group is being entered to create and fill the client rows.

OnExitGroup : TWPBlockTemplateExitGroupEvent= TWPBlockTemplateExitGroupEvent

This event is triggered when the group is left.

OnGetFirstRow : TWPBlockTemplateGetFirstRowEvent= TWPBlockTemplateGetFirstRowEvent

OnGetNextRow : TWPBlockTemplateGetNextRowEvent= TWPBlockTemplateGetNextRowEvent

The event OnGetNextRow is triggered after the next data record was alocated. It can be used to initialise running variables or limit the count of data rows which should be displayed: if CurrRowNr>3 then Proceed := false;

OnGetRowCount : TWPBlockTemplateGetRowCount= TWPBlockTemplateGetRowCount

OnMailMergeGetText : TWPBlockTemplateMailMergeEvent= TWPBlockTemplateMailMergeEvent

This event will be triggered for fields in the TextTemplate when using in table cells.

OnPrepareRow : TWPBlockTemplatePrepareRowEvent= TWPBlockTemplatePrepareRowEvent

Use this event to create data which is required by the current row. The "Values" and "GlobalValues" of the Group Object can be very helpful in this contect. You can use those Variant values within your calculation. The "GlobalValues" will be unassigned at the start of the creation process, "Values" will refresh for each Enter/Leave Group event.
Example:
Group.GlobalValue['SUM_YEARS'] := Group.GlobalValue['SUM_YEARS'] + MasterYear.AsInteger;

Used or referenced by

-Property TWPEditLinkParagraphObj.EditLink : TWPCollectionItem
-Property TWPEditLinkParagraphObj.EditLink : TWPCollectionItem
-Property TWPColumnTemplates.ParentBlock : TWPBlockTemplate