WordSettings

Settings for Word. Values fall back through three levels: document → SDK → built-in default. Writes target the document only when set on a document’s settings, otherwise the SDK globally when set on SdkSettings.

Tags: Format

from nutrient_sdk import WordSettings

Construction

# Per-document override
with Document.open("input.pdf") as doc:
    settings = doc.settings.word_settings
    settings.some_field = new_value          # mutate fields directly

# SDK-wide default (applies to all documents)
SdkSettings.word_settings.some_field = new_value

Settings are configured by writing to fields on the returned object. The settings property itself cannot be reassigned — doc.settings.word_settings = other_settings is rejected.

Properties

bookmark_source

@property
def bookmark_source(self) -> DocumentBookmarkSource

@bookmark_source.setter
def bookmark_source(self, value: DocumentBookmarkSource) -> None

The boorkmark source for Word documents.

Type: DocumentBookmarkSource

Default: DocumentBookmarkSource.Headings

half_transparent_header_footer

@property
def half_transparent_header_footer(self) -> bool

@half_transparent_header_footer.setter
def half_transparent_header_footer(self, value: bool) -> None

Flag indicating if header/footer content should be rendered with half-transparency.

Type: bool

Default: false

markup_mode

@property
def markup_mode(self) -> DocumentMarkupMode

@markup_mode.setter
def markup_mode(self, value: DocumentMarkupMode) -> None

The markup mode for Word documents.

Type: DocumentMarkupMode

Default: DocumentMarkupMode.AllMarkup