9779 lines
524 KiB
XML
9779 lines
524 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>NativeSDK.Settings</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Nutrient.NativeSDK.API.SettingsAttribute">
|
|
<summary>
|
|
Marks a class as a settings container, indicating that it holds configuration or preference data.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.SettingsTag">
|
|
<summary>
|
|
Tags that can be applied to settings classes for categorization and filtering.
|
|
|
|
<para>
|
|
<b>Order in the API reference.</b> When a settings class has multiple tags,
|
|
the tag extractor walks this enum in declaration order and emits each tag
|
|
that is set. That declaration order is the order the tags appear in the API
|
|
reference breadcrumb — e.g. <c>[SettingsTags(Vision | Advanced)]</c> renders
|
|
as <c>Vision/Advanced</c>, not alphabetically and not by numeric value.
|
|
</para>
|
|
<para>
|
|
To change how a class is sorted in the docs, change the order of values in
|
|
this enum, not the order of operands at the call site (the bitwise OR
|
|
doesn't preserve operand order). New categorical tags go between
|
|
<see cref="F:Nutrient.NativeSDK.API.SettingsTag.Document"/> and <see cref="F:Nutrient.NativeSDK.API.SettingsTag.Format"/>. The high bit
|
|
(<see cref="F:Nutrient.NativeSDK.API.SettingsTag.Advanced"/>) is reserved as a meta-tag and always emits last.
|
|
</para>
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.SettingsTag.None">
|
|
<summary>No tags.</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.SettingsTag.Document">
|
|
<summary>Document-level settings (open, conversion, lifecycle).</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.SettingsTag.Vision">
|
|
<summary>Vision and AI-related settings (OCR, classification, recognition).</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.SettingsTag.Development">
|
|
<summary>Development-only settings (not for production use).</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.SettingsTag.Format">
|
|
<summary>File-format settings (per-output-type configuration).</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.SettingsTag.Advanced">
|
|
<summary>
|
|
Marks the settings class as advanced — not part of the everyday surface.
|
|
Reserved as the top bit so it always emits last in extraction
|
|
(e.g. <c>[SettingsTags(Vision | Advanced)]</c> renders as <c>Vision/Advanced</c>).
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.SettingsTagsAttribute">
|
|
<summary>
|
|
Applies tags to a settings class for categorization and filtering.
|
|
|
|
<para>
|
|
Conditional on <c>DATA_EXTRACTION</c> so the attribute application is
|
|
stripped from customer builds (no trace in IL or via reflection). Only the
|
|
codegen pipeline — which compiles with <c>DATA_EXTRACTION</c> defined —
|
|
sees the applied tags. The Roslyn source generators read tags from the
|
|
source syntax tree, not from IL metadata, so they continue to work.
|
|
</para>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.SettingsTagsAttribute.Tags">
|
|
<summary>
|
|
The tags applied to the settings class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.SettingsTagsAttribute.#ctor(Nutrient.NativeSDK.API.SettingsTag)">
|
|
<summary>
|
|
Initializes a new instance with the specified tags.
|
|
</summary>
|
|
<param name="tags">The tags to apply.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.DevelopmentAttribute">
|
|
<summary>
|
|
Marks a settings class as development-only.
|
|
Classes with this attribute will not have generated settings code (SDK/Document overrides, registry entries).
|
|
The class itself remains in the assembly for development tools, but is not discoverable at runtime.
|
|
This attribute is conditional on NATIVE_SDK_DEACTIVATE_DEVELOPMENT_FEATURES (defined in non-Debug builds).
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.SettingsPropertyTag">
|
|
<summary>
|
|
Per-property metadata tags. Used by <see cref="T:Nutrient.NativeSDK.API.SettingsPropertyAttribute"/>
|
|
to flow per-property metadata into the API reference and the JSON schema
|
|
generator. Each set flag is re-emitted as a <c>NativeSDKDocPropertyTag</c>
|
|
on the generated merged-view accessor — consumed downstream by the docs
|
|
pipeline and the schema generator. No compiler/IDE attributes are emitted.
|
|
|
|
<para>
|
|
<b>Order in the API reference.</b> Same contract as <see cref="T:Nutrient.NativeSDK.API.SettingsTag"/>:
|
|
the extractor walks this enum in declaration order and emits each tag that
|
|
is set. <see cref="F:Nutrient.NativeSDK.API.SettingsPropertyTag.Advanced"/> is reserved as the top bit so it always
|
|
emits last.
|
|
</para>
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.SettingsPropertyTag.None">
|
|
<summary>No tags.</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.SettingsPropertyTag.Optional">
|
|
<summary>
|
|
The property has a sensible default and most callers won't need to set it.
|
|
Display hint only — does not affect codegen. The API reference may render
|
|
optional properties in a separate / collapsible section.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.SettingsPropertyTag.Deprecated">
|
|
<summary>
|
|
The property is deprecated and should not be used in new code. Surfaced
|
|
to the API reference as a <c>Deprecated</c> doc tag. No compiler warning
|
|
is generated.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.SettingsPropertyTag.Replaced">
|
|
<summary>
|
|
The property has been replaced by another. Must be combined with
|
|
<see cref="P:Nutrient.NativeSDK.API.SettingsPropertyAttribute.ReplacedBy"/>. Surfaced to the API
|
|
reference as a <c>Replaced</c> doc tag carrying the replacement name,
|
|
and emitted as <c>replacedBy</c> in the generated JSON schema. No
|
|
compiler warning is generated.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.SettingsPropertyTag.Hidden">
|
|
<summary>
|
|
The property is omitted from the API reference and from the generated
|
|
JSON schema, but remains runtime-functional and IDE-visible. Useful for
|
|
internal diagnostic toggles or staging properties not yet ready for
|
|
public documentation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.SettingsPropertyTag.Advanced">
|
|
<summary>
|
|
Marks the property as advanced — not part of the everyday surface.
|
|
Reserved as the top bit so it always emits last in extraction
|
|
(e.g. <c>[SettingsProperty(Optional | Advanced)]</c> renders as
|
|
<c>Optional/Advanced</c>).
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.SettingsPropertyAttribute">
|
|
<summary>
|
|
Applies documentation metadata to a single property of a settings class.
|
|
The set tags flow into the API reference (Advanced/Optional/Deprecated/
|
|
Replaced buckets) and the JSON schema (Hidden suppresses the entry,
|
|
Replaced emits <c>replacedBy</c>). No compiler or IDE attributes are
|
|
generated — IntelliSense and IL stay unchanged.
|
|
|
|
<para>
|
|
When <see cref="P:Nutrient.NativeSDK.API.SettingsPropertyAttribute.Tags"/> includes <see cref="F:Nutrient.NativeSDK.API.SettingsPropertyTag.Replaced"/>,
|
|
the <see cref="P:Nutrient.NativeSDK.API.SettingsPropertyAttribute.ReplacedBy"/> property must be set to the replacement
|
|
property's name (use <c>nameof(...)</c>). The Roslyn analyzer flags missing
|
|
<see cref="P:Nutrient.NativeSDK.API.SettingsPropertyAttribute.ReplacedBy"/> at edit time.
|
|
</para>
|
|
|
|
<para>
|
|
Conditional on <c>DATA_EXTRACTION</c> so the attribute application is
|
|
stripped from customer builds (no trace in IL or via reflection), matching
|
|
<see cref="T:Nutrient.NativeSDK.API.SettingsTagsAttribute"/> and the other DataExtractor attributes.
|
|
The metadata is re-emitted by the settings source generator as
|
|
<c>NativeSDKDocPropertyTag</c> attributes on the merged-view accessor,
|
|
which is the form the docs/schema pipelines consume.
|
|
</para>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.SettingsPropertyAttribute.Tags">
|
|
<summary>The tags applied to the property.</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.SettingsPropertyAttribute.ReplacedBy">
|
|
<summary>
|
|
The name of the property that replaces this one. Required when
|
|
<see cref="F:Nutrient.NativeSDK.API.SettingsPropertyTag.Replaced"/> is set; ignored otherwise.
|
|
Prefer <c>nameof(NewName)</c> over a string literal so renames stay in sync.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.SettingsPropertyAttribute.#ctor(Nutrient.NativeSDK.API.SettingsPropertyTag)">
|
|
<summary>Initializes a new instance with the specified tags.</summary>
|
|
<param name="tags">The tags to apply.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.TypeHint">
|
|
<summary>
|
|
Specifies the semantic type of a string property for UI editor selection.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.TypeHint.Default">
|
|
<summary>Plain text - single-line text box (default for strings).</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.TypeHint.FilePath">
|
|
<summary>File path - text box with browse button.</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.TypeHint.FolderPath">
|
|
<summary>Folder path - text box with browse button.</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.TypeHint.MultilineText">
|
|
<summary>Multi-line text - text area with multiple lines.</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.TypeHintAttribute">
|
|
<summary>
|
|
Specifies the semantic type of a string property for UI editor selection.
|
|
Apply to string properties to indicate file paths, folder paths, or multi-line text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.TypeHintAttribute.Hint">
|
|
<summary>The semantic type hint.</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.TypeHintAttribute.Filter">
|
|
<summary>Optional file filter for FilePath hint (e.g., "PDF Files|*.pdf").</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.TypeHintAttribute.#ctor(Nutrient.NativeSDK.API.TypeHint)">
|
|
<summary>
|
|
Creates a new TypeHintAttribute with the specified hint.
|
|
</summary>
|
|
<param name="hint">The semantic type hint.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Types.Color">
|
|
<summary>
|
|
Represents a color in ARGB format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Types.Color.A">
|
|
<summary>
|
|
Alpha component (0-255).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Types.Color.R">
|
|
<summary>
|
|
Red component (0-255).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Types.Color.G">
|
|
<summary>
|
|
Green component (0-255).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Types.Color.B">
|
|
<summary>
|
|
Blue component (0-255).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Types.Color.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the Color class with default values (transparent black).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Types.Color.#ctor(System.Byte,System.Byte,System.Byte,System.Byte)">
|
|
<summary>
|
|
Initializes a new instance of the Color class.
|
|
</summary>
|
|
<param name="alpha">Alpha component (0-255).</param>
|
|
<param name="red">Red component (0-255).</param>
|
|
<param name="green">Green component (0-255).</param>
|
|
<param name="blue">Blue component (0-255).</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Types.Color.FromArgb(System.Int32,System.Int32,System.Int32,System.Int32)">
|
|
<summary>
|
|
Creates a Color from ARGB components.
|
|
</summary>
|
|
<param name="alpha">Alpha component (0-255).</param>
|
|
<param name="red">Red component (0-255).</param>
|
|
<param name="green">Green component (0-255).</param>
|
|
<param name="blue">Blue component (0-255).</param>
|
|
<returns>A new Color instance.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Types.Color.op_Implicit(GdPicture14.Imaging.GdPictureColor)~Nutrient.NativeSDK.API.Types.Color">
|
|
<summary>
|
|
Implicitly converts a GdPictureColor to a Color.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Types.Color.op_Implicit(Nutrient.NativeSDK.API.Types.Color)~GdPicture14.Imaging.GdPictureColor">
|
|
<summary>
|
|
Implicitly converts a Color to a GdPictureColor.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Types.Color.Transparent">
|
|
<summary>
|
|
Transparent color (ARGB: 0, 0, 0, 0).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Types.Color.Black">
|
|
<summary>
|
|
Black color (ARGB: 255, 0, 0, 0).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Types.Color.Silver">
|
|
<summary>
|
|
Silver color (ARGB: 255, 192, 192, 192).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Types.Color.Gray">
|
|
<summary>
|
|
Gray color (ARGB: 255, 128, 128, 128).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Types.Color.White">
|
|
<summary>
|
|
White color (ARGB: 255, 255, 255, 255).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Types.Color.Maroon">
|
|
<summary>
|
|
Maroon color (ARGB: 255, 128, 0, 0).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Types.Color.Red">
|
|
<summary>
|
|
Red color (ARGB: 255, 255, 0, 0).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Types.Color.Purple">
|
|
<summary>
|
|
Purple color (ARGB: 255, 128, 0, 128).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Types.Color.Fuchsia">
|
|
<summary>
|
|
Fuchsia color (ARGB: 255, 255, 0, 255).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Types.Color.Green">
|
|
<summary>
|
|
Green color (ARGB: 255, 0, 255, 0).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Types.Color.Lime">
|
|
<summary>
|
|
Lime color (ARGB: 255, 0, 128, 0).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Types.Color.Olive">
|
|
<summary>
|
|
Olive color (ARGB: 255, 128, 128, 0).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Types.Color.Yellow">
|
|
<summary>
|
|
Yellow color (ARGB: 255, 255, 255, 0).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Types.Color.Navy">
|
|
<summary>
|
|
Navy color (ARGB: 255, 0, 0, 128).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Types.Color.Blue">
|
|
<summary>
|
|
Blue color (ARGB: 255, 0, 0, 255).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Types.Color.Teal">
|
|
<summary>
|
|
Teal color (ARGB: 255, 0, 128, 128).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Types.Color.Aqua">
|
|
<summary>
|
|
Aqua color (ARGB: 255, 0, 255, 255).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Types.Color.ToString">
|
|
<summary>
|
|
Returns a string representation of the color in "A, R, G, B" format.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Interfaces.ISdkSettings">
|
|
<summary>
|
|
Provides functionality for managing SDK settings, including loading and exporting configuration.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Interfaces.ISdkSettings.Get``1">
|
|
<summary>
|
|
Retrieves a specific setting by its type.
|
|
</summary>
|
|
<typeparam name="T">The type of setting to retrieve.</typeparam>
|
|
<returns>The requested setting instance.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Interfaces.ISdkSettings.Load(System.IO.Stream)">
|
|
<summary>
|
|
Loads settings from a JSON stream.
|
|
</summary>
|
|
<param name="stream">The stream containing JSON-formatted settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Interfaces.ISdkSettings.Load(System.String)">
|
|
<summary>
|
|
Loads settings from a JSON file.
|
|
</summary>
|
|
<param name="path">The file path to the JSON settings file.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Interfaces.ISdkSettings.Export(System.IO.Stream)">
|
|
<summary>
|
|
Exports the current settings to a JSON stream.
|
|
</summary>
|
|
<param name="stream">The stream to write the JSON-formatted settings to.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Interfaces.ISdkSettings.Export(System.String)">
|
|
<summary>
|
|
Exports the current settings to a JSON file.
|
|
</summary>
|
|
<param name="path">The file path where the JSON settings will be saved.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.OcrLanguages">
|
|
<summary>
|
|
Supported OCR languages (Tesseract language codes).
|
|
Used for warmup resource resolution.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OcrLanguages.GetSupportedLanguages">
|
|
<summary>
|
|
Gets all supported OCR language codes.
|
|
Each code corresponds to a {code}.traineddata file.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.ImageClassificationSettings">
|
|
<summary>
|
|
SDK-level default settings for ONNX-based image classifier.
|
|
Controls the execution of ONNX Runtime inference for image classifier.
|
|
Model paths are resolved through the ResourceDownloader service.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.InferenceEquationSettings">
|
|
<summary>
|
|
SDK-level default settings for ONNX-based formula recognizer.
|
|
Controls the execution of ONNX Runtime inference for formula recognizer.
|
|
Model paths are resolved through the ResourceDownloader service.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.InferenceKVRSettings">
|
|
<summary>
|
|
SDK-level default settings for ONNX-based key-value-region recognizer.
|
|
Controls the execution of ONNX Runtime inference for key-value-region recognizer.
|
|
Model paths are resolved through the ResourceDownloader service.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.PPTextDetSettings">
|
|
<summary>
|
|
SDK-level default settings for ONNX-based text detection.
|
|
Controls the execution of ONNX Runtime inference for text detection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PPTextDetSettings.ModelPath">
|
|
<summary>
|
|
Path to the ONNX model file (model.onnx).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PPTextDetSettings.LimitSideLength">
|
|
<summary>
|
|
Limit value for resizing, PaddleOCR runtime uses limit_side_len=64, limit_type='min' for better quality
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PPTextDetSettings.LimitType">
|
|
<summary>
|
|
'max' to limit longest side, 'min' to limit shortest side
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PPTextDetSettings.Threshold">
|
|
<summary>
|
|
Binarization threshold for probability map
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PPTextDetSettings.BoxThreshold">
|
|
<summary>
|
|
Threshold for box confidence
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PPTextDetSettings.MaxCandidates">
|
|
<summary>
|
|
Maximum number of text boxes to detect
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PPTextDetSettings.UnclipRatio">
|
|
<summary>
|
|
Ratio for polygon expansion (Official PaddleOCR uses 1.5)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PPTextDetSettings.UseCpuOnly">
|
|
<summary>
|
|
Enable CPU mode for ONNX Runtime.
|
|
When true, forces CPU execution. When false, uses default providers.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.PPTextRecSettings">
|
|
<summary>
|
|
SDK-level default settings for ONNX-based text recognition.
|
|
Controls the execution of ONNX Runtime inference for text recognition.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PPTextRecSettings.ModelPath">
|
|
<summary>
|
|
Path to the ONNX model file (model.onnx).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PPTextRecSettings.ConfigPath">
|
|
<summary>
|
|
Path to the model configuration file (model.yml).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PPTextRecSettings.MaxImageWidth">
|
|
<summary>
|
|
Maximum width for text images
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PPTextRecSettings.BatchSize">
|
|
<summary>
|
|
Batch size for text recognition inference.
|
|
Higher values improve throughput but require more memory.
|
|
Set to 1 to disable batching (process one image at a time).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PPTextRecSettings.UseCpuOnly">
|
|
<summary>
|
|
Enable CPU mode for ONNX Runtime.
|
|
When true, forces CPU execution. When false, uses default providers.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.PythonSegmenterSettings">
|
|
<summary>
|
|
SDK-level default settings for Python-based document segmentation.
|
|
Controls the execution of the external Python segmentation script.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PythonSegmenterSettings.VenvPath">
|
|
<summary>
|
|
Path to the Python virtual environment directory.
|
|
The Python executable will be constructed from this path based on platform.
|
|
Can be overridden via NATIVESDK_PYTHON_VENV environment variable.
|
|
</summary>
|
|
<value>The default value points to the ensemble-layout-segmentation venv.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PythonSegmenterSettings.SegmenterScriptPath">
|
|
<summary>
|
|
Path to the Python segmentation script (segment.py).
|
|
Can be overridden via NATIVESDK_PYTHON_SEGMENTER_SCRIPT environment variable.
|
|
</summary>
|
|
<value>The default value points to the segment.py in ensemble-layout-segmentation.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.TestArraySettings">
|
|
<summary>
|
|
Temporary test settings class for verifying primitive-array bridge marshalling (NAT-107).
|
|
Remove the whole class once NAT-475 (ImageSettings.PageIndices) lands on master.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.TestArraySettings.Indices">
|
|
<summary>
|
|
A list of integer indices used to exercise the int[] ctypes bridge path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.TestArraySettings.Weights">
|
|
<summary>
|
|
A list of float values used to exercise the float[] ctypes bridge path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.TestArraySettings.Tags">
|
|
<summary>
|
|
A list of string tags used to exercise the string[] ctypes bridge path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.TestArraySettings.Modes">
|
|
<summary>
|
|
A list of enum values used to exercise the enum[] ctypes bridge path.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.ConversionSettings">
|
|
<summary>
|
|
SDK-level default settings for document conversion operations.
|
|
Controls timeout and other conversion-related settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ConversionSettings.Mode">
|
|
<summary>
|
|
The internal mode options for conversion.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ConversionSettings.TimeoutMilliseconds">
|
|
<summary>
|
|
The conversion timeout in milliseconds.
|
|
After this time, the conversion will be aborted and return a TimeoutException.
|
|
</summary>
|
|
<value>The default value is -1, which means no timeout.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.OpenSettings">
|
|
<summary>
|
|
SDK-level default settings for opening documents.
|
|
Controls various aspects of how documents are loaded and cached.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenSettings.PageCacheMode">
|
|
<summary>
|
|
The page caching mode for the document.
|
|
</summary>
|
|
<value>The default value is <see cref="F:GdPicture14.PageCacheMode.Memory"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenSettings.Mode">
|
|
<summary>
|
|
The operational mode for opening the document.
|
|
</summary>
|
|
<value>The default value is <see cref="F:Nutrient.NativeSDK.API.Settings.OpenSettingsMode.Unspecified"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenSettings.DocumentFormat">
|
|
<summary>
|
|
The expected document format.
|
|
</summary>
|
|
<value>The default value is <see cref="F:GdPicture14.DocumentFormat.DocumentFormatUNKNOWN"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenSettings.MaxPages">
|
|
<summary>
|
|
The maximum number of pages to load from the document.
|
|
</summary>
|
|
<value>The default value is 0, which means all pages will be loaded.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenSettings.ImplicitConversion">
|
|
<summary>
|
|
Whether implicit conversion is enabled when opening documents in editors.
|
|
When enabled, documents will be automatically converted to a compatible format for editing.
|
|
</summary>
|
|
<value>The default value is <see cref="F:Nutrient.NativeSDK.API.Settings.ImplicitConversion.Enabled"/>.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.CadSettings">
|
|
<summary>
|
|
SDK-level default settings for saving CAD (Computer-Aided Design) documents.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.CadSettings.EnableLineWeight">
|
|
<summary>
|
|
This flags controls the support of line weight.
|
|
It is the same command option as AutoCad "Lineweight".
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.CadSettings.CanvasBackgroundColor">
|
|
<summary>
|
|
The canvas background color.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.CadSettings.RenderingLayoutMode">
|
|
<summary>
|
|
The rendering layout mode that determines how the canvas size and rendering origin are computed.
|
|
</summary>
|
|
<value>The default value is <see cref="F:Nutrient.NativeSDK.API.Settings.RenderingLayoutMode.ZoomExtents"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.CadSettings.ThumbnailMode">
|
|
<summary>
|
|
Indicates whether thumbnail mode is enabled for CAD rendering.
|
|
</summary>
|
|
<value>The default value is false.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.CadSettings.UnitMode">
|
|
<summary>
|
|
The unit mode for measurement in CAD documents.
|
|
</summary>
|
|
<value>The default value is <see cref="F:GdPicture14.UnitMode.UnitPoint"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.CadSettings.RenderZoom">
|
|
<summary>
|
|
The zoom level for rendering CAD documents.
|
|
</summary>
|
|
<value>The default value is 0.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.EmailSettings">
|
|
<summary>
|
|
SDK-level default settings for email document conversion (EML and MSG).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.EmailSettings.Language">
|
|
<summary>
|
|
The preferred language for conversion, as a BCP 47 language tag (e.g. "fr-FR", "en-US").
|
|
Controls date/time formatting and label translations in the converted document.
|
|
</summary>
|
|
<value>The default value is "en-US".</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.HtmlSettings">
|
|
<summary>
|
|
SDK-level default settings for saving HTML documents.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.HtmlSettings.Layout">
|
|
<summary>
|
|
The layout type to use when saving HTML documents.
|
|
</summary>
|
|
<value>The default value is <see cref="F:GdPicture14.HtmlLayoutType.PageLayout"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.HtmlSettings.ImageExport">
|
|
<summary>
|
|
Controls how images are exported when converting documents to HTML.
|
|
</summary>
|
|
<value>The default value is <see cref="F:Nutrient.NativeSDK.API.Settings.ImageExportMode.Embedded"/>.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.ImageSettings">
|
|
<summary>
|
|
SDK-level default settings for saving image documents.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ImageSettings.Mode">
|
|
<summary>
|
|
The mode options for image processing.
|
|
</summary>
|
|
<value>The default value is <see cref="F:Nutrient.NativeSDK.API.Settings.ImageSettingMode.FollowExifRotation"/> | <see cref="F:Nutrient.NativeSDK.API.Settings.ImageSettingMode.PreserveIccProfile"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ImageSettings.RasterizationDpi">
|
|
<summary>
|
|
The rasterization DPI for image rasterization.
|
|
</summary>
|
|
<value>The default value is 200.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ImageSettings.ExportFormat">
|
|
<summary>
|
|
The export format for the image.
|
|
</summary>
|
|
<value>The default value is <see cref="F:Nutrient.NativeSDK.API.Settings.ImageExportFormat.Auto"/>, which infers the format from the destination filename extension.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ImageSettings.JpegQuality">
|
|
<summary>
|
|
JPEG compression quality, in the 1..100 range. Only used when <see cref="P:Nutrient.NativeSDK.API.Settings.Default.ImageSettings.ExportFormat"/> resolves to <see cref="F:Nutrient.NativeSDK.API.Settings.ImageExportFormat.Jpeg"/>.
|
|
</summary>
|
|
<value>The default value is 90.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ImageSettings.PageIndex">
|
|
<summary>
|
|
Zero-based page index to render for single-page raster formats (PNG, JPEG, BMP).
|
|
</summary>
|
|
<remarks>
|
|
<para>When <c>null</c> (the default):</para>
|
|
<list type="bullet">
|
|
<item><description>Single-page documents render page 0.</description></item>
|
|
<item><description>Multi-page documents exported via the Stream API are rejected — use the filename-based API for numbered files.</description></item>
|
|
</list>
|
|
<para>The filename-based multi-page dispatch sets this per page during iteration. Ignored entirely for TIFF (which writes all pages to a single multi-page file regardless).</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.InstantJsonSettings">
|
|
<summary>
|
|
SDK-level default settings for Instant JSON import and export.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.InstantJsonSettings.RenderTheme">
|
|
<summary>
|
|
The annotation appearance theme to use when importing Instant JSON.
|
|
</summary>
|
|
<value>The default value is <see cref="F:Nutrient.NativeSDK.API.Settings.InstantJsonRenderTheme.Default"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.InstantJsonSettings.ChangeTrackingEnabled">
|
|
<summary>
|
|
Whether Instant JSON change tracking is enabled. When enabled, modifications
|
|
to annotations, form fields, form field values, comments, and bookmarks are recorded
|
|
so that export produces a diff containing only items that changed — matching
|
|
Core SDK's export_document_json behavior.
|
|
</summary>
|
|
<value>The default value is <c>true</c>.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.Jbig2Settings">
|
|
<summary>
|
|
SDK-level default settings for JBIG2 compression.
|
|
JBIG2 is a lossless and lossy compression standard for bi-level images.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.Jbig2Settings.Jbig2PmsThreshold">
|
|
<summary>
|
|
The threshold for Pattern Matching and Substitution (PMS) in JBIG2 compression.
|
|
Higher values result in more aggressive compression but may reduce quality.
|
|
</summary>
|
|
<value>The default value is 0.85. Valid range is 0.0 to 1.0.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.JpegSettings">
|
|
<summary>
|
|
SDK-level default settings for JPEG compression.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.JpegSettings.QualitySettings">
|
|
<summary>
|
|
The quality level for JPEG compression.
|
|
Higher values produce better quality but larger file sizes.
|
|
</summary>
|
|
<value>The default value is 75. Valid range is 0 to 100.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.MarkdownSettings">
|
|
<summary>
|
|
SDK-level default settings for Markdown export.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.MarkdownSettings.ImageExport">
|
|
<summary>
|
|
Controls how images are exported when converting documents to Markdown.
|
|
</summary>
|
|
<value>The default value is <see cref="F:Nutrient.NativeSDK.API.Settings.ImageExportMode.None"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.MarkdownSettings.EnableInlineFormatting">
|
|
<summary>
|
|
Controls whether inline text formatting (bold, italic) is preserved
|
|
in the Markdown output using standard markers (<c>**bold**</c>, <c>*italic*</c>).
|
|
</summary>
|
|
<value>The default value is <see langword="false"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.MarkdownSettings.EmitPageBoundaryMarkers">
|
|
<summary>
|
|
When enabled, the converter emits a unique HTML-comment marker at the
|
|
start of every page (<c><!-- nutrient-page-start: N --></c>,
|
|
where <c>N</c> is the 1-indexed physical page number). The markers
|
|
are invisible when the Markdown is rendered to HTML but allow
|
|
downstream tooling to slice the output reliably back into per-page
|
|
chunks.
|
|
</summary>
|
|
<value>The default value is <see langword="false"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.MarkdownSettings.EnableSemanticBlockFormatting">
|
|
<summary>
|
|
Controls whether footnotes and captions are rendered with semantic Markdown
|
|
markers (<c>> </c>, <c>*…*</c>) and whether pictures/charts are emitted at all
|
|
(<c>![alt]</c> / <c>[Figure]</c>). When <see langword="false"/>, footnotes and
|
|
captions render as plain paragraphs and pictures/charts are dropped entirely. List
|
|
items always render with <c>- </c> regardless.
|
|
</summary>
|
|
<value>The default value is <see langword="true"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.MarkdownSettings.IncludeHeadersAndFooters">
|
|
<summary>
|
|
Controls whether running headers and footers are included in the Markdown
|
|
output. When included, they render as plain text paragraphs.
|
|
</summary>
|
|
<value>The default value is <see langword="false"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.MarkdownSettings.ExtractWordsFromPictures">
|
|
<summary>
|
|
Controls whether words detected inside picture regions are emitted as plain text
|
|
in Markdown output. This helps preserve chart labels, axis text, legends, and
|
|
similar image-contained text when available.
|
|
</summary>
|
|
<value>The default value is <see langword="true"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.MarkdownSettings.UseHtmlTables">
|
|
<summary>
|
|
Controls how tables are rendered in the Markdown output. When enabled, tables
|
|
are emitted as HTML (<c><table>/<tr>/<td></c>) preserving
|
|
row/column spans where available; when disabled, tables render as pipe-style
|
|
Markdown.
|
|
</summary>
|
|
<value>The default value is <see langword="true"/>.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.PdfPageSettings">
|
|
<summary>
|
|
SDK-level default settings for PDF page configuration when saving documents.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PdfPageSettings.PageSize">
|
|
<summary>
|
|
The page size for PDF documents.
|
|
</summary>
|
|
<value>The default value is <see cref="F:GdPicture14.PdfPageSizes.PdfPageSizeA4"/>.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.PdfSettings">
|
|
<summary>
|
|
SDK-level default settings for saving PDF documents.
|
|
These settings can be modified and serve as defaults for all documents.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PdfSettings.Conformance">
|
|
<summary>
|
|
The PDF conformance level for the output document.
|
|
</summary>
|
|
<value>The default value is <see cref="F:GdPicture14.PdfConformance.PDF1_7"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PdfSettings.Mode">
|
|
<summary>
|
|
The mode options for PDF processing.
|
|
</summary>
|
|
<value>The default value is <see cref="F:Nutrient.NativeSDK.API.Settings.PdfSettingsMode.Unspecified"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PdfSettings.SavePreferences">
|
|
<summary>
|
|
Preferences for saving PDF documents.
|
|
</summary>
|
|
<value>The default value is <see cref="F:Nutrient.NativeSDK.API.Settings.PdfSavePreferences.None"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PdfSettings.BitonalImageCompression">
|
|
<summary>
|
|
The compression method to use for bitonal (black and white) images in PDF documents.
|
|
</summary>
|
|
<value>The default value is <see cref="F:GdPicture14.PdfCompression.PdfCompressionJBIG2"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PdfSettings.ColorImageCompression">
|
|
<summary>
|
|
The compression method to use for color images in PDF documents.
|
|
</summary>
|
|
<value>The default value is <see cref="F:GdPicture14.PdfCompression.PdfCompressionJPEG"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PdfSettings.EnableColorDetection">
|
|
<summary>
|
|
Indicates whether automatic color detection is enabled to determine if an image is bitonal or color.
|
|
</summary>
|
|
<value>The default value is false.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PdfSettings.UseDeflateOnJpeg">
|
|
<summary>
|
|
Indicates whether Deflate compression should be applied to JPEG images.
|
|
</summary>
|
|
<value>The default value is false.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PdfSettings.ZlibLevel">
|
|
<summary>
|
|
The compression level for Zlib/Deflate compression.
|
|
Higher values provide better compression but take longer to process.
|
|
</summary>
|
|
<value>The default value is 4. Valid range is 0 to 9.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PdfSettings.EnableLinearization">
|
|
<summary>
|
|
Indicates whether PDF linearization (fast web view) is enabled.
|
|
Linearized PDFs can be displayed page-by-page while still downloading.
|
|
</summary>
|
|
<value>The default value is false.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PdfSettings.Optimize">
|
|
<summary>
|
|
Indicates whether PDF optimization is enabled to reduce file size.
|
|
</summary>
|
|
<value>The default value is false.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.PdfSettings.ForceImageDpi">
|
|
<summary>
|
|
Forces all images in the PDF to a specific DPI (dots per inch) resolution.
|
|
A value of 0 means no DPI forcing is applied.
|
|
</summary>
|
|
<value>The default value is 0.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.PresentationSettings">
|
|
<summary>
|
|
SDK-level default settings for presentation documents.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.SpreadsheetSettings">
|
|
<summary>
|
|
SDK-level default settings for spreadsheet documents.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.SpreadsheetSettings.SplitSheetsIntoPages">
|
|
<summary>
|
|
Flag indicating if spreadsheet sheets should be split into multiple pages.
|
|
</summary>
|
|
<value>The default value is <see langword="false"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.SpreadsheetSettings.RenderSheetHeadersAndFooters">
|
|
<summary>
|
|
Flag indicating if sheet headers and footers should be rendered.
|
|
</summary>
|
|
<value>The default value is <see langword="false"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.SpreadsheetSettings.RenderOnlyPrintArea">
|
|
<summary>
|
|
Flag indicating if only the print area of spreadsheet sheets should be rendered.
|
|
If no print area is defined in the sheet, the entire sheet will be rendered.
|
|
</summary>
|
|
<value>The default value is <see langword="true"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.SpreadsheetSettings.HalfTransparentHeaderFooter">
|
|
<summary>
|
|
Flag indicating if header/footer content should be rendered with half-transparency.
|
|
</summary>
|
|
<value>The default value is <see langword="false"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.SpreadsheetSettings.PageHeightOverride">
|
|
<summary>
|
|
Override for the page height in millimeters. If not positive, the default page height is used.
|
|
</summary>
|
|
<value>The default value is 0 (use document default).</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.SpreadsheetSettings.PageWidthOverride">
|
|
<summary>
|
|
Override for the page width in millimeters. If not positive, the default page width is used.
|
|
</summary>
|
|
<value>The default value is 0 (use document default).</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.SpreadsheetSettings.LeftMarginOverride">
|
|
<summary>
|
|
Override for the left margin in millimeters. If negative, the default left margin is used.
|
|
</summary>
|
|
<value>The default value is -1 (use document default).</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.SpreadsheetSettings.TopMarginOverride">
|
|
<summary>
|
|
Override for the top margin in millimeters. If negative, the default top margin is used.
|
|
</summary>
|
|
<value>The default value is -1 (use document default).</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.SpreadsheetSettings.RightMarginOverride">
|
|
<summary>
|
|
Override for the right margin in millimeters. If negative, the default right margin is used.
|
|
</summary>
|
|
<value>The default value is -1 (use document default).</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.SpreadsheetSettings.BottomMarginOverride">
|
|
<summary>
|
|
Override for the bottom margin in millimeters. If negative, the default bottom margin is used.
|
|
</summary>
|
|
<value>The default value is -1 (use document default).</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.SpreadsheetSettings.MaximumContentWidthPerSheet">
|
|
<summary>
|
|
Maximum content width per sheet in millimeters. If 0, no limit is applied.
|
|
</summary>
|
|
<value>The default value is 0.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.SpreadsheetSettings.MaximumContentHeightPerSheet">
|
|
<summary>
|
|
Maximum content height per sheet in millimeters. If 0, no limit is applied.
|
|
</summary>
|
|
<value>The default value is 0.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.SpreadsheetSettings.MaximumPageWidth">
|
|
<summary>
|
|
Maximum page width in millimeters.
|
|
</summary>
|
|
<value>The default value is 1800.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.SpreadsheetSettings.MaximumPageHeight">
|
|
<summary>
|
|
Maximum page height in millimeters.
|
|
</summary>
|
|
<value>The default value is 2800.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.TiffSettings">
|
|
<summary>
|
|
SDK-level default settings specific to TIFF image format.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.TiffSettings.TiffCompression">
|
|
<summary>
|
|
The compression method to use for TIFF images.
|
|
</summary>
|
|
<value>The default value is <see cref="F:GdPicture14.TiffCompression.TiffCompressionAUTO"/>.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.WordSettings">
|
|
<summary>
|
|
SDK-level default settings for Word documents.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.WordSettings.MarkupMode">
|
|
<summary>
|
|
The markup mode for Word documents.
|
|
</summary>
|
|
<value>The default value is <see cref="F:GdPicture14.DocumentMarkupMode.AllMarkup"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.WordSettings.HalfTransparentHeaderFooter">
|
|
<summary>
|
|
Flag indicating if header/footer content should be rendered with half-transparency.
|
|
</summary>
|
|
<value>The default value is <see langword="false"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.WordSettings.BookmarkSource">
|
|
<summary>
|
|
The boorkmark source for Word documents.
|
|
</summary>
|
|
<value>The default value is <see cref="F:GdPicture14.DocumentBookmarkSource.Headings"/>.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.AiAugmenterSettings">
|
|
<summary>
|
|
SDK-level default settings for AI-based document augmentation.
|
|
Controls zone classification, language detection, and relationship analysis.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.AiAugmenterSettings.EnableVlmClassification">
|
|
<summary>
|
|
Enable or disable VLM-based classification.
|
|
When disabled, falls back to heuristic classification.
|
|
</summary>
|
|
<value>The default value is true.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.AiAugmenterSettings.EnableContentDescription">
|
|
<summary>
|
|
Enable content description extraction for each zone.
|
|
When enabled, the VLM will provide descriptions of zone content.
|
|
</summary>
|
|
<value>The default value is true.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.AiAugmenterSettings.ClassificationConfidence">
|
|
<summary>
|
|
Minimum confidence threshold for zone classification (0.0 - 1.0).
|
|
</summary>
|
|
<value>The default value is 0.7.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.AiAugmenterSettings.EnableLanguageDetection">
|
|
<summary>
|
|
Indicates whether language detection is enabled for text zones.
|
|
</summary>
|
|
<value>The default value is true.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.AiAugmenterSettings.EnableReadingOrder">
|
|
<summary>
|
|
Indicates whether reading order analysis is enabled.
|
|
</summary>
|
|
<value>The default value is true.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.AiAugmenterSettings.EnableRelationshipDetection">
|
|
<summary>
|
|
Indicates whether relationship detection between zones is enabled.
|
|
</summary>
|
|
<value>The default value is true.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.AiProcessingSettings">
|
|
<summary>
|
|
Daemon-level defaults for AI processing capacities (extraction, classification).
|
|
Per-request overrides on individual actions take precedence over these settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.AiProcessingSettings.Provider">
|
|
<summary>
|
|
Provider discriminator. One of <c>"openai"</c>, <c>"azure"</c>, or <c>"local"</c>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.AiProcessingSettings.Model">
|
|
<summary>
|
|
Model identifier (e.g. <c>"gpt-4o"</c>, an Azure deployment name, or a local model id).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.AiProcessingSettings.Endpoint">
|
|
<summary>
|
|
Endpoint URL for Azure or local providers. Ignored for the public OpenAI provider.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.AiProcessingSettings.ApiKey">
|
|
<summary>
|
|
API key for the configured provider.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.AiProcessingSettings.Temperature">
|
|
<summary>
|
|
Sampling temperature passed to the model. <see langword="null"/> uses the provider default.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.AiProcessingSettings.MaxAttempts">
|
|
<summary>
|
|
Maximum retry attempts on structured-output failure. <see langword="null"/> uses the
|
|
capacity default of <c>1</c>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.AiProcessingSettings.IncludeConfidence">
|
|
<summary>
|
|
Daemon-level default for whether AI processing capacities emit confidence output -
|
|
the <c>confidence.json</c> sidecar and the per-field confidence signals on
|
|
<c>result.json</c> metadata. Defaults to <see langword="false"/> (off); a per-request
|
|
<c>includeConfidence</c> action parameter overrides it.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.AiProcessingSettings.IncludeCompositeConfidence">
|
|
<summary>
|
|
Daemon-level default for whether the single rolled-up composite confidence number is
|
|
attached to <c>result.json</c> metadata leaves (the individual signals are surfaced
|
|
whenever <see cref="P:Nutrient.NativeSDK.API.Settings.Default.AiProcessingSettings.IncludeConfidence"/> is on; this controls only the composite).
|
|
Defaults to <see langword="false"/> (off); a per-request <c>includeCompositeConfidence</c>
|
|
action parameter overrides it.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.AiProcessingSettings.IncludeSourceLocations">
|
|
<summary>
|
|
Whether extraction grounds each extracted field back to its source location in the
|
|
document — the <c>metadata</c> node of <c>result.json</c> with per-field <c>match</c>
|
|
labels and source bounding boxes. Defaults to <see langword="true"/>. Turn off to cut
|
|
model token usage when only the extracted values matter: grounding mirrors the schema
|
|
in the structured-output request so the model also returns per-field source ids.
|
|
A per-request <c>includeSourceLocations</c> action parameter overrides it.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.AiProcessingSettings.StrictStructuredOutput">
|
|
<summary>
|
|
Opt-in (default <see langword="false"/>): when true, structured output runs in the
|
|
provider's strict mode — the response is grammar-constrained to the schema, which is
|
|
normalized automatically (<c>additionalProperties: false</c>, all properties required,
|
|
unsupported keywords moved into descriptions). Note that under strict mode the model
|
|
must emit every schema property — absence can't be expressed by omission unless the
|
|
schema allows null. A per-request <c>strictStructuredOutput</c> action parameter
|
|
overrides it.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.ClaudeApiSettings">
|
|
<summary>
|
|
Settings for OpenAI-compatible Vision API classification
|
|
Used for zone classification via local Vision Language Models (VLM)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ClaudeApiSettings.ApiKey">
|
|
<summary>
|
|
OpenAI API key for authentication.
|
|
</summary>
|
|
<value>The default value is an empty string.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ClaudeApiSettings.ApiEndpoint">
|
|
<summary>
|
|
API endpoint URL for OpenAI-compatible chat completions
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ClaudeApiSettings.Model">
|
|
<summary>
|
|
Model identifier to use for classification
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ClaudeApiSettings.Temperature">
|
|
<summary>
|
|
Temperature for response generation (0.0 = deterministic, 1.0 = creative).
|
|
Defaults to 0.0 because zone classification and verbatim text extraction
|
|
are deterministic tasks — randomness only adds run-to-run noise.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ClaudeApiSettings.MaxTokens">
|
|
<summary>
|
|
Maximum tokens in response. Claude API requires a positive value.
|
|
Claude Sonnet 4 supports up to 64K (65536) output tokens.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ClaudeApiSettings.SystemPrompt">
|
|
<summary>
|
|
Optional custom system prompt for zone classification.
|
|
When empty, the module uses a default prompt based on the ClassificationStrategy.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ClaudeApiSettings.Stream">
|
|
<summary>
|
|
Whether to stream responses from the API
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ClaudeApiSettings.ClassificationStrategy">
|
|
<summary>
|
|
Strategy for how zones are sent to the VLM for classification.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ClaudeApiSettings.SendFullPageReference">
|
|
<summary>
|
|
Whether to send the full page image as reference context alongside cropped zones.
|
|
Only used when UseZoneCropping is true.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ClaudeApiSettings.BatchSize">
|
|
<summary>
|
|
Number of zone images to include per VLM API call.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ClaudeApiSettings.MaxConcurrency">
|
|
<summary>
|
|
Maximum number of concurrent VLM API calls.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.ContentExtractionSettings">
|
|
<summary>
|
|
SDK-level default settings for content extraction.
|
|
Controls which extraction types are enabled and confidence thresholds.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ContentExtractionSettings.EnableOcrExtraction">
|
|
<summary>
|
|
Indicates whether OCR extraction is enabled for text zones.
|
|
</summary>
|
|
<value>The default value is true.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ContentExtractionSettings.EnableImageExtraction">
|
|
<summary>
|
|
Indicates whether image metadata extraction is enabled for image zones.
|
|
</summary>
|
|
<value>The default value is true.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ContentExtractionSettings.EnableTableExtraction">
|
|
<summary>
|
|
Indicates whether table structure extraction is enabled for table zones.
|
|
</summary>
|
|
<value>The default value is true.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ContentExtractionSettings.MinimumZoneConfidence">
|
|
<summary>
|
|
Minimum confidence threshold to process a zone (0.0 - 1.0).
|
|
Zones below this confidence will be skipped.
|
|
</summary>
|
|
<value>The default value is 0.5.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ContentExtractionSettings.EnableFullPageOcrFallback">
|
|
<summary>
|
|
Indicates whether to run full page OCR when no zones are detected.
|
|
This provides a simple OCR-only pipeline without segmentation.
|
|
</summary>
|
|
<value>The default value is true.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.CustomVlmApiSettings">
|
|
<summary>
|
|
Settings for custom OpenAI-compatible VLM API endpoints.
|
|
Used for Vision Language Model features with local or custom API providers.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.CustomVlmApiSettings.ApiEndpoint">
|
|
<summary>
|
|
API endpoint URL for OpenAI-compatible chat completions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.CustomVlmApiSettings.ApiKey">
|
|
<summary>
|
|
API key for authentication with the VLM service.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.CustomVlmApiSettings.Model">
|
|
<summary>
|
|
Model identifier to use.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.CustomVlmApiSettings.Temperature">
|
|
<summary>
|
|
Temperature for response generation (0.0 = deterministic, 1.0 = creative).
|
|
Defaults to 0.0 because zone classification and verbatim text extraction
|
|
are deterministic tasks — randomness only adds run-to-run noise.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.CustomVlmApiSettings.MaxTokens">
|
|
<summary>
|
|
Maximum tokens in response (-1 = unlimited)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.CustomVlmApiSettings.SystemPrompt">
|
|
<summary>
|
|
Optional custom system prompt for zone classification.
|
|
When empty, the module uses a default prompt based on the ClassificationStrategy.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.CustomVlmApiSettings.Stream">
|
|
<summary>
|
|
Whether to stream responses from the API
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.CustomVlmApiSettings.ClassificationStrategy">
|
|
<summary>
|
|
Strategy for how zones are sent to the VLM for classification.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.CustomVlmApiSettings.SendFullPageReference">
|
|
<summary>
|
|
Whether to send the full page image as reference context alongside cropped zones.
|
|
Only used when UseZoneCropping is true.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.CustomVlmApiSettings.BatchSize">
|
|
<summary>
|
|
Number of zone images to include per VLM API call.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.CustomVlmApiSettings.MaxConcurrency">
|
|
<summary>
|
|
Maximum number of concurrent VLM API calls.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.DeskewSettings">
|
|
<summary>
|
|
SDK-level default settings for image deskewing.
|
|
Controls skew detection and correction behavior.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.DeskewSettings.EnableDeskew">
|
|
<summary>
|
|
Indicates whether automatic deskewing is enabled.
|
|
</summary>
|
|
<value>The default value is true.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.DeskewSettings.InverseDeskew">
|
|
<summary>
|
|
Indicates whether the inverse deskew transform is enabled.
|
|
When disabled, bounding boxes remain in deskewed-image coordinates.
|
|
</summary>
|
|
<value>The default value is true.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.DeskewSettings.SkewTolerance">
|
|
<summary>
|
|
Maximum skew angle tolerance in degrees.
|
|
</summary>
|
|
<value>The default value is 15.0.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.DeskewSettings.SkewBinarizationMethod">
|
|
<summary>
|
|
Binarization method for skew detection.
|
|
Supported values: "default" (internal Modified Otsu), "sauvola" (better for poor contrast), "otsu" (explicit Modified Otsu).
|
|
</summary>
|
|
<value>The default value is "default".</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.DocumentLayoutJsonExportSettings">
|
|
<summary>
|
|
SDK-level default settings for document layout JSON export.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.DocumentLayoutJsonExportSettings.Content">
|
|
<summary>
|
|
The content elements to include in JSON output.
|
|
</summary>
|
|
<value>The default value is <see cref="F:Nutrient.NativeSDK.API.Settings.JsonExportContent.IncludeWords"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.DocumentLayoutJsonExportSettings.Format">
|
|
<summary>
|
|
The formatting options for JSON output.
|
|
</summary>
|
|
<value>The default value is <see cref="F:Nutrient.NativeSDK.API.Settings.JsonExportFormat.Unspecified"/>.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.FinalizerSettings">
|
|
<summary>
|
|
SDK-level default settings for document finalization.
|
|
Controls validation and quality checks for the final document layout.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.FinalizerSettings.EnableValidation">
|
|
<summary>
|
|
Indicates whether validation of the final document layout is enabled.
|
|
</summary>
|
|
<value>The default value is true.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.FinalizerSettings.MinimumDocumentConfidence">
|
|
<summary>
|
|
Minimum overall confidence threshold for the final document (0.0 - 1.0).
|
|
Documents with average confidence below this threshold will trigger a validation warning.
|
|
</summary>
|
|
<value>The default value is 0.6.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.FormLabelingSettings">
|
|
<summary>
|
|
Behavior settings for AI semantic labeling of detected form fields. When labeling is
|
|
enabled, the labeler draws numbered marks (T-1, C-2, S-1, ...) on the page image and
|
|
asks a vision model to return a semantic label for each (e.g. "First name", "Birthday").
|
|
<para>
|
|
This class only carries form-labeling behavior. The vision model connection (provider,
|
|
endpoint, key, model) is shared with the rest of the Vision API: select the provider via
|
|
<see cref="P:Nutrient.NativeSDK.API.Settings.Default.VisionSettings.Provider"/> and configure the matching settings class
|
|
(<see cref="T:Nutrient.NativeSDK.API.Settings.Default.CustomVlmApiSettings"/>, <see cref="T:Nutrient.NativeSDK.API.Settings.Default.OpenAIApiEndpointSettings"/>, or
|
|
<see cref="T:Nutrient.NativeSDK.API.Settings.Default.ClaudeApiSettings"/>) — the same way <c>Vision.Describe()</c> is configured.
|
|
</para>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.FormLabelingSettings.EnableAiLabeling">
|
|
<summary>
|
|
Opt in to AI semantic labeling of detected form fields. When false (default),
|
|
form detection runs offline and no vision model is contacted; when true, the
|
|
labeler draws numbered marks on the page and queries the provider configured via
|
|
<see cref="P:Nutrient.NativeSDK.API.Settings.Default.VisionSettings.Provider"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.FormLabelingSettings.EnableAiRemoveFalsePositives">
|
|
<summary>
|
|
When true, form fields the AI flags as false positives are removed from the
|
|
document graph so they never reach the exported output. When false (default),
|
|
flagged fields are kept and annotated (non-destructive). Only takes effect when
|
|
<see cref="P:Nutrient.NativeSDK.API.Settings.Default.FormLabelingSettings.EnableAiLabeling"/> is true.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.FormLabelingSettings.CandidateLabels">
|
|
<summary>
|
|
Optional vocabulary of candidate labels the model should prefer when labeling.
|
|
Provide labels as a newline- or comma-separated list (for example,
|
|
"First name, Last name, Date of birth"). The model matches a field to one of these
|
|
when it fits, and proposes a new label otherwise; each field's
|
|
<c>FormFieldNode.LabelSource</c> records whether the label was "matched" or
|
|
"invented". Matched labels are normalized to the casing given here. Empty (default)
|
|
means fully free-form labeling.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.FormRecognitionSettings">
|
|
<summary>
|
|
SDK-level default settings for TorchScript-based form field detection.
|
|
Controls the execution of RF-DETR inference for form field recognition (TextBox, ChoiceButton, Signature).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.FormRecognitionSettings.ModelPath">
|
|
<summary>
|
|
Path to the TorchScript RF-DETR model file (model.onnx).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.FormRecognitionSettings.UseCpuOnly">
|
|
<summary>
|
|
Enable CPU mode for ONNX.
|
|
When true, forces CPU execution. When false, attempts to use GPU if available (CUDA/MPS).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.FormRecognitionSettings.ConfidenceThreshold">
|
|
<summary>
|
|
Confidence threshold for form field predictions.
|
|
Default is 0.5 as specified in the RF-DETR model.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.FormRecognitionSettings.NumSelect">
|
|
<summary>
|
|
Number of top predictions to select during postprocessing.
|
|
Default is 300 as specified in the RF-DETR configuration.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.FormRecognitionSettings.NumClasses">
|
|
<summary>
|
|
Number of object classes (TextBox, ChoiceButton, Signature).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.FormRecognitionSettings.TextLogitBias">
|
|
<summary>
|
|
Logit bias applied to the Text class before sigmoid during postprocessing.
|
|
Positive values increase Text detections, negative values suppress them.
|
|
Default 0 (no bias).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.FormRecognitionSettings.CheckboxLogitBias">
|
|
<summary>
|
|
Logit bias applied to the Checkbox class before sigmoid during postprocessing.
|
|
Positive values increase Checkbox detections, negative values suppress them.
|
|
Default 0 (no bias).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.FormRecognitionSettings.SignatureLogitBias">
|
|
<summary>
|
|
Logit bias applied to the Signature class before sigmoid during postprocessing.
|
|
Positive values increase Signature detections, negative values suppress them.
|
|
Default 0 (no bias).
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.HandwritingSettings">
|
|
<summary>
|
|
Settings for the handwriting word extraction capacity.
|
|
Controls how handwritten zone content is processed into word-level nodes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.HandwritingSettings.WordRefiningMethod">
|
|
<summary>
|
|
Controls the method used to refine detected handwritten words when
|
|
AI-augmented text is available for the zone.
|
|
</summary>
|
|
<value>The default value is <see cref="F:Nutrient.NativeSDK.API.Settings.WordRefiningMethod.Heuristic"/>.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.InferenceLayoutSettings">
|
|
<summary>
|
|
SDK-level default settings for ONNX-based document segmentation.
|
|
Controls the execution of ONNX Runtime inference for document layout detection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.InferenceLayoutSettings.ConfidenceThreshold">
|
|
<summary>
|
|
Detection confidence threshold (0.0 to 1.0).
|
|
Detections with confidence below this threshold will be filtered out.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.OcrSettings">
|
|
<summary>
|
|
SDK-level default settings for OCR extraction.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OcrSettings.DefaultLanguages">
|
|
<summary>
|
|
Default OCR languages to use (comma-separated language codes).
|
|
</summary>
|
|
<value>The default value is "eng" (English).</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OcrSettings.FavorAccuracy">
|
|
<summary>
|
|
Indicates whether to favor accuracy over speed in OCR processing.
|
|
</summary>
|
|
<value>The default value is true.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OcrSettings.EnablePreprocessing">
|
|
<summary>
|
|
Indicates whether to enable image preprocessing before OCR.
|
|
</summary>
|
|
<value>The default value is true.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OcrSettings.EnableSkewDetection">
|
|
<summary>
|
|
Indicates whether to enable automatic skew detection and correction.
|
|
</summary>
|
|
<value>The default value is true.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OcrSettings.EnableTableDetection">
|
|
<summary>
|
|
Indicates whether to detect and extract tables from OCR output.
|
|
</summary>
|
|
<value>The default value is true.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.OpenAIApiEndpointSettings">
|
|
<summary>
|
|
Settings for OpenAI-compatible Vision API classification
|
|
Used for zone classification via local Vision Language Models (VLM)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAIApiEndpointSettings.ApiKey">
|
|
<summary>
|
|
OpenAI API key for authentication.
|
|
</summary>
|
|
<value>The default value is an empty string.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAIApiEndpointSettings.ApiEndpoint">
|
|
<summary>
|
|
API endpoint URL for OpenAI-compatible chat completions
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAIApiEndpointSettings.Model">
|
|
<summary>
|
|
Model identifier to use for classification
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAIApiEndpointSettings.Temperature">
|
|
<summary>
|
|
Temperature for response generation (0.0 = deterministic, 1.0 = creative).
|
|
Defaults to 0.0 because zone classification and verbatim text extraction
|
|
are deterministic tasks — randomness only adds run-to-run noise.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAIApiEndpointSettings.MaxTokens">
|
|
<summary>
|
|
Maximum tokens in response (-1 = unlimited)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAIApiEndpointSettings.SystemPrompt">
|
|
<summary>
|
|
Optional custom system prompt for zone classification.
|
|
When empty, the module uses a default prompt based on the ClassificationStrategy.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAIApiEndpointSettings.Stream">
|
|
<summary>
|
|
Whether to stream responses from the API
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAIApiEndpointSettings.ClassificationStrategy">
|
|
<summary>
|
|
Strategy for how zones are sent to the VLM for classification.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAIApiEndpointSettings.SendFullPageReference">
|
|
<summary>
|
|
Whether to send the full page image as reference context alongside cropped zones.
|
|
Only used when UseZoneCropping is true.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAIApiEndpointSettings.BatchSize">
|
|
<summary>
|
|
Number of zone images to include per VLM API call.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAIApiEndpointSettings.MaxConcurrency">
|
|
<summary>
|
|
Maximum number of concurrent VLM API calls.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.OpenAILanguagesDetectionSettings">
|
|
<summary>
|
|
SDK-level default settings for OpenAI Languages Detection.
|
|
Controls OpenAI API configuration for language and text direction detection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAILanguagesDetectionSettings.ApiKey">
|
|
<summary>
|
|
OpenAI API key for authentication.
|
|
</summary>
|
|
<value>The default value is an empty string.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAILanguagesDetectionSettings.ApiEndpoint">
|
|
<summary>
|
|
OpenAI API endpoint URL.
|
|
</summary>
|
|
<value>The default value is "https://api.openai.com/v1".</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAILanguagesDetectionSettings.Model">
|
|
<summary>
|
|
Model to use for language detection (e.g., "gpt-4o-mini").
|
|
</summary>
|
|
<value>The default value is "gpt-4o-mini".</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAILanguagesDetectionSettings.MaxTokens">
|
|
<summary>
|
|
Maximum number of tokens in the response.
|
|
</summary>
|
|
<value>The default value is 500.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAILanguagesDetectionSettings.Temperature">
|
|
<summary>
|
|
Temperature for response generation (0.0 to 1.0).
|
|
Lower values produce more deterministic outputs.
|
|
</summary>
|
|
<value>The default value is 0.0 for consistent detection.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAILanguagesDetectionSettings.Detail">
|
|
<summary>
|
|
Detail level for image analysis (low, high, auto).
|
|
</summary>
|
|
<value>The default value is "low" for faster processing.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.OpenAIPictureAltSettings">
|
|
<summary>
|
|
SDK-level default settings for OpenAI Picture Alt generator.
|
|
Controls OpenAI API configuration for picture description.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAIPictureAltSettings.ApiKey">
|
|
<summary>
|
|
OpenAI API key for authentication.
|
|
</summary>
|
|
<value>The default value is an empty string.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAIPictureAltSettings.ApiEndpoint">
|
|
<summary>
|
|
OpenAI API endpoint URL.
|
|
</summary>
|
|
<value>The default value is "https://api.openai.com/v1".</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAIPictureAltSettings.Model">
|
|
<summary>
|
|
Model to use for language detection (e.g., "gpt-4o-mini").
|
|
</summary>
|
|
<value>The default value is "gpt-4o-mini".</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAIPictureAltSettings.MaxTokens">
|
|
<summary>
|
|
Maximum number of tokens in the response.
|
|
</summary>
|
|
<value>The default value is 500.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAIPictureAltSettings.Temperature">
|
|
<summary>
|
|
Temperature for response generation (0.0 to 1.0).
|
|
Lower values produce more deterministic outputs.
|
|
</summary>
|
|
<value>The default value is 0.0 for consistent detection.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.OpenAIPictureAltSettings.Detail">
|
|
<summary>
|
|
Detail level for image analysis (low, high, auto).
|
|
</summary>
|
|
<value>The default value is "low" for faster processing.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.ReadingOrderSettings">
|
|
<summary>
|
|
SDK-level default settings for reading order prediction.
|
|
Controls the behavior of the rule-based reading order algorithm.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ReadingOrderSettings.HorizontalDilationThreshold">
|
|
<summary>
|
|
Horizontal dilation threshold for column detection (normalized by page width).
|
|
Default is 0.15 (15% of page width). Increase for wider column detection tolerance,
|
|
decrease for stricter column boundaries.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.ReadingOrderSettings.TextDirection">
|
|
<summary>
|
|
Text direction for reading order computation.
|
|
Determines how elements are sorted and ordered on the page.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.SegmenterSettings">
|
|
<summary>
|
|
SDK-level default settings for document segmentation.
|
|
Controls zone detection, page segmentation behavior, and ONNX inference settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.SegmenterSettings.TargetSize">
|
|
<summary>
|
|
Target size for image preprocessing (height and width).
|
|
</summary>
|
|
<value>The default value is 640.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.SegmenterSettings.ConfidenceThreshold">
|
|
<summary>
|
|
Detection confidence threshold (0.0 to 1.0).
|
|
Detections with confidence below this threshold will be filtered out.
|
|
</summary>
|
|
<value>The default value is 0.5.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.SegmenterSettings.UseCpuOnly">
|
|
<summary>
|
|
Enable CPU mode for ONNX Runtime.
|
|
When true, forces CPU execution. When false, uses default providers.
|
|
</summary>
|
|
<value>The default value is true.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.SegmenterSettings.MinimumZoneSize">
|
|
<summary>
|
|
Minimum zone size in pixels (width * height).
|
|
Zones smaller than this will be filtered out.
|
|
</summary>
|
|
<value>The default value is 100.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.SegmenterSettings.DetectOrientation">
|
|
<summary>
|
|
Indicates whether automatic page orientation detection is enabled.
|
|
</summary>
|
|
<value>The default value is true.</value>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.TableRecognitionSettings">
|
|
<summary>
|
|
SDK-level default settings for ONNX-based table structure recognition.
|
|
Controls the execution of TableFormer ONNX inference for table cell detection and structure extraction.
|
|
Model paths are resolved through the ResourceDownloader service.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.TableRecognitionSettings.TargetSize">
|
|
<summary>
|
|
Target size for image preprocessing (height and width).
|
|
Default is 448x448 as specified in the TableFormer model.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.TableRecognitionSettings.NormalizationMean">
|
|
<summary>
|
|
Image normalization mean values (RGB) for preprocessing.
|
|
Default values are from the TableFormer model training.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.TableRecognitionSettings.NormalizationStd">
|
|
<summary>
|
|
Image normalization standard deviation values (RGB) for preprocessing.
|
|
Default values are from the TableFormer model training.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.Default.TableRecognitionSettings.GetTargetSize">
|
|
<summary>
|
|
Target size for image preprocessing (height and width). Default is 448x448 as specified in the TableFormer model.
|
|
</summary>
|
|
<returns>The value of the TargetSize property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.Default.TableRecognitionSettings.SetTargetSize(System.Int32)">
|
|
<summary>
|
|
Target size for image preprocessing (height and width). Default is 448x448 as specified in the TableFormer model.
|
|
</summary>
|
|
<param name="value">The value to set for the TargetSize property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.Default.TableRecognitionSettings.GetNormalizationMean">
|
|
<summary>
|
|
Image normalization mean values (RGB) for preprocessing. Default values are from the TableFormer model training.
|
|
</summary>
|
|
<returns>The value of the NormalizationMean property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.Default.TableRecognitionSettings.SetNormalizationMean(System.Single[])">
|
|
<summary>
|
|
Image normalization mean values (RGB) for preprocessing. Default values are from the TableFormer model training.
|
|
</summary>
|
|
<param name="value">The value to set for the NormalizationMean property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.Default.TableRecognitionSettings.GetNormalizationStd">
|
|
<summary>
|
|
Image normalization standard deviation values (RGB) for preprocessing. Default values are from the TableFormer model training.
|
|
</summary>
|
|
<returns>The value of the NormalizationStd property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.Default.TableRecognitionSettings.SetNormalizationStd(System.Single[])">
|
|
<summary>
|
|
Image normalization standard deviation values (RGB) for preprocessing. Default values are from the TableFormer model training.
|
|
</summary>
|
|
<param name="value">The value to set for the NormalizationStd property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.VisionDescriptorSettings">
|
|
<summary>
|
|
SDK-level default settings for Vision document description.
|
|
Controls AI-powered document content description generation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.VisionDescriptorSettings.Level">
|
|
<summary>
|
|
Description detail level to use.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.VisionDescriptorSettings.StandardPrompt">
|
|
<summary>
|
|
Prompt template for standard description generation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.VisionDescriptorSettings.DetailedPrompt">
|
|
<summary>
|
|
Prompt template for detailed description generation.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.VisionSettings">
|
|
<summary>
|
|
SDK-level default settings for Vision document processing.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.VisionSettings.Provider">
|
|
<summary>
|
|
The Vision Language Model provider to use for AI-powered features.
|
|
</summary>
|
|
<value>The default value is <see cref="F:Nutrient.NativeSDK.API.Settings.VlmProvider.Custom"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.VisionSettings.Features">
|
|
<summary>
|
|
Vision features to enable during document processing.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.VisionSettings.EnableOcr">
|
|
<summary>
|
|
Controls OCR resource loading and OCR-based word detection inside the ICR image pipeline.
|
|
</summary>
|
|
<value>
|
|
The default value is <see cref="F:Nutrient.NativeSDK.API.Settings.OcrActivationMode.Auto"/>: OCR is enabled when VLM augmentation is
|
|
off and disabled when it is on. Use <see cref="F:Nutrient.NativeSDK.API.Settings.OcrActivationMode.Activated"/> or
|
|
<see cref="F:Nutrient.NativeSDK.API.Settings.OcrActivationMode.Deactivated"/> to force OCR on or off regardless of <see cref="P:Nutrient.NativeSDK.API.Settings.Default.VisionSettings.EnableVlm"/>.
|
|
</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.VisionSettings.EnableVlm">
|
|
<summary>
|
|
Indicates whether the ICR image pipeline should run late VLM augmentation.
|
|
<see cref="F:Nutrient.NativeSDK.API.Settings.VisionEngine.VlmEnhancedIcr"/> also enables this behavior for
|
|
backward-compatible engine selection.
|
|
</summary>
|
|
<value>The default value is false.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.VisionSettings.Engine">
|
|
<summary>
|
|
Specifies which vision processing engine/pipeline to use for content extraction.
|
|
</summary>
|
|
<value>The default value is <see cref="F:Nutrient.NativeSDK.API.Settings.VisionEngine.Icr"/>.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.VisionSettings.OutputFormat">
|
|
<summary>
|
|
Format of content returned by <see cref="!:Concepts.Vision.ExtractContent()"/>.
|
|
Defaults to <see cref="F:Nutrient.NativeSDK.API.Settings.VisionOutputFormat.Json"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Default.WordsDetectionSettings">
|
|
<summary>
|
|
SDK-level default settings for ONNX-based document segmentation.
|
|
Controls the execution of ONNX Runtime inference for document layout detection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Default.WordsDetectionSettings.ConfidenceThreshold">
|
|
<summary>
|
|
Detection confidence threshold (0.0 to 1.0).
|
|
Detections with confidence below this threshold will be filtered out.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.RenderingLayoutMode.ZoomExtents">
|
|
<summary>
|
|
Computes canvas size and rendering origin to display the maximum extents of all objects.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.ImageExportMode">
|
|
<summary>
|
|
Specifies how images are handled during document export to markup formats (Markdown, HTML).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.ImageExportMode.None">
|
|
<summary>
|
|
Images are not included in the exported output.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.ImageExportMode.Embedded">
|
|
<summary>
|
|
Images are embedded inline as base64-encoded data URIs.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.ImageExportMode.External">
|
|
<summary>
|
|
Images are saved as separate files in a sibling "{output}_resources" folder
|
|
next to the output file and referenced by relative path. Requires writing to
|
|
a file path (or a <see cref="T:System.IO.FileStream"/>) so the resources folder
|
|
can be derived from the output file name.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.ImageSettingMode">
|
|
<summary>
|
|
Specifies the mode options for image settings.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.ImageSettingMode.Unspecified">
|
|
<summary>
|
|
No specific mode is set.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.ImageSettingMode.FollowExifRotation">
|
|
<summary>Specifies if the Exif Rotation information should be followed if it's present in the loaded document</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.ImageSettingMode.PreserveIccProfile">
|
|
<summary>Specifies if the ICC profile should be preserved during the conversion if it's present in the loaded document.</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.ImageExportFormat">
|
|
<summary>
|
|
Specifies the export format for images.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.ImageExportFormat.Auto">
|
|
<summary>
|
|
Auto-detect from the destination filename extension. When exporting via a filename,
|
|
the extension determines the format (.tif/.tiff → Tiff, .png → Png, .jpg/.jpeg → Jpeg,
|
|
.bmp → Bmp). When exporting via a Stream, the caller must set this to an explicit
|
|
format; Auto is rejected because no extension is available.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.ImageExportFormat.Tiff">
|
|
<summary>TIFF image format. Multi-page documents are written as multi-page TIFF.</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.ImageExportFormat.Png">
|
|
<summary>PNG image format. Multi-page documents produce numbered files (e.g., output-1.png, output-2.png).</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.ImageExportFormat.Jpeg">
|
|
<summary>JPEG image format. Multi-page documents produce numbered files (e.g., output-1.jpg, output-2.jpg).</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.ImageExportFormat.Bmp">
|
|
<summary>BMP image format. Multi-page documents produce numbered files (e.g., output-1.bmp, output-2.bmp).</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.InstantJsonRenderTheme">
|
|
<summary>
|
|
Specifies the annotation appearance theme used when importing Instant JSON.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.InstantJsonRenderTheme.Default">
|
|
<summary>
|
|
Use the default annotation appearance generation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.InstantJsonRenderTheme.Core">
|
|
<summary>
|
|
Use annotation appearance generation that matches the Core SDK.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.PdfSettingsMode">
|
|
<summary>
|
|
Specifies the mode options for PDF settings.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.PdfSettingsMode.Unspecified">
|
|
<summary>
|
|
No specific mode is set.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.PdfSettingsMode.PreserveAnnotations">
|
|
<summary>
|
|
Preserve annotations when saving PDF documents.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.PdfSavePreferences">
|
|
<summary>
|
|
Specifies preferences for saving PDF documents.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.PdfSavePreferences.None">
|
|
<summary>
|
|
No specific preferences are set.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.PdfSavePreferences.ApplyRedactions">
|
|
<summary>
|
|
Automatically apply redaction annotations when saving PDF documents.
|
|
When enabled, all redaction annotations are applied (content is permanently removed)
|
|
during save operations. The redaction annotations are removed after applying.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.JsonExportContent">
|
|
<summary>
|
|
Specifies which content elements to include in JSON export.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.JsonExportContent.Unspecified">
|
|
<summary>
|
|
No specific content options.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.JsonExportContent.IncludeWords">
|
|
<summary>
|
|
Include word-level details with coordinates in the export.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.JsonExportFormat">
|
|
<summary>
|
|
Specifies formatting options for JSON export.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.JsonExportFormat.Unspecified">
|
|
<summary>
|
|
No specific formatting options.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.JsonExportFormat.PrettyPrint">
|
|
<summary>
|
|
Format the JSON output with indentation for readability.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.WordRefiningMethod">
|
|
<summary>
|
|
Method used to refine handwritten word text when AI-augmented text is available.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.WordRefiningMethod.Heuristic">
|
|
<summary>
|
|
Uses heuristic character-level alignment to redistribute AI-augmented word
|
|
boundaries across detected bounding boxes.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.WordRefiningMethod.Vlm">
|
|
<summary>
|
|
Uses an additional AI model call to correct each detected word's text individually.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.TextDirection">
|
|
<summary>
|
|
Text direction modes for reading order computation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.TextDirection.LeftToRightTopToBottom">
|
|
<summary>Left-to-right, then top-to-bottom (e.g., English, most European languages)</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.TextDirection.RightToLeftTopToBottom">
|
|
<summary>Right-to-left, then top-to-bottom (e.g., Arabic, Hebrew)</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.TextDirection.TopToBottomRightToLeft">
|
|
<summary>Top-to-bottom, then right-to-left (e.g., Traditional Chinese, Japanese vertical)</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.TextDirection.TopToBottomLeftToRight">
|
|
<summary>Top-to-bottom, then left-to-right (e.g., Mongolian vertical)</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DescriptionLevel">
|
|
<summary>
|
|
Description detail levels for Vision document description.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.DescriptionLevel.Unknown">
|
|
<summary>
|
|
No description.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.DescriptionLevel.Standard">
|
|
<summary>
|
|
Standard concise description.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.DescriptionLevel.Detailed">
|
|
<summary>
|
|
Detailed description with additional context.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.VisionFeatures">
|
|
<summary>
|
|
Vision processing features that can be enabled or disabled.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.VisionFeatures.Unknown">
|
|
<summary>
|
|
No features enabled.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.VisionFeatures.Equation">
|
|
<summary>
|
|
Mathematical equation detection and recognition.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.VisionFeatures.Table">
|
|
<summary>
|
|
Table structure detection and extraction.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.VisionFeatures.KeyValueRegion">
|
|
<summary>
|
|
Key-value region detection for form-like content.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.VisionFeatures.ImageClassification">
|
|
<summary>
|
|
Image classification for figures and diagrams.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.VisionFeatures.Handwriting">
|
|
<summary>
|
|
Image classification for figures and diagrams.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.VisionFeatures.Form">
|
|
<summary>
|
|
Form field detection (TextBox, ChoiceButton, Signature).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.VisionFeatures.All">
|
|
<summary>
|
|
All vision features enabled.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.OcrActivationMode">
|
|
<summary>
|
|
Controls whether OCR resource loading and OCR-based word detection run inside the ICR image pipeline.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.OcrActivationMode.Auto">
|
|
<summary>
|
|
OCR follows the pipeline: it runs when VLM augmentation is disabled (the ICR pipeline
|
|
relies on OCR for text) and is skipped when VLM augmentation is enabled (the VLM supplies
|
|
the text). This is the default.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.OcrActivationMode.Activated">
|
|
<summary>
|
|
OCR always runs, regardless of whether VLM augmentation is enabled.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.OcrActivationMode.Deactivated">
|
|
<summary>
|
|
OCR never runs, regardless of whether VLM augmentation is enabled.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.VlmClassificationStrategy">
|
|
<summary>
|
|
Strategy for how zones are sent to the VLM for classification.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.VlmClassificationStrategy.OneShot">
|
|
<summary>
|
|
Send a single full-page image with bounding box coordinates in the prompt.
|
|
The VLM performs spatial reasoning to classify each zone by its bbox.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.VlmClassificationStrategy.MultiZone">
|
|
<summary>
|
|
Crop each zone from the source image and send multiple zone images per VLM call.
|
|
The VLM classifies each cropped image by its visual content.
|
|
Supports batching (BatchSize) and parallel execution (MaxConcurrency).
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.VlmProvider">
|
|
<summary>
|
|
Available Vision Language Model providers.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.VlmProvider.Unknown">
|
|
<summary>
|
|
No provider specified.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.VlmProvider.Custom">
|
|
<summary>
|
|
Custom OpenAI-compatible API endpoint.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.VlmProvider.Claude">
|
|
<summary>
|
|
Anthropic Claude Vision API.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.VlmProvider.OpenAI">
|
|
<summary>
|
|
OpenAI Vision API.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.VisionOutputFormat">
|
|
<summary>
|
|
Format of content returned by <see cref="!:Concepts.Vision.ExtractContent()"/>
|
|
and <see cref="!:Concepts.Vision.ExtractContentToFile(string)"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.VisionOutputFormat.Json">
|
|
<summary>
|
|
Structured JSON with elements sorted by reading order (default).
|
|
Contains paragraph text, tables, key-value regions, word-level coordinates,
|
|
and per-page metadata.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.VisionOutputFormat.Markdown">
|
|
<summary>
|
|
Markdown text optimized for human reading and LLM consumption.
|
|
Uses standard markdown primitives (headings, paragraphs, tables, blockquotes
|
|
for footnotes). Loses structural information like coordinates.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.VisionOutputFormat.IrLite">
|
|
<summary>
|
|
IR Lite intermediate representation optimized for LLM position retrieval.
|
|
Preserves spatial coordinates with a compact token-efficient format.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.VisionEngine">
|
|
<summary>
|
|
Specifies which vision processing pipeline to use for content extraction.
|
|
</summary>
|
|
<remarks>
|
|
ICR (Intelligent Content Recognition) refers to intelligent document understanding
|
|
that goes beyond traditional OCR. While OCR simply converts images of text into
|
|
machine-readable characters, ICR analyzes the full document structure.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.VisionEngine.VlmEnhancedIcr">
|
|
<summary>
|
|
VLM-enhanced ICR extraction pipeline combining ICR with Vision Language Models.
|
|
</summary>
|
|
<remarks>
|
|
Requires a VLM provider to be configured via <see cref="P:Nutrient.NativeSDK.API.Settings.VisionSettings.Provider"/> with
|
|
appropriate API credentials (if required). The VLM enhances extraction quality by providing
|
|
contextual understanding with AI.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.VisionEngine.AdaptiveOcr">
|
|
<summary>
|
|
Adaptive OCR pipeline: heuristic-first with OCR fallback per page.
|
|
</summary>
|
|
<remarks>
|
|
Born-digital pages are extracted directly from the PDF content stream — no
|
|
rasterization, no segmentation, no OCR — yielding sub-2 s/page throughput on
|
|
typical documents. Image-based or non-PDF pages transparently fall through to
|
|
OCR so callers don't need to know the document type up front. Does not require
|
|
a VLM provider.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.VisionEngine.Icr">
|
|
<summary>
|
|
Local ICR extraction pipeline using only small models (no VLM required).
|
|
</summary>
|
|
<remarks>
|
|
Provides full document layout analysis and content extraction using local inference only.
|
|
This mode runs entirely offline without requiring external API calls, making it suitable
|
|
for air-gapped environments or when VLM setup/costs/latency are a concern.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.ImplicitConversion">
|
|
<summary>
|
|
Specifies the conversion behavior when a document format is not compatible with the editor.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.ImplicitConversion.Disabled">
|
|
<summary>
|
|
Throw an error when the original provided document is not compatible with the editor. Consider converting it or enabling AutoConversion.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.ImplicitConversion.Enabled">
|
|
<summary>
|
|
Automatically convert the document to a format the editor can edit.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.OpenSettingsMode">
|
|
<summary>
|
|
Defines the operational modes for opening documents.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.OpenSettingsMode.Unspecified">
|
|
<summary>
|
|
No specific mode is set.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.OpenSettingsMode.OwnStream">
|
|
<summary>
|
|
Indicates that the document uses its own stream.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.OpenSettingsMode.PrintContext">
|
|
<summary>
|
|
Indicates the document is opened in a print context.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.OpenSettingsMode.EditContext">
|
|
<summary>
|
|
Indicates the document is opened in an edit context.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Serialization.SettingsSerializationMode">
|
|
<summary>
|
|
Specifies the mode for settings serialization and deserialization.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.Serialization.SettingsSerializationMode.OverrideAll">
|
|
<summary>
|
|
Overrides all settings with the loaded values, replacing any existing configuration.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.Serialization.SettingsSerializationMode.Differential">
|
|
<summary>
|
|
Applies only the differences from defaults, merging with existing settings.
|
|
Only properties with non-null values are applied.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Serialization.SerializableSettingsContainer">
|
|
<summary>
|
|
Container for serialized settings with version and mode information.
|
|
This class is used as a wrapper for JSON serialization of SDK and Document settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Serialization.SerializableSettingsContainer.Version">
|
|
<summary>
|
|
The version of the settings format.
|
|
</summary>
|
|
<value>The default value is 1.</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Serialization.SerializableSettingsContainer.Mode">
|
|
<summary>
|
|
The serialization mode as a string.
|
|
</summary>
|
|
<value>Valid values are "overrideAll" or "differential".</value>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Serialization.SerializableSettingsContainer.Settings">
|
|
<summary>
|
|
The dictionary of settings, keyed by setting category name.
|
|
Values are stored as JsonElement for flexible deserialization.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.Serialization.SerializableSettingsContainer.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.Serialization.SerializableSettingsContainer"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkConversionSettings">
|
|
<summary>
|
|
SDK-level overrides for ConversionSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkConversionSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkConversionSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentConversionSettings">
|
|
<summary>
|
|
Document-level overrides for ConversionSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentConversionSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentConversionSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.ConversionSettings">
|
|
<summary>
|
|
Settings for Conversion. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ConversionSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.ConversionSettings,Nutrient.NativeSDK.API.Settings.SdkConversionSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.ConversionSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ConversionSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.ConversionSettings,Nutrient.NativeSDK.API.Settings.SdkConversionSettings,Nutrient.NativeSDK.API.Settings.DocumentConversionSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.ConversionSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ConversionSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ConversionSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ConversionSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ConversionSettings.TimeoutMilliseconds">
|
|
<summary>
|
|
Gets or sets the value of TimeoutMilliseconds.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ConversionSettings.Mode">
|
|
<summary>
|
|
Gets the value of Mode from the default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ConversionSettings.IsTimeoutMillisecondsOverridden">
|
|
<summary>
|
|
Gets whether TimeoutMilliseconds is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ConversionSettings.GetTimeoutMilliseconds">
|
|
<summary>
|
|
The conversion timeout in milliseconds. After this time, the conversion will be aborted and return a TimeoutException.
|
|
</summary>
|
|
<returns>The value of the TimeoutMilliseconds property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ConversionSettings.SetTimeoutMilliseconds(System.Int32)">
|
|
<summary>
|
|
The conversion timeout in milliseconds. After this time, the conversion will be aborted and return a TimeoutException.
|
|
</summary>
|
|
<param name="value">The value to set for the TimeoutMilliseconds property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkOpenSettings">
|
|
<summary>
|
|
SDK-level overrides for OpenSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkOpenSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkOpenSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentOpenSettings">
|
|
<summary>
|
|
Document-level overrides for OpenSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentOpenSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentOpenSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.OpenSettings">
|
|
<summary>
|
|
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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.OpenSettings,Nutrient.NativeSDK.API.Settings.SdkOpenSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.OpenSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.OpenSettings,Nutrient.NativeSDK.API.Settings.SdkOpenSettings,Nutrient.NativeSDK.API.Settings.DocumentOpenSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.OpenSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenSettings.PageCacheMode">
|
|
<summary>
|
|
Gets or sets the value of PageCacheMode.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenSettings.Mode">
|
|
<summary>
|
|
Gets or sets the value of Mode.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenSettings.DocumentFormat">
|
|
<summary>
|
|
Gets or sets the value of DocumentFormat.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenSettings.MaxPages">
|
|
<summary>
|
|
Gets or sets the value of MaxPages.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenSettings.ImplicitConversion">
|
|
<summary>
|
|
Gets or sets the value of ImplicitConversion.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenSettings.IsPageCacheModeOverridden">
|
|
<summary>
|
|
Gets whether PageCacheMode is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenSettings.IsModeOverridden">
|
|
<summary>
|
|
Gets whether Mode is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenSettings.IsDocumentFormatOverridden">
|
|
<summary>
|
|
Gets whether DocumentFormat is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenSettings.IsMaxPagesOverridden">
|
|
<summary>
|
|
Gets whether MaxPages is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenSettings.IsImplicitConversionOverridden">
|
|
<summary>
|
|
Gets whether ImplicitConversion is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenSettings.GetPageCacheMode">
|
|
<summary>
|
|
The page caching mode for the document.
|
|
</summary>
|
|
<returns>The value of the PageCacheMode property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenSettings.SetPageCacheMode(GdPicture14.PageCacheMode)">
|
|
<summary>
|
|
The page caching mode for the document.
|
|
</summary>
|
|
<param name="value">The value to set for the PageCacheMode property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenSettings.GetMode">
|
|
<summary>
|
|
The operational mode for opening the document.
|
|
</summary>
|
|
<returns>The value of the Mode property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenSettings.SetMode(Nutrient.NativeSDK.API.Settings.OpenSettingsMode)">
|
|
<summary>
|
|
The operational mode for opening the document.
|
|
</summary>
|
|
<param name="value">The value to set for the Mode property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenSettings.GetDocumentFormat">
|
|
<summary>
|
|
The expected document format.
|
|
</summary>
|
|
<returns>The value of the DocumentFormat property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenSettings.SetDocumentFormat(GdPicture14.DocumentFormat)">
|
|
<summary>
|
|
The expected document format.
|
|
</summary>
|
|
<param name="value">The value to set for the DocumentFormat property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenSettings.GetMaxPages">
|
|
<summary>
|
|
The maximum number of pages to load from the document.
|
|
</summary>
|
|
<returns>The value of the MaxPages property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenSettings.SetMaxPages(System.Int32)">
|
|
<summary>
|
|
The maximum number of pages to load from the document.
|
|
</summary>
|
|
<param name="value">The value to set for the MaxPages property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenSettings.GetImplicitConversion">
|
|
<summary>
|
|
Whether implicit conversion is enabled when opening documents in editors. When enabled, documents will be automatically converted to a compatible format for editing.
|
|
</summary>
|
|
<returns>The value of the ImplicitConversion property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenSettings.SetImplicitConversion(Nutrient.NativeSDK.API.Settings.ImplicitConversion)">
|
|
<summary>
|
|
Whether implicit conversion is enabled when opening documents in editors. When enabled, documents will be automatically converted to a compatible format for editing.
|
|
</summary>
|
|
<param name="value">The value to set for the ImplicitConversion property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkCadSettings">
|
|
<summary>
|
|
SDK-level overrides for CadSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkCadSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkCadSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentCadSettings">
|
|
<summary>
|
|
Document-level overrides for CadSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentCadSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentCadSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.CadSettings">
|
|
<summary>
|
|
Settings for Cad. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CadSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.CadSettings,Nutrient.NativeSDK.API.Settings.SdkCadSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.CadSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CadSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.CadSettings,Nutrient.NativeSDK.API.Settings.SdkCadSettings,Nutrient.NativeSDK.API.Settings.DocumentCadSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.CadSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CadSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CadSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CadSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CadSettings.EnableLineWeight">
|
|
<summary>
|
|
Gets or sets the value of EnableLineWeight.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CadSettings.CanvasBackgroundColor">
|
|
<summary>
|
|
Gets or sets the value of CanvasBackgroundColor.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CadSettings.RenderingLayoutMode">
|
|
<summary>
|
|
Gets or sets the value of RenderingLayoutMode.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CadSettings.ThumbnailMode">
|
|
<summary>
|
|
Gets or sets the value of ThumbnailMode.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CadSettings.UnitMode">
|
|
<summary>
|
|
Gets or sets the value of UnitMode.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CadSettings.RenderZoom">
|
|
<summary>
|
|
Gets or sets the value of RenderZoom.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CadSettings.IsEnableLineWeightOverridden">
|
|
<summary>
|
|
Gets whether EnableLineWeight is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CadSettings.IsCanvasBackgroundColorOverridden">
|
|
<summary>
|
|
Gets whether CanvasBackgroundColor is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CadSettings.IsRenderingLayoutModeOverridden">
|
|
<summary>
|
|
Gets whether RenderingLayoutMode is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CadSettings.IsThumbnailModeOverridden">
|
|
<summary>
|
|
Gets whether ThumbnailMode is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CadSettings.IsUnitModeOverridden">
|
|
<summary>
|
|
Gets whether UnitMode is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CadSettings.IsRenderZoomOverridden">
|
|
<summary>
|
|
Gets whether RenderZoom is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CadSettings.GetEnableLineWeight">
|
|
<summary>
|
|
This flags controls the support of line weight. It is the same command option as AutoCad "Lineweight".
|
|
</summary>
|
|
<returns>The value of the EnableLineWeight property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CadSettings.SetEnableLineWeight(System.Boolean)">
|
|
<summary>
|
|
This flags controls the support of line weight. It is the same command option as AutoCad "Lineweight".
|
|
</summary>
|
|
<param name="value">The value to set for the EnableLineWeight property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CadSettings.GetCanvasBackgroundColor">
|
|
<summary>
|
|
The canvas background color.
|
|
</summary>
|
|
<returns>The value of the CanvasBackgroundColor property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CadSettings.SetCanvasBackgroundColor(Nutrient.NativeSDK.API.Types.Color)">
|
|
<summary>
|
|
The canvas background color.
|
|
</summary>
|
|
<param name="value">The value to set for the CanvasBackgroundColor property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CadSettings.GetRenderingLayoutMode">
|
|
<summary>
|
|
The rendering layout mode that determines how the canvas size and rendering origin are computed.
|
|
</summary>
|
|
<returns>The value of the RenderingLayoutMode property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CadSettings.SetRenderingLayoutMode(Nutrient.NativeSDK.API.Settings.RenderingLayoutMode)">
|
|
<summary>
|
|
The rendering layout mode that determines how the canvas size and rendering origin are computed.
|
|
</summary>
|
|
<param name="value">The value to set for the RenderingLayoutMode property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CadSettings.GetThumbnailMode">
|
|
<summary>
|
|
Indicates whether thumbnail mode is enabled for CAD rendering.
|
|
</summary>
|
|
<returns>The value of the ThumbnailMode property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CadSettings.SetThumbnailMode(System.Boolean)">
|
|
<summary>
|
|
Indicates whether thumbnail mode is enabled for CAD rendering.
|
|
</summary>
|
|
<param name="value">The value to set for the ThumbnailMode property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CadSettings.GetUnitMode">
|
|
<summary>
|
|
The unit mode for measurement in CAD documents.
|
|
</summary>
|
|
<returns>The value of the UnitMode property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CadSettings.SetUnitMode(GdPicture14.UnitMode)">
|
|
<summary>
|
|
The unit mode for measurement in CAD documents.
|
|
</summary>
|
|
<param name="value">The value to set for the UnitMode property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CadSettings.GetRenderZoom">
|
|
<summary>
|
|
The zoom level for rendering CAD documents.
|
|
</summary>
|
|
<returns>The value of the RenderZoom property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CadSettings.SetRenderZoom(System.Double)">
|
|
<summary>
|
|
The zoom level for rendering CAD documents.
|
|
</summary>
|
|
<param name="value">The value to set for the RenderZoom property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkEmailSettings">
|
|
<summary>
|
|
SDK-level overrides for EmailSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkEmailSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkEmailSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentEmailSettings">
|
|
<summary>
|
|
Document-level overrides for EmailSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentEmailSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentEmailSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.EmailSettings">
|
|
<summary>
|
|
Settings for Email. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.EmailSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.EmailSettings,Nutrient.NativeSDK.API.Settings.SdkEmailSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.EmailSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.EmailSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.EmailSettings,Nutrient.NativeSDK.API.Settings.SdkEmailSettings,Nutrient.NativeSDK.API.Settings.DocumentEmailSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.EmailSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.EmailSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.EmailSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.EmailSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.EmailSettings.Language">
|
|
<summary>
|
|
Gets or sets the value of Language.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.EmailSettings.IsLanguageOverridden">
|
|
<summary>
|
|
Gets whether Language is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.EmailSettings.GetLanguage">
|
|
<summary>
|
|
The preferred language for conversion, as a BCP 47 language tag (e.g. "fr-FR", "en-US"). Controls date/time formatting and label translations in the converted document.
|
|
</summary>
|
|
<returns>The value of the Language property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.EmailSettings.SetLanguage(System.String)">
|
|
<summary>
|
|
The preferred language for conversion, as a BCP 47 language tag (e.g. "fr-FR", "en-US"). Controls date/time formatting and label translations in the converted document.
|
|
</summary>
|
|
<param name="value">The value to set for the Language property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkHtmlSettings">
|
|
<summary>
|
|
SDK-level overrides for HtmlSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkHtmlSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkHtmlSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentHtmlSettings">
|
|
<summary>
|
|
Document-level overrides for HtmlSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentHtmlSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentHtmlSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.HtmlSettings">
|
|
<summary>
|
|
Settings for Html. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.HtmlSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.HtmlSettings,Nutrient.NativeSDK.API.Settings.SdkHtmlSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.HtmlSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.HtmlSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.HtmlSettings,Nutrient.NativeSDK.API.Settings.SdkHtmlSettings,Nutrient.NativeSDK.API.Settings.DocumentHtmlSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.HtmlSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.HtmlSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.HtmlSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.HtmlSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.HtmlSettings.Layout">
|
|
<summary>
|
|
Gets or sets the value of Layout.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.HtmlSettings.ImageExport">
|
|
<summary>
|
|
Gets or sets the value of ImageExport.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.HtmlSettings.IsLayoutOverridden">
|
|
<summary>
|
|
Gets whether Layout is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.HtmlSettings.IsImageExportOverridden">
|
|
<summary>
|
|
Gets whether ImageExport is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.HtmlSettings.GetLayout">
|
|
<summary>
|
|
The layout type to use when saving HTML documents.
|
|
</summary>
|
|
<returns>The value of the Layout property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.HtmlSettings.SetLayout(GdPicture14.HtmlLayoutType)">
|
|
<summary>
|
|
The layout type to use when saving HTML documents.
|
|
</summary>
|
|
<param name="value">The value to set for the Layout property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.HtmlSettings.GetImageExport">
|
|
<summary>
|
|
Controls how images are exported when converting documents to HTML.
|
|
</summary>
|
|
<returns>The value of the ImageExport property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.HtmlSettings.SetImageExport(Nutrient.NativeSDK.API.Settings.ImageExportMode)">
|
|
<summary>
|
|
Controls how images are exported when converting documents to HTML.
|
|
</summary>
|
|
<param name="value">The value to set for the ImageExport property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkImageSettings">
|
|
<summary>
|
|
SDK-level overrides for ImageSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkImageSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkImageSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentImageSettings">
|
|
<summary>
|
|
Document-level overrides for ImageSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentImageSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentImageSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.ImageSettings">
|
|
<summary>
|
|
Settings for Image. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ImageSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.ImageSettings,Nutrient.NativeSDK.API.Settings.SdkImageSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.ImageSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ImageSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.ImageSettings,Nutrient.NativeSDK.API.Settings.SdkImageSettings,Nutrient.NativeSDK.API.Settings.DocumentImageSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.ImageSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ImageSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ImageSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ImageSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ImageSettings.Mode">
|
|
<summary>
|
|
Gets or sets the value of Mode.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ImageSettings.RasterizationDpi">
|
|
<summary>
|
|
Gets or sets the value of RasterizationDpi.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ImageSettings.ExportFormat">
|
|
<summary>
|
|
Gets or sets the value of ExportFormat.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ImageSettings.JpegQuality">
|
|
<summary>
|
|
Gets or sets the value of JpegQuality.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ImageSettings.PageIndex">
|
|
<summary>
|
|
Gets or sets the value of PageIndex.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ImageSettings.IsModeOverridden">
|
|
<summary>
|
|
Gets whether Mode is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ImageSettings.IsRasterizationDpiOverridden">
|
|
<summary>
|
|
Gets whether RasterizationDpi is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ImageSettings.IsExportFormatOverridden">
|
|
<summary>
|
|
Gets whether ExportFormat is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ImageSettings.IsJpegQualityOverridden">
|
|
<summary>
|
|
Gets whether JpegQuality is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ImageSettings.IsPageIndexOverridden">
|
|
<summary>
|
|
Gets whether PageIndex is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ImageSettings.GetMode">
|
|
<summary>
|
|
The mode options for image processing.
|
|
</summary>
|
|
<returns>The value of the Mode property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ImageSettings.SetMode(Nutrient.NativeSDK.API.Settings.ImageSettingMode)">
|
|
<summary>
|
|
The mode options for image processing.
|
|
</summary>
|
|
<param name="value">The value to set for the Mode property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ImageSettings.GetRasterizationDpi">
|
|
<summary>
|
|
The rasterization DPI for image rasterization.
|
|
</summary>
|
|
<returns>The value of the RasterizationDpi property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ImageSettings.SetRasterizationDpi(System.Single)">
|
|
<summary>
|
|
The rasterization DPI for image rasterization.
|
|
</summary>
|
|
<param name="value">The value to set for the RasterizationDpi property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ImageSettings.GetExportFormat">
|
|
<summary>
|
|
The export format for the image.
|
|
</summary>
|
|
<returns>The value of the ExportFormat property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ImageSettings.SetExportFormat(Nutrient.NativeSDK.API.Settings.ImageExportFormat)">
|
|
<summary>
|
|
The export format for the image.
|
|
</summary>
|
|
<param name="value">The value to set for the ExportFormat property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ImageSettings.GetJpegQuality">
|
|
<summary>
|
|
JPEG compression quality, in the 1..100 range. Only used when <see cref="P:Nutrient.NativeSDK.API.Settings.Default.ImageSettings.ExportFormat"/> resolves to <see cref="F:Nutrient.NativeSDK.API.Settings.ImageExportFormat.Jpeg"/>.
|
|
</summary>
|
|
<returns>The value of the JpegQuality property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ImageSettings.SetJpegQuality(System.Int32)">
|
|
<summary>
|
|
JPEG compression quality, in the 1..100 range. Only used when <see cref="P:Nutrient.NativeSDK.API.Settings.Default.ImageSettings.ExportFormat"/> resolves to <see cref="F:Nutrient.NativeSDK.API.Settings.ImageExportFormat.Jpeg"/>.
|
|
</summary>
|
|
<param name="value">The value to set for the JpegQuality property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ImageSettings.GetPageIndex">
|
|
<summary>
|
|
Zero-based page index to render for single-page raster formats (PNG, JPEG, BMP).
|
|
</summary>
|
|
<returns>The value of the PageIndex property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ImageSettings.SetPageIndex(System.Nullable{System.Int32})">
|
|
<summary>
|
|
Zero-based page index to render for single-page raster formats (PNG, JPEG, BMP).
|
|
</summary>
|
|
<param name="value">The value to set for the PageIndex property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkInstantJsonSettings">
|
|
<summary>
|
|
SDK-level overrides for InstantJsonSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkInstantJsonSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkInstantJsonSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentInstantJsonSettings">
|
|
<summary>
|
|
Document-level overrides for InstantJsonSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentInstantJsonSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentInstantJsonSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.InstantJsonSettings">
|
|
<summary>
|
|
Settings for InstantJson. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.InstantJsonSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.InstantJsonSettings,Nutrient.NativeSDK.API.Settings.SdkInstantJsonSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.InstantJsonSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.InstantJsonSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.InstantJsonSettings,Nutrient.NativeSDK.API.Settings.SdkInstantJsonSettings,Nutrient.NativeSDK.API.Settings.DocumentInstantJsonSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.InstantJsonSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.InstantJsonSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.InstantJsonSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.InstantJsonSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.InstantJsonSettings.RenderTheme">
|
|
<summary>
|
|
Gets or sets the value of RenderTheme.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.InstantJsonSettings.ChangeTrackingEnabled">
|
|
<summary>
|
|
Gets or sets the value of ChangeTrackingEnabled.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.InstantJsonSettings.IsRenderThemeOverridden">
|
|
<summary>
|
|
Gets whether RenderTheme is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.InstantJsonSettings.IsChangeTrackingEnabledOverridden">
|
|
<summary>
|
|
Gets whether ChangeTrackingEnabled is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.InstantJsonSettings.GetRenderTheme">
|
|
<summary>
|
|
The annotation appearance theme to use when importing Instant JSON.
|
|
</summary>
|
|
<returns>The value of the RenderTheme property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.InstantJsonSettings.SetRenderTheme(Nutrient.NativeSDK.API.Settings.InstantJsonRenderTheme)">
|
|
<summary>
|
|
The annotation appearance theme to use when importing Instant JSON.
|
|
</summary>
|
|
<param name="value">The value to set for the RenderTheme property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.InstantJsonSettings.GetChangeTrackingEnabled">
|
|
<summary>
|
|
Whether Instant JSON change tracking is enabled. When enabled, modifications to annotations, form fields, form field values, comments, and bookmarks are recorded so that export produces a diff containing only items that changed — matching Core SDK's export_document_json behavior.
|
|
</summary>
|
|
<returns>The value of the ChangeTrackingEnabled property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.InstantJsonSettings.SetChangeTrackingEnabled(System.Boolean)">
|
|
<summary>
|
|
Whether Instant JSON change tracking is enabled. When enabled, modifications to annotations, form fields, form field values, comments, and bookmarks are recorded so that export produces a diff containing only items that changed — matching Core SDK's export_document_json behavior.
|
|
</summary>
|
|
<param name="value">The value to set for the ChangeTrackingEnabled property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkJbig2Settings">
|
|
<summary>
|
|
SDK-level overrides for Jbig2Settings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkJbig2Settings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkJbig2Settings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentJbig2Settings">
|
|
<summary>
|
|
Document-level overrides for Jbig2Settings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentJbig2Settings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentJbig2Settings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.Jbig2Settings">
|
|
<summary>
|
|
Settings for Jbig2. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.Jbig2Settings.#ctor(Nutrient.NativeSDK.API.Settings.Default.Jbig2Settings,Nutrient.NativeSDK.API.Settings.SdkJbig2Settings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.Jbig2Settings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.Jbig2Settings.#ctor(Nutrient.NativeSDK.API.Settings.Default.Jbig2Settings,Nutrient.NativeSDK.API.Settings.SdkJbig2Settings,Nutrient.NativeSDK.API.Settings.DocumentJbig2Settings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.Jbig2Settings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Jbig2Settings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Jbig2Settings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Jbig2Settings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Jbig2Settings.Jbig2PmsThreshold">
|
|
<summary>
|
|
Gets or sets the value of Jbig2PmsThreshold.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.Jbig2Settings.IsJbig2PmsThresholdOverridden">
|
|
<summary>
|
|
Gets whether Jbig2PmsThreshold is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.Jbig2Settings.GetJbig2PmsThreshold">
|
|
<summary>
|
|
The threshold for Pattern Matching and Substitution (PMS) in JBIG2 compression. Higher values result in more aggressive compression but may reduce quality.
|
|
</summary>
|
|
<returns>The value of the Jbig2PmsThreshold property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.Jbig2Settings.SetJbig2PmsThreshold(System.Single)">
|
|
<summary>
|
|
The threshold for Pattern Matching and Substitution (PMS) in JBIG2 compression. Higher values result in more aggressive compression but may reduce quality.
|
|
</summary>
|
|
<param name="value">The value to set for the Jbig2PmsThreshold property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkJpegSettings">
|
|
<summary>
|
|
SDK-level overrides for JpegSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkJpegSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkJpegSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentJpegSettings">
|
|
<summary>
|
|
Document-level overrides for JpegSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentJpegSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentJpegSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.JpegSettings">
|
|
<summary>
|
|
Settings for Jpeg. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.JpegSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.JpegSettings,Nutrient.NativeSDK.API.Settings.SdkJpegSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.JpegSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.JpegSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.JpegSettings,Nutrient.NativeSDK.API.Settings.SdkJpegSettings,Nutrient.NativeSDK.API.Settings.DocumentJpegSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.JpegSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.JpegSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.JpegSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.JpegSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.JpegSettings.QualitySettings">
|
|
<summary>
|
|
Gets or sets the value of QualitySettings.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.JpegSettings.IsQualitySettingsOverridden">
|
|
<summary>
|
|
Gets whether QualitySettings is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.JpegSettings.GetQualitySettings">
|
|
<summary>
|
|
The quality level for JPEG compression. Higher values produce better quality but larger file sizes.
|
|
</summary>
|
|
<returns>The value of the QualitySettings property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.JpegSettings.SetQualitySettings(System.Byte)">
|
|
<summary>
|
|
The quality level for JPEG compression. Higher values produce better quality but larger file sizes.
|
|
</summary>
|
|
<param name="value">The value to set for the QualitySettings property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkMarkdownSettings">
|
|
<summary>
|
|
SDK-level overrides for MarkdownSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkMarkdownSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkMarkdownSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentMarkdownSettings">
|
|
<summary>
|
|
Document-level overrides for MarkdownSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentMarkdownSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentMarkdownSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.MarkdownSettings">
|
|
<summary>
|
|
Settings for Markdown. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.MarkdownSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.MarkdownSettings,Nutrient.NativeSDK.API.Settings.SdkMarkdownSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.MarkdownSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.MarkdownSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.MarkdownSettings,Nutrient.NativeSDK.API.Settings.SdkMarkdownSettings,Nutrient.NativeSDK.API.Settings.DocumentMarkdownSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.MarkdownSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.MarkdownSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.MarkdownSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.MarkdownSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.MarkdownSettings.ImageExport">
|
|
<summary>
|
|
Gets or sets the value of ImageExport.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.MarkdownSettings.EnableInlineFormatting">
|
|
<summary>
|
|
Gets or sets the value of EnableInlineFormatting.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.MarkdownSettings.EmitPageBoundaryMarkers">
|
|
<summary>
|
|
Gets or sets the value of EmitPageBoundaryMarkers.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.MarkdownSettings.EnableSemanticBlockFormatting">
|
|
<summary>
|
|
Gets or sets the value of EnableSemanticBlockFormatting.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.MarkdownSettings.IncludeHeadersAndFooters">
|
|
<summary>
|
|
Gets or sets the value of IncludeHeadersAndFooters.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.MarkdownSettings.ExtractWordsFromPictures">
|
|
<summary>
|
|
Gets or sets the value of ExtractWordsFromPictures.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.MarkdownSettings.UseHtmlTables">
|
|
<summary>
|
|
Gets or sets the value of UseHtmlTables.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.MarkdownSettings.IsImageExportOverridden">
|
|
<summary>
|
|
Gets whether ImageExport is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.MarkdownSettings.IsEnableInlineFormattingOverridden">
|
|
<summary>
|
|
Gets whether EnableInlineFormatting is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.MarkdownSettings.IsEmitPageBoundaryMarkersOverridden">
|
|
<summary>
|
|
Gets whether EmitPageBoundaryMarkers is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.MarkdownSettings.IsEnableSemanticBlockFormattingOverridden">
|
|
<summary>
|
|
Gets whether EnableSemanticBlockFormatting is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.MarkdownSettings.IsIncludeHeadersAndFootersOverridden">
|
|
<summary>
|
|
Gets whether IncludeHeadersAndFooters is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.MarkdownSettings.IsExtractWordsFromPicturesOverridden">
|
|
<summary>
|
|
Gets whether ExtractWordsFromPictures is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.MarkdownSettings.IsUseHtmlTablesOverridden">
|
|
<summary>
|
|
Gets whether UseHtmlTables is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.MarkdownSettings.GetImageExport">
|
|
<summary>
|
|
Controls how images are exported when converting documents to Markdown.
|
|
</summary>
|
|
<returns>The value of the ImageExport property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.MarkdownSettings.SetImageExport(Nutrient.NativeSDK.API.Settings.ImageExportMode)">
|
|
<summary>
|
|
Controls how images are exported when converting documents to Markdown.
|
|
</summary>
|
|
<param name="value">The value to set for the ImageExport property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.MarkdownSettings.GetEnableInlineFormatting">
|
|
<summary>
|
|
Controls whether inline text formatting (bold, italic) is preserved in the Markdown output using standard markers (<c>**bold**</c>, <c>*italic*</c>).
|
|
</summary>
|
|
<returns>The value of the EnableInlineFormatting property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.MarkdownSettings.SetEnableInlineFormatting(System.Boolean)">
|
|
<summary>
|
|
Controls whether inline text formatting (bold, italic) is preserved in the Markdown output using standard markers (<c>**bold**</c>, <c>*italic*</c>).
|
|
</summary>
|
|
<param name="value">The value to set for the EnableInlineFormatting property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.MarkdownSettings.GetEmitPageBoundaryMarkers">
|
|
<summary>
|
|
When enabled, the converter emits a unique HTML-comment marker at the start of every page (<c><!-- nutrient-page-start: N --></c>, where <c>N</c> is the 1-indexed physical page number). The markers are invisible when the Markdown is rendered to HTML but allow downstream tooling to slice the output reliably back into per-page chunks.
|
|
</summary>
|
|
<returns>The value of the EmitPageBoundaryMarkers property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.MarkdownSettings.SetEmitPageBoundaryMarkers(System.Boolean)">
|
|
<summary>
|
|
When enabled, the converter emits a unique HTML-comment marker at the start of every page (<c><!-- nutrient-page-start: N --></c>, where <c>N</c> is the 1-indexed physical page number). The markers are invisible when the Markdown is rendered to HTML but allow downstream tooling to slice the output reliably back into per-page chunks.
|
|
</summary>
|
|
<param name="value">The value to set for the EmitPageBoundaryMarkers property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.MarkdownSettings.GetEnableSemanticBlockFormatting">
|
|
<summary>
|
|
Controls whether footnotes and captions are rendered with semantic Markdown markers (<c>> </c>, <c>*…*</c>) and whether pictures/charts are emitted at all (<c>![alt]</c> / <c>[Figure]</c>). When <see langword="false"/>, footnotes and captions render as plain paragraphs and pictures/charts are dropped entirely. List items always render with <c>- </c> regardless.
|
|
</summary>
|
|
<returns>The value of the EnableSemanticBlockFormatting property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.MarkdownSettings.SetEnableSemanticBlockFormatting(System.Boolean)">
|
|
<summary>
|
|
Controls whether footnotes and captions are rendered with semantic Markdown markers (<c>> </c>, <c>*…*</c>) and whether pictures/charts are emitted at all (<c>![alt]</c> / <c>[Figure]</c>). When <see langword="false"/>, footnotes and captions render as plain paragraphs and pictures/charts are dropped entirely. List items always render with <c>- </c> regardless.
|
|
</summary>
|
|
<param name="value">The value to set for the EnableSemanticBlockFormatting property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.MarkdownSettings.GetIncludeHeadersAndFooters">
|
|
<summary>
|
|
Controls whether running headers and footers are included in the Markdown output. When included, they render as plain text paragraphs.
|
|
</summary>
|
|
<returns>The value of the IncludeHeadersAndFooters property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.MarkdownSettings.SetIncludeHeadersAndFooters(System.Boolean)">
|
|
<summary>
|
|
Controls whether running headers and footers are included in the Markdown output. When included, they render as plain text paragraphs.
|
|
</summary>
|
|
<param name="value">The value to set for the IncludeHeadersAndFooters property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.MarkdownSettings.GetExtractWordsFromPictures">
|
|
<summary>
|
|
Controls whether words detected inside picture regions are emitted as plain text in Markdown output. This helps preserve chart labels, axis text, legends, and similar image-contained text when available.
|
|
</summary>
|
|
<returns>The value of the ExtractWordsFromPictures property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.MarkdownSettings.SetExtractWordsFromPictures(System.Boolean)">
|
|
<summary>
|
|
Controls whether words detected inside picture regions are emitted as plain text in Markdown output. This helps preserve chart labels, axis text, legends, and similar image-contained text when available.
|
|
</summary>
|
|
<param name="value">The value to set for the ExtractWordsFromPictures property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.MarkdownSettings.GetUseHtmlTables">
|
|
<summary>
|
|
Controls how tables are rendered in the Markdown output. When enabled, tables are emitted as HTML (<c><table>/<tr>/<td></c>) preserving row/column spans where available; when disabled, tables render as pipe-style Markdown.
|
|
</summary>
|
|
<returns>The value of the UseHtmlTables property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.MarkdownSettings.SetUseHtmlTables(System.Boolean)">
|
|
<summary>
|
|
Controls how tables are rendered in the Markdown output. When enabled, tables are emitted as HTML (<c><table>/<tr>/<td></c>) preserving row/column spans where available; when disabled, tables render as pipe-style Markdown.
|
|
</summary>
|
|
<param name="value">The value to set for the UseHtmlTables property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkPdfPageSettings">
|
|
<summary>
|
|
SDK-level overrides for PdfPageSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkPdfPageSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkPdfPageSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentPdfPageSettings">
|
|
<summary>
|
|
Document-level overrides for PdfPageSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentPdfPageSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentPdfPageSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.PdfPageSettings">
|
|
<summary>
|
|
Settings for PdfPage. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfPageSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.PdfPageSettings,Nutrient.NativeSDK.API.Settings.SdkPdfPageSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.PdfPageSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfPageSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.PdfPageSettings,Nutrient.NativeSDK.API.Settings.SdkPdfPageSettings,Nutrient.NativeSDK.API.Settings.DocumentPdfPageSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.PdfPageSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfPageSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfPageSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfPageSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfPageSettings.PageSize">
|
|
<summary>
|
|
Gets or sets the value of PageSize.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfPageSettings.IsPageSizeOverridden">
|
|
<summary>
|
|
Gets whether PageSize is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfPageSettings.GetPageSize">
|
|
<summary>
|
|
The page size for PDF documents.
|
|
</summary>
|
|
<returns>The value of the PageSize property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfPageSettings.SetPageSize(GdPicture14.PdfPageSizes)">
|
|
<summary>
|
|
The page size for PDF documents.
|
|
</summary>
|
|
<param name="value">The value to set for the PageSize property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkPdfSettings">
|
|
<summary>
|
|
SDK-level overrides for PdfSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkPdfSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkPdfSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentPdfSettings">
|
|
<summary>
|
|
Document-level overrides for PdfSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentPdfSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentPdfSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.PdfSettings">
|
|
<summary>
|
|
Settings for Pdf. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.PdfSettings,Nutrient.NativeSDK.API.Settings.SdkPdfSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.PdfSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.PdfSettings,Nutrient.NativeSDK.API.Settings.SdkPdfSettings,Nutrient.NativeSDK.API.Settings.DocumentPdfSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.PdfSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.Conformance">
|
|
<summary>
|
|
Gets or sets the value of Conformance.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.Mode">
|
|
<summary>
|
|
Gets or sets the value of Mode.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.SavePreferences">
|
|
<summary>
|
|
Gets or sets the value of SavePreferences.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.BitonalImageCompression">
|
|
<summary>
|
|
Gets or sets the value of BitonalImageCompression.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.ColorImageCompression">
|
|
<summary>
|
|
Gets or sets the value of ColorImageCompression.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.EnableColorDetection">
|
|
<summary>
|
|
Gets or sets the value of EnableColorDetection.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.UseDeflateOnJpeg">
|
|
<summary>
|
|
Gets or sets the value of UseDeflateOnJpeg.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.ZlibLevel">
|
|
<summary>
|
|
Gets or sets the value of ZlibLevel.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.EnableLinearization">
|
|
<summary>
|
|
Gets or sets the value of EnableLinearization.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.Optimize">
|
|
<summary>
|
|
Gets or sets the value of Optimize.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.ForceImageDpi">
|
|
<summary>
|
|
Gets or sets the value of ForceImageDpi.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.IsConformanceOverridden">
|
|
<summary>
|
|
Gets whether Conformance is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.IsModeOverridden">
|
|
<summary>
|
|
Gets whether Mode is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.IsSavePreferencesOverridden">
|
|
<summary>
|
|
Gets whether SavePreferences is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.IsBitonalImageCompressionOverridden">
|
|
<summary>
|
|
Gets whether BitonalImageCompression is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.IsColorImageCompressionOverridden">
|
|
<summary>
|
|
Gets whether ColorImageCompression is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.IsEnableColorDetectionOverridden">
|
|
<summary>
|
|
Gets whether EnableColorDetection is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.IsUseDeflateOnJpegOverridden">
|
|
<summary>
|
|
Gets whether UseDeflateOnJpeg is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.IsZlibLevelOverridden">
|
|
<summary>
|
|
Gets whether ZlibLevel is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.IsEnableLinearizationOverridden">
|
|
<summary>
|
|
Gets whether EnableLinearization is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.IsOptimizeOverridden">
|
|
<summary>
|
|
Gets whether Optimize is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PdfSettings.IsForceImageDpiOverridden">
|
|
<summary>
|
|
Gets whether ForceImageDpi is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.GetConformance">
|
|
<summary>
|
|
The PDF conformance level for the output document.
|
|
</summary>
|
|
<returns>The value of the Conformance property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.SetConformance(GdPicture14.PdfConformance)">
|
|
<summary>
|
|
The PDF conformance level for the output document.
|
|
</summary>
|
|
<param name="value">The value to set for the Conformance property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.GetMode">
|
|
<summary>
|
|
The mode options for PDF processing.
|
|
</summary>
|
|
<returns>The value of the Mode property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.SetMode(Nutrient.NativeSDK.API.Settings.PdfSettingsMode)">
|
|
<summary>
|
|
The mode options for PDF processing.
|
|
</summary>
|
|
<param name="value">The value to set for the Mode property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.GetSavePreferences">
|
|
<summary>
|
|
Preferences for saving PDF documents.
|
|
</summary>
|
|
<returns>The value of the SavePreferences property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.SetSavePreferences(Nutrient.NativeSDK.API.Settings.PdfSavePreferences)">
|
|
<summary>
|
|
Preferences for saving PDF documents.
|
|
</summary>
|
|
<param name="value">The value to set for the SavePreferences property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.GetBitonalImageCompression">
|
|
<summary>
|
|
The compression method to use for bitonal (black and white) images in PDF documents.
|
|
</summary>
|
|
<returns>The value of the BitonalImageCompression property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.SetBitonalImageCompression(GdPicture14.PdfCompression)">
|
|
<summary>
|
|
The compression method to use for bitonal (black and white) images in PDF documents.
|
|
</summary>
|
|
<param name="value">The value to set for the BitonalImageCompression property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.GetColorImageCompression">
|
|
<summary>
|
|
The compression method to use for color images in PDF documents.
|
|
</summary>
|
|
<returns>The value of the ColorImageCompression property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.SetColorImageCompression(GdPicture14.PdfCompression)">
|
|
<summary>
|
|
The compression method to use for color images in PDF documents.
|
|
</summary>
|
|
<param name="value">The value to set for the ColorImageCompression property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.GetEnableColorDetection">
|
|
<summary>
|
|
Indicates whether automatic color detection is enabled to determine if an image is bitonal or color.
|
|
</summary>
|
|
<returns>The value of the EnableColorDetection property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.SetEnableColorDetection(System.Boolean)">
|
|
<summary>
|
|
Indicates whether automatic color detection is enabled to determine if an image is bitonal or color.
|
|
</summary>
|
|
<param name="value">The value to set for the EnableColorDetection property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.GetUseDeflateOnJpeg">
|
|
<summary>
|
|
Indicates whether Deflate compression should be applied to JPEG images.
|
|
</summary>
|
|
<returns>The value of the UseDeflateOnJpeg property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.SetUseDeflateOnJpeg(System.Boolean)">
|
|
<summary>
|
|
Indicates whether Deflate compression should be applied to JPEG images.
|
|
</summary>
|
|
<param name="value">The value to set for the UseDeflateOnJpeg property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.GetZlibLevel">
|
|
<summary>
|
|
The compression level for Zlib/Deflate compression. Higher values provide better compression but take longer to process.
|
|
</summary>
|
|
<returns>The value of the ZlibLevel property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.SetZlibLevel(System.Int32)">
|
|
<summary>
|
|
The compression level for Zlib/Deflate compression. Higher values provide better compression but take longer to process.
|
|
</summary>
|
|
<param name="value">The value to set for the ZlibLevel property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.GetEnableLinearization">
|
|
<summary>
|
|
Indicates whether PDF linearization (fast web view) is enabled. Linearized PDFs can be displayed page-by-page while still downloading.
|
|
</summary>
|
|
<returns>The value of the EnableLinearization property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.SetEnableLinearization(System.Boolean)">
|
|
<summary>
|
|
Indicates whether PDF linearization (fast web view) is enabled. Linearized PDFs can be displayed page-by-page while still downloading.
|
|
</summary>
|
|
<param name="value">The value to set for the EnableLinearization property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.GetOptimize">
|
|
<summary>
|
|
Indicates whether PDF optimization is enabled to reduce file size.
|
|
</summary>
|
|
<returns>The value of the Optimize property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.SetOptimize(System.Boolean)">
|
|
<summary>
|
|
Indicates whether PDF optimization is enabled to reduce file size.
|
|
</summary>
|
|
<param name="value">The value to set for the Optimize property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.GetForceImageDpi">
|
|
<summary>
|
|
Forces all images in the PDF to a specific DPI (dots per inch) resolution. A value of 0 means no DPI forcing is applied.
|
|
</summary>
|
|
<returns>The value of the ForceImageDpi property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PdfSettings.SetForceImageDpi(System.Int32)">
|
|
<summary>
|
|
Forces all images in the PDF to a specific DPI (dots per inch) resolution. A value of 0 means no DPI forcing is applied.
|
|
</summary>
|
|
<param name="value">The value to set for the ForceImageDpi property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkPresentationSettings">
|
|
<summary>
|
|
SDK-level overrides for PresentationSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkPresentationSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkPresentationSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentPresentationSettings">
|
|
<summary>
|
|
Document-level overrides for PresentationSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentPresentationSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentPresentationSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.PresentationSettings">
|
|
<summary>
|
|
Settings for Presentation. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PresentationSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.PresentationSettings,Nutrient.NativeSDK.API.Settings.SdkPresentationSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.PresentationSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.PresentationSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.PresentationSettings,Nutrient.NativeSDK.API.Settings.SdkPresentationSettings,Nutrient.NativeSDK.API.Settings.DocumentPresentationSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.PresentationSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PresentationSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PresentationSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.PresentationSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkSpreadsheetSettings">
|
|
<summary>
|
|
SDK-level overrides for SpreadsheetSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkSpreadsheetSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkSpreadsheetSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentSpreadsheetSettings">
|
|
<summary>
|
|
Document-level overrides for SpreadsheetSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentSpreadsheetSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentSpreadsheetSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings">
|
|
<summary>
|
|
Settings for Spreadsheet. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.SpreadsheetSettings,Nutrient.NativeSDK.API.Settings.SdkSpreadsheetSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.SpreadsheetSettings,Nutrient.NativeSDK.API.Settings.SdkSpreadsheetSettings,Nutrient.NativeSDK.API.Settings.DocumentSpreadsheetSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.SplitSheetsIntoPages">
|
|
<summary>
|
|
Gets or sets the value of SplitSheetsIntoPages.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.RenderSheetHeadersAndFooters">
|
|
<summary>
|
|
Gets or sets the value of RenderSheetHeadersAndFooters.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.RenderOnlyPrintArea">
|
|
<summary>
|
|
Gets or sets the value of RenderOnlyPrintArea.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.HalfTransparentHeaderFooter">
|
|
<summary>
|
|
Gets or sets the value of HalfTransparentHeaderFooter.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.PageHeightOverride">
|
|
<summary>
|
|
Gets or sets the value of PageHeightOverride.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.PageWidthOverride">
|
|
<summary>
|
|
Gets or sets the value of PageWidthOverride.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.LeftMarginOverride">
|
|
<summary>
|
|
Gets or sets the value of LeftMarginOverride.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.TopMarginOverride">
|
|
<summary>
|
|
Gets or sets the value of TopMarginOverride.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.RightMarginOverride">
|
|
<summary>
|
|
Gets or sets the value of RightMarginOverride.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.BottomMarginOverride">
|
|
<summary>
|
|
Gets or sets the value of BottomMarginOverride.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.MaximumContentWidthPerSheet">
|
|
<summary>
|
|
Gets or sets the value of MaximumContentWidthPerSheet.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.MaximumContentHeightPerSheet">
|
|
<summary>
|
|
Gets or sets the value of MaximumContentHeightPerSheet.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.MaximumPageWidth">
|
|
<summary>
|
|
Gets or sets the value of MaximumPageWidth.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.MaximumPageHeight">
|
|
<summary>
|
|
Gets or sets the value of MaximumPageHeight.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.IsSplitSheetsIntoPagesOverridden">
|
|
<summary>
|
|
Gets whether SplitSheetsIntoPages is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.IsRenderSheetHeadersAndFootersOverridden">
|
|
<summary>
|
|
Gets whether RenderSheetHeadersAndFooters is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.IsRenderOnlyPrintAreaOverridden">
|
|
<summary>
|
|
Gets whether RenderOnlyPrintArea is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.IsHalfTransparentHeaderFooterOverridden">
|
|
<summary>
|
|
Gets whether HalfTransparentHeaderFooter is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.IsPageHeightOverrideOverridden">
|
|
<summary>
|
|
Gets whether PageHeightOverride is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.IsPageWidthOverrideOverridden">
|
|
<summary>
|
|
Gets whether PageWidthOverride is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.IsLeftMarginOverrideOverridden">
|
|
<summary>
|
|
Gets whether LeftMarginOverride is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.IsTopMarginOverrideOverridden">
|
|
<summary>
|
|
Gets whether TopMarginOverride is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.IsRightMarginOverrideOverridden">
|
|
<summary>
|
|
Gets whether RightMarginOverride is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.IsBottomMarginOverrideOverridden">
|
|
<summary>
|
|
Gets whether BottomMarginOverride is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.IsMaximumContentWidthPerSheetOverridden">
|
|
<summary>
|
|
Gets whether MaximumContentWidthPerSheet is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.IsMaximumContentHeightPerSheetOverridden">
|
|
<summary>
|
|
Gets whether MaximumContentHeightPerSheet is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.IsMaximumPageWidthOverridden">
|
|
<summary>
|
|
Gets whether MaximumPageWidth is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.IsMaximumPageHeightOverridden">
|
|
<summary>
|
|
Gets whether MaximumPageHeight is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.GetSplitSheetsIntoPages">
|
|
<summary>
|
|
Flag indicating if spreadsheet sheets should be split into multiple pages.
|
|
</summary>
|
|
<returns>The value of the SplitSheetsIntoPages property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.SetSplitSheetsIntoPages(System.Boolean)">
|
|
<summary>
|
|
Flag indicating if spreadsheet sheets should be split into multiple pages.
|
|
</summary>
|
|
<param name="value">The value to set for the SplitSheetsIntoPages property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.GetRenderSheetHeadersAndFooters">
|
|
<summary>
|
|
Flag indicating if sheet headers and footers should be rendered.
|
|
</summary>
|
|
<returns>The value of the RenderSheetHeadersAndFooters property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.SetRenderSheetHeadersAndFooters(System.Boolean)">
|
|
<summary>
|
|
Flag indicating if sheet headers and footers should be rendered.
|
|
</summary>
|
|
<param name="value">The value to set for the RenderSheetHeadersAndFooters property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.GetRenderOnlyPrintArea">
|
|
<summary>
|
|
Flag indicating if only the print area of spreadsheet sheets should be rendered. If no print area is defined in the sheet, the entire sheet will be rendered.
|
|
</summary>
|
|
<returns>The value of the RenderOnlyPrintArea property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.SetRenderOnlyPrintArea(System.Boolean)">
|
|
<summary>
|
|
Flag indicating if only the print area of spreadsheet sheets should be rendered. If no print area is defined in the sheet, the entire sheet will be rendered.
|
|
</summary>
|
|
<param name="value">The value to set for the RenderOnlyPrintArea property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.GetHalfTransparentHeaderFooter">
|
|
<summary>
|
|
Flag indicating if header/footer content should be rendered with half-transparency.
|
|
</summary>
|
|
<returns>The value of the HalfTransparentHeaderFooter property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.SetHalfTransparentHeaderFooter(System.Boolean)">
|
|
<summary>
|
|
Flag indicating if header/footer content should be rendered with half-transparency.
|
|
</summary>
|
|
<param name="value">The value to set for the HalfTransparentHeaderFooter property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.GetPageHeightOverride">
|
|
<summary>
|
|
Override for the page height in millimeters. If not positive, the default page height is used.
|
|
</summary>
|
|
<returns>The value of the PageHeightOverride property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.SetPageHeightOverride(System.Single)">
|
|
<summary>
|
|
Override for the page height in millimeters. If not positive, the default page height is used.
|
|
</summary>
|
|
<param name="value">The value to set for the PageHeightOverride property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.GetPageWidthOverride">
|
|
<summary>
|
|
Override for the page width in millimeters. If not positive, the default page width is used.
|
|
</summary>
|
|
<returns>The value of the PageWidthOverride property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.SetPageWidthOverride(System.Single)">
|
|
<summary>
|
|
Override for the page width in millimeters. If not positive, the default page width is used.
|
|
</summary>
|
|
<param name="value">The value to set for the PageWidthOverride property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.GetLeftMarginOverride">
|
|
<summary>
|
|
Override for the left margin in millimeters. If negative, the default left margin is used.
|
|
</summary>
|
|
<returns>The value of the LeftMarginOverride property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.SetLeftMarginOverride(System.Single)">
|
|
<summary>
|
|
Override for the left margin in millimeters. If negative, the default left margin is used.
|
|
</summary>
|
|
<param name="value">The value to set for the LeftMarginOverride property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.GetTopMarginOverride">
|
|
<summary>
|
|
Override for the top margin in millimeters. If negative, the default top margin is used.
|
|
</summary>
|
|
<returns>The value of the TopMarginOverride property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.SetTopMarginOverride(System.Single)">
|
|
<summary>
|
|
Override for the top margin in millimeters. If negative, the default top margin is used.
|
|
</summary>
|
|
<param name="value">The value to set for the TopMarginOverride property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.GetRightMarginOverride">
|
|
<summary>
|
|
Override for the right margin in millimeters. If negative, the default right margin is used.
|
|
</summary>
|
|
<returns>The value of the RightMarginOverride property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.SetRightMarginOverride(System.Single)">
|
|
<summary>
|
|
Override for the right margin in millimeters. If negative, the default right margin is used.
|
|
</summary>
|
|
<param name="value">The value to set for the RightMarginOverride property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.GetBottomMarginOverride">
|
|
<summary>
|
|
Override for the bottom margin in millimeters. If negative, the default bottom margin is used.
|
|
</summary>
|
|
<returns>The value of the BottomMarginOverride property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.SetBottomMarginOverride(System.Single)">
|
|
<summary>
|
|
Override for the bottom margin in millimeters. If negative, the default bottom margin is used.
|
|
</summary>
|
|
<param name="value">The value to set for the BottomMarginOverride property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.GetMaximumContentWidthPerSheet">
|
|
<summary>
|
|
Maximum content width per sheet in millimeters. If 0, no limit is applied.
|
|
</summary>
|
|
<returns>The value of the MaximumContentWidthPerSheet property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.SetMaximumContentWidthPerSheet(System.Single)">
|
|
<summary>
|
|
Maximum content width per sheet in millimeters. If 0, no limit is applied.
|
|
</summary>
|
|
<param name="value">The value to set for the MaximumContentWidthPerSheet property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.GetMaximumContentHeightPerSheet">
|
|
<summary>
|
|
Maximum content height per sheet in millimeters. If 0, no limit is applied.
|
|
</summary>
|
|
<returns>The value of the MaximumContentHeightPerSheet property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.SetMaximumContentHeightPerSheet(System.Single)">
|
|
<summary>
|
|
Maximum content height per sheet in millimeters. If 0, no limit is applied.
|
|
</summary>
|
|
<param name="value">The value to set for the MaximumContentHeightPerSheet property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.GetMaximumPageWidth">
|
|
<summary>
|
|
Maximum page width in millimeters.
|
|
</summary>
|
|
<returns>The value of the MaximumPageWidth property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.SetMaximumPageWidth(System.Single)">
|
|
<summary>
|
|
Maximum page width in millimeters.
|
|
</summary>
|
|
<param name="value">The value to set for the MaximumPageWidth property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.GetMaximumPageHeight">
|
|
<summary>
|
|
Maximum page height in millimeters.
|
|
</summary>
|
|
<returns>The value of the MaximumPageHeight property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SpreadsheetSettings.SetMaximumPageHeight(System.Single)">
|
|
<summary>
|
|
Maximum page height in millimeters.
|
|
</summary>
|
|
<param name="value">The value to set for the MaximumPageHeight property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkTiffSettings">
|
|
<summary>
|
|
SDK-level overrides for TiffSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkTiffSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkTiffSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentTiffSettings">
|
|
<summary>
|
|
Document-level overrides for TiffSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentTiffSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentTiffSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.TiffSettings">
|
|
<summary>
|
|
Settings for Tiff. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.TiffSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.TiffSettings,Nutrient.NativeSDK.API.Settings.SdkTiffSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.TiffSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.TiffSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.TiffSettings,Nutrient.NativeSDK.API.Settings.SdkTiffSettings,Nutrient.NativeSDK.API.Settings.DocumentTiffSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.TiffSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.TiffSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.TiffSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.TiffSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.TiffSettings.TiffCompression">
|
|
<summary>
|
|
Gets or sets the value of TiffCompression.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.TiffSettings.IsTiffCompressionOverridden">
|
|
<summary>
|
|
Gets whether TiffCompression is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.TiffSettings.GetTiffCompression">
|
|
<summary>
|
|
The compression method to use for TIFF images.
|
|
</summary>
|
|
<returns>The value of the TiffCompression property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.TiffSettings.SetTiffCompression(GdPicture14.TiffCompression)">
|
|
<summary>
|
|
The compression method to use for TIFF images.
|
|
</summary>
|
|
<param name="value">The value to set for the TiffCompression property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkWordSettings">
|
|
<summary>
|
|
SDK-level overrides for WordSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkWordSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkWordSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentWordSettings">
|
|
<summary>
|
|
Document-level overrides for WordSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentWordSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentWordSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.WordSettings">
|
|
<summary>
|
|
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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.WordSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.WordSettings,Nutrient.NativeSDK.API.Settings.SdkWordSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.WordSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.WordSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.WordSettings,Nutrient.NativeSDK.API.Settings.SdkWordSettings,Nutrient.NativeSDK.API.Settings.DocumentWordSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.WordSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.WordSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.WordSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.WordSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.WordSettings.MarkupMode">
|
|
<summary>
|
|
Gets or sets the value of MarkupMode.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.WordSettings.HalfTransparentHeaderFooter">
|
|
<summary>
|
|
Gets or sets the value of HalfTransparentHeaderFooter.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.WordSettings.BookmarkSource">
|
|
<summary>
|
|
Gets or sets the value of BookmarkSource.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.WordSettings.IsMarkupModeOverridden">
|
|
<summary>
|
|
Gets whether MarkupMode is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.WordSettings.IsHalfTransparentHeaderFooterOverridden">
|
|
<summary>
|
|
Gets whether HalfTransparentHeaderFooter is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.WordSettings.IsBookmarkSourceOverridden">
|
|
<summary>
|
|
Gets whether BookmarkSource is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.WordSettings.GetMarkupMode">
|
|
<summary>
|
|
The markup mode for Word documents.
|
|
</summary>
|
|
<returns>The value of the MarkupMode property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.WordSettings.SetMarkupMode(GdPicture14.DocumentMarkupMode)">
|
|
<summary>
|
|
The markup mode for Word documents.
|
|
</summary>
|
|
<param name="value">The value to set for the MarkupMode property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.WordSettings.GetHalfTransparentHeaderFooter">
|
|
<summary>
|
|
Flag indicating if header/footer content should be rendered with half-transparency.
|
|
</summary>
|
|
<returns>The value of the HalfTransparentHeaderFooter property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.WordSettings.SetHalfTransparentHeaderFooter(System.Boolean)">
|
|
<summary>
|
|
Flag indicating if header/footer content should be rendered with half-transparency.
|
|
</summary>
|
|
<param name="value">The value to set for the HalfTransparentHeaderFooter property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.WordSettings.GetBookmarkSource">
|
|
<summary>
|
|
The boorkmark source for Word documents.
|
|
</summary>
|
|
<returns>The value of the BookmarkSource property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.WordSettings.SetBookmarkSource(GdPicture14.DocumentBookmarkSource)">
|
|
<summary>
|
|
The boorkmark source for Word documents.
|
|
</summary>
|
|
<param name="value">The value to set for the BookmarkSource property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkAiAugmenterSettings">
|
|
<summary>
|
|
SDK-level overrides for AiAugmenterSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkAiAugmenterSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkAiAugmenterSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentAiAugmenterSettings">
|
|
<summary>
|
|
Document-level overrides for AiAugmenterSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentAiAugmenterSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentAiAugmenterSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings">
|
|
<summary>
|
|
Settings for AiAugmenter. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.AiAugmenterSettings,Nutrient.NativeSDK.API.Settings.SdkAiAugmenterSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.AiAugmenterSettings,Nutrient.NativeSDK.API.Settings.SdkAiAugmenterSettings,Nutrient.NativeSDK.API.Settings.DocumentAiAugmenterSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.EnableVlmClassification">
|
|
<summary>
|
|
Gets or sets the value of EnableVlmClassification.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.EnableContentDescription">
|
|
<summary>
|
|
Gets or sets the value of EnableContentDescription.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.ClassificationConfidence">
|
|
<summary>
|
|
Gets or sets the value of ClassificationConfidence.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.EnableLanguageDetection">
|
|
<summary>
|
|
Gets or sets the value of EnableLanguageDetection.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.EnableReadingOrder">
|
|
<summary>
|
|
Gets or sets the value of EnableReadingOrder.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.EnableRelationshipDetection">
|
|
<summary>
|
|
Gets or sets the value of EnableRelationshipDetection.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.IsEnableVlmClassificationOverridden">
|
|
<summary>
|
|
Gets whether EnableVlmClassification is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.IsEnableContentDescriptionOverridden">
|
|
<summary>
|
|
Gets whether EnableContentDescription is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.IsClassificationConfidenceOverridden">
|
|
<summary>
|
|
Gets whether ClassificationConfidence is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.IsEnableLanguageDetectionOverridden">
|
|
<summary>
|
|
Gets whether EnableLanguageDetection is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.IsEnableReadingOrderOverridden">
|
|
<summary>
|
|
Gets whether EnableReadingOrder is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.IsEnableRelationshipDetectionOverridden">
|
|
<summary>
|
|
Gets whether EnableRelationshipDetection is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.GetEnableVlmClassification">
|
|
<summary>
|
|
Enable or disable VLM-based classification. When disabled, falls back to heuristic classification.
|
|
</summary>
|
|
<returns>The value of the EnableVlmClassification property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.SetEnableVlmClassification(System.Boolean)">
|
|
<summary>
|
|
Enable or disable VLM-based classification. When disabled, falls back to heuristic classification.
|
|
</summary>
|
|
<param name="value">The value to set for the EnableVlmClassification property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.GetEnableContentDescription">
|
|
<summary>
|
|
Enable content description extraction for each zone. When enabled, the VLM will provide descriptions of zone content.
|
|
</summary>
|
|
<returns>The value of the EnableContentDescription property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.SetEnableContentDescription(System.Boolean)">
|
|
<summary>
|
|
Enable content description extraction for each zone. When enabled, the VLM will provide descriptions of zone content.
|
|
</summary>
|
|
<param name="value">The value to set for the EnableContentDescription property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.GetClassificationConfidence">
|
|
<summary>
|
|
Minimum confidence threshold for zone classification (0.0 - 1.0).
|
|
</summary>
|
|
<returns>The value of the ClassificationConfidence property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.SetClassificationConfidence(System.Single)">
|
|
<summary>
|
|
Minimum confidence threshold for zone classification (0.0 - 1.0).
|
|
</summary>
|
|
<param name="value">The value to set for the ClassificationConfidence property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.GetEnableLanguageDetection">
|
|
<summary>
|
|
Indicates whether language detection is enabled for text zones.
|
|
</summary>
|
|
<returns>The value of the EnableLanguageDetection property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.SetEnableLanguageDetection(System.Boolean)">
|
|
<summary>
|
|
Indicates whether language detection is enabled for text zones.
|
|
</summary>
|
|
<param name="value">The value to set for the EnableLanguageDetection property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.GetEnableReadingOrder">
|
|
<summary>
|
|
Indicates whether reading order analysis is enabled.
|
|
</summary>
|
|
<returns>The value of the EnableReadingOrder property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.SetEnableReadingOrder(System.Boolean)">
|
|
<summary>
|
|
Indicates whether reading order analysis is enabled.
|
|
</summary>
|
|
<param name="value">The value to set for the EnableReadingOrder property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.GetEnableRelationshipDetection">
|
|
<summary>
|
|
Indicates whether relationship detection between zones is enabled.
|
|
</summary>
|
|
<returns>The value of the EnableRelationshipDetection property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiAugmenterSettings.SetEnableRelationshipDetection(System.Boolean)">
|
|
<summary>
|
|
Indicates whether relationship detection between zones is enabled.
|
|
</summary>
|
|
<param name="value">The value to set for the EnableRelationshipDetection property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkAiProcessingSettings">
|
|
<summary>
|
|
SDK-level overrides for AiProcessingSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkAiProcessingSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkAiProcessingSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentAiProcessingSettings">
|
|
<summary>
|
|
Document-level overrides for AiProcessingSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentAiProcessingSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentAiProcessingSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.AiProcessingSettings">
|
|
<summary>
|
|
Settings for AiProcessing. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.AiProcessingSettings,Nutrient.NativeSDK.API.Settings.SdkAiProcessingSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.AiProcessingSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.AiProcessingSettings,Nutrient.NativeSDK.API.Settings.SdkAiProcessingSettings,Nutrient.NativeSDK.API.Settings.DocumentAiProcessingSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.AiProcessingSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.Provider">
|
|
<summary>
|
|
Gets or sets the value of Provider.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.Model">
|
|
<summary>
|
|
Gets or sets the value of Model.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.Endpoint">
|
|
<summary>
|
|
Gets or sets the value of Endpoint.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.ApiKey">
|
|
<summary>
|
|
Gets or sets the value of ApiKey.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.Temperature">
|
|
<summary>
|
|
Gets or sets the value of Temperature.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.MaxAttempts">
|
|
<summary>
|
|
Gets or sets the value of MaxAttempts.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.IncludeConfidence">
|
|
<summary>
|
|
Gets or sets the value of IncludeConfidence.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.IncludeCompositeConfidence">
|
|
<summary>
|
|
Gets or sets the value of IncludeCompositeConfidence.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.IncludeSourceLocations">
|
|
<summary>
|
|
Gets or sets the value of IncludeSourceLocations.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.StrictStructuredOutput">
|
|
<summary>
|
|
Gets or sets the value of StrictStructuredOutput.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.IsProviderOverridden">
|
|
<summary>
|
|
Gets whether Provider is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.IsModelOverridden">
|
|
<summary>
|
|
Gets whether Model is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.IsEndpointOverridden">
|
|
<summary>
|
|
Gets whether Endpoint is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.IsApiKeyOverridden">
|
|
<summary>
|
|
Gets whether ApiKey is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.IsTemperatureOverridden">
|
|
<summary>
|
|
Gets whether Temperature is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.IsMaxAttemptsOverridden">
|
|
<summary>
|
|
Gets whether MaxAttempts is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.IsIncludeConfidenceOverridden">
|
|
<summary>
|
|
Gets whether IncludeConfidence is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.IsIncludeCompositeConfidenceOverridden">
|
|
<summary>
|
|
Gets whether IncludeCompositeConfidence is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.IsIncludeSourceLocationsOverridden">
|
|
<summary>
|
|
Gets whether IncludeSourceLocations is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.IsStrictStructuredOutputOverridden">
|
|
<summary>
|
|
Gets whether StrictStructuredOutput is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.GetProvider">
|
|
<summary>
|
|
Provider discriminator. One of <c>"openai"</c>, <c>"azure"</c>, or <c>"local"</c>.
|
|
</summary>
|
|
<returns>The value of the Provider property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.SetProvider(System.String)">
|
|
<summary>
|
|
Provider discriminator. One of <c>"openai"</c>, <c>"azure"</c>, or <c>"local"</c>.
|
|
</summary>
|
|
<param name="value">The value to set for the Provider property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.GetModel">
|
|
<summary>
|
|
Model identifier (e.g. <c>"gpt-4o"</c>, an Azure deployment name, or a local model id).
|
|
</summary>
|
|
<returns>The value of the Model property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.SetModel(System.String)">
|
|
<summary>
|
|
Model identifier (e.g. <c>"gpt-4o"</c>, an Azure deployment name, or a local model id).
|
|
</summary>
|
|
<param name="value">The value to set for the Model property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.GetEndpoint">
|
|
<summary>
|
|
Endpoint URL for Azure or local providers. Ignored for the public OpenAI provider.
|
|
</summary>
|
|
<returns>The value of the Endpoint property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.SetEndpoint(System.String)">
|
|
<summary>
|
|
Endpoint URL for Azure or local providers. Ignored for the public OpenAI provider.
|
|
</summary>
|
|
<param name="value">The value to set for the Endpoint property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.GetApiKey">
|
|
<summary>
|
|
API key for the configured provider.
|
|
</summary>
|
|
<returns>The value of the ApiKey property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.SetApiKey(System.String)">
|
|
<summary>
|
|
API key for the configured provider.
|
|
</summary>
|
|
<param name="value">The value to set for the ApiKey property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.GetTemperature">
|
|
<summary>
|
|
Sampling temperature passed to the model. <see langword="null"/> uses the provider default.
|
|
</summary>
|
|
<returns>The value of the Temperature property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.SetTemperature(System.Nullable{System.Double})">
|
|
<summary>
|
|
Sampling temperature passed to the model. <see langword="null"/> uses the provider default.
|
|
</summary>
|
|
<param name="value">The value to set for the Temperature property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.GetMaxAttempts">
|
|
<summary>
|
|
Maximum retry attempts on structured-output failure. <see langword="null"/> uses the capacity default of <c>1</c>.
|
|
</summary>
|
|
<returns>The value of the MaxAttempts property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.SetMaxAttempts(System.Nullable{System.Int32})">
|
|
<summary>
|
|
Maximum retry attempts on structured-output failure. <see langword="null"/> uses the capacity default of <c>1</c>.
|
|
</summary>
|
|
<param name="value">The value to set for the MaxAttempts property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.GetIncludeConfidence">
|
|
<summary>
|
|
Daemon-level default for whether AI processing capacities emit confidence output - the <c>confidence.json</c> sidecar and the per-field confidence signals on <c>result.json</c> metadata. Defaults to <see langword="false"/> (off); a per-request <c>includeConfidence</c> action parameter overrides it.
|
|
</summary>
|
|
<returns>The value of the IncludeConfidence property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.SetIncludeConfidence(System.Boolean)">
|
|
<summary>
|
|
Daemon-level default for whether AI processing capacities emit confidence output - the <c>confidence.json</c> sidecar and the per-field confidence signals on <c>result.json</c> metadata. Defaults to <see langword="false"/> (off); a per-request <c>includeConfidence</c> action parameter overrides it.
|
|
</summary>
|
|
<param name="value">The value to set for the IncludeConfidence property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.GetIncludeCompositeConfidence">
|
|
<summary>
|
|
Daemon-level default for whether the single rolled-up composite confidence number is attached to <c>result.json</c> metadata leaves (the individual signals are surfaced whenever <see cref="P:Nutrient.NativeSDK.API.Settings.Default.AiProcessingSettings.IncludeConfidence"/> is on; this controls only the composite). Defaults to <see langword="false"/> (off); a per-request <c>includeCompositeConfidence</c> action parameter overrides it.
|
|
</summary>
|
|
<returns>The value of the IncludeCompositeConfidence property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.SetIncludeCompositeConfidence(System.Boolean)">
|
|
<summary>
|
|
Daemon-level default for whether the single rolled-up composite confidence number is attached to <c>result.json</c> metadata leaves (the individual signals are surfaced whenever <see cref="P:Nutrient.NativeSDK.API.Settings.Default.AiProcessingSettings.IncludeConfidence"/> is on; this controls only the composite). Defaults to <see langword="false"/> (off); a per-request <c>includeCompositeConfidence</c> action parameter overrides it.
|
|
</summary>
|
|
<param name="value">The value to set for the IncludeCompositeConfidence property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.GetIncludeSourceLocations">
|
|
<summary>
|
|
Whether extraction grounds each extracted field back to its source location in the document — the <c>metadata</c> node of <c>result.json</c> with per-field <c>match</c> labels and source bounding boxes. Defaults to <see langword="true"/>. Turn off to cut model token usage when only the extracted values matter: grounding mirrors the schema in the structured-output request so the model also returns per-field source ids. A per-request <c>includeSourceLocations</c> action parameter overrides it.
|
|
</summary>
|
|
<returns>The value of the IncludeSourceLocations property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.SetIncludeSourceLocations(System.Boolean)">
|
|
<summary>
|
|
Whether extraction grounds each extracted field back to its source location in the document — the <c>metadata</c> node of <c>result.json</c> with per-field <c>match</c> labels and source bounding boxes. Defaults to <see langword="true"/>. Turn off to cut model token usage when only the extracted values matter: grounding mirrors the schema in the structured-output request so the model also returns per-field source ids. A per-request <c>includeSourceLocations</c> action parameter overrides it.
|
|
</summary>
|
|
<param name="value">The value to set for the IncludeSourceLocations property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.GetStrictStructuredOutput">
|
|
<summary>
|
|
Opt-in (default <see langword="false"/>): when true, structured output runs in the provider's strict mode — the response is grammar-constrained to the schema, which is normalized automatically (<c>additionalProperties: false</c>, all properties required, unsupported keywords moved into descriptions). Note that under strict mode the model must emit every schema property — absence can't be expressed by omission unless the schema allows null. A per-request <c>strictStructuredOutput</c> action parameter overrides it.
|
|
</summary>
|
|
<returns>The value of the StrictStructuredOutput property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.AiProcessingSettings.SetStrictStructuredOutput(System.Boolean)">
|
|
<summary>
|
|
Opt-in (default <see langword="false"/>): when true, structured output runs in the provider's strict mode — the response is grammar-constrained to the schema, which is normalized automatically (<c>additionalProperties: false</c>, all properties required, unsupported keywords moved into descriptions). Note that under strict mode the model must emit every schema property — absence can't be expressed by omission unless the schema allows null. A per-request <c>strictStructuredOutput</c> action parameter overrides it.
|
|
</summary>
|
|
<param name="value">The value to set for the StrictStructuredOutput property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkClaudeApiSettings">
|
|
<summary>
|
|
SDK-level overrides for ClaudeApiSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkClaudeApiSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkClaudeApiSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentClaudeApiSettings">
|
|
<summary>
|
|
Document-level overrides for ClaudeApiSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentClaudeApiSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentClaudeApiSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings">
|
|
<summary>
|
|
Settings for ClaudeApi. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.ClaudeApiSettings,Nutrient.NativeSDK.API.Settings.SdkClaudeApiSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.ClaudeApiSettings,Nutrient.NativeSDK.API.Settings.SdkClaudeApiSettings,Nutrient.NativeSDK.API.Settings.DocumentClaudeApiSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.ApiKey">
|
|
<summary>
|
|
Gets or sets the value of ApiKey.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.ApiEndpoint">
|
|
<summary>
|
|
Gets or sets the value of ApiEndpoint.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.Model">
|
|
<summary>
|
|
Gets or sets the value of Model.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.Temperature">
|
|
<summary>
|
|
Gets or sets the value of Temperature.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.MaxTokens">
|
|
<summary>
|
|
Gets or sets the value of MaxTokens.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.SystemPrompt">
|
|
<summary>
|
|
Gets or sets the value of SystemPrompt.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.Stream">
|
|
<summary>
|
|
Gets or sets the value of Stream.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.ClassificationStrategy">
|
|
<summary>
|
|
Gets or sets the value of ClassificationStrategy.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.SendFullPageReference">
|
|
<summary>
|
|
Gets or sets the value of SendFullPageReference.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.BatchSize">
|
|
<summary>
|
|
Gets or sets the value of BatchSize.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.MaxConcurrency">
|
|
<summary>
|
|
Gets or sets the value of MaxConcurrency.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.IsApiKeyOverridden">
|
|
<summary>
|
|
Gets whether ApiKey is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.IsApiEndpointOverridden">
|
|
<summary>
|
|
Gets whether ApiEndpoint is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.IsModelOverridden">
|
|
<summary>
|
|
Gets whether Model is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.IsTemperatureOverridden">
|
|
<summary>
|
|
Gets whether Temperature is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.IsMaxTokensOverridden">
|
|
<summary>
|
|
Gets whether MaxTokens is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.IsSystemPromptOverridden">
|
|
<summary>
|
|
Gets whether SystemPrompt is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.IsStreamOverridden">
|
|
<summary>
|
|
Gets whether Stream is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.IsClassificationStrategyOverridden">
|
|
<summary>
|
|
Gets whether ClassificationStrategy is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.IsSendFullPageReferenceOverridden">
|
|
<summary>
|
|
Gets whether SendFullPageReference is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.IsBatchSizeOverridden">
|
|
<summary>
|
|
Gets whether BatchSize is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.IsMaxConcurrencyOverridden">
|
|
<summary>
|
|
Gets whether MaxConcurrency is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.GetApiKey">
|
|
<summary>
|
|
OpenAI API key for authentication.
|
|
</summary>
|
|
<returns>The value of the ApiKey property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.SetApiKey(System.String)">
|
|
<summary>
|
|
OpenAI API key for authentication.
|
|
</summary>
|
|
<param name="value">The value to set for the ApiKey property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.GetApiEndpoint">
|
|
<summary>
|
|
API endpoint URL for OpenAI-compatible chat completions
|
|
</summary>
|
|
<returns>The value of the ApiEndpoint property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.SetApiEndpoint(System.String)">
|
|
<summary>
|
|
API endpoint URL for OpenAI-compatible chat completions
|
|
</summary>
|
|
<param name="value">The value to set for the ApiEndpoint property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.GetModel">
|
|
<summary>
|
|
Model identifier to use for classification
|
|
</summary>
|
|
<returns>The value of the Model property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.SetModel(System.String)">
|
|
<summary>
|
|
Model identifier to use for classification
|
|
</summary>
|
|
<param name="value">The value to set for the Model property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.GetTemperature">
|
|
<summary>
|
|
Temperature for response generation (0.0 = deterministic, 1.0 = creative). Defaults to 0.0 because zone classification and verbatim text extraction are deterministic tasks — randomness only adds run-to-run noise.
|
|
</summary>
|
|
<returns>The value of the Temperature property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.SetTemperature(System.Double)">
|
|
<summary>
|
|
Temperature for response generation (0.0 = deterministic, 1.0 = creative). Defaults to 0.0 because zone classification and verbatim text extraction are deterministic tasks — randomness only adds run-to-run noise.
|
|
</summary>
|
|
<param name="value">The value to set for the Temperature property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.GetMaxTokens">
|
|
<summary>
|
|
Maximum tokens in response. Claude API requires a positive value. Claude Sonnet 4 supports up to 64K (65536) output tokens.
|
|
</summary>
|
|
<returns>The value of the MaxTokens property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.SetMaxTokens(System.Int32)">
|
|
<summary>
|
|
Maximum tokens in response. Claude API requires a positive value. Claude Sonnet 4 supports up to 64K (65536) output tokens.
|
|
</summary>
|
|
<param name="value">The value to set for the MaxTokens property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.GetSystemPrompt">
|
|
<summary>
|
|
Optional custom system prompt for zone classification. When empty, the module uses a default prompt based on the ClassificationStrategy.
|
|
</summary>
|
|
<returns>The value of the SystemPrompt property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.SetSystemPrompt(System.String)">
|
|
<summary>
|
|
Optional custom system prompt for zone classification. When empty, the module uses a default prompt based on the ClassificationStrategy.
|
|
</summary>
|
|
<param name="value">The value to set for the SystemPrompt property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.GetStream">
|
|
<summary>
|
|
Whether to stream responses from the API
|
|
</summary>
|
|
<returns>The value of the Stream property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.SetStream(System.Boolean)">
|
|
<summary>
|
|
Whether to stream responses from the API
|
|
</summary>
|
|
<param name="value">The value to set for the Stream property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.GetClassificationStrategy">
|
|
<summary>
|
|
Strategy for how zones are sent to the VLM for classification.
|
|
</summary>
|
|
<returns>The value of the ClassificationStrategy property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.SetClassificationStrategy(Nutrient.NativeSDK.API.Settings.VlmClassificationStrategy)">
|
|
<summary>
|
|
Strategy for how zones are sent to the VLM for classification.
|
|
</summary>
|
|
<param name="value">The value to set for the ClassificationStrategy property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.GetSendFullPageReference">
|
|
<summary>
|
|
Whether to send the full page image as reference context alongside cropped zones. Only used when UseZoneCropping is true.
|
|
</summary>
|
|
<returns>The value of the SendFullPageReference property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.SetSendFullPageReference(System.Boolean)">
|
|
<summary>
|
|
Whether to send the full page image as reference context alongside cropped zones. Only used when UseZoneCropping is true.
|
|
</summary>
|
|
<param name="value">The value to set for the SendFullPageReference property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.GetBatchSize">
|
|
<summary>
|
|
Number of zone images to include per VLM API call.
|
|
</summary>
|
|
<returns>The value of the BatchSize property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.SetBatchSize(System.Int32)">
|
|
<summary>
|
|
Number of zone images to include per VLM API call.
|
|
</summary>
|
|
<param name="value">The value to set for the BatchSize property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.GetMaxConcurrency">
|
|
<summary>
|
|
Maximum number of concurrent VLM API calls.
|
|
</summary>
|
|
<returns>The value of the MaxConcurrency property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ClaudeApiSettings.SetMaxConcurrency(System.Int32)">
|
|
<summary>
|
|
Maximum number of concurrent VLM API calls.
|
|
</summary>
|
|
<param name="value">The value to set for the MaxConcurrency property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkContentExtractionSettings">
|
|
<summary>
|
|
SDK-level overrides for ContentExtractionSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkContentExtractionSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkContentExtractionSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentContentExtractionSettings">
|
|
<summary>
|
|
Document-level overrides for ContentExtractionSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentContentExtractionSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentContentExtractionSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings">
|
|
<summary>
|
|
Settings for ContentExtraction. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.ContentExtractionSettings,Nutrient.NativeSDK.API.Settings.SdkContentExtractionSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.ContentExtractionSettings,Nutrient.NativeSDK.API.Settings.SdkContentExtractionSettings,Nutrient.NativeSDK.API.Settings.DocumentContentExtractionSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.EnableOcrExtraction">
|
|
<summary>
|
|
Gets or sets the value of EnableOcrExtraction.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.EnableImageExtraction">
|
|
<summary>
|
|
Gets or sets the value of EnableImageExtraction.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.EnableTableExtraction">
|
|
<summary>
|
|
Gets or sets the value of EnableTableExtraction.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.MinimumZoneConfidence">
|
|
<summary>
|
|
Gets or sets the value of MinimumZoneConfidence.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.EnableFullPageOcrFallback">
|
|
<summary>
|
|
Gets or sets the value of EnableFullPageOcrFallback.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.IsEnableOcrExtractionOverridden">
|
|
<summary>
|
|
Gets whether EnableOcrExtraction is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.IsEnableImageExtractionOverridden">
|
|
<summary>
|
|
Gets whether EnableImageExtraction is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.IsEnableTableExtractionOverridden">
|
|
<summary>
|
|
Gets whether EnableTableExtraction is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.IsMinimumZoneConfidenceOverridden">
|
|
<summary>
|
|
Gets whether MinimumZoneConfidence is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.IsEnableFullPageOcrFallbackOverridden">
|
|
<summary>
|
|
Gets whether EnableFullPageOcrFallback is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.GetEnableOcrExtraction">
|
|
<summary>
|
|
Indicates whether OCR extraction is enabled for text zones.
|
|
</summary>
|
|
<returns>The value of the EnableOcrExtraction property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.SetEnableOcrExtraction(System.Boolean)">
|
|
<summary>
|
|
Indicates whether OCR extraction is enabled for text zones.
|
|
</summary>
|
|
<param name="value">The value to set for the EnableOcrExtraction property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.GetEnableImageExtraction">
|
|
<summary>
|
|
Indicates whether image metadata extraction is enabled for image zones.
|
|
</summary>
|
|
<returns>The value of the EnableImageExtraction property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.SetEnableImageExtraction(System.Boolean)">
|
|
<summary>
|
|
Indicates whether image metadata extraction is enabled for image zones.
|
|
</summary>
|
|
<param name="value">The value to set for the EnableImageExtraction property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.GetEnableTableExtraction">
|
|
<summary>
|
|
Indicates whether table structure extraction is enabled for table zones.
|
|
</summary>
|
|
<returns>The value of the EnableTableExtraction property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.SetEnableTableExtraction(System.Boolean)">
|
|
<summary>
|
|
Indicates whether table structure extraction is enabled for table zones.
|
|
</summary>
|
|
<param name="value">The value to set for the EnableTableExtraction property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.GetMinimumZoneConfidence">
|
|
<summary>
|
|
Minimum confidence threshold to process a zone (0.0 - 1.0). Zones below this confidence will be skipped.
|
|
</summary>
|
|
<returns>The value of the MinimumZoneConfidence property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.SetMinimumZoneConfidence(System.Single)">
|
|
<summary>
|
|
Minimum confidence threshold to process a zone (0.0 - 1.0). Zones below this confidence will be skipped.
|
|
</summary>
|
|
<param name="value">The value to set for the MinimumZoneConfidence property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.GetEnableFullPageOcrFallback">
|
|
<summary>
|
|
Indicates whether to run full page OCR when no zones are detected. This provides a simple OCR-only pipeline without segmentation.
|
|
</summary>
|
|
<returns>The value of the EnableFullPageOcrFallback property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ContentExtractionSettings.SetEnableFullPageOcrFallback(System.Boolean)">
|
|
<summary>
|
|
Indicates whether to run full page OCR when no zones are detected. This provides a simple OCR-only pipeline without segmentation.
|
|
</summary>
|
|
<param name="value">The value to set for the EnableFullPageOcrFallback property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkCustomVlmApiSettings">
|
|
<summary>
|
|
SDK-level overrides for CustomVlmApiSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkCustomVlmApiSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkCustomVlmApiSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentCustomVlmApiSettings">
|
|
<summary>
|
|
Document-level overrides for CustomVlmApiSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentCustomVlmApiSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentCustomVlmApiSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings">
|
|
<summary>
|
|
Settings for CustomVlmApi. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.CustomVlmApiSettings,Nutrient.NativeSDK.API.Settings.SdkCustomVlmApiSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.CustomVlmApiSettings,Nutrient.NativeSDK.API.Settings.SdkCustomVlmApiSettings,Nutrient.NativeSDK.API.Settings.DocumentCustomVlmApiSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.ApiEndpoint">
|
|
<summary>
|
|
Gets or sets the value of ApiEndpoint.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.ApiKey">
|
|
<summary>
|
|
Gets or sets the value of ApiKey.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.Model">
|
|
<summary>
|
|
Gets or sets the value of Model.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.Temperature">
|
|
<summary>
|
|
Gets or sets the value of Temperature.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.MaxTokens">
|
|
<summary>
|
|
Gets or sets the value of MaxTokens.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.SystemPrompt">
|
|
<summary>
|
|
Gets or sets the value of SystemPrompt.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.Stream">
|
|
<summary>
|
|
Gets or sets the value of Stream.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.ClassificationStrategy">
|
|
<summary>
|
|
Gets or sets the value of ClassificationStrategy.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.SendFullPageReference">
|
|
<summary>
|
|
Gets or sets the value of SendFullPageReference.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.BatchSize">
|
|
<summary>
|
|
Gets or sets the value of BatchSize.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.MaxConcurrency">
|
|
<summary>
|
|
Gets or sets the value of MaxConcurrency.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.IsApiEndpointOverridden">
|
|
<summary>
|
|
Gets whether ApiEndpoint is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.IsApiKeyOverridden">
|
|
<summary>
|
|
Gets whether ApiKey is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.IsModelOverridden">
|
|
<summary>
|
|
Gets whether Model is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.IsTemperatureOverridden">
|
|
<summary>
|
|
Gets whether Temperature is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.IsMaxTokensOverridden">
|
|
<summary>
|
|
Gets whether MaxTokens is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.IsSystemPromptOverridden">
|
|
<summary>
|
|
Gets whether SystemPrompt is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.IsStreamOverridden">
|
|
<summary>
|
|
Gets whether Stream is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.IsClassificationStrategyOverridden">
|
|
<summary>
|
|
Gets whether ClassificationStrategy is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.IsSendFullPageReferenceOverridden">
|
|
<summary>
|
|
Gets whether SendFullPageReference is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.IsBatchSizeOverridden">
|
|
<summary>
|
|
Gets whether BatchSize is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.IsMaxConcurrencyOverridden">
|
|
<summary>
|
|
Gets whether MaxConcurrency is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.GetApiEndpoint">
|
|
<summary>
|
|
API endpoint URL for OpenAI-compatible chat completions.
|
|
</summary>
|
|
<returns>The value of the ApiEndpoint property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.SetApiEndpoint(System.String)">
|
|
<summary>
|
|
API endpoint URL for OpenAI-compatible chat completions.
|
|
</summary>
|
|
<param name="value">The value to set for the ApiEndpoint property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.GetApiKey">
|
|
<summary>
|
|
API key for authentication with the VLM service.
|
|
</summary>
|
|
<returns>The value of the ApiKey property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.SetApiKey(System.String)">
|
|
<summary>
|
|
API key for authentication with the VLM service.
|
|
</summary>
|
|
<param name="value">The value to set for the ApiKey property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.GetModel">
|
|
<summary>
|
|
Model identifier to use.
|
|
</summary>
|
|
<returns>The value of the Model property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.SetModel(System.String)">
|
|
<summary>
|
|
Model identifier to use.
|
|
</summary>
|
|
<param name="value">The value to set for the Model property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.GetTemperature">
|
|
<summary>
|
|
Temperature for response generation (0.0 = deterministic, 1.0 = creative). Defaults to 0.0 because zone classification and verbatim text extraction are deterministic tasks — randomness only adds run-to-run noise.
|
|
</summary>
|
|
<returns>The value of the Temperature property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.SetTemperature(System.Double)">
|
|
<summary>
|
|
Temperature for response generation (0.0 = deterministic, 1.0 = creative). Defaults to 0.0 because zone classification and verbatim text extraction are deterministic tasks — randomness only adds run-to-run noise.
|
|
</summary>
|
|
<param name="value">The value to set for the Temperature property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.GetMaxTokens">
|
|
<summary>
|
|
Maximum tokens in response (-1 = unlimited)
|
|
</summary>
|
|
<returns>The value of the MaxTokens property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.SetMaxTokens(System.Int32)">
|
|
<summary>
|
|
Maximum tokens in response (-1 = unlimited)
|
|
</summary>
|
|
<param name="value">The value to set for the MaxTokens property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.GetSystemPrompt">
|
|
<summary>
|
|
Optional custom system prompt for zone classification. When empty, the module uses a default prompt based on the ClassificationStrategy.
|
|
</summary>
|
|
<returns>The value of the SystemPrompt property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.SetSystemPrompt(System.String)">
|
|
<summary>
|
|
Optional custom system prompt for zone classification. When empty, the module uses a default prompt based on the ClassificationStrategy.
|
|
</summary>
|
|
<param name="value">The value to set for the SystemPrompt property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.GetStream">
|
|
<summary>
|
|
Whether to stream responses from the API
|
|
</summary>
|
|
<returns>The value of the Stream property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.SetStream(System.Boolean)">
|
|
<summary>
|
|
Whether to stream responses from the API
|
|
</summary>
|
|
<param name="value">The value to set for the Stream property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.GetClassificationStrategy">
|
|
<summary>
|
|
Strategy for how zones are sent to the VLM for classification.
|
|
</summary>
|
|
<returns>The value of the ClassificationStrategy property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.SetClassificationStrategy(Nutrient.NativeSDK.API.Settings.VlmClassificationStrategy)">
|
|
<summary>
|
|
Strategy for how zones are sent to the VLM for classification.
|
|
</summary>
|
|
<param name="value">The value to set for the ClassificationStrategy property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.GetSendFullPageReference">
|
|
<summary>
|
|
Whether to send the full page image as reference context alongside cropped zones. Only used when UseZoneCropping is true.
|
|
</summary>
|
|
<returns>The value of the SendFullPageReference property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.SetSendFullPageReference(System.Boolean)">
|
|
<summary>
|
|
Whether to send the full page image as reference context alongside cropped zones. Only used when UseZoneCropping is true.
|
|
</summary>
|
|
<param name="value">The value to set for the SendFullPageReference property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.GetBatchSize">
|
|
<summary>
|
|
Number of zone images to include per VLM API call.
|
|
</summary>
|
|
<returns>The value of the BatchSize property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.SetBatchSize(System.Int32)">
|
|
<summary>
|
|
Number of zone images to include per VLM API call.
|
|
</summary>
|
|
<param name="value">The value to set for the BatchSize property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.GetMaxConcurrency">
|
|
<summary>
|
|
Maximum number of concurrent VLM API calls.
|
|
</summary>
|
|
<returns>The value of the MaxConcurrency property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.CustomVlmApiSettings.SetMaxConcurrency(System.Int32)">
|
|
<summary>
|
|
Maximum number of concurrent VLM API calls.
|
|
</summary>
|
|
<param name="value">The value to set for the MaxConcurrency property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkDeskewSettings">
|
|
<summary>
|
|
SDK-level overrides for DeskewSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkDeskewSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkDeskewSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentDeskewSettings">
|
|
<summary>
|
|
Document-level overrides for DeskewSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentDeskewSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentDeskewSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DeskewSettings">
|
|
<summary>
|
|
Settings for Deskew. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DeskewSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.DeskewSettings,Nutrient.NativeSDK.API.Settings.SdkDeskewSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DeskewSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DeskewSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.DeskewSettings,Nutrient.NativeSDK.API.Settings.SdkDeskewSettings,Nutrient.NativeSDK.API.Settings.DocumentDeskewSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DeskewSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.DeskewSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.DeskewSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.DeskewSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.DeskewSettings.EnableDeskew">
|
|
<summary>
|
|
Gets or sets the value of EnableDeskew.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.DeskewSettings.InverseDeskew">
|
|
<summary>
|
|
Gets or sets the value of InverseDeskew.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.DeskewSettings.SkewTolerance">
|
|
<summary>
|
|
Gets or sets the value of SkewTolerance.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.DeskewSettings.SkewBinarizationMethod">
|
|
<summary>
|
|
Gets or sets the value of SkewBinarizationMethod.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.DeskewSettings.IsEnableDeskewOverridden">
|
|
<summary>
|
|
Gets whether EnableDeskew is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.DeskewSettings.IsInverseDeskewOverridden">
|
|
<summary>
|
|
Gets whether InverseDeskew is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.DeskewSettings.IsSkewToleranceOverridden">
|
|
<summary>
|
|
Gets whether SkewTolerance is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.DeskewSettings.IsSkewBinarizationMethodOverridden">
|
|
<summary>
|
|
Gets whether SkewBinarizationMethod is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DeskewSettings.GetEnableDeskew">
|
|
<summary>
|
|
Indicates whether automatic deskewing is enabled.
|
|
</summary>
|
|
<returns>The value of the EnableDeskew property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DeskewSettings.SetEnableDeskew(System.Boolean)">
|
|
<summary>
|
|
Indicates whether automatic deskewing is enabled.
|
|
</summary>
|
|
<param name="value">The value to set for the EnableDeskew property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DeskewSettings.GetInverseDeskew">
|
|
<summary>
|
|
Indicates whether the inverse deskew transform is enabled. When disabled, bounding boxes remain in deskewed-image coordinates.
|
|
</summary>
|
|
<returns>The value of the InverseDeskew property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DeskewSettings.SetInverseDeskew(System.Boolean)">
|
|
<summary>
|
|
Indicates whether the inverse deskew transform is enabled. When disabled, bounding boxes remain in deskewed-image coordinates.
|
|
</summary>
|
|
<param name="value">The value to set for the InverseDeskew property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DeskewSettings.GetSkewTolerance">
|
|
<summary>
|
|
Maximum skew angle tolerance in degrees.
|
|
</summary>
|
|
<returns>The value of the SkewTolerance property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DeskewSettings.SetSkewTolerance(System.Single)">
|
|
<summary>
|
|
Maximum skew angle tolerance in degrees.
|
|
</summary>
|
|
<param name="value">The value to set for the SkewTolerance property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DeskewSettings.GetSkewBinarizationMethod">
|
|
<summary>
|
|
Binarization method for skew detection. Supported values: "default" (internal Modified Otsu), "sauvola" (better for poor contrast), "otsu" (explicit Modified Otsu).
|
|
</summary>
|
|
<returns>The value of the SkewBinarizationMethod property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DeskewSettings.SetSkewBinarizationMethod(System.String)">
|
|
<summary>
|
|
Binarization method for skew detection. Supported values: "default" (internal Modified Otsu), "sauvola" (better for poor contrast), "otsu" (explicit Modified Otsu).
|
|
</summary>
|
|
<param name="value">The value to set for the SkewBinarizationMethod property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkDocumentLayoutJsonExportSettings">
|
|
<summary>
|
|
SDK-level overrides for DocumentLayoutJsonExportSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkDocumentLayoutJsonExportSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkDocumentLayoutJsonExportSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentDocumentLayoutJsonExportSettings">
|
|
<summary>
|
|
Document-level overrides for DocumentLayoutJsonExportSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentDocumentLayoutJsonExportSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentDocumentLayoutJsonExportSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentLayoutJsonExportSettings">
|
|
<summary>
|
|
Settings for DocumentLayoutJsonExport. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentLayoutJsonExportSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.DocumentLayoutJsonExportSettings,Nutrient.NativeSDK.API.Settings.SdkDocumentLayoutJsonExportSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentLayoutJsonExportSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentLayoutJsonExportSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.DocumentLayoutJsonExportSettings,Nutrient.NativeSDK.API.Settings.SdkDocumentLayoutJsonExportSettings,Nutrient.NativeSDK.API.Settings.DocumentDocumentLayoutJsonExportSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentLayoutJsonExportSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.DocumentLayoutJsonExportSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.DocumentLayoutJsonExportSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.DocumentLayoutJsonExportSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.DocumentLayoutJsonExportSettings.Content">
|
|
<summary>
|
|
Gets or sets the value of Content.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.DocumentLayoutJsonExportSettings.Format">
|
|
<summary>
|
|
Gets or sets the value of Format.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.DocumentLayoutJsonExportSettings.IsContentOverridden">
|
|
<summary>
|
|
Gets whether Content is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.DocumentLayoutJsonExportSettings.IsFormatOverridden">
|
|
<summary>
|
|
Gets whether Format is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentLayoutJsonExportSettings.GetContent">
|
|
<summary>
|
|
The content elements to include in JSON output.
|
|
</summary>
|
|
<returns>The value of the Content property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentLayoutJsonExportSettings.SetContent(Nutrient.NativeSDK.API.Settings.JsonExportContent)">
|
|
<summary>
|
|
The content elements to include in JSON output.
|
|
</summary>
|
|
<param name="value">The value to set for the Content property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentLayoutJsonExportSettings.GetFormat">
|
|
<summary>
|
|
The formatting options for JSON output.
|
|
</summary>
|
|
<returns>The value of the Format property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentLayoutJsonExportSettings.SetFormat(Nutrient.NativeSDK.API.Settings.JsonExportFormat)">
|
|
<summary>
|
|
The formatting options for JSON output.
|
|
</summary>
|
|
<param name="value">The value to set for the Format property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkFinalizerSettings">
|
|
<summary>
|
|
SDK-level overrides for FinalizerSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkFinalizerSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkFinalizerSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentFinalizerSettings">
|
|
<summary>
|
|
Document-level overrides for FinalizerSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentFinalizerSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentFinalizerSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.FinalizerSettings">
|
|
<summary>
|
|
Settings for Finalizer. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FinalizerSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.FinalizerSettings,Nutrient.NativeSDK.API.Settings.SdkFinalizerSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.FinalizerSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FinalizerSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.FinalizerSettings,Nutrient.NativeSDK.API.Settings.SdkFinalizerSettings,Nutrient.NativeSDK.API.Settings.DocumentFinalizerSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.FinalizerSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FinalizerSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FinalizerSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FinalizerSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FinalizerSettings.EnableValidation">
|
|
<summary>
|
|
Gets or sets the value of EnableValidation.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FinalizerSettings.MinimumDocumentConfidence">
|
|
<summary>
|
|
Gets or sets the value of MinimumDocumentConfidence.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FinalizerSettings.IsEnableValidationOverridden">
|
|
<summary>
|
|
Gets whether EnableValidation is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FinalizerSettings.IsMinimumDocumentConfidenceOverridden">
|
|
<summary>
|
|
Gets whether MinimumDocumentConfidence is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FinalizerSettings.GetEnableValidation">
|
|
<summary>
|
|
Indicates whether validation of the final document layout is enabled.
|
|
</summary>
|
|
<returns>The value of the EnableValidation property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FinalizerSettings.SetEnableValidation(System.Boolean)">
|
|
<summary>
|
|
Indicates whether validation of the final document layout is enabled.
|
|
</summary>
|
|
<param name="value">The value to set for the EnableValidation property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FinalizerSettings.GetMinimumDocumentConfidence">
|
|
<summary>
|
|
Minimum overall confidence threshold for the final document (0.0 - 1.0). Documents with average confidence below this threshold will trigger a validation warning.
|
|
</summary>
|
|
<returns>The value of the MinimumDocumentConfidence property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FinalizerSettings.SetMinimumDocumentConfidence(System.Single)">
|
|
<summary>
|
|
Minimum overall confidence threshold for the final document (0.0 - 1.0). Documents with average confidence below this threshold will trigger a validation warning.
|
|
</summary>
|
|
<param name="value">The value to set for the MinimumDocumentConfidence property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkFormLabelingSettings">
|
|
<summary>
|
|
SDK-level overrides for FormLabelingSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkFormLabelingSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkFormLabelingSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentFormLabelingSettings">
|
|
<summary>
|
|
Document-level overrides for FormLabelingSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentFormLabelingSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentFormLabelingSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.FormLabelingSettings">
|
|
<summary>
|
|
Settings for FormLabeling. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormLabelingSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.FormLabelingSettings,Nutrient.NativeSDK.API.Settings.SdkFormLabelingSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.FormLabelingSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormLabelingSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.FormLabelingSettings,Nutrient.NativeSDK.API.Settings.SdkFormLabelingSettings,Nutrient.NativeSDK.API.Settings.DocumentFormLabelingSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.FormLabelingSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormLabelingSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormLabelingSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormLabelingSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormLabelingSettings.EnableAiLabeling">
|
|
<summary>
|
|
Gets or sets the value of EnableAiLabeling.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormLabelingSettings.EnableAiRemoveFalsePositives">
|
|
<summary>
|
|
Gets or sets the value of EnableAiRemoveFalsePositives.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormLabelingSettings.CandidateLabels">
|
|
<summary>
|
|
Gets or sets the value of CandidateLabels.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormLabelingSettings.IsEnableAiLabelingOverridden">
|
|
<summary>
|
|
Gets whether EnableAiLabeling is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormLabelingSettings.IsEnableAiRemoveFalsePositivesOverridden">
|
|
<summary>
|
|
Gets whether EnableAiRemoveFalsePositives is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormLabelingSettings.IsCandidateLabelsOverridden">
|
|
<summary>
|
|
Gets whether CandidateLabels is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormLabelingSettings.GetEnableAiLabeling">
|
|
<summary>
|
|
Opt in to AI semantic labeling of detected form fields. When false (default), form detection runs offline and no vision model is contacted; when true, the labeler draws numbered marks on the page and queries the provider configured via <see cref="P:Nutrient.NativeSDK.API.Settings.Default.VisionSettings.Provider"/>.
|
|
</summary>
|
|
<returns>The value of the EnableAiLabeling property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormLabelingSettings.SetEnableAiLabeling(System.Boolean)">
|
|
<summary>
|
|
Opt in to AI semantic labeling of detected form fields. When false (default), form detection runs offline and no vision model is contacted; when true, the labeler draws numbered marks on the page and queries the provider configured via <see cref="P:Nutrient.NativeSDK.API.Settings.Default.VisionSettings.Provider"/>.
|
|
</summary>
|
|
<param name="value">The value to set for the EnableAiLabeling property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormLabelingSettings.GetEnableAiRemoveFalsePositives">
|
|
<summary>
|
|
When true, form fields the AI flags as false positives are removed from the document graph so they never reach the exported output. When false (default), flagged fields are kept and annotated (non-destructive). Only takes effect when <see cref="P:Nutrient.NativeSDK.API.Settings.Default.FormLabelingSettings.EnableAiLabeling"/> is true.
|
|
</summary>
|
|
<returns>The value of the EnableAiRemoveFalsePositives property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormLabelingSettings.SetEnableAiRemoveFalsePositives(System.Boolean)">
|
|
<summary>
|
|
When true, form fields the AI flags as false positives are removed from the document graph so they never reach the exported output. When false (default), flagged fields are kept and annotated (non-destructive). Only takes effect when <see cref="P:Nutrient.NativeSDK.API.Settings.Default.FormLabelingSettings.EnableAiLabeling"/> is true.
|
|
</summary>
|
|
<param name="value">The value to set for the EnableAiRemoveFalsePositives property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormLabelingSettings.GetCandidateLabels">
|
|
<summary>
|
|
Optional vocabulary of candidate labels the model should prefer when labeling. Provide labels as a newline- or comma-separated list (for example, "First name, Last name, Date of birth"). The model matches a field to one of these when it fits, and proposes a new label otherwise; each field's <c>FormFieldNode.LabelSource</c> records whether the label was "matched" or "invented". Matched labels are normalized to the casing given here. Empty (default) means fully free-form labeling.
|
|
</summary>
|
|
<returns>The value of the CandidateLabels property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormLabelingSettings.SetCandidateLabels(System.String)">
|
|
<summary>
|
|
Optional vocabulary of candidate labels the model should prefer when labeling. Provide labels as a newline- or comma-separated list (for example, "First name, Last name, Date of birth"). The model matches a field to one of these when it fits, and proposes a new label otherwise; each field's <c>FormFieldNode.LabelSource</c> records whether the label was "matched" or "invented". Matched labels are normalized to the casing given here. Empty (default) means fully free-form labeling.
|
|
</summary>
|
|
<param name="value">The value to set for the CandidateLabels property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkFormRecognitionSettings">
|
|
<summary>
|
|
SDK-level overrides for FormRecognitionSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkFormRecognitionSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkFormRecognitionSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentFormRecognitionSettings">
|
|
<summary>
|
|
Document-level overrides for FormRecognitionSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentFormRecognitionSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentFormRecognitionSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings">
|
|
<summary>
|
|
Settings for FormRecognition. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.FormRecognitionSettings,Nutrient.NativeSDK.API.Settings.SdkFormRecognitionSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.FormRecognitionSettings,Nutrient.NativeSDK.API.Settings.SdkFormRecognitionSettings,Nutrient.NativeSDK.API.Settings.DocumentFormRecognitionSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.ModelPath">
|
|
<summary>
|
|
Gets or sets the value of ModelPath.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.UseCpuOnly">
|
|
<summary>
|
|
Gets or sets the value of UseCpuOnly.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.ConfidenceThreshold">
|
|
<summary>
|
|
Gets or sets the value of ConfidenceThreshold.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.NumSelect">
|
|
<summary>
|
|
Gets or sets the value of NumSelect.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.NumClasses">
|
|
<summary>
|
|
Gets or sets the value of NumClasses.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.TextLogitBias">
|
|
<summary>
|
|
Gets or sets the value of TextLogitBias.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.CheckboxLogitBias">
|
|
<summary>
|
|
Gets or sets the value of CheckboxLogitBias.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.SignatureLogitBias">
|
|
<summary>
|
|
Gets or sets the value of SignatureLogitBias.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.IsModelPathOverridden">
|
|
<summary>
|
|
Gets whether ModelPath is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.IsUseCpuOnlyOverridden">
|
|
<summary>
|
|
Gets whether UseCpuOnly is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.IsConfidenceThresholdOverridden">
|
|
<summary>
|
|
Gets whether ConfidenceThreshold is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.IsNumSelectOverridden">
|
|
<summary>
|
|
Gets whether NumSelect is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.IsNumClassesOverridden">
|
|
<summary>
|
|
Gets whether NumClasses is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.IsTextLogitBiasOverridden">
|
|
<summary>
|
|
Gets whether TextLogitBias is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.IsCheckboxLogitBiasOverridden">
|
|
<summary>
|
|
Gets whether CheckboxLogitBias is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.IsSignatureLogitBiasOverridden">
|
|
<summary>
|
|
Gets whether SignatureLogitBias is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.GetModelPath">
|
|
<summary>
|
|
Path to the TorchScript RF-DETR model file (model.onnx).
|
|
</summary>
|
|
<returns>The value of the ModelPath property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.SetModelPath(System.String)">
|
|
<summary>
|
|
Path to the TorchScript RF-DETR model file (model.onnx).
|
|
</summary>
|
|
<param name="value">The value to set for the ModelPath property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.GetUseCpuOnly">
|
|
<summary>
|
|
Enable CPU mode for ONNX. When true, forces CPU execution. When false, attempts to use GPU if available (CUDA/MPS).
|
|
</summary>
|
|
<returns>The value of the UseCpuOnly property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.SetUseCpuOnly(System.Boolean)">
|
|
<summary>
|
|
Enable CPU mode for ONNX. When true, forces CPU execution. When false, attempts to use GPU if available (CUDA/MPS).
|
|
</summary>
|
|
<param name="value">The value to set for the UseCpuOnly property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.GetConfidenceThreshold">
|
|
<summary>
|
|
Confidence threshold for form field predictions. Default is 0.5 as specified in the RF-DETR model.
|
|
</summary>
|
|
<returns>The value of the ConfidenceThreshold property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.SetConfidenceThreshold(System.Single)">
|
|
<summary>
|
|
Confidence threshold for form field predictions. Default is 0.5 as specified in the RF-DETR model.
|
|
</summary>
|
|
<param name="value">The value to set for the ConfidenceThreshold property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.GetNumSelect">
|
|
<summary>
|
|
Number of top predictions to select during postprocessing. Default is 300 as specified in the RF-DETR configuration.
|
|
</summary>
|
|
<returns>The value of the NumSelect property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.SetNumSelect(System.Int32)">
|
|
<summary>
|
|
Number of top predictions to select during postprocessing. Default is 300 as specified in the RF-DETR configuration.
|
|
</summary>
|
|
<param name="value">The value to set for the NumSelect property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.GetNumClasses">
|
|
<summary>
|
|
Number of object classes (TextBox, ChoiceButton, Signature).
|
|
</summary>
|
|
<returns>The value of the NumClasses property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.SetNumClasses(System.Int32)">
|
|
<summary>
|
|
Number of object classes (TextBox, ChoiceButton, Signature).
|
|
</summary>
|
|
<param name="value">The value to set for the NumClasses property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.GetTextLogitBias">
|
|
<summary>
|
|
Logit bias applied to the Text class before sigmoid during postprocessing. Positive values increase Text detections, negative values suppress them. Default 0 (no bias).
|
|
</summary>
|
|
<returns>The value of the TextLogitBias property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.SetTextLogitBias(System.Single)">
|
|
<summary>
|
|
Logit bias applied to the Text class before sigmoid during postprocessing. Positive values increase Text detections, negative values suppress them. Default 0 (no bias).
|
|
</summary>
|
|
<param name="value">The value to set for the TextLogitBias property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.GetCheckboxLogitBias">
|
|
<summary>
|
|
Logit bias applied to the Checkbox class before sigmoid during postprocessing. Positive values increase Checkbox detections, negative values suppress them. Default 0 (no bias).
|
|
</summary>
|
|
<returns>The value of the CheckboxLogitBias property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.SetCheckboxLogitBias(System.Single)">
|
|
<summary>
|
|
Logit bias applied to the Checkbox class before sigmoid during postprocessing. Positive values increase Checkbox detections, negative values suppress them. Default 0 (no bias).
|
|
</summary>
|
|
<param name="value">The value to set for the CheckboxLogitBias property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.GetSignatureLogitBias">
|
|
<summary>
|
|
Logit bias applied to the Signature class before sigmoid during postprocessing. Positive values increase Signature detections, negative values suppress them. Default 0 (no bias).
|
|
</summary>
|
|
<returns>The value of the SignatureLogitBias property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.FormRecognitionSettings.SetSignatureLogitBias(System.Single)">
|
|
<summary>
|
|
Logit bias applied to the Signature class before sigmoid during postprocessing. Positive values increase Signature detections, negative values suppress them. Default 0 (no bias).
|
|
</summary>
|
|
<param name="value">The value to set for the SignatureLogitBias property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkHandwritingSettings">
|
|
<summary>
|
|
SDK-level overrides for HandwritingSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkHandwritingSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkHandwritingSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentHandwritingSettings">
|
|
<summary>
|
|
Document-level overrides for HandwritingSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentHandwritingSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentHandwritingSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.HandwritingSettings">
|
|
<summary>
|
|
Settings for Handwriting. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.HandwritingSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.HandwritingSettings,Nutrient.NativeSDK.API.Settings.SdkHandwritingSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.HandwritingSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.HandwritingSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.HandwritingSettings,Nutrient.NativeSDK.API.Settings.SdkHandwritingSettings,Nutrient.NativeSDK.API.Settings.DocumentHandwritingSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.HandwritingSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.HandwritingSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.HandwritingSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.HandwritingSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.HandwritingSettings.WordRefiningMethod">
|
|
<summary>
|
|
Gets or sets the value of WordRefiningMethod.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.HandwritingSettings.IsWordRefiningMethodOverridden">
|
|
<summary>
|
|
Gets whether WordRefiningMethod is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.HandwritingSettings.GetWordRefiningMethod">
|
|
<summary>
|
|
Controls the method used to refine detected handwritten words when AI-augmented text is available for the zone.
|
|
</summary>
|
|
<returns>The value of the WordRefiningMethod property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.HandwritingSettings.SetWordRefiningMethod(Nutrient.NativeSDK.API.Settings.WordRefiningMethod)">
|
|
<summary>
|
|
Controls the method used to refine detected handwritten words when AI-augmented text is available for the zone.
|
|
</summary>
|
|
<param name="value">The value to set for the WordRefiningMethod property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkInferenceLayoutSettings">
|
|
<summary>
|
|
SDK-level overrides for InferenceLayoutSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkInferenceLayoutSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkInferenceLayoutSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentInferenceLayoutSettings">
|
|
<summary>
|
|
Document-level overrides for InferenceLayoutSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentInferenceLayoutSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentInferenceLayoutSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.InferenceLayoutSettings">
|
|
<summary>
|
|
Settings for InferenceLayout. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.InferenceLayoutSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.InferenceLayoutSettings,Nutrient.NativeSDK.API.Settings.SdkInferenceLayoutSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.InferenceLayoutSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.InferenceLayoutSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.InferenceLayoutSettings,Nutrient.NativeSDK.API.Settings.SdkInferenceLayoutSettings,Nutrient.NativeSDK.API.Settings.DocumentInferenceLayoutSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.InferenceLayoutSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.InferenceLayoutSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.InferenceLayoutSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.InferenceLayoutSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.InferenceLayoutSettings.ConfidenceThreshold">
|
|
<summary>
|
|
Gets or sets the value of ConfidenceThreshold.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.InferenceLayoutSettings.IsConfidenceThresholdOverridden">
|
|
<summary>
|
|
Gets whether ConfidenceThreshold is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.InferenceLayoutSettings.GetConfidenceThreshold">
|
|
<summary>
|
|
Detection confidence threshold (0.0 to 1.0). Detections with confidence below this threshold will be filtered out.
|
|
</summary>
|
|
<returns>The value of the ConfidenceThreshold property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.InferenceLayoutSettings.SetConfidenceThreshold(System.Single)">
|
|
<summary>
|
|
Detection confidence threshold (0.0 to 1.0). Detections with confidence below this threshold will be filtered out.
|
|
</summary>
|
|
<param name="value">The value to set for the ConfidenceThreshold property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkOcrSettings">
|
|
<summary>
|
|
SDK-level overrides for OcrSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkOcrSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkOcrSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentOcrSettings">
|
|
<summary>
|
|
Document-level overrides for OcrSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentOcrSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentOcrSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.OcrSettings">
|
|
<summary>
|
|
Settings for Ocr. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OcrSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.OcrSettings,Nutrient.NativeSDK.API.Settings.SdkOcrSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.OcrSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OcrSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.OcrSettings,Nutrient.NativeSDK.API.Settings.SdkOcrSettings,Nutrient.NativeSDK.API.Settings.DocumentOcrSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.OcrSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OcrSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OcrSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OcrSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OcrSettings.DefaultLanguages">
|
|
<summary>
|
|
Gets or sets the value of DefaultLanguages.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OcrSettings.FavorAccuracy">
|
|
<summary>
|
|
Gets or sets the value of FavorAccuracy.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OcrSettings.EnablePreprocessing">
|
|
<summary>
|
|
Gets or sets the value of EnablePreprocessing.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OcrSettings.EnableSkewDetection">
|
|
<summary>
|
|
Gets or sets the value of EnableSkewDetection.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OcrSettings.EnableTableDetection">
|
|
<summary>
|
|
Gets or sets the value of EnableTableDetection.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OcrSettings.IsDefaultLanguagesOverridden">
|
|
<summary>
|
|
Gets whether DefaultLanguages is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OcrSettings.IsFavorAccuracyOverridden">
|
|
<summary>
|
|
Gets whether FavorAccuracy is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OcrSettings.IsEnablePreprocessingOverridden">
|
|
<summary>
|
|
Gets whether EnablePreprocessing is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OcrSettings.IsEnableSkewDetectionOverridden">
|
|
<summary>
|
|
Gets whether EnableSkewDetection is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OcrSettings.IsEnableTableDetectionOverridden">
|
|
<summary>
|
|
Gets whether EnableTableDetection is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OcrSettings.GetDefaultLanguages">
|
|
<summary>
|
|
Default OCR languages to use (comma-separated language codes).
|
|
</summary>
|
|
<returns>The value of the DefaultLanguages property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OcrSettings.SetDefaultLanguages(System.String)">
|
|
<summary>
|
|
Default OCR languages to use (comma-separated language codes).
|
|
</summary>
|
|
<param name="value">The value to set for the DefaultLanguages property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OcrSettings.GetFavorAccuracy">
|
|
<summary>
|
|
Indicates whether to favor accuracy over speed in OCR processing.
|
|
</summary>
|
|
<returns>The value of the FavorAccuracy property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OcrSettings.SetFavorAccuracy(System.Boolean)">
|
|
<summary>
|
|
Indicates whether to favor accuracy over speed in OCR processing.
|
|
</summary>
|
|
<param name="value">The value to set for the FavorAccuracy property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OcrSettings.GetEnablePreprocessing">
|
|
<summary>
|
|
Indicates whether to enable image preprocessing before OCR.
|
|
</summary>
|
|
<returns>The value of the EnablePreprocessing property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OcrSettings.SetEnablePreprocessing(System.Boolean)">
|
|
<summary>
|
|
Indicates whether to enable image preprocessing before OCR.
|
|
</summary>
|
|
<param name="value">The value to set for the EnablePreprocessing property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OcrSettings.GetEnableSkewDetection">
|
|
<summary>
|
|
Indicates whether to enable automatic skew detection and correction.
|
|
</summary>
|
|
<returns>The value of the EnableSkewDetection property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OcrSettings.SetEnableSkewDetection(System.Boolean)">
|
|
<summary>
|
|
Indicates whether to enable automatic skew detection and correction.
|
|
</summary>
|
|
<param name="value">The value to set for the EnableSkewDetection property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OcrSettings.GetEnableTableDetection">
|
|
<summary>
|
|
Indicates whether to detect and extract tables from OCR output.
|
|
</summary>
|
|
<returns>The value of the EnableTableDetection property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OcrSettings.SetEnableTableDetection(System.Boolean)">
|
|
<summary>
|
|
Indicates whether to detect and extract tables from OCR output.
|
|
</summary>
|
|
<param name="value">The value to set for the EnableTableDetection property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkOpenAIApiEndpointSettings">
|
|
<summary>
|
|
SDK-level overrides for OpenAIApiEndpointSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkOpenAIApiEndpointSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkOpenAIApiEndpointSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentOpenAIApiEndpointSettings">
|
|
<summary>
|
|
Document-level overrides for OpenAIApiEndpointSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentOpenAIApiEndpointSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentOpenAIApiEndpointSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings">
|
|
<summary>
|
|
Settings for OpenAIApiEndpoint. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.OpenAIApiEndpointSettings,Nutrient.NativeSDK.API.Settings.SdkOpenAIApiEndpointSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.OpenAIApiEndpointSettings,Nutrient.NativeSDK.API.Settings.SdkOpenAIApiEndpointSettings,Nutrient.NativeSDK.API.Settings.DocumentOpenAIApiEndpointSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.ApiKey">
|
|
<summary>
|
|
Gets or sets the value of ApiKey.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.ApiEndpoint">
|
|
<summary>
|
|
Gets or sets the value of ApiEndpoint.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.Model">
|
|
<summary>
|
|
Gets or sets the value of Model.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.Temperature">
|
|
<summary>
|
|
Gets or sets the value of Temperature.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.MaxTokens">
|
|
<summary>
|
|
Gets or sets the value of MaxTokens.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.SystemPrompt">
|
|
<summary>
|
|
Gets or sets the value of SystemPrompt.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.Stream">
|
|
<summary>
|
|
Gets or sets the value of Stream.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.ClassificationStrategy">
|
|
<summary>
|
|
Gets or sets the value of ClassificationStrategy.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.SendFullPageReference">
|
|
<summary>
|
|
Gets or sets the value of SendFullPageReference.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.BatchSize">
|
|
<summary>
|
|
Gets or sets the value of BatchSize.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.MaxConcurrency">
|
|
<summary>
|
|
Gets or sets the value of MaxConcurrency.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.IsApiKeyOverridden">
|
|
<summary>
|
|
Gets whether ApiKey is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.IsApiEndpointOverridden">
|
|
<summary>
|
|
Gets whether ApiEndpoint is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.IsModelOverridden">
|
|
<summary>
|
|
Gets whether Model is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.IsTemperatureOverridden">
|
|
<summary>
|
|
Gets whether Temperature is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.IsMaxTokensOverridden">
|
|
<summary>
|
|
Gets whether MaxTokens is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.IsSystemPromptOverridden">
|
|
<summary>
|
|
Gets whether SystemPrompt is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.IsStreamOverridden">
|
|
<summary>
|
|
Gets whether Stream is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.IsClassificationStrategyOverridden">
|
|
<summary>
|
|
Gets whether ClassificationStrategy is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.IsSendFullPageReferenceOverridden">
|
|
<summary>
|
|
Gets whether SendFullPageReference is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.IsBatchSizeOverridden">
|
|
<summary>
|
|
Gets whether BatchSize is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.IsMaxConcurrencyOverridden">
|
|
<summary>
|
|
Gets whether MaxConcurrency is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.GetApiKey">
|
|
<summary>
|
|
OpenAI API key for authentication.
|
|
</summary>
|
|
<returns>The value of the ApiKey property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.SetApiKey(System.String)">
|
|
<summary>
|
|
OpenAI API key for authentication.
|
|
</summary>
|
|
<param name="value">The value to set for the ApiKey property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.GetApiEndpoint">
|
|
<summary>
|
|
API endpoint URL for OpenAI-compatible chat completions
|
|
</summary>
|
|
<returns>The value of the ApiEndpoint property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.SetApiEndpoint(System.String)">
|
|
<summary>
|
|
API endpoint URL for OpenAI-compatible chat completions
|
|
</summary>
|
|
<param name="value">The value to set for the ApiEndpoint property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.GetModel">
|
|
<summary>
|
|
Model identifier to use for classification
|
|
</summary>
|
|
<returns>The value of the Model property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.SetModel(System.String)">
|
|
<summary>
|
|
Model identifier to use for classification
|
|
</summary>
|
|
<param name="value">The value to set for the Model property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.GetTemperature">
|
|
<summary>
|
|
Temperature for response generation (0.0 = deterministic, 1.0 = creative). Defaults to 0.0 because zone classification and verbatim text extraction are deterministic tasks — randomness only adds run-to-run noise.
|
|
</summary>
|
|
<returns>The value of the Temperature property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.SetTemperature(System.Double)">
|
|
<summary>
|
|
Temperature for response generation (0.0 = deterministic, 1.0 = creative). Defaults to 0.0 because zone classification and verbatim text extraction are deterministic tasks — randomness only adds run-to-run noise.
|
|
</summary>
|
|
<param name="value">The value to set for the Temperature property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.GetMaxTokens">
|
|
<summary>
|
|
Maximum tokens in response (-1 = unlimited)
|
|
</summary>
|
|
<returns>The value of the MaxTokens property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.SetMaxTokens(System.Int32)">
|
|
<summary>
|
|
Maximum tokens in response (-1 = unlimited)
|
|
</summary>
|
|
<param name="value">The value to set for the MaxTokens property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.GetSystemPrompt">
|
|
<summary>
|
|
Optional custom system prompt for zone classification. When empty, the module uses a default prompt based on the ClassificationStrategy.
|
|
</summary>
|
|
<returns>The value of the SystemPrompt property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.SetSystemPrompt(System.String)">
|
|
<summary>
|
|
Optional custom system prompt for zone classification. When empty, the module uses a default prompt based on the ClassificationStrategy.
|
|
</summary>
|
|
<param name="value">The value to set for the SystemPrompt property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.GetStream">
|
|
<summary>
|
|
Whether to stream responses from the API
|
|
</summary>
|
|
<returns>The value of the Stream property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.SetStream(System.Boolean)">
|
|
<summary>
|
|
Whether to stream responses from the API
|
|
</summary>
|
|
<param name="value">The value to set for the Stream property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.GetClassificationStrategy">
|
|
<summary>
|
|
Strategy for how zones are sent to the VLM for classification.
|
|
</summary>
|
|
<returns>The value of the ClassificationStrategy property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.SetClassificationStrategy(Nutrient.NativeSDK.API.Settings.VlmClassificationStrategy)">
|
|
<summary>
|
|
Strategy for how zones are sent to the VLM for classification.
|
|
</summary>
|
|
<param name="value">The value to set for the ClassificationStrategy property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.GetSendFullPageReference">
|
|
<summary>
|
|
Whether to send the full page image as reference context alongside cropped zones. Only used when UseZoneCropping is true.
|
|
</summary>
|
|
<returns>The value of the SendFullPageReference property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.SetSendFullPageReference(System.Boolean)">
|
|
<summary>
|
|
Whether to send the full page image as reference context alongside cropped zones. Only used when UseZoneCropping is true.
|
|
</summary>
|
|
<param name="value">The value to set for the SendFullPageReference property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.GetBatchSize">
|
|
<summary>
|
|
Number of zone images to include per VLM API call.
|
|
</summary>
|
|
<returns>The value of the BatchSize property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.SetBatchSize(System.Int32)">
|
|
<summary>
|
|
Number of zone images to include per VLM API call.
|
|
</summary>
|
|
<param name="value">The value to set for the BatchSize property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.GetMaxConcurrency">
|
|
<summary>
|
|
Maximum number of concurrent VLM API calls.
|
|
</summary>
|
|
<returns>The value of the MaxConcurrency property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIApiEndpointSettings.SetMaxConcurrency(System.Int32)">
|
|
<summary>
|
|
Maximum number of concurrent VLM API calls.
|
|
</summary>
|
|
<param name="value">The value to set for the MaxConcurrency property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkOpenAILanguagesDetectionSettings">
|
|
<summary>
|
|
SDK-level overrides for OpenAILanguagesDetectionSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkOpenAILanguagesDetectionSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkOpenAILanguagesDetectionSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentOpenAILanguagesDetectionSettings">
|
|
<summary>
|
|
Document-level overrides for OpenAILanguagesDetectionSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentOpenAILanguagesDetectionSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentOpenAILanguagesDetectionSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings">
|
|
<summary>
|
|
Settings for OpenAILanguagesDetection. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.OpenAILanguagesDetectionSettings,Nutrient.NativeSDK.API.Settings.SdkOpenAILanguagesDetectionSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.OpenAILanguagesDetectionSettings,Nutrient.NativeSDK.API.Settings.SdkOpenAILanguagesDetectionSettings,Nutrient.NativeSDK.API.Settings.DocumentOpenAILanguagesDetectionSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.ApiKey">
|
|
<summary>
|
|
Gets or sets the value of ApiKey.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.ApiEndpoint">
|
|
<summary>
|
|
Gets or sets the value of ApiEndpoint.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.Model">
|
|
<summary>
|
|
Gets or sets the value of Model.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.MaxTokens">
|
|
<summary>
|
|
Gets or sets the value of MaxTokens.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.Temperature">
|
|
<summary>
|
|
Gets or sets the value of Temperature.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.Detail">
|
|
<summary>
|
|
Gets or sets the value of Detail.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.IsApiKeyOverridden">
|
|
<summary>
|
|
Gets whether ApiKey is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.IsApiEndpointOverridden">
|
|
<summary>
|
|
Gets whether ApiEndpoint is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.IsModelOverridden">
|
|
<summary>
|
|
Gets whether Model is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.IsMaxTokensOverridden">
|
|
<summary>
|
|
Gets whether MaxTokens is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.IsTemperatureOverridden">
|
|
<summary>
|
|
Gets whether Temperature is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.IsDetailOverridden">
|
|
<summary>
|
|
Gets whether Detail is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.GetApiKey">
|
|
<summary>
|
|
OpenAI API key for authentication.
|
|
</summary>
|
|
<returns>The value of the ApiKey property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.SetApiKey(System.String)">
|
|
<summary>
|
|
OpenAI API key for authentication.
|
|
</summary>
|
|
<param name="value">The value to set for the ApiKey property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.GetApiEndpoint">
|
|
<summary>
|
|
OpenAI API endpoint URL.
|
|
</summary>
|
|
<returns>The value of the ApiEndpoint property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.SetApiEndpoint(System.String)">
|
|
<summary>
|
|
OpenAI API endpoint URL.
|
|
</summary>
|
|
<param name="value">The value to set for the ApiEndpoint property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.GetModel">
|
|
<summary>
|
|
Model to use for language detection (e.g., "gpt-4o-mini").
|
|
</summary>
|
|
<returns>The value of the Model property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.SetModel(System.String)">
|
|
<summary>
|
|
Model to use for language detection (e.g., "gpt-4o-mini").
|
|
</summary>
|
|
<param name="value">The value to set for the Model property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.GetMaxTokens">
|
|
<summary>
|
|
Maximum number of tokens in the response.
|
|
</summary>
|
|
<returns>The value of the MaxTokens property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.SetMaxTokens(System.Int32)">
|
|
<summary>
|
|
Maximum number of tokens in the response.
|
|
</summary>
|
|
<param name="value">The value to set for the MaxTokens property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.GetTemperature">
|
|
<summary>
|
|
Temperature for response generation (0.0 to 1.0). Lower values produce more deterministic outputs.
|
|
</summary>
|
|
<returns>The value of the Temperature property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.SetTemperature(System.Double)">
|
|
<summary>
|
|
Temperature for response generation (0.0 to 1.0). Lower values produce more deterministic outputs.
|
|
</summary>
|
|
<param name="value">The value to set for the Temperature property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.GetDetail">
|
|
<summary>
|
|
Detail level for image analysis (low, high, auto).
|
|
</summary>
|
|
<returns>The value of the Detail property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAILanguagesDetectionSettings.SetDetail(System.String)">
|
|
<summary>
|
|
Detail level for image analysis (low, high, auto).
|
|
</summary>
|
|
<param name="value">The value to set for the Detail property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkOpenAIPictureAltSettings">
|
|
<summary>
|
|
SDK-level overrides for OpenAIPictureAltSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkOpenAIPictureAltSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkOpenAIPictureAltSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentOpenAIPictureAltSettings">
|
|
<summary>
|
|
Document-level overrides for OpenAIPictureAltSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentOpenAIPictureAltSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentOpenAIPictureAltSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings">
|
|
<summary>
|
|
Settings for OpenAIPictureAlt. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.OpenAIPictureAltSettings,Nutrient.NativeSDK.API.Settings.SdkOpenAIPictureAltSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.OpenAIPictureAltSettings,Nutrient.NativeSDK.API.Settings.SdkOpenAIPictureAltSettings,Nutrient.NativeSDK.API.Settings.DocumentOpenAIPictureAltSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.ApiKey">
|
|
<summary>
|
|
Gets or sets the value of ApiKey.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.ApiEndpoint">
|
|
<summary>
|
|
Gets or sets the value of ApiEndpoint.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.Model">
|
|
<summary>
|
|
Gets or sets the value of Model.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.MaxTokens">
|
|
<summary>
|
|
Gets or sets the value of MaxTokens.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.Temperature">
|
|
<summary>
|
|
Gets or sets the value of Temperature.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.Detail">
|
|
<summary>
|
|
Gets or sets the value of Detail.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.IsApiKeyOverridden">
|
|
<summary>
|
|
Gets whether ApiKey is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.IsApiEndpointOverridden">
|
|
<summary>
|
|
Gets whether ApiEndpoint is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.IsModelOverridden">
|
|
<summary>
|
|
Gets whether Model is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.IsMaxTokensOverridden">
|
|
<summary>
|
|
Gets whether MaxTokens is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.IsTemperatureOverridden">
|
|
<summary>
|
|
Gets whether Temperature is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.IsDetailOverridden">
|
|
<summary>
|
|
Gets whether Detail is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.GetApiKey">
|
|
<summary>
|
|
OpenAI API key for authentication.
|
|
</summary>
|
|
<returns>The value of the ApiKey property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.SetApiKey(System.String)">
|
|
<summary>
|
|
OpenAI API key for authentication.
|
|
</summary>
|
|
<param name="value">The value to set for the ApiKey property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.GetApiEndpoint">
|
|
<summary>
|
|
OpenAI API endpoint URL.
|
|
</summary>
|
|
<returns>The value of the ApiEndpoint property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.SetApiEndpoint(System.String)">
|
|
<summary>
|
|
OpenAI API endpoint URL.
|
|
</summary>
|
|
<param name="value">The value to set for the ApiEndpoint property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.GetModel">
|
|
<summary>
|
|
Model to use for language detection (e.g., "gpt-4o-mini").
|
|
</summary>
|
|
<returns>The value of the Model property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.SetModel(System.String)">
|
|
<summary>
|
|
Model to use for language detection (e.g., "gpt-4o-mini").
|
|
</summary>
|
|
<param name="value">The value to set for the Model property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.GetMaxTokens">
|
|
<summary>
|
|
Maximum number of tokens in the response.
|
|
</summary>
|
|
<returns>The value of the MaxTokens property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.SetMaxTokens(System.Int32)">
|
|
<summary>
|
|
Maximum number of tokens in the response.
|
|
</summary>
|
|
<param name="value">The value to set for the MaxTokens property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.GetTemperature">
|
|
<summary>
|
|
Temperature for response generation (0.0 to 1.0). Lower values produce more deterministic outputs.
|
|
</summary>
|
|
<returns>The value of the Temperature property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.SetTemperature(System.Double)">
|
|
<summary>
|
|
Temperature for response generation (0.0 to 1.0). Lower values produce more deterministic outputs.
|
|
</summary>
|
|
<param name="value">The value to set for the Temperature property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.GetDetail">
|
|
<summary>
|
|
Detail level for image analysis (low, high, auto).
|
|
</summary>
|
|
<returns>The value of the Detail property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.OpenAIPictureAltSettings.SetDetail(System.String)">
|
|
<summary>
|
|
Detail level for image analysis (low, high, auto).
|
|
</summary>
|
|
<param name="value">The value to set for the Detail property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkReadingOrderSettings">
|
|
<summary>
|
|
SDK-level overrides for ReadingOrderSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkReadingOrderSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkReadingOrderSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentReadingOrderSettings">
|
|
<summary>
|
|
Document-level overrides for ReadingOrderSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentReadingOrderSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentReadingOrderSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.ReadingOrderSettings">
|
|
<summary>
|
|
Settings for ReadingOrder. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ReadingOrderSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.ReadingOrderSettings,Nutrient.NativeSDK.API.Settings.SdkReadingOrderSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.ReadingOrderSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ReadingOrderSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.ReadingOrderSettings,Nutrient.NativeSDK.API.Settings.SdkReadingOrderSettings,Nutrient.NativeSDK.API.Settings.DocumentReadingOrderSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.ReadingOrderSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ReadingOrderSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ReadingOrderSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ReadingOrderSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ReadingOrderSettings.HorizontalDilationThreshold">
|
|
<summary>
|
|
Gets or sets the value of HorizontalDilationThreshold.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ReadingOrderSettings.TextDirection">
|
|
<summary>
|
|
Gets or sets the value of TextDirection.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ReadingOrderSettings.IsHorizontalDilationThresholdOverridden">
|
|
<summary>
|
|
Gets whether HorizontalDilationThreshold is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.ReadingOrderSettings.IsTextDirectionOverridden">
|
|
<summary>
|
|
Gets whether TextDirection is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ReadingOrderSettings.GetHorizontalDilationThreshold">
|
|
<summary>
|
|
Horizontal dilation threshold for column detection (normalized by page width). Default is 0.15 (15% of page width). Increase for wider column detection tolerance, decrease for stricter column boundaries.
|
|
</summary>
|
|
<returns>The value of the HorizontalDilationThreshold property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ReadingOrderSettings.SetHorizontalDilationThreshold(System.Single)">
|
|
<summary>
|
|
Horizontal dilation threshold for column detection (normalized by page width). Default is 0.15 (15% of page width). Increase for wider column detection tolerance, decrease for stricter column boundaries.
|
|
</summary>
|
|
<param name="value">The value to set for the HorizontalDilationThreshold property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ReadingOrderSettings.GetTextDirection">
|
|
<summary>
|
|
Text direction for reading order computation. Determines how elements are sorted and ordered on the page.
|
|
</summary>
|
|
<returns>The value of the TextDirection property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.ReadingOrderSettings.SetTextDirection(Nutrient.NativeSDK.API.Settings.TextDirection)">
|
|
<summary>
|
|
Text direction for reading order computation. Determines how elements are sorted and ordered on the page.
|
|
</summary>
|
|
<param name="value">The value to set for the TextDirection property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkSegmenterSettings">
|
|
<summary>
|
|
SDK-level overrides for SegmenterSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkSegmenterSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkSegmenterSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentSegmenterSettings">
|
|
<summary>
|
|
Document-level overrides for SegmenterSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentSegmenterSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentSegmenterSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SegmenterSettings">
|
|
<summary>
|
|
Settings for Segmenter. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SegmenterSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.SegmenterSettings,Nutrient.NativeSDK.API.Settings.SdkSegmenterSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SegmenterSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SegmenterSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.SegmenterSettings,Nutrient.NativeSDK.API.Settings.SdkSegmenterSettings,Nutrient.NativeSDK.API.Settings.DocumentSegmenterSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SegmenterSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SegmenterSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SegmenterSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SegmenterSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SegmenterSettings.TargetSize">
|
|
<summary>
|
|
Gets or sets the value of TargetSize.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SegmenterSettings.ConfidenceThreshold">
|
|
<summary>
|
|
Gets or sets the value of ConfidenceThreshold.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SegmenterSettings.UseCpuOnly">
|
|
<summary>
|
|
Gets or sets the value of UseCpuOnly.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SegmenterSettings.MinimumZoneSize">
|
|
<summary>
|
|
Gets or sets the value of MinimumZoneSize.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SegmenterSettings.DetectOrientation">
|
|
<summary>
|
|
Gets or sets the value of DetectOrientation.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SegmenterSettings.IsTargetSizeOverridden">
|
|
<summary>
|
|
Gets whether TargetSize is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SegmenterSettings.IsConfidenceThresholdOverridden">
|
|
<summary>
|
|
Gets whether ConfidenceThreshold is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SegmenterSettings.IsUseCpuOnlyOverridden">
|
|
<summary>
|
|
Gets whether UseCpuOnly is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SegmenterSettings.IsMinimumZoneSizeOverridden">
|
|
<summary>
|
|
Gets whether MinimumZoneSize is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.SegmenterSettings.IsDetectOrientationOverridden">
|
|
<summary>
|
|
Gets whether DetectOrientation is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SegmenterSettings.GetTargetSize">
|
|
<summary>
|
|
Target size for image preprocessing (height and width).
|
|
</summary>
|
|
<returns>The value of the TargetSize property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SegmenterSettings.SetTargetSize(System.Int32)">
|
|
<summary>
|
|
Target size for image preprocessing (height and width).
|
|
</summary>
|
|
<param name="value">The value to set for the TargetSize property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SegmenterSettings.GetConfidenceThreshold">
|
|
<summary>
|
|
Detection confidence threshold (0.0 to 1.0). Detections with confidence below this threshold will be filtered out.
|
|
</summary>
|
|
<returns>The value of the ConfidenceThreshold property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SegmenterSettings.SetConfidenceThreshold(System.Single)">
|
|
<summary>
|
|
Detection confidence threshold (0.0 to 1.0). Detections with confidence below this threshold will be filtered out.
|
|
</summary>
|
|
<param name="value">The value to set for the ConfidenceThreshold property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SegmenterSettings.GetUseCpuOnly">
|
|
<summary>
|
|
Enable CPU mode for ONNX Runtime. When true, forces CPU execution. When false, uses default providers.
|
|
</summary>
|
|
<returns>The value of the UseCpuOnly property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SegmenterSettings.SetUseCpuOnly(System.Boolean)">
|
|
<summary>
|
|
Enable CPU mode for ONNX Runtime. When true, forces CPU execution. When false, uses default providers.
|
|
</summary>
|
|
<param name="value">The value to set for the UseCpuOnly property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SegmenterSettings.GetMinimumZoneSize">
|
|
<summary>
|
|
Minimum zone size in pixels (width * height). Zones smaller than this will be filtered out.
|
|
</summary>
|
|
<returns>The value of the MinimumZoneSize property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SegmenterSettings.SetMinimumZoneSize(System.Int32)">
|
|
<summary>
|
|
Minimum zone size in pixels (width * height). Zones smaller than this will be filtered out.
|
|
</summary>
|
|
<param name="value">The value to set for the MinimumZoneSize property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SegmenterSettings.GetDetectOrientation">
|
|
<summary>
|
|
Indicates whether automatic page orientation detection is enabled.
|
|
</summary>
|
|
<returns>The value of the DetectOrientation property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SegmenterSettings.SetDetectOrientation(System.Boolean)">
|
|
<summary>
|
|
Indicates whether automatic page orientation detection is enabled.
|
|
</summary>
|
|
<param name="value">The value to set for the DetectOrientation property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkTableRecognitionSettings">
|
|
<summary>
|
|
SDK-level overrides for TableRecognitionSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkTableRecognitionSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkTableRecognitionSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentTableRecognitionSettings">
|
|
<summary>
|
|
Document-level overrides for TableRecognitionSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentTableRecognitionSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentTableRecognitionSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.TableRecognitionSettings">
|
|
<summary>
|
|
Settings for TableRecognition. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.TableRecognitionSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.TableRecognitionSettings,Nutrient.NativeSDK.API.Settings.SdkTableRecognitionSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.TableRecognitionSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.TableRecognitionSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.TableRecognitionSettings,Nutrient.NativeSDK.API.Settings.SdkTableRecognitionSettings,Nutrient.NativeSDK.API.Settings.DocumentTableRecognitionSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.TableRecognitionSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.TableRecognitionSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.TableRecognitionSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.TableRecognitionSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.TableRecognitionSettings.TargetSize">
|
|
<summary>
|
|
Gets or sets the value of TargetSize.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.TableRecognitionSettings.NormalizationMean">
|
|
<summary>
|
|
Gets or sets the value of NormalizationMean.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.TableRecognitionSettings.NormalizationStd">
|
|
<summary>
|
|
Gets or sets the value of NormalizationStd.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.TableRecognitionSettings.IsTargetSizeOverridden">
|
|
<summary>
|
|
Gets whether TargetSize is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.TableRecognitionSettings.IsNormalizationMeanOverridden">
|
|
<summary>
|
|
Gets whether NormalizationMean is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.TableRecognitionSettings.IsNormalizationStdOverridden">
|
|
<summary>
|
|
Gets whether NormalizationStd is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.TableRecognitionSettings.GetTargetSize">
|
|
<summary>
|
|
Target size for image preprocessing (height and width). Default is 448x448 as specified in the TableFormer model.
|
|
</summary>
|
|
<returns>The value of the TargetSize property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.TableRecognitionSettings.SetTargetSize(System.Int32)">
|
|
<summary>
|
|
Target size for image preprocessing (height and width). Default is 448x448 as specified in the TableFormer model.
|
|
</summary>
|
|
<param name="value">The value to set for the TargetSize property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.TableRecognitionSettings.GetNormalizationMean">
|
|
<summary>
|
|
Image normalization mean values (RGB) for preprocessing. Default values are from the TableFormer model training.
|
|
</summary>
|
|
<returns>The value of the NormalizationMean property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.TableRecognitionSettings.SetNormalizationMean(System.Single[])">
|
|
<summary>
|
|
Image normalization mean values (RGB) for preprocessing. Default values are from the TableFormer model training.
|
|
</summary>
|
|
<param name="value">The value to set for the NormalizationMean property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.TableRecognitionSettings.GetNormalizationStd">
|
|
<summary>
|
|
Image normalization standard deviation values (RGB) for preprocessing. Default values are from the TableFormer model training.
|
|
</summary>
|
|
<returns>The value of the NormalizationStd property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.TableRecognitionSettings.SetNormalizationStd(System.Single[])">
|
|
<summary>
|
|
Image normalization standard deviation values (RGB) for preprocessing. Default values are from the TableFormer model training.
|
|
</summary>
|
|
<param name="value">The value to set for the NormalizationStd property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkVisionDescriptorSettings">
|
|
<summary>
|
|
SDK-level overrides for VisionDescriptorSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkVisionDescriptorSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkVisionDescriptorSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentVisionDescriptorSettings">
|
|
<summary>
|
|
Document-level overrides for VisionDescriptorSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentVisionDescriptorSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentVisionDescriptorSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.VisionDescriptorSettings">
|
|
<summary>
|
|
Settings for VisionDescriptor. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.VisionDescriptorSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.VisionDescriptorSettings,Nutrient.NativeSDK.API.Settings.SdkVisionDescriptorSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.VisionDescriptorSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.VisionDescriptorSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.VisionDescriptorSettings,Nutrient.NativeSDK.API.Settings.SdkVisionDescriptorSettings,Nutrient.NativeSDK.API.Settings.DocumentVisionDescriptorSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.VisionDescriptorSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionDescriptorSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionDescriptorSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionDescriptorSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionDescriptorSettings.Level">
|
|
<summary>
|
|
Gets or sets the value of Level.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionDescriptorSettings.StandardPrompt">
|
|
<summary>
|
|
Gets or sets the value of StandardPrompt.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionDescriptorSettings.DetailedPrompt">
|
|
<summary>
|
|
Gets or sets the value of DetailedPrompt.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionDescriptorSettings.IsLevelOverridden">
|
|
<summary>
|
|
Gets whether Level is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionDescriptorSettings.IsStandardPromptOverridden">
|
|
<summary>
|
|
Gets whether StandardPrompt is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionDescriptorSettings.IsDetailedPromptOverridden">
|
|
<summary>
|
|
Gets whether DetailedPrompt is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.VisionDescriptorSettings.GetLevel">
|
|
<summary>
|
|
Description detail level to use.
|
|
</summary>
|
|
<returns>The value of the Level property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.VisionDescriptorSettings.SetLevel(Nutrient.NativeSDK.API.Settings.DescriptionLevel)">
|
|
<summary>
|
|
Description detail level to use.
|
|
</summary>
|
|
<param name="value">The value to set for the Level property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.VisionDescriptorSettings.GetStandardPrompt">
|
|
<summary>
|
|
Prompt template for standard description generation.
|
|
</summary>
|
|
<returns>The value of the StandardPrompt property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.VisionDescriptorSettings.SetStandardPrompt(System.String)">
|
|
<summary>
|
|
Prompt template for standard description generation.
|
|
</summary>
|
|
<param name="value">The value to set for the StandardPrompt property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.VisionDescriptorSettings.GetDetailedPrompt">
|
|
<summary>
|
|
Prompt template for detailed description generation.
|
|
</summary>
|
|
<returns>The value of the DetailedPrompt property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.VisionDescriptorSettings.SetDetailedPrompt(System.String)">
|
|
<summary>
|
|
Prompt template for detailed description generation.
|
|
</summary>
|
|
<param name="value">The value to set for the DetailedPrompt property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkVisionSettings">
|
|
<summary>
|
|
SDK-level overrides for VisionSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkVisionSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkVisionSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentVisionSettings">
|
|
<summary>
|
|
Document-level overrides for VisionSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentVisionSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentVisionSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.VisionSettings">
|
|
<summary>
|
|
Settings for Vision. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.VisionSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.VisionSettings,Nutrient.NativeSDK.API.Settings.SdkVisionSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.VisionSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.VisionSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.VisionSettings,Nutrient.NativeSDK.API.Settings.SdkVisionSettings,Nutrient.NativeSDK.API.Settings.DocumentVisionSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.VisionSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionSettings.Provider">
|
|
<summary>
|
|
Gets or sets the value of Provider.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionSettings.Features">
|
|
<summary>
|
|
Gets or sets the value of Features.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionSettings.EnableOcr">
|
|
<summary>
|
|
Gets or sets the value of EnableOcr.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionSettings.EnableVlm">
|
|
<summary>
|
|
Gets or sets the value of EnableVlm.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionSettings.Engine">
|
|
<summary>
|
|
Gets or sets the value of Engine.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionSettings.OutputFormat">
|
|
<summary>
|
|
Gets or sets the value of OutputFormat.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionSettings.IsProviderOverridden">
|
|
<summary>
|
|
Gets whether Provider is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionSettings.IsFeaturesOverridden">
|
|
<summary>
|
|
Gets whether Features is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionSettings.IsEnableOcrOverridden">
|
|
<summary>
|
|
Gets whether EnableOcr is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionSettings.IsEnableVlmOverridden">
|
|
<summary>
|
|
Gets whether EnableVlm is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionSettings.IsEngineOverridden">
|
|
<summary>
|
|
Gets whether Engine is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.VisionSettings.IsOutputFormatOverridden">
|
|
<summary>
|
|
Gets whether OutputFormat is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.VisionSettings.GetProvider">
|
|
<summary>
|
|
The Vision Language Model provider to use for AI-powered features.
|
|
</summary>
|
|
<returns>The value of the Provider property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.VisionSettings.SetProvider(Nutrient.NativeSDK.API.Settings.VlmProvider)">
|
|
<summary>
|
|
The Vision Language Model provider to use for AI-powered features.
|
|
</summary>
|
|
<param name="value">The value to set for the Provider property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.VisionSettings.GetFeatures">
|
|
<summary>
|
|
Vision features to enable during document processing.
|
|
</summary>
|
|
<returns>The value of the Features property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.VisionSettings.SetFeatures(Nutrient.NativeSDK.API.Settings.VisionFeatures)">
|
|
<summary>
|
|
Vision features to enable during document processing.
|
|
</summary>
|
|
<param name="value">The value to set for the Features property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.VisionSettings.GetEnableOcr">
|
|
<summary>
|
|
Controls OCR resource loading and OCR-based word detection inside the ICR image pipeline.
|
|
</summary>
|
|
<returns>The value of the EnableOcr property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.VisionSettings.SetEnableOcr(Nutrient.NativeSDK.API.Settings.OcrActivationMode)">
|
|
<summary>
|
|
Controls OCR resource loading and OCR-based word detection inside the ICR image pipeline.
|
|
</summary>
|
|
<param name="value">The value to set for the EnableOcr property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.VisionSettings.GetEnableVlm">
|
|
<summary>
|
|
Indicates whether the ICR image pipeline should run late VLM augmentation. <see cref="F:Nutrient.NativeSDK.API.Settings.VisionEngine.VlmEnhancedIcr"/> also enables this behavior for backward-compatible engine selection.
|
|
</summary>
|
|
<returns>The value of the EnableVlm property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.VisionSettings.SetEnableVlm(System.Boolean)">
|
|
<summary>
|
|
Indicates whether the ICR image pipeline should run late VLM augmentation. <see cref="F:Nutrient.NativeSDK.API.Settings.VisionEngine.VlmEnhancedIcr"/> also enables this behavior for backward-compatible engine selection.
|
|
</summary>
|
|
<param name="value">The value to set for the EnableVlm property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.VisionSettings.GetEngine">
|
|
<summary>
|
|
Specifies which vision processing engine/pipeline to use for content extraction.
|
|
</summary>
|
|
<returns>The value of the Engine property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.VisionSettings.SetEngine(Nutrient.NativeSDK.API.Settings.VisionEngine)">
|
|
<summary>
|
|
Specifies which vision processing engine/pipeline to use for content extraction.
|
|
</summary>
|
|
<param name="value">The value to set for the Engine property.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.VisionSettings.GetOutputFormat">
|
|
<summary>
|
|
Format of content returned by <see cref="!:Concepts.Vision.ExtractContent()"/>. Defaults to <see cref="F:Nutrient.NativeSDK.API.Settings.VisionOutputFormat.Json"/>.
|
|
</summary>
|
|
<returns>The value of the OutputFormat property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.VisionSettings.SetOutputFormat(Nutrient.NativeSDK.API.Settings.VisionOutputFormat)">
|
|
<summary>
|
|
Format of content returned by <see cref="!:Concepts.Vision.ExtractContent()"/>. Defaults to <see cref="F:Nutrient.NativeSDK.API.Settings.VisionOutputFormat.Json"/>.
|
|
</summary>
|
|
<param name="value">The value to set for the OutputFormat property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SdkWordsDetectionSettings">
|
|
<summary>
|
|
SDK-level overrides for WordsDetectionSettings.
|
|
Nullable properties indicate inherited values from immutable defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.SdkWordsDetectionSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.SdkWordsDetectionSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.DocumentWordsDetectionSettings">
|
|
<summary>
|
|
Document-level overrides for WordsDetectionSettings.
|
|
Nullable properties indicate inherited values from SDK defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.DocumentWordsDetectionSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.DocumentWordsDetectionSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.WordsDetectionSettings">
|
|
<summary>
|
|
Settings for WordsDetection. 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.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.WordsDetectionSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.WordsDetectionSettings,Nutrient.NativeSDK.API.Settings.SdkWordsDetectionSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.WordsDetectionSettings"/> class for SDK-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.WordsDetectionSettings.#ctor(Nutrient.NativeSDK.API.Settings.Default.WordsDetectionSettings,Nutrient.NativeSDK.API.Settings.SdkWordsDetectionSettings,Nutrient.NativeSDK.API.Settings.DocumentWordsDetectionSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Nutrient.NativeSDK.API.Settings.WordsDetectionSettings"/> class for document-level access.
|
|
</summary>
|
|
<param name="defaults">The immutable default settings.</param>
|
|
<param name="sdkOverrides">The SDK-level override settings.</param>
|
|
<param name="documentOverrides">The document-level override settings.</param>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.WordsDetectionSettings.Default">
|
|
<summary>
|
|
Gets the immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.WordsDetectionSettings.SdkOverrides">
|
|
<summary>
|
|
Gets the SDK-level override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.WordsDetectionSettings.DocumentOverrides">
|
|
<summary>
|
|
Gets the document-level override settings (null for SDK-level access).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.WordsDetectionSettings.ConfidenceThreshold">
|
|
<summary>
|
|
Gets or sets the value of ConfidenceThreshold.
|
|
Reads walk the chain: Document override → SDK override → Default.
|
|
Writes go to document level if available, otherwise SDK level.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Nutrient.NativeSDK.API.Settings.WordsDetectionSettings.IsConfidenceThresholdOverridden">
|
|
<summary>
|
|
Gets whether ConfidenceThreshold is overridden at the current level.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.WordsDetectionSettings.GetConfidenceThreshold">
|
|
<summary>
|
|
Detection confidence threshold (0.0 to 1.0). Detections with confidence below this threshold will be filtered out.
|
|
</summary>
|
|
<returns>The value of the ConfidenceThreshold property.</returns>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.Settings.WordsDetectionSettings.SetConfidenceThreshold(System.Single)">
|
|
<summary>
|
|
Detection confidence threshold (0.0 to 1.0). Detections with confidence below this threshold will be filtered out.
|
|
</summary>
|
|
<param name="value">The value to set for the ConfidenceThreshold property.</param>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.Settings.SettingsSchema">
|
|
<summary>
|
|
JSON Schema 2020-12 document for the settings envelope (SdkSettings + DocumentSettings).
|
|
Generated at build time from every <c>[Settings]</c>-marked class.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.Settings.SettingsSchema.Json">
|
|
<summary>
|
|
The generated JSON Schema as a compile-time constant string.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.SettingCategory">
|
|
<summary>
|
|
Defines the categories of settings available in the SDK.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Nutrient.NativeSDK.API.SdkSettingRegistry">
|
|
<summary>
|
|
Registry for SDK-level settings (immutable defaults and mutable SDK overrides).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.SdkSettingRegistry._immutableDefaults">
|
|
<summary>
|
|
Immutable default settings (shared, never modified).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Nutrient.NativeSDK.API.SdkSettingRegistry._sdkOverrides">
|
|
<summary>
|
|
SDK-level override settings (mutable, singleton per category).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.SdkSettingRegistry.GetDefault``1(Nutrient.NativeSDK.API.SettingCategory)">
|
|
<summary>
|
|
Gets the immutable default settings instance.
|
|
Returns the Default class instance (e.g., PdfSettingsDefault).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.SdkSettingRegistry.GetSdkOverride``1(Nutrient.NativeSDK.API.SettingCategory)">
|
|
<summary>
|
|
Gets the SDK-level override settings instance.
|
|
Returns the SDK override class instance (e.g., SdkPdfSettings).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.SdkSettingRegistry.GetAllDefaults">
|
|
<summary>
|
|
Gets all immutable default settings.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.SdkSettingRegistry.GetAllSdkOverrides">
|
|
<summary>
|
|
Gets all SDK override settings.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.SdkSettingRegistry.GetSettingsClassName(Nutrient.NativeSDK.API.SettingCategory)">
|
|
<summary>
|
|
Gets the settings class name for a category (e.g., "PdfSettings").
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.SdkSettingRegistry.GetDefaultClassName(Nutrient.NativeSDK.API.SettingCategory)">
|
|
<summary>
|
|
Gets the default class name for a category (e.g., "PdfSettingsDefault").
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.SdkSettingRegistry.GetSdkClassName(Nutrient.NativeSDK.API.SettingCategory)">
|
|
<summary>
|
|
Gets the SDK override class name for a category (e.g., "SdkPdfSettings").
|
|
</summary>
|
|
</member>
|
|
<member name="M:Nutrient.NativeSDK.API.SdkSettingRegistry.GetDocumentClassName(Nutrient.NativeSDK.API.SettingCategory)">
|
|
<summary>
|
|
Gets the document override class name for a category (e.g., "DocumentPdfSettings").
|
|
</summary>
|
|
</member>
|
|
<member name="T:GdPicture14.DocumentFormat">
|
|
<summary>Defines the format of the currently processed/used document.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatUNKNOWN">
|
|
<summary>Unknown or undefined document format. It is also returned if any error occurs.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatICO">
|
|
<summary>Icon and cursor format (single or multi page).</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatBMP">
|
|
<summary>Standard Windows Bitmap Format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatWBMP">
|
|
<summary>Wireless Bitmap.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatJPEG">
|
|
<summary>Joint Photographic Expert Group.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatGIF">
|
|
<summary>Graphics Interchange Format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatPNG">
|
|
<summary>Portable Network Graphics Format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatTIFF">
|
|
<summary>Tagged Image Format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatFAXG3">
|
|
<summary>Group 3 Raw Fax Format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatEXIF">
|
|
<summary>Exchangeable Image Format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatEMF">
|
|
<summary>Enhanced Windows Meta-format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatWMF">
|
|
<summary>Standard Windows Meta-format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatJNG">
|
|
<summary>JPEG Network Graphics.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatKOALA">
|
|
<summary>KOALA Format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatIFF">
|
|
<summary>Interchange Format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatMNG">
|
|
<summary>Multiple-image Network Graphics.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatPCD">
|
|
<summary>Kodak Photo-CD file.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatPCX">
|
|
<summary>PC Paintbrush Format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatPBM">
|
|
<summary>Portable Bitmap File.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatPBMRAW">
|
|
<summary>Portable Bitmap BINARY.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatPFM">
|
|
<summary>Portable Float Map.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatPGM">
|
|
<summary>Portable Gray-map File.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatPGMRAW">
|
|
<summary>Portable Gray-map BINARY.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatPPM">
|
|
<summary>Portable Pix-map File.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatPPMRAW">
|
|
<summary>Portable Pix-map BINARY.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatRAS">
|
|
<summary>Sun Raster Format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatTARGA">
|
|
<summary>TARGA Image Format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatPSD">
|
|
<summary>Photoshop File.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatCUT">
|
|
<summary>Dr. Halo/Dr.Genius Clipboard Format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatXBM">
|
|
<summary>X-Bitmap Format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatXPM">
|
|
<summary>X Pixmap Format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatDDS">
|
|
<summary>Microsoft Direct-draw Surface Format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatHDR">
|
|
<summary>High Dynamic Range Format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatSGI">
|
|
<summary>Silicon Graphics Image Format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatEXR">
|
|
<summary>OpenEXR Format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatJ2K">
|
|
<summary>JPEG-2000 Code-stream.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatJP2">
|
|
<summary>JPEG-2000 Format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatJBIG">
|
|
<summary>Joint Bi-level Image Experts Group.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatPICT">
|
|
<summary>Macintosh PICT Format</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatRAW">
|
|
<summary>RAW bitmap.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatWEBP">
|
|
<summary>WebP format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatDICOM">
|
|
<summary>Digital Imaging and Communications in Medicine.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatWSQ">
|
|
<summary>Wavelet scalar quantization.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatHEIF">
|
|
<summary>High Efficiency Image File Format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatJBIG2">
|
|
<summary>Joint Bi-level Image Experts Group.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatMemoryBMP">
|
|
<summary>Standard Windows Bitmap Format using memory.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatPDF">
|
|
<summary>Portable Document Format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatSVG">
|
|
<summary>Scalable Vector Graphics.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatTXT">
|
|
<summary>Plain text file.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatDOCX">
|
|
<summary>Microsoft Word OpenXML.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatRTF">
|
|
<summary>Rich Text File Format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatDXF">
|
|
<summary>AutoCAD DXF (Drawing Interchange Format, or Drawing Exchange Format).</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatODT">
|
|
<summary>OpenDocument text file format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatXLSX">
|
|
<summary>Microsoft Excel Spreadsheet format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatPPTX">
|
|
<summary>Microsoft Powerpoint Presentation format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatDOC">
|
|
<summary>Microsoft Word (.doc) binary file format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatXLS">
|
|
<summary>Microsoft Excel (.xls) binary file format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatPPT">
|
|
<summary>Microsoft PowerPoint (.ppt) binary file format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatHTML">
|
|
<summary>HTML format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatMSG">
|
|
<summary>Outlook Message Item File format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatEML">
|
|
<summary>E-Mail Message format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatPostScript">
|
|
<summary>
|
|
PostScript format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatDWG">
|
|
<summary>Binary CAD format</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatMHTML">
|
|
<summary>MIME HTML format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatMD">
|
|
<summary>Markdown text file format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatFlatPPTX">
|
|
<summary>Flat OPC Package format for PowerPoint documents.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentFormat.DocumentFormatFlatDOCX">
|
|
<summary>Flat OPC Package format for Word documents.</summary>
|
|
</member>
|
|
<member name="T:GdPicture14.DocumentType">
|
|
<summary>The type of the document currently used.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypeUnknown">
|
|
<summary>Unknown or undefined document type.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypeBitmap">
|
|
<summary>Raster image.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypeMetaFile">
|
|
<summary>Metafile image.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypePDF">
|
|
<summary>PDF.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypeSVG">
|
|
<summary>SVG.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypeTXT">
|
|
<summary>Text-based document.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypeOpenXMLWord">
|
|
<summary>Open XML Wordprocessing.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypeRTF">
|
|
<summary>RTF format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypeDXF">
|
|
<summary>DXF format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypeOpenDocumentText">
|
|
<summary>OpenDocument Text format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypeOpenXMLSpreadsheet">
|
|
<summary>Open XML Spreadsheet. </summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypeOpenXMLPresentation">
|
|
<summary>Open XML Presentation. </summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypeWordBinary">
|
|
<summary>
|
|
Word (.doc) Binary File Format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypeExcelBinary">
|
|
<summary>
|
|
Excel (.xls) Binary File Format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypePowerPointBinary">
|
|
<summary>
|
|
PowerPoint (.ppt) Binary File Format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypeHTML">
|
|
<summary>
|
|
HTML Format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypeMSG">
|
|
<summary>
|
|
Outlook Message Item File format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypeEML">
|
|
<summary>
|
|
E-Mail Message format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypePostScript">
|
|
<summary>
|
|
PostScript format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypeDWG">
|
|
<summary>
|
|
Binary CAD format
|
|
</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypeMD">
|
|
<summary>
|
|
Markdown text file format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypePowerPointFlat">
|
|
<summary>
|
|
Represents a Flat OPC XML PowerPoint presentation document type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentType.DocumentTypeWordFlat">
|
|
<summary>
|
|
Represents a Flat OPC XML Word document type.
|
|
</summary>
|
|
</member>
|
|
<member name="T:GdPicture14.UnitMode">
|
|
<summary>Specifies different unit modes.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.UnitMode.UnitWorld">
|
|
<summary>Do not use.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.UnitMode.UnitDisplay">
|
|
<summary>Do not use.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.UnitMode.UnitPixel">
|
|
<summary>Each unit is one device pixel.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.UnitMode.UnitPoint">
|
|
<summary>Each unit is a printer's point, or 1/72 inch.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.UnitMode.UnitInch">
|
|
<summary>Each unit is 1 inch.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.UnitMode.UnitDocument">
|
|
<summary>Each unit is 1/300 inch.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.UnitMode.UnitMillimeter">
|
|
<summary>Each unit is 1 millimeter.</summary>
|
|
</member>
|
|
<member name="T:GdPicture14.EnumExtensions">
|
|
<summary>
|
|
Extension methods for DocumentType to provide consistent DocumentFormat mapping for telemetry.
|
|
</summary>
|
|
</member>
|
|
<member name="T:GdPicture14.PageCacheMode">
|
|
<summary>Defines the cache mode for the page.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PageCacheMode.Unspecified">
|
|
<summary>Here for internal usage. Do not use.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PageCacheMode.Memory">
|
|
<summary>Page content is cached in an allocated memory buffer.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PageCacheMode.File">
|
|
<summary>Page content is cached in a temporary file.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PageCacheMode.FileNoDeleteOnClose">
|
|
<summary>Page content is cached in a temporary file that is not deleted on closing.</summary>
|
|
</member>
|
|
<member name="T:GdPicture14.PdfCompression">
|
|
<summary>Specifies the standard scheme to be used to compress image data in PDF documents.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfCompression.PdfCompressionUnknown">
|
|
<summary>Unknown compression.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfCompression.PdfCompressionNone">
|
|
<summary>No compression.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfCompression.PdfCompressionFlate">
|
|
<summary>Zlib/deflate compression method.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfCompression.PdfCompressionCCITT4">
|
|
<summary>CCITT 4 facsimile standard.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfCompression.PdfCompressionJPEG">
|
|
<summary>DCT (discrete cosine transform) technique based on the JPEG standard.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfCompression.PdfCompressionJBIG2">
|
|
<summary>JBIG2 standard.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfCompression.PdfCompressionJPEG2000">
|
|
<summary>Wavelet-based JPEG2000 standard.</summary>
|
|
</member>
|
|
<member name="T:GdPicture14.PdfConformance">
|
|
<summary>Specifies PDF versions and conformance levels of a PDF document.
|
|
<para>The PDF versions correspond to the PDF major releases, starting from PDF 1.0. In each PDF version the new features have been introduced.
|
|
The different conformance levels reflect the quality of the archived document and depend on the input material and the documents purpose.
|
|
PDF/A versions and levels are given one after another.</para>
|
|
<para>PDF/A-1 is the first archiving standard based on PDF version 1.4. All resources must be embedded within the PDF/A document itself.</para>
|
|
<para>PDF/A-2 is based on PDF 1.7. It allows JPEG2000 compression, transparent elements, PDF layers and more.</para>
|
|
<para>PDF/A-3 is available since October 2012. It allows to embed any file format desired.</para><para></para>
|
|
<para>Level a (accessible) meets all requirements for the standard.</para>
|
|
<para>Level b (basic) guaranteed that the content of the document can be unambiguously reproduced.</para>
|
|
<para>Level u (unicode) specifies that all text can be mapped to standard Unicode character codes.</para>
|
|
</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.Unknown">
|
|
<summary>The PDF conformance level is unknown.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.PDF">
|
|
<summary>This is a common PDF document.
|
|
Read more about PDF compatibility levels <a href="https://acrobatusers.com/tutorials/understanding-pdf-compatibility-levels">here</a> .</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.PDF_A_1a">
|
|
<summary>The PDF conformance level is PDF/A-1a.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.PDF_A_1b">
|
|
<summary>The PDF conformance level is PDF/A-1b.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.PDF_A_2a">
|
|
<summary>The PDF conformance level is PDF/A-2a.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.PDF_A_2u">
|
|
<summary>The PDF conformance level is PDF/A-2u.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.PDF_A_2b">
|
|
<summary>The PDF conformance level is PDF/A-2b.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.PDF_A_3a">
|
|
<summary>The PDF conformance level is PDF/A-3a.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.PDF_A_3u">
|
|
<summary>The PDF conformance level is PDF/A-3u.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.PDF_A_3b">
|
|
<summary>The PDF conformance level is PDF/A-3b.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.PDF_A_4">
|
|
<summary>The PDF conformance level is PDF/A-4.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.PDF_A_4e">
|
|
<summary>The PDF conformance level is PDF/A-4e.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.PDF_A_4f">
|
|
<summary>The PDF conformance level is PDF/A-4f.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.PDF1_0">
|
|
<summary>The PDF version is PDF 1.0.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.PDF1_1">
|
|
<summary>The PDF version is PDF 1.1.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.PDF1_2">
|
|
<summary>The PDF version is PDF 1.2.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.PDF1_3">
|
|
<summary>The PDF version is PDF 1.3.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.PDF1_4">
|
|
<summary>The PDF version is PDF 1.4.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.PDF1_5">
|
|
<summary>The PDF version is PDF 1.5.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.PDF1_6">
|
|
<summary>The PDF version is PDF 1.6.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.PDF1_7">
|
|
<summary>The PDF version is PDF 1.7.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.PDF2_0">
|
|
<summary>The PDF version is PDF 2.0 (ISO 32000-2).</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfConformance.PDF_UA_1">
|
|
<summary>The PDF conformance level is PDF/UA-1.</summary>
|
|
</member>
|
|
<member name="T:GdPicture14.PdfPageSizes">
|
|
<summary>Specifies page sizes.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeLetter">
|
|
<summary>US Letter 8 1/2 x 11 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeLetterSmall">
|
|
<summary>US Letter Small 8 1/2 x 11 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeTabloid">
|
|
<summary>Tabloid 11 x 17 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeLedger">
|
|
<summary>US Ledger 17 x 11 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeLegal">
|
|
<summary>US Legal 8 1/2 x 14 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeStatement">
|
|
<summary>US Statement 5 1/2 x 8 1/2 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeExecutive">
|
|
<summary>US Executive 7 1/4 x 10 1/2 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeA3">
|
|
<summary>A3 297 x 420 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeA4">
|
|
<summary>A4 210 x 297 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeA4Small">
|
|
<summary>A4 Small 210 x 297 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeA5">
|
|
<summary>A5 148 x 210 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeB4">
|
|
<summary>B4 (JIS) 257 x 364 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeB5">
|
|
<summary>B5 (JIS) 182 x 257 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeFolio">
|
|
<summary>Folio 8 1/2 x 13 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeQuarto">
|
|
<summary>Quarto 215 x 275 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSize10X14">
|
|
<summary>10 x 14 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSize11X17">
|
|
<summary>11 x 17 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeNote">
|
|
<summary>US Note 8 1/2 x 11 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeEnv_9">
|
|
<summary>US Envelope #9 3 7/8 x 8 7/8</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeEnv_10">
|
|
<summary>US Envelope #10 4 1/8 x 9 1/2</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeEnv_11">
|
|
<summary>US Envelope #11 4 1/2 x 10 3/8</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeEnv_12">
|
|
<summary>US Envelope #12 4 3/4 x 11 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeEnv_14">
|
|
<summary>US Envelope #14 5 x 11 1/2</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeCSheet">
|
|
<summary>C size sheet 43.18 x 55.88 cm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeDSheet">
|
|
<summary>D size sheet 55.88 x 86.36</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeESheet">
|
|
<summary>E size sheet 86.36 x 111.76</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeEnv_Dl">
|
|
<summary>Envelope DL 110 x 220mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeEnv_C5">
|
|
<summary>Envelope C5 162 x 229 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeEnv_C3">
|
|
<summary>Envelope C3 324 x 458 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeEnv_C4">
|
|
<summary>Envelope C4 229 x 324 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeEnv_C6">
|
|
<summary>Envelope C6 114 x 162 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeEnv_C65">
|
|
<summary>Envelope C65 114 x 229 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeEnv_B4">
|
|
<summary>Envelope B4 250 x 353 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeEnv_B5">
|
|
<summary>Envelope B5 176 x 250 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeEnv_B6">
|
|
<summary>Envelope B6 176 x 125 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeEnv_Italy">
|
|
<summary>Envelope 110 x 230 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeEnv_Monarch">
|
|
<summary>US Envelope Monarch 3.875 x 7.5 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeEnv_Personal">
|
|
<summary>6 3/4 US Envelope 3 5/8 x 6 1/2 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeFanFold_Us">
|
|
<summary>US Std Fanfold 14 7/8 x 11 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeFanFold_Std_German">
|
|
<summary>German Std Fanfold 8 1/2 x 12 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeFanFold_Lgl_German">
|
|
<summary>German Legal Fanfold 8 1/2 x 13 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeIso_B4">
|
|
<summary>B4 (ISO) 250 x 353 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeJapanese_Postcard">
|
|
<summary>Japanese Postcard 100 x 148 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSize9X11">
|
|
<summary>9 x 11 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSize10X11">
|
|
<summary>10 x 11 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSize15X11">
|
|
<summary>15 x 11 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeEnv_Invite">
|
|
<summary>Envelope Invite 220 x 220 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeLetter_Extra">
|
|
<summary>US Letter Extra 9 1/2 x 12 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeLegal_Extra">
|
|
<summary>US Legal Extra 9 1/2 x 15 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeTabloid_Extra">
|
|
<summary>US Tabloid Extra 11.69 x 18 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeA4_Extra">
|
|
<summary>A4 Extra 9.27 x 12.69 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeLetter_Transverse">
|
|
<summary>Letter Transverse 8 1/2 x 11 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeA4_Transverse">
|
|
<summary>A4 Transverse 210 x 297 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeLetter_Extra_Transverse">
|
|
<summary>Letter Extra Transverse 9 1/2 x 12 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeA_Plus">
|
|
<summary>SuperA/SuperA/A4 227 x 356 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeB_Plus">
|
|
<summary>SuperB/SuperB/A3 305 x 487 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeLetter_Plus">
|
|
<summary>US Letter Plus 8.5 x 12.69 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeA4_Plus">
|
|
<summary>A4 Plus 210 x 330 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeA5_Transverse">
|
|
<summary>A5 Transverse 148 x 210 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeB5_Transverse">
|
|
<summary>B5 (JIS) Transverse 182 x 257 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeA3_Extra">
|
|
<summary>A3 Extra 322 x 445 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeA5_Extra">
|
|
<summary>A5 Extra 174 x 235 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeB5_Extra">
|
|
<summary>B5 (ISO) Extra 201 x 276 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeA2">
|
|
<summary>A2 420 x 594 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeA3_Transverse">
|
|
<summary>A3 Transverse 297 x 420 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeA3_Extra_Transverse">
|
|
<summary>A3 Extra Transverse 322 x 445 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeDbl_Japanese_Postcard">
|
|
<summary>Japanese Double Postcard 200 x 148 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeA6">
|
|
<summary>A6 105 x 148 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeJEnv_Kaku2">
|
|
<summary>Japanese Envelope Kaku #2 240 x 332 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeJEnv_Kaku3">
|
|
<summary>Japanese Envelope Kaku #3 9 x 324 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeJEnv_Chou3">
|
|
<summary>Japanese Envelope Chou #3 120 x 235 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeJEnv_Chou4">
|
|
<summary>Japanese Envelope Chou #4 90 x 205 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeLetter_Rotated">
|
|
<summary>Letter Rotated 11 x 8 1/2 11 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeA3_Rotated">
|
|
<summary>A3 Rotated 420 x 297 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeA4_Rotated">
|
|
<summary>A4 Rotated 297 x 210 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeA5_Rotated">
|
|
<summary>A5 Rotated 210 x 148 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeB4_Jis_Rotated">
|
|
<summary>B4 (JIS) Rotated 364 x 257 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeB5_Jis_Rotated">
|
|
<summary>B5 (JIS) Rotated 257 x 182 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeJapanese_Postcard_Rotated">
|
|
<summary>Japanese Postcard Rotated 148 x 100 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeDbl_Japanese_Postcard_Rotated">
|
|
<summary>Double Japanese Postcard Rotated 148 x 200 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeA6_Rotated">
|
|
<summary>A6 Rotated 148 x 105 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeJEnv_Kaku2_Rotated">
|
|
<summary>Japanese Envelope Kaku #2 Rotated 332 x 240 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeJEnv_Kaku3_Rotated">
|
|
<summary>Japanese Envelope Kaku #3 Rotated 277 x 216 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeJEnv_Chou3_Rotated">
|
|
<summary>Japanese Envelope Chou #3 Rotated 235 x 120 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeJEnv_Chou4_Rotated">
|
|
<summary>Japanese Envelope Chou #4 Rotated 205 x 90 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeB6_Jis">
|
|
<summary>B6 (JIS) 128 x 182 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeB6_Jis_Rotated">
|
|
<summary>B6 (JIS) Rotated 182 x 128 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSize12X11">
|
|
<summary>12 x 11 in</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeJEnv_You4">
|
|
<summary>Japanese Envelope You #4 235 x 105 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeJEnv_You4_Rotated">
|
|
<summary>Japanese Envelope You #4 Rotated 105 x 235 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeP16K">
|
|
<summary>PRC 16K 146 x 215 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeP32K">
|
|
<summary>PRC 32K 97 x 151 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeP32KBig">
|
|
<summary>PRC 32K(Big) 97 x 151 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizePEnv_1">
|
|
<summary>PRC Envelope #1 102 x 165 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizePEnv_2">
|
|
<summary>PRC Envelope #2 102 x 176 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizePEnv_3">
|
|
<summary>PRC Envelope #3 125 x 176 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizePEnv_4">
|
|
<summary>PRC Envelope #4 110 x 208 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizePEnv_5">
|
|
<summary>PRC Envelope #5 110 x 220 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizePEnv_6">
|
|
<summary>PRC Envelope #6 120 x 230 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizePEnv_7">
|
|
<summary>PRC Envelope #7 160 x 230 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizePEnv_8">
|
|
<summary>PRC Envelope #8 120 x 309 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizePEnv_9">
|
|
<summary>PRC Envelope #9 229 x 324 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizePEnv_10">
|
|
<summary>PRC Envelope #10 324 x 458 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeP16K_Rotated">
|
|
<summary>PRC 16K Rotated</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeP32K_Rotated">
|
|
<summary>PRC 32K Rotated</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizeP32KBig_Rotated">
|
|
<summary>PRC 32K(Big) Rotated</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizePEnv_1_Rotated">
|
|
<summary>PRC Envelope #1 Rotated 165 x 102 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizePEnv_2_Rotated">
|
|
<summary>PRC Envelope #2 Rotated 176 x 102 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizePEnv_3_Rotated">
|
|
<summary>PRC Envelope #3 Rotated 176 x 125 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizePEnv_4_Rotated">
|
|
<summary>PRC Envelope #4 Rotated 208 x 110 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizePEnv_5_Rotated">
|
|
<summary>PRC Envelope #5 Rotated 220 x 110 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizePEnv_6_Rotated">
|
|
<summary>PRC Envelope #6 Rotated 230 x 120 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizePEnv_7_Rotated">
|
|
<summary>PRC Envelope #7 Rotated 230 x 160 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizePEnv_8_Rotated">
|
|
<summary>PRC Envelope #8 Rotated 309 x 120 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizePEnv_9_Rotated">
|
|
<summary>PRC Envelope #9 Rotated 324 x 229 mm</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfPageSizes.PdfPageSizePEnv_10_Rotated">
|
|
<summary>PRC Envelope #10 Rotated 458 x 324 mm</summary>
|
|
</member>
|
|
<member name="T:GdPicture14.PdfRubberStampAnnotationIcon">
|
|
<summary>Specifies the name of an icon to be used in displaying the rubber stamp annotation.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfRubberStampAnnotationIcon.Approved">
|
|
<summary>Approved.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfRubberStampAnnotationIcon.NotApproved">
|
|
<summary>Not approved.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfRubberStampAnnotationIcon.NotForPublicRelease">
|
|
<summary>Not for public release.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfRubberStampAnnotationIcon.Confidential">
|
|
<summary>Confidential.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfRubberStampAnnotationIcon.Final">
|
|
<summary>Final.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfRubberStampAnnotationIcon.ForComment">
|
|
<summary>For comment.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfRubberStampAnnotationIcon.Draft">
|
|
<summary>Draft.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfRubberStampAnnotationIcon.ForPublicRelease">
|
|
<summary>For public release.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfRubberStampAnnotationIcon.SBCompleted">
|
|
<summary>Completed.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfRubberStampAnnotationIcon.SBInformationOnly">
|
|
<summary>Information only.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfRubberStampAnnotationIcon.SBVoid">
|
|
<summary>Void.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfRubberStampAnnotationIcon.SBPreliminaryResults">
|
|
<summary>Preliminary results.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfRubberStampAnnotationIcon.SBRejected">
|
|
<summary>Rejected.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfRubberStampAnnotationIcon.SHAccepted">
|
|
<summary>Accepted.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfRubberStampAnnotationIcon.SHInitialHere">
|
|
<summary>Initial here.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfRubberStampAnnotationIcon.SHSignHere">
|
|
<summary>Sign here.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfRubberStampAnnotationIcon.SHWitness">
|
|
<summary>Witness.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfRubberStampAnnotationIcon.DApproved">
|
|
<summary>Approved.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfRubberStampAnnotationIcon.DConfidential">
|
|
<summary>Confidential.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfRubberStampAnnotationIcon.DReceived">
|
|
<summary>Received.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.PdfRubberStampAnnotationIcon.DReviewed">
|
|
<summary>Reviewed.</summary>
|
|
</member>
|
|
<member name="T:GdPicture14.TiffCompression">
|
|
<summary>Specifies the TIFF compression when saving images in TIFF format.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.TiffCompression.TiffCompressionUnknown">
|
|
<summary>Unknown compression.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.TiffCompression.TiffCompressionNONE">
|
|
<summary>No compression.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.TiffCompression.TiffCompressionRLE">
|
|
<summary>CCITT modified Huffman RLE</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.TiffCompression.TiffCompressionCCITT3">
|
|
<summary>CCITT Group 3 fax encoding</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.TiffCompression.TiffCompressionCCITT4">
|
|
<summary>CCITT Group 4 fax encoding</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.TiffCompression.TiffCompressionLZW">
|
|
<summary>Lempel-Ziv and Welch</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.TiffCompression.TiffCompressionOJPEG">
|
|
<summary>!6.0 JPEG</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.TiffCompression.TiffCompressionJPEG">
|
|
<summary>%JPEG DCT compression</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.TiffCompression.TiffCompressionADOBEDEFLATE">
|
|
<summary>Deflate compression, as recognized by Adobe.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.TiffCompression.TiffCompressionNEXT">
|
|
<summary>NeXT 2-bit RLE</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.TiffCompression.TiffCompressionCCITTRLEW">
|
|
<summary>#1 w/ word alignment</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.TiffCompression.TiffCompressionPACKBITS">
|
|
<summary>Macintosh RLE</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.TiffCompression.TiffCompressionTHUNDERSCAN">
|
|
<summary>ThunderScan RLE</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.TiffCompression.TiffCompressionDEFLATE">
|
|
<summary>Deflate compression.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.TiffCompression.TiffCompressionAUTO">
|
|
<summary>Uses CCITT4 compression for bitonal image and LZW for others.
|
|
TiffCompressionAUTO allows to mix compression in a multipage tiff document.</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.TiffCompression.TiffCompressionAUTO2">
|
|
<summary>Beta: do not use yet.</summary>
|
|
</member>
|
|
<member name="T:GdPicture14.DocumentBookmarkSource">
|
|
<summary>
|
|
Specifies the source for PDF document outline (bookmarks) when converting Office documents to PDF.
|
|
</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentBookmarkSource.Headings">
|
|
<summary>
|
|
Create PDF outline entries from document headings (Heading 1, Heading 2, etc.).
|
|
This is the default behavior, matching Word's "Create bookmarks using: Headings" option.
|
|
</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentBookmarkSource.WordBookmarks">
|
|
<summary>
|
|
Create PDF outline entries from Word bookmarks.
|
|
This matches Word's "Create bookmarks using: Word bookmarks" option.
|
|
</summary>
|
|
</member>
|
|
<member name="T:GdPicture14.DocumentMarkupMode">
|
|
<summary>
|
|
Specifies the modes for converting document markups, including how changes and comments are rendered.
|
|
</summary>
|
|
<remarks>This enumeration provides options for controlling the visibility of markups, such as tracked
|
|
changes and comments, in a document. Each mode determines whether changes are shown, hidden, or treated as
|
|
accepted or rejected, and whether comments are converted to annotations.</remarks>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentMarkupMode.AllMarkup">
|
|
<summary>
|
|
Show all the markups in different colors, underlined/struck through. Comments are converted to annotations. This is the default behavior.
|
|
</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentMarkupMode.SimpleMarkup">
|
|
<summary>
|
|
Show the document as if all the changes were accepted. Comments are converted to annotations.
|
|
</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentMarkupMode.NoMarkup">
|
|
<summary>
|
|
Show the document as if all the changes were accepted. Comments are NOT converted to annotations.
|
|
</summary>
|
|
</member>
|
|
<member name="F:GdPicture14.DocumentMarkupMode.Original">
|
|
<summary>
|
|
Show the document as if none of the changes were made (= as if all changes were rejected). Comments are NOT converted to annotations.
|
|
</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|