OpenSettings

Settings for Open. 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: Document

from nutrient_sdk import OpenSettings

Construction

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

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

Properties

document_format

@property
def document_format(self) -> DocumentFormat

@document_format.setter
def document_format(self, value: DocumentFormat) -> None

The expected document format.

Type: DocumentFormat

Default: GdPicture14.DocumentFormat.DocumentFormatUNKNOWN

implicit_conversion

@property
def implicit_conversion(self) -> ImplicitConversion

@implicit_conversion.setter
def implicit_conversion(self, value: ImplicitConversion) -> None

Whether implicit conversion is enabled when opening documents in editors. When enabled, documents will be automatically converted to a compatible format for editing.

Type: ImplicitConversion

Default: ImplicitConversion.Enabled

max_pages

@property
def max_pages(self) -> int

@max_pages.setter
def max_pages(self, value: int) -> None

The maximum number of pages to load from the document.

Type: int

Default: 0

mode

@property
def mode(self) -> OpenSettingsMode

@mode.setter
def mode(self, value: OpenSettingsMode) -> None

The operational mode for opening the document.

Type: OpenSettingsMode

Default: OpenSettingsMode.Unspecified

page_cache_mode

@property
def page_cache_mode(self) -> PageCacheMode

@page_cache_mode.setter
def page_cache_mode(self, value: PageCacheMode) -> None

The page caching mode for the document.

Type: PageCacheMode

Default: PageCacheMode.Memory