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

Class Methods

edit

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

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

Parameters:

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

Methods

apply_template_model

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

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

Parameters:

close

def close(self) -> None

Closes the current document’s editing context without disposing the editor. The editor remains available for another editing operation.

save

def save(self) -> None

Saves the current changes made in the editor.

save_as

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

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

Parameters:

save_with_model_as

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

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

Parameters:

Context manager

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  # released automatically on exit

Or manage it explicitly. Closing the document and releasing the object are two different operations:

word_editor = WordEditor.edit(...)
try:
    # ... use word_editor ...
    word_editor.close()    # close the document; the object stays usable
finally:
    word_editor.dispose()  # close it and release the native handle

close() closes the document currently being edited and leaves this object usable: call edit() again to edit another document. It does not release the native handle.

dispose() ends this object’s life. It closes the document first — that is what hands ownership of a converted document back to the SDK — and then releases the handle. Leaving a with block does the same. Calling it more than once has no effect.

An object that is never disposed has its handle reclaimed when it is garbage collected, but that is a safety net rather than a substitute: it releases the handle without closing the document, and finalization runs at an unpredictable time.