WordEditor

Provides specialized editing capabilities for Word documents. Supports template-based document generation and manipulation of OpenXML Word documents.

from nutrient_sdk import WordEditor

Construction

WordEditor cannot be instantiated directly. Obtain instances through static factory methods or via other SDK classes.

@classmethod
def edit(cls, document: Document) -> WordEditor

Creates a new WordEditor instance and begins editing the specified document.

Parameters:

Name	Type	Description
`document`	`Document`	The document to edit.

Returns: WordEditor - A new WordEditor instance for editing the document.

def apply_template_model(self, json_template: str) -> None

Applies a template model to the Word document from a JSON string.

Parameters:

Name	Type	Description
`json_template`	`str`	The JSON string containing the template model data.

def close(self) -> None

Closes the editor and releases all associated resources.

def save(self) -> None

Saves the current changes made in the editor.

def save_as(self, path: str) -> None

Saves the current changes to a file at the specified path.

Parameters:

Name	Type	Description
`path`	`str`	The file path where the document will be saved.

def save_with_model_as(self, path: str) -> None

Saves the Word document with the applied template model to a file.

Parameters:

Name	Type	Description
`path`	`str`	The file path where the processed document will be saved.

WordEditor supports the context manager protocol. Use with to ensure native resources are released automatically:

with WordEditor.edit(...) as word_editor:
    # ... use word_editor ...
    pass  # closed automatically on exit

Or close explicitly:

word_editor = WordEditor.edit(...)
try:
    # ... use word_editor ...
    pass
finally:
    word_editor.close()