Fields in ASP.NET MVC DOCX Editor

27 Aug 20261 minute to read

ASP.NET MVC DOCX Editor (Document Editor) has preservation support for all types of fields in an existing Word document without any data loss.

Adding Fields

You can add a field to the document by using the insertField method in the Editor module.

var fieldCode = 'MERGEFIELD  First Name  \\* MERGEFORMAT ';
var fieldResult = '«First Name»';
documenteditor.editor.insertField(fieldCode, fieldResult);

DOCX Editor does not validate or process the field code or field result. It simply inserts the field with the specified field information.

Update fields

DOCX Editor provides support for updating bookmark cross reference fields.

//Update all the bookmark cross reference fields in the document.
documenteditor.updateFields();

Bookmark cross reference fields can be updated through the UI by using the update fields option in Toolbar.

Update bookmark cross reference fields.

The following types of fields are automatically updated in DOCX Editor.

  • NUMPAGES
  • SECTION
  • PAGE

Get field info

You can get the field code and field result of the currently selected field by using the getFieldInfo method in the Selection module.

//Gets the field information of the selected field.
var fieldInfo = documenteditor.selection.getFieldInfo();

For nested fields, this method returns the combined field code and result.

Set field info

You can modify the field code and field result of the currently selected field by using the setFieldInfo method in the Editor module.

//Get the field information for the selected field.
var fieldInfo = documenteditor.selection.getFieldInfo();

//Modify field code
fieldInfo.code = 'MERGEFIELD  First Name  \\* MERGEFORMAT ';

//Modify field result
fieldInfo.result = '«First Name»';

//Modify field code and result of the currently selected field.
documenteditor.editor.setFieldInfo(fieldInfo);

For a nested field, the entire field is replaced completely with the specified field information.

See Also

Mail merge using DocIO
Mail merge demo