Xojo Plugin

Get a Mail-Merge Replacement String by Index

See more Email Object Examples

Demonstrates the Chilkat Email.GetReplaceString method, which returns the replacement string for the Nth previously-defined pattern/replacement pair (a mail-merge feature). The index is zero-based and corresponds to the same index used by GetReplacePattern. This example defines two pairs and prints each pattern with its replacement.

Background: Pairing GetReplacePattern (the token to find) with GetReplaceString (the text to substitute) at the same index lets you walk the full mail-merge table. Retrieving a replacement by its position is handy when enumerating all substitutions; to look one up by its pattern instead, use GetReplaceString2.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

//  Demonstrates the GetReplaceString method, which returns the replacement string for the
//  Nth previously-defined pattern/replacement pair (a mail-merge feature).  The index is
//  zero-based and corresponds to the same index used by GetReplacePattern.

Dim email As New Chilkat.Email
email.Subject = "Hello FIRST_NAME"
email.Body = "Dear FIRST_NAME, welcome to CITY."

Dim success As Boolean
success = email.SetReplacePattern("FIRST_NAME","John")
success = email.SetReplacePattern("CITY","Denver")

Dim n As Int32
n = email.NumReplacePatterns
Dim i As Int32
For i = 0 To n - 1
    System.DebugLog(email.GetReplacePattern(i) + " -> " + email.GetReplaceString(i))
Next