RichEditMailMergeOptions.FieldNameFormatString Property

Specifies the field format string.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v20.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

[Browsable(false)]
public string FieldNameFormatString { get; set; }

VB.NET

<Browsable(False)>
Public Property FieldNameFormatString As String

Property Value

Type	Description
String	A String.Format value that specifies the field format.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to FieldNameFormatString
WinForms Controls	SnapControlOptions	.MailMerge .FieldNameFormatString
	RichEditControlOptions	.MailMerge .FieldNameFormatString
WPF Controls	RichEditControlOptions	.MailMerge .FieldNameFormatString
Office File API	RichEditControlOptionsBase	.MailMerge .FieldNameFormatString

Remarks

When the RichEditMailMergeOptions.ViewMergedData property is set to false, the RichEditControl and RichEditDocumentServer display the merged field in the «FieldName» string format. Use the FieldNameFormatString property to change the field format.

The code sample below shows how to specify the ({0}) format for merged fields:

C#

wordProcessor.Options.MailMerge.FieldNameFormatString = "({0})";

VB.NET

wordProcessor.Options.MailMerge.FieldNameFormatString = "({0})"