Edit and Update Form Fields Leave feedback

Create Load Options
Initialize the WordProcessingLoadOptions for loading the document. If your document is password-protected, specify the password. In this example, the document is unprotected, so the password will be ignored.
```
WordProcessingLoadOptions loadOptions = new WordProcessingLoadOptions();
loadOptions.Password = "some_password_to_open_a_document";
```
Load the Document into the Editor Instance
Use the Editor class to load the document with the specified load options.
```
using (Editor editor = new Editor(fs, loadOptions))
{
    // Further code will be placed here
}
```

Retrieve and Update Form Fields

Obtain the FormFieldManager instance from the Editor and read the FormFieldCollection. Update a specific text form field by modifying its properties and then call the UpdateFormFiled method to apply the changes.

FormFieldManager fieldManager = editor.FormFieldManager;
FormFieldCollection collection = fieldManager.FormFieldCollection;

TextFormField textField = collection.GetFormField<TextFormField>("Text1");
textField.LocaleId = 1029;
textField.Value = "new Value";
fieldManager.UpdateFormFiled(collection);

Create and Set Save Options

Initialize the WordProcessingSaveOptions with the desired format. Optimize memory usage if necessary, and protect the document from writing with a password.

WordProcessingFormats docFormat = WordProcessingFormats.Docx;
WordProcessingSaveOptions saveOptions = new WordProcessingSaveOptions(docFormat);
saveOptions.OptimizeMemoryUsage = true;
saveOptions.Protection = new WordProcessingProtection(WordProcessingProtectionType.AllowOnlyFormFields, "write_password");

Save the Document

Prepare a stream for saving and use the Save method of the Editor to save the updated document.

using (MemoryStream outputStream = new MemoryStream())
{
    editor.Save(outputStream, saveOptions);
}

Completion Message
Print a confirmation message to indicate the successful completion of the operation.
```
System.Console.WriteLine("EditFormFieldCollection routine has successfully finished");
```

Complete Example Code

Below is the complete example code demonstrating the entire process:

/// <summary>
/// This example demonstrates how to edit form fields in a Word document using GroupDocs.Editor for .NET.
/// </summary>
internal static class EditFormFieldCollection
{
    /// <summary>
    /// Runs the example to demonstrate loading, editing, and saving form fields in a document.
    /// </summary>
    internal static void Run()
    {
        // 1. Get a path to the input file (or stream with file content).
        // In this case, it is a sample DOCX with form fields.
        string inputFilePath = Constants.SampleLegacyFormFields_docx;

        // 2. Create a stream from this path
        using (FileStream fs = File.OpenRead(inputFilePath))
        {
            // 3. Create load options for this document
            WordProcessingLoadOptions loadOptions = new WordProcessingLoadOptions();
            // 3.1. If the input document is password-protected, specify the password for its opening...
            loadOptions.Password = "some_password_to_open_a_document";
            // 3.2. ...but, because the document is unprotected, this password will be ignored

            // 4. Load the document with options into the Editor instance
            using (Editor editor = new Editor(fs, loadOptions))
            {
                // 4.1. Read the FormFieldManager instance
                FormFieldManager fieldManager = editor.FormFieldManager;
                // 4.2. Read the FormFieldCollection in the document
                FormFieldCollection collection = fieldManager.FormFieldCollection;

                // 4.3. Update a specific text form field
                TextFormField textField = collection.GetFormField<TextFormField>("Text1");
                textField.LocaleId = 1029;
                textField.Value = "new Value";
                fieldManager.UpdateFormFiled(collection);

                // 5. Create document save options
                WordProcessingFormats docFormat = WordProcessingFormats.Docx;
                WordProcessingSaveOptions saveOptions = new WordProcessingSaveOptions(docFormat);

                // 5.1. If the document is large and causes OutOfMemoryException, set the memory optimization option
                saveOptions.OptimizeMemoryUsage = true;

                // 5.2. Protect the document from writing (allow only form fields) with a password
                saveOptions.Protection = new WordProcessingProtection(WordProcessingProtectionType.AllowOnlyFormFields, "write_password");

                // 6. Save the document
                // 6.1. Prepare a stream for saving
                using (MemoryStream outputStream = new MemoryStream())
                {
                    // 6.2. Save the document
                    editor.Save(outputStream, saveOptions);
                }
            }
        }
        System.Console.WriteLine("EditFormFieldCollection routine has successfully finished");
    }
}

We value your opinion. Your feedback will help us improve our documentation.

Edit and Update Form Fields Leave feedback

On this page

Step-by-Step Guide

Complete Example Code

Was this page helpful?

Any additional feedback you'd like to share with us?

Please tell us how we can improve this page.

Thank you for your feedback!

On this page