Class WMergeField

Represents the mail merge field in the document.

Inheritance
System.Object
OwnerHolder
XDLSSerializableBase
Entity
WidgetBase
ParagraphItem
WTextRange
WField
WMergeField
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.DocIO.DLS
Assembly: Syncfusion.DocIO.Base.dll
Syntax
public class WMergeField : WField, IXDLSSerializable, IOfficeRun, IStringWidget, ISplitLeafWidget, ITextMeasurable, ILeafWidget, IWidget, IWMergeField, IWField, IWTextRange, IParagraphItem, IEntity

Constructors

WMergeField(IWordDocument)

Initializes a new instance of the WMergeField class with specified IWordDocument instance.

Declaration
public WMergeField(IWordDocument doc)
Parameters
Type Name Description
IWordDocument doc

The word document instance.

Fields

m_fieldName

Declaration
protected string m_fieldName
Field Value
Type
System.String

Properties

DateFormat

Gets the date format of the merge field. Read-only.

Declaration
public string DateFormat { get; }
Property Value
Type
System.String

EntityType

Gets the type of the entity.

Declaration
public override EntityType EntityType { get; }
Property Value
Type Description
EntityType

The EntityType of the current item.
Overrides

FieldName

Gets or sets mail merge field name.

Declaration
public string FieldName { get; set; }
Property Value
Type
System.String

NumberFormat

Gets the number format of the merge field. Read-only.

Declaration
public string NumberFormat { get; }
Property Value
Type
System.String

Prefix

Gets the prefix of merge field. Read-only.

Declaration
public string Prefix { get; }
Property Value
Type
System.String

TextAfter

Gets or sets the text that is displayed after the merge field.

Declaration
public string TextAfter { get; set; }
Property Value
Type
System.String

TextBefore

Gets or sets the text that is displayed before the merge field.

Declaration
public string TextBefore { get; set; }
Property Value
Type
System.String

TextItems

Gets the result text items in the merge field. Read-only.

Declaration
[Obsolete("This property has been deprecated. Use the Text property of WField class to get result text of the field.")]
public ParagraphItemCollection TextItems { get; }
Property Value
Type Description
ParagraphItemCollection

The text item collection that represents the merge field result value.

Methods

CloneImpl()

Clones itself.

Declaration
protected override object CloneImpl()
Returns
Type Description
System.Object

Returns cloned object.
Overrides

GetFieldValues(String)

Get Field Values - Parse for Field name and field switches

Declaration
protected string[] GetFieldValues(string fieldvalue)
Parameters
Type Name Description
System.String fieldvalue
Returns
Type
System.String[]

ParseFieldCode(String)

Declaration
protected override void ParseFieldCode(string fieldCode)
Parameters
Type Name Description
System.String fieldCode
Overrides

ReadXmlAttributes(IXDLSAttributeReader)

Reads object data from xml attributes.

Declaration
protected override void ReadXmlAttributes(IXDLSAttributeReader reader)
Parameters
Type Name Description
IXDLSAttributeReader reader

The IXDLSAttributeReader object.
Overrides

UpdateFieldCode(String)

updates field code

Declaration
protected override void UpdateFieldCode(string fieldCode)
Parameters
Type Name Description
System.String fieldCode
Overrides

WriteXmlAttributes(IXDLSAttributeWriter)

Writes object data as xml attributes.

Declaration
protected override void WriteXmlAttributes(IXDLSAttributeWriter writer)
Parameters
Type Name Description
IXDLSAttributeWriter writer

The IXDLSAttributeWriter object.
Overrides

Implements