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

Function TWPRTFDataBlockEd.MergeText(SenderForCallBack:TObject; CallBack:TWPMailMergeGetTextEvent; Readonly:Boolean; FieldName:string; FieldCommand:string; StartPar:TParagraph; LastPar:TParagraph; ContentsClass:TWPMMInsertTextContentsClass; MergeObjType:TWPTextObjType; Options:TWPMergeTextOptions; CheckField:TWPMailMergeUseFieldCallback) : Boolean

Unit: WPRTEEdit
Class: WPRTEEdit.TWPRTFDataBlockEd

Parameters

  • SenderForCallBack:TObject
  • CallBack:TWPMailMergeGetTextEvent
  • Readonly:Boolean
  • FieldName:string
  • FieldCommand:string
  • StartPar:TParagraph
  • LastPar:TParagraph
  • ContentsClass:TWPMMInsertTextContentsClass
  • MergeObjType:TWPTextObjType
  • Options:TWPMergeTextOptions
  • CheckField:TWPMailMergeUseFieldCallback

Returns

The type of the result value is Boolean.

Description

Start the mailmerge process.
The Mailmerge procedure in WPTools modifies the cursor position and the selection to do the text replacement. This makes the mailmerge probably a little slower than the process in WPTools 4 but provides far more options since during the mailmerge procedure the text insertion and character attribute change procedures can be used.
The MergeText function can also be used to read the contents of all fields. If a FieldName is provided only fields with this name will be used. This makes it possible to merge fields which are inside other merge fields which are invisible otherwise! FieldName may contain a * as wildcard.