TextSettings

Settings for Text. 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 TextSettings

Construction

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

# SDK-wide default (applies to all documents)
SdkSettings.text_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.text_settings = other_settings is rejected.

Properties

emit_page_boundary_markers

@property
def emit_page_boundary_markers(self) -> bool

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

When enabled, the layout-preserving text converter emits a unique HTML-comment marker at the start of every page (<!-- nutrient-page-start: N -->, where N is the 1-indexed physical page number), so downstream tooling can slice the text reliably back into per-page chunks. The same marker format the Markdown exporter uses, so consumers can treat both identically.

Type: bool

Default: false