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)

Function TWPRTFDataCollectionBase.CodeLocatePair(FormatName:string; spar:TParagraph; epar:TParagraph; spos:Integer; epos:Integer; global:Boolean) : Integer

Unit: WPRTEDefs
Class: WPRTEDefs.TWPRTFDataCollectionBase

Parameters

Returns

The type of the result value is Integer.

Description

Locates paired objects based on the given FormatName. This FormatName uses this syntax: "X:text" or "X:text=".
X can be one of this letters:
lowercase letters:
c: search for wpobjCustom comparing the object name = text
f: search for wpobjMergeField
h: search for wpobjHyperlink
b: search for wpobjBookmark
p: search for wpobjTextProtection
s: search for wpobjSPANStyle
capital letters:
C: search for wpobjCustom comparing the object source parameter = text
F: search for wpobjMergeField etc.
If the FormatName was processed the function will return the count of characters which were interpreted. If a pair was found spar and epar will be > nil - otherwise nothing was found!

It is also possible to locate a named paragraph (using property WPAT_PAR_NAME) with @:PARNAME=.... This makes sense to load and save data of sub paragraphs in the Save and Load methods.