menu

UWP

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class WMergeField - UWP API Reference | Syncfusion

    Show / Hide Table of Contents

    Class WMergeField

    Represents the mail merge field in the document.

    Inheritance
    System.Object
    OwnerHolder
    XDLSSerializableBase
    Entity
    WidgetBase
    ParagraphItem
    WTextRange
    WField
    WMergeField
    Implements
    IXDLSSerializable
    IOfficeRun
    IWMergeField
    IWField
    IWTextRange
    IParagraphItem
    IEntity
    Inherited Members
    Entity.Clone()
    Entity.IsComposite
    Entity.NextSibling
    Entity.Owner
    Entity.PreviousSibling
    OwnerHolder.Document
    OwnerHolder.m_doc
    ParagraphItem.ApplyStyle(String)
    ParagraphItem.CloneRun()
    ParagraphItem.Dispose()
    ParagraphItem.IsDeleteRevision
    ParagraphItem.IsInsertRevision
    ParagraphItem.m_charFormat
    ParagraphItem.OwnerMathRunElement
    ParagraphItem.OwnerParagraph
    WField.ConvertSwitchesToString()
    WField.FieldCode
    WField.FieldPattern
    WField.FieldType
    WField.FieldValue
    WField.GetClonedTable(Entity, Boolean)
    WField.GetTextRange(String)
    WField.m_bConvertedToText
    WField.m_fieldType
    WField.m_fieldValue
    WField.m_formattingString
    WField.m_paraItemType
    WField.m_textFormat
    WField.ParseField(String)
    WField.ParseFieldFormat(String[])
    WField.RemoveMergeFormat(String)
    WField.RemovePreviousResult()
    WField.RemoveText(String, String)
    WField.ReplaceAllMergeFormatWithEmpty(String)
    WField.SplitIfArguments(String, List<Int32>, String)
    WField.Text
    WField.TextFormat
    WField.Unlink()
    WField.Update()
    WField.UpdateCondition(String, List<Int32>, String)
    WField.UpdateTextForParagraphItem(Entity, Boolean)
    WField.UpdateTextForTextBodyItem(Entity, Boolean)
    WTextRange.ApplyCharacterFormat(WCharacterFormat)
    WTextRange.CharacterFormat
    WTextRange.InitXDLSHolder()
    WTextRange.ReadXmlContent(IXDLSContentReader)
    WTextRange.WriteXmlContent(IXDLSContentWriter)
    XDLSSerializableBase.IXDLSSerializable.ReadXmlAttributes(IXDLSAttributeReader)
    XDLSSerializableBase.IXDLSSerializable.ReadXmlContent(IXDLSContentReader)
    XDLSSerializableBase.IXDLSSerializable.RestoreReference(String, Int32)
    XDLSSerializableBase.IXDLSSerializable.WriteXmlAttributes(IXDLSAttributeWriter)
    XDLSSerializableBase.IXDLSSerializable.WriteXmlContent(IXDLSContentWriter)
    XDLSSerializableBase.IXDLSSerializable.XDLSHolder
    XDLSSerializableBase.RestoreReference(String, Int32)
    XDLSSerializableBase.XDLSHolder
    Namespace: Syncfusion.DocIO.DLS
    Assembly: Syncfusion.DocIO.UWP.dll
    Syntax
    public class WMergeField : WField, IXDLSSerializable, IWidget, IOfficeRun, 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
    WField.EntityType

    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
    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
    WField.CloneImpl()

    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
    WField.ParseFieldCode(String)

    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
    WField.ReadXmlAttributes(IXDLSAttributeReader)

    UpdateFieldCode(String)

    updates field code

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

    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
    WField.WriteXmlAttributes(IXDLSAttributeWriter)

    Implements

    IXDLSSerializable
    IOfficeRun
    IWMergeField
    IWField
    IWTextRange
    IParagraphItem
    IEntity

    Extension Methods

    DateTimeExtension.ToDateTime(Object)
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved