Description

The abstract MailMergeFieldAdapter class is the base class of all special DocumentServer mail merge field adapters. It implements the necessary means to access field properties.

Syntax

public abstract class MailMergeFieldAdapter : FieldAdapter

Public MustInherit Class MailMergeFieldAdapter
    Inherits FieldAdapter

Examples

The following example includes the preserve formatting value from a Mail Merge Field Adapter object in application diagnostics. The created object is then available to the surrounding document workflow.

Console.WriteLine($"Preserve Formatting: {mailMergeFieldAdapter.PreserveFormatting}");
Console.WriteLine("Mail Merge Field Adapter is ready for use.");

Console.WriteLine($"Preserve Formatting: {mailMergeFieldAdapter.PreserveFormatting}")
Console.WriteLine("Mail Merge Field Adapter is ready for use.")

Members

Constructors

Constructor	Description
FieldAdapter	Initializes a new instance of the FieldAdapter class. (Inherited from FieldAdapter.)
MailMergeFieldAdapter	Initializes a new instance of the MailMergeFieldAdapter class.

Properties

Property	Description
ApplicationField	Gets the adapted ApplicationField of the field. Each special field acts like an adapter for the specific ApplicationField. (Inherited from FieldAdapter.)
ID	Gets the ID of the specific field through its adapter. (Inherited from FieldAdapter.)
Length	Gets the number of characters in a text field through its adapter. (Inherited from FieldAdapter.)
PreserveFormatting	Specifies whether the field's formatting should be preserved.
Start	Gets the first character position (one-based) of the field through its adapter. (Inherited from FieldAdapter.)
TypeName	Gets the field's type name of the specific field through its adapter. For example for the type name of a Microsoft Word MergeField is MERGEFIELD. If the type name of the field is changed, its parameters must also be changed. (Inherited from FieldAdapter.)

Methods

Method	Description
ShowDialog	Opens the specific field options dialog box. (Inherited from FieldAdapter.)

Fields

Field	Description
TYPE_NAME	Represents the name of the respective field type. Every subclass of FieldAdapter overwrites this with its respective type name. (Inherited from FieldAdapter.)