Class AddTimestampOptions

[Obsolete("The class will be deleted soon. Please use SignOptions class.")]
public class AddTimestampOptions : PluginBaseOptions, IPluginOptions

Наследование

object ← PluginBaseOptions ← AddTimestampOptions

Реализует

• IPluginOptions

Унаследованные члены

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

AddTimestampOptions(Stream, string, string, string)

Инициализирует новый экземпляр объекта Documentize.AddTimestampOptions с параметрами по умолчанию.

public AddTimestampOptions(Stream pfx, string password, string serverUrl, string serverBasicAuthCredentials = "")

Параметры

• pfx Stream: Путь к файлу pfx.
• password string: Пароль к файлу pfx.
• serverUrl string: URL сервера временных меток.
• serverBasicAuthCredentials string: Учётные данные базовой аутентификации, имя пользователя и пароль объединяются в строку «username:password». (Необязательно).

AddTimestampOptions(string, string, string, string)

Инициализирует новый экземпляр объекта Documentize.AddTimestampOptions с параметрами по умолчанию.

public AddTimestampOptions(string pfx, string password, string serverUrl, string serverBasicAuthCredentials = "")

Параметры

• pfx string: Путь к файлу pfx.
• password string: Пароль к файлу pfx.
• serverUrl string: URL сервера временных меток.
• serverBasicAuthCredentials string: Учётные данные базовой аутентификации, имя пользователя и пароль объединяются в строку «username:password». (Необязательно).

Class ChatCompletion

public class ChatCompletion

Наследование

object ← ChatCompletion

Унаследованные члены

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

ChatCompletion()

public ChatCompletion()

Свойства

Choices

Список вариантов завершения чата. Может быть более одного, если n больше 1.

[JsonProperty("choices")]
public List<choice> Choices { get; set; }

Значение свойства

List<Choice>

Created

Unix‑временная метка (в секундах) времени создания завершения чата.

[JsonProperty("created")]
public long Created { get; set; }

Значение свойства

long

Id

Уникальный идентификатор завершения чата.

[JsonProperty("id")]
public string Id { get; set; }

Значение свойства

string

Model

Модель, использованная для завершения чата.

[JsonProperty("model")]
public string Model { get; set; }

Значение свойства

string

Object

Тип объекта, который всегда равен chat.completion.

[JsonProperty("object")]
public string Object { get; set; }

Значение свойства

string

SystemFingerprint

Этот отпечаток представляет конфигурацию бэкенда, с которой работает модель.

[JsonProperty("system_fingerprint")]
public string SystemFingerprint { get; set; }

Значение свойства

string

Usage

Статистика использования для запроса завершения.

[JsonProperty("usage")]
public Usage Usage { get; set; }

Значение свойства

Usage

Class ChatGptConsts

public static class ChatGptConsts

Наследование

object ← ChatGptConsts

Унаследованные члены

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Поля

• ApiUrl

Значение поля

string

ModelName

public static string ModelName

Значение поля

string

SystemRole

public static string SystemRole

Значение поля

string

SystemRoleDescription

public static string SystemRoleDescription

Значение поля

string

UserRole

public static string UserRole

Значение поля

string

Class ChatGptRequestOptions

public class ChatGptRequestOptions : PluginBaseOptions, IPluginOptions

Наследование

object ←
PluginBaseOptions ←
ChatGptRequestOptions

Реализует

• IPluginOptions

Наследованные члены

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

ChatGptRequestOptions()

Инициализирует новый экземпляр объекта Documentize.ChatGptRequestOptions с параметрами по умолчанию.

public ChatGptRequestOptions()

ChatGptRequestOptions(string, string, string, string)

Инициализирует новый экземпляр объекта Documentize.ChatGptRequestOptions с указанными параметрами.

public ChatGptRequestOptions(string apiKey, string model, string apiUrl, string query)

Параметры

• apiKey string: Ключ доступа к API ChatGPT.
• model string: Название модели ChatGPT. Модель по умолчанию: gpt-3.5-turbo-1106.
• apiUrl string: URL API ChatGPT. URL по умолчанию: https://api.openai.com/v1/chat/completions.
• query string: Строковый запрос к ChatGPT.

Свойства

ApiKey

Получает или задаёт ключ доступа к API ChatGPT.

public string ApiKey { get; set; }

Тип свойства

string

ApiUrl

Получает или задаёт URL API ChatGPT.

public string ApiUrl { get; set; }

Тип свойства

string

CancellationToken

Токен отмены.

public CancellationToken CancellationToken { get; set; }

Тип свойства

CancellationToken

MaxTokens

Максимальное количество токенов в ответе. Значение по умолчанию — null, что означает бесконечность.

public int? MaxTokens { get; set; }

Тип свойства

int?

Messages

Получает или задаёт коллекцию объектов Documentize.Message.

public List<message> Messages { get; set; }

Тип свойства

List<Message>

Примечание

При добавлении нескольких сообщений в параметры порядок в коллекции сообщений следующий:

• Первое сообщение (если оно есть) берётся из options.Query, перед ним добавляется сообщение с содержимым «You are a helpful assistant.» и ролью «system».
• Затем (если есть) добавляются сообщения из коллекции options.Messages.
• Сообщения из файлов‑источников (если есть) добавляются последними, по одному объекту сообщения для каждого документа с ролью «user».
  Если ни одно сообщение не предоставлено, генерируется ArgumentException.

Model

Задаёт или получает идентификатор модели, которую следует использовать.

public string Model { get; set; }

Тип свойства

string

NumberOfChoices

Сколько вариантов завершения чата генерировать для каждого входного сообщения.

public int NumberOfChoices { get; set; }

Тип свойства

int

Query

Получает или задаёт строковый запрос к ChatGPT. Если не пустой, это первое сообщение в коллекции, которое будет отправлено в запросе.

public string Query { get; set; }

Тип свойства

string

Temperature

Температура сэмплирования, значение от 0 до 2. Более высокие значения (например, 0.8) делают вывод более случайным, а более низкие (например, 0.2) делают его более сфокусированным и детерминированным. Значение по умолчанию — 1.

public double Temperature { get; set; }

Тип свойства

double

Class CompressOptions

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

Наследование

object ← PluginBaseOptions ← CompressOptions

Реализует

• IPluginOptions

Унаследованные члены

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

CompressOptions()

Инициализирует новый экземпляр объекта Documentize.CompressOptions с параметрами по умолчанию.

public CompressOptions()

Class DecryptionOptions

public class DecryptionOptions : PluginBaseOptions, IPluginOptions

Наследование

object ← PluginBaseOptions ← DecryptionOptions

Реализует

• IPluginOptions

Унаследованные члены

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

DecryptionOptions(string)

Инициализирует новый экземпляр объекта Documentize.DecryptionOptions с параметрами по умолчанию.

public DecryptionOptions(string ownerPassword)

Параметры

• ownerPassword string: Пароль владельца.

Свойства

OwnerPassword

Пароль владельца.

public string OwnerPassword { get; set; }

Значение свойства

string

Class DecryptOptions

public class DecryptOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← DecryptOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

DecryptOptions(string)

Инициализирует новый экземпляр объекта Documentize.DecryptOptions с параметрами по умолчанию.

public DecryptOptions(string ownerPassword)

Parameters

• ownerPassword string: Пароль владельца.

Properties

OwnerPassword

Пароль владельца.

public string OwnerPassword { get; set; }

Property Value

string

Class DirectoryData

public sealed class DirectoryData : IData

Наследование

object ← DirectoryData

Реализует

• IData

Унаследованные члены

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

DirectoryData(string)

Инициализирует новые данные каталога с указанным путем.

public DirectoryData(string path)

Параметры

• path string: строка, представляющая путь к каталогу.

Свойства

DataType

Тип источника данных.

public DataType DataType { get; }

Значение свойства

DataType

Path

Получает путь к каталогу текущих данных.

public string Path { get; }

Значение свойства

string

Class DirectoryDataSource

public sealed class DirectoryDataSource : IDataSource

Наследование

object ← DirectoryDataSource

Реализует

• IDataSource

Унаследованные члены

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

DirectoryDataSource(string)

Инициализирует новые данные каталога с указанным путем.

public DirectoryDataSource(string path)

Параметры

• path string: Строка, представляющая путь к каталогу.

Свойства

DataType

Тип источника данных.

public DataType DataType { get; }

Значение свойства

DataType

Path

Получает путь к каталогу текущих данных.

public string Path { get; }

Значение свойства

string

Class DocConverter

[Obsolete("Класс будет удален в ближайшее время. Пожалуйста, используйте класс PdfConverter.")]
public static class DocConverter

Наследование

object ← DocConverter

Унаследованные члены

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Методы

Process(PdfToDocOptions)

Конвертирует PDF документ в формат DOC/DOCX.

public static ResultContainer Process(PdfToDocOptions options)

Параметры

• options PdfToDocOptions: Объект параметров, содержащий инструкции для операции.

Возвращает

ResultContainer : Объект, содержащий результат операции.

Исключения

ArgumentException

Если параметры не заданы.

Class EncryptionOptions

public class EncryptionOptions : PluginBaseOptions, IPluginOptions

Наследование

object ← PluginBaseOptions ← EncryptionOptions

Реализует

• IPluginOptions

Унаследованные члены

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

EncryptionOptions(string, string)

Инициализирует новый экземпляр объекта Documentize.EncryptionOptions с параметрами по умолчанию.

public EncryptionOptions(string ownerPassword, string userPassword)

Параметры

• ownerPassword string: Пароль владельца.
• userPassword string: Пароль пользователя.

Свойства

OwnerPassword

Пароль владельца.

public string OwnerPassword { get; set; }

Значение свойства

string

UserPassword

Пароль пользователя.

public string UserPassword { get; set; }

Значение свойства

string

Class EncryptOptions

public class EncryptOptions : PluginBaseOptions, IPluginOptions

Наследование

object ← PluginBaseOptions ← EncryptOptions

Реализует

• IPluginOptions

Унаследованные члены

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

EncryptOptions(string, string)

Инициализирует новый экземпляр объекта Documentize.EncryptOptions со значениями параметров по умолчанию.

public EncryptOptions(string ownerPassword, string userPassword)

Параметры

• ownerPassword string: Пароль владельца.
• userPassword string: Пароль пользователя.

Свойства

OwnerPassword

Пароль владельца.

public string OwnerPassword { get; set; }

Тип свойства

string

UserPassword

Пароль пользователя.

public string UserPassword { get; set; }

Тип свойства

string

Class ExtractFormDataToDsvOptions

public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions

Наследование

object ← PluginBaseOptions ← ExtractFormDataToDsvOptions

Реализует

• IPluginOptions

Унаследованные члены

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

ExtractFormDataToDsvOptions(char, bool)

Инициализирует новый экземпляр объекта Documentize.ExtractFormDataToDsvOptions.

public ExtractFormDataToDsvOptions(char delimiter = ',', bool addFieldNames = false)

Параметры

• delimiter char: Указывает разделитель, используемый в экспортированных данных между значениями. Значение по умолчанию — ‘,’.
• addFieldNames bool: Добавляет имя поля перед значением. Формат: Имя + разделитель + Значение + разделитель.

Свойства

AddFieldName

Добавляет имя поля перед значением. Формат: Имя + разделитель + Значение + разделитель.

public bool AddFieldName { get; set; }

Значение свойства

bool

Delimiter

Разделитель, используемый для экспортированных значений.

public char Delimiter { get; set; }

Значение свойства

char

Class ExtractImagesOptions

public sealed class ExtractImagesOptions : PluginBaseOptions, IPluginOptions

Наследование

object ← PluginBaseOptions ← ExtractImagesOptions

Реализует

• IPluginOptions

Унаследованные члены

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

ExtractImagesOptions()

Инициализирует новый экземпляр объекта Documentize.ExtractImagesOptions с параметрами по умолчанию.

public ExtractImagesOptions()

Class ExtractPropertiesOptions

public sealed class ExtractPropertiesOptions : OptionsWithInput, IHaveInput

Наследование

object ←
OptionsWithInput ←
ExtractPropertiesOptions

Реализует

• IHaveInput

Унаследованные члены

• OptionsWithInput.Input,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

ExtractPropertiesOptions()

Инициализирует новый экземпляр объекта Documentize.ExtractPropertiesOptions с параметрами по умолчанию.

public ExtractPropertiesOptions()

ExtractPropertiesOptions(IData)

Инициализирует новый экземпляр объекта Documentize.ExtractPropertiesOptions с указанными данными.

public ExtractPropertiesOptions(IData data)

Параметры

• data IData: Входные данные.

ExtractPropertiesOptions(string)

Инициализирует новый экземпляр объекта Documentize.ExtractPropertiesOptions с указанным файлом.

public ExtractPropertiesOptions(string file)

Параметры

• file string: Путь к входному файлу.

ExtractPropertiesOptions(Stream)

Инициализирует новый экземпляр объекта Documentize.ExtractPropertiesOptions с указанным потоком.

public ExtractPropertiesOptions(Stream stream)

Параметры

• stream Stream: Входной поток.

Свойства

Input

Получает или задает входные данные.

public override IData Input { get; set; }

Значение свойства

IData

Class ExtractTextOptions

public sealed class ExtractTextOptions : OptionsWithInput, IHaveInput

Наследование

object ← OptionsWithInput ← ExtractTextOptions

Реализует

• IHaveInput

Унаследованные члены

• OptionsWithInput.Input,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

ExtractTextOptions(TextFormattingMode)

Инициализирует новый экземпляр объекта Documentize.ExtractTextOptions для указанного режима форматирования текста.

public ExtractTextOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

Параметры

• formattingMode TextFormattingMode: Значение режима форматирования текста.

ExtractTextOptions(IData, TextFormattingMode)

Инициализирует новый экземпляр объекта Documentize.ExtractTextOptions с указанными данными.

public ExtractTextOptions(IData data, TextFormattingMode formattingMode = TextFormattingMode.Raw)

Параметры

• data IData: Входные данные.
• formattingMode TextFormattingMode: Значение режима форматирования текста.

ExtractTextOptions(string, TextFormattingMode)

Инициализирует новый экземпляр объекта Documentize.ExtractTextOptions с указанным файлом.

public ExtractTextOptions(string file, TextFormattingMode formattingMode = TextFormattingMode.Raw)

Параметры

• file string: Путь к входному файлу.
• formattingMode TextFormattingMode: Значение режима форматирования текста.

ExtractTextOptions(Stream, TextFormattingMode)

Инициализирует новый экземпляр объекта Documentize.ExtractTextOptions с указанным потоком.

public ExtractTextOptions(Stream stream, TextFormattingMode formattingMode = TextFormattingMode.Raw)

Параметры

• stream Stream: Входной поток.
• formattingMode TextFormattingMode: Значение режима форматирования текста.

Свойства

FormattingMode

Получает или задает режим форматирования.

public TextFormattingMode FormattingMode { get; set; }

Значение свойства

TextFormattingMode

Input

Получает или задает входные данные.

public override IData Input { get; set; }

Значение свойства

IData

Class FileData

public sealed class FileData : IData

Наследование

object ← FileData

Реализует

• IData

Унаследованные члены

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

FileData(string)

Инициализирует новый источник данных файла с указанным путем.

public FileData(string path)

Параметры

• path string: Строка, представляющая путь к исходному файлу.

Свойства

DataType

Тип источника данных.

public DataType DataType { get; }

Значение свойства

DataType

Path

Получает путь к файлу текущих данных.

public string Path { get; }

Значение свойства

string

Class FileDataSource

public sealed class FileDataSource : IDataSource

Наследование

object ← FileDataSource

Реализует

• IDataSource

Унаследованные члены

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

FileDataSource(string)

Инициализирует новый источник данных файла с указанным путем.

public FileDataSource(string path)

Параметры

• path string: Строка, представляющая путь к исходному файлу.

Свойства

DataType

Тип источника данных.

public DataType DataType { get; }

Значение свойства

DataType

Path

Возвращает путь к файлу текущих данных.

public string Path { get; }

Значение свойства

string

Class FileResult

public sealed class FileResult : IOperationResult

Наследование

object ← FileResult

Реализует

• IOperationResult

Унаследованные члены

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Свойства

Data

Получает необработанные данные.

public object Data { get; }

Значение свойства

object

IsFile

Указывает, является ли результат путем к выходному файлу.

public bool IsFile { get; }

Значение свойства

bool

IsStream

Указывает, является ли результат выходным потоком.

public bool IsStream { get; }

Значение свойства

bool

IsString

Указывает, является ли результат текстовой строкой.

public bool IsString { get; }

Значение свойства

bool

Методы

ToFile()

Пытается преобразовать результат в файл.

public string ToFile()

Возвращает

string : Строка, представляющая путь к выходному файлу, если результат является файлом; в противном случае null.

ToStream()

Пытается преобразовать результат в объект потока.

public Stream ToStream()

Возвращает

Stream : Объект потока, представляющий выходные данные, если результат является потоком; в противном случае null.

Class FlattenFieldsOptions

public class FlattenFieldsOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← FlattenFieldsOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

FlattenFieldsOptions()

Инициализирует новый экземпляр объекта Documentize.FlattenFieldsOptions с параметрами по умолчанию.

public FlattenFieldsOptions()

Properties

SkipFields

Список полей, которые не будут уплощены.

public List<string> SkipFields { get; set; }

Property Value

List<string>

Class FormExporter

[Obsolete("The class will be deleted soon. Please use PdfExtractor or PdfForm class.")]
public static class FormExporter

Наследование

object ← FormExporter

Унаследованные члены

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Методы

Process(ExtractFormDataToDsvOptions)

Запускает обработку Documentize.FormExporter с указанными параметрами.

public static ResultContainer Process(ExtractFormDataToDsvOptions options)

Параметры

• options ExtractFormDataToDsvOptions: Объект параметров, содержащий инструкции для операции.

Возвращаемое значение

ResultContainer : Объект, содержащий результат операции.

Исключения

ArgumentException

Если параметр options не указан.

Class FormExportToDsvOptions

public sealed class FormExportToDsvOptions : PluginBaseOptions, IPluginOptions

Наследование

object ← PluginBaseOptions ← FormExportToDsvOptions

Реализует

• IPluginOptions

Унаследованные члены

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

FormExportToDsvOptions(char, bool)

Инициализирует новый экземпляр объекта Documentize.FormExportToDsvOptions.

public FormExportToDsvOptions(char delimeter = ',', bool addFieldNames = false)

Параметры

• delimeter char: Указывает разделитель, который будет использоваться в экспортируемых данных между значениями. Значение по умолчанию - ‘,’.
• addFieldNames bool: Добавить имя поля перед значением. Формат: Имя + разделитель + Значение + разделитель.

Свойства

AddFieldName

Добавить имя поля перед значением. Формат: Имя + разделитель + Значение + разделитель.

public bool AddFieldName { get; set; }

Значение свойства

bool

Delimeter

Разделитель, используемый для экспортируемых значений.

public char Delimeter { get; set; }

Значение свойства

char

Class FormFlattener

[Obsolete("The class will be deleted soon. Please use PdfForm class.")]
public static class FormFlattener

Inheritance

object ← FormFlattener

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Методы

GetFieldNames(string)

Получить имена полей в PDF‑документе.

public static List<string> GetFieldNames(string path)

Параметры

• path string: Путь к PDF‑документу.

Возвращаемое значение

List<string>

Список имён в PDF‑документе.

GetFieldNames(Stream) : Get Field Names in the PDF Document.

public static List<string> GetFieldNames(Stream stream)

Параметры

• stream Stream: Поток с PDF‑документом.

Возвращаемое значение

List<string>

Список имён в PDF‑документе.

Process(FlattenFieldsOptions) : Flatten Form fields in PDF document.

public static ResultContainer Process(FlattenFieldsOptions options)

Параметры

• options FlattenFieldsOptions: Объект параметров, содержащий инструкции для операции.

Возвращаемое значение

ResultContainer : Объект, содержащий результат операции.

Исключения

ArgumentException

Если параметры не заданы.

Class FormFlattenerOptions

public class FormFlattenerOptions : PluginBaseOptions, IPluginOptions

Наследование

object ← PluginBaseOptions ← FormFlattenerOptions

Реализует

• IPluginOptions

Унаследованные члены

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

FormFlattenerOptions()

Инициализирует новый экземпляр объекта Documentize.FormFlattenerOptions с параметрами по умолчанию.

public FormFlattenerOptions()

Свойства

SkipFields

Список полей, которые не будут сглажены.

public List<string> SkipFields { get; set; }

Значение свойства

List<string>

Class GetFieldNamesOptions

public class GetFieldNamesOptions

Inheritance

object ← GetFieldNamesOptions

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

GetFieldNamesOptions(string)

Constructor for options with input Path to file.

public GetFieldNamesOptions(string path)

Parameters

• path string: Входной путь к файлу.

GetFieldNamesOptions(Stream)

Constructor for options with input Stream.

public GetFieldNamesOptions(Stream stream)

Parameters

• stream Stream: Входной поток.

Class HtmlConverter

[Obsolete("Класс будет удален в ближайшее время. Пожалуйста, используйте класс PdfConverter.")]
public static class HtmlConverter

Наследование

object ← HtmlConverter

Унаследованные члены

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Методы

Process(PdfToHtmlOptions)

Преобразует PDF-документы в HTML-формат.

public static ResultContainer Process(PdfToHtmlOptions options)

Параметры

• options PdfToHtmlOptions: Объект параметров, содержащий инструкции для операции.

Возвращает

ResultContainer : Объект, содержащий результат операции.

Исключения

ArgumentException

Если параметры не установлены.

Process(HtmlToPdfOptions)

Преобразует HTML-документы в PDF-формат.

public static ResultContainer Process(HtmlToPdfOptions options)

Параметры

• options HtmlToPdfOptions: Объект параметров, содержащий инструкции для операции.

Возвращает

ResultContainer : Объект, содержащий результат операции.

Исключения

ArgumentException

Если параметры не установлены.

Class HtmlToPdfOptions

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ←
PluginBaseOptions ←
HtmlToPdfOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

HtmlToPdfOptions()

Инициализирует новый экземпляр объекта Documentize.HtmlToPdfOptions.

public HtmlToPdfOptions()

Properties

BasePath

Базовый путь/URL для HTML‑файла.

public string BasePath { get; set; }

Property Value

string

HtmlMediaType

Получает или задаёт возможные типы медиа, используемые при рендеринге.

public HtmlMediaType HtmlMediaType { get; set; }

Property Value

HtmlMediaType

IsRenderToSinglePage

Получает или задаёт рендеринг всего документа в одну страницу.

public bool IsRenderToSinglePage { get; set; }

Property Value

bool

PageInfo

Получает или задаёт информацию о страницах документа.

public PageInfo PageInfo { get; set; }

Property Value

PageInfo

PageLayoutOption

Получает или задаёт параметры макета страницы.

public HtmlPageLayoutOption PageLayoutOption { get; set; }

Property Value

HtmlPageLayoutOption

Class ImageExtractor

[Obsolete("The class will be deleted soon. Please use PdfExtractor class.")]
public static class ImageExtractor

Наследование

object ← ImageExtractor

Унаследованные члены

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Методы

Process(ExtractImagesOptions)

Извлекает изображения из PDF-документа.

public static ResultContainer Process(ExtractImagesOptions options)

Параметры

• options ExtractImagesOptions: Объект параметров, содержащий инструкции для операции.

Возвращает

ResultContainer : Объект, содержащий результат операции.

Исключения

ArgumentException

Если параметры не установлены.

Class ImageExtractorOptions

public sealed class ImageExtractorOptions : PluginBaseOptions, IPluginOptions

Наследование

object ← PluginBaseOptions ← ImageExtractorOptions

Реализует

• IPluginOptions

Унаследованные члены

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

ImageExtractorOptions()

Инициализирует новый экземпляр объекта Documentize.ImageExtractorOptions с параметрами по умолчанию.

public ImageExtractorOptions()

Class Info

public static class Info

Наследование

object ← Info

Унаследованные члены

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Поля

• AssemblyVersion Версия сборки.

Значение поля

string

Product

Имя продукта.

public const string Product = "Documentize"

Значение поля

string

Class JpegConverter

[Obsolete("Класс будет удалён скоро. Пожалуйста, используйте класс PdfConverter.")]
public static class JpegConverter

Наследование

object ← JpegConverter

Унаследованные Члены

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Методы

Process(PdfToJpegOptions)

Конвертирует PDF-документ в формат JPEG.

public static ResultContainer Process(PdfToJpegOptions options)

Параметры

• options PdfToJpegOptions: Объект параметров, содержащий инструкции для Documentize.JpegConverter.

Возвращает

ResultContainer : Объект, содержащий результат операции.

Исключения

ArgumentException

Если параметры не заданы.

Class MergeOptions

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions

Наследование

object ← PluginBaseOptions ← MergeOptions

Реализует

• IPluginOptions

Унаследованные члены

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

MergeOptions()

Инициализирует новый экземпляр объекта Documentize.MergeOptions с параметрами по умолчанию.

public MergeOptions()

Class Merger

[Obsolete("Класс будет удалён в ближайшее время. Пожалуйста, используйте класс PdfManager.")]  
public static class Merger  

Наследование

object ←
Merger

Унаследованные члены

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Методы

Process(MergeOptions)

Объединяет PDF-документы.

public static ResultContainer Process(MergeOptions options)  

Параметры

• options MergeOptions: Объект параметров, содержащий инструкции для операции.

Возвращает

ResultContainer: Объект, содержащий результат операции.

Исключения

ArgumentException

Если параметры не заданы.

Class Message

public class Message

Наследование

object ← Message

Унаследованные члены

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

Message()

public Message()

Свойства

Content

Содержимое сообщения.

[JsonProperty("content")]
public string Content { get; set; }

Значение свойства

string

Role

Устанавливает или получает роль автора этого сообщения.

[JsonProperty("role")]
[JsonConverter(typeof(StringEnumConverter), new object[] { true })]
public Role Role { get; set; }

Значение свойства

Role

Class ObjectResult

public sealed class ObjectResult : IOperationResult

Наследование

object ← ObjectResult

Реализует

• IOperationResult

Унаследованные члены

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Свойства

Data

Получает необработанные данные.

public object Data { get; }

Значение свойства

object

IsFile

Указывает, является ли результат путем к выходному файлу.

public bool IsFile { get; }

Значение свойства

bool

IsObject

Указывает, является ли результат объектом.

public bool IsObject { get; }

Значение свойства

bool

IsStream

Указывает, является ли результат путем к выходному файлу.

public bool IsStream { get; }

Значение свойства

bool

IsString

Указывает, является ли результат строкой.

public bool IsString { get; }

Значение свойства

bool

Text

Возвращает строковое представление результата.

public string Text { get; }

Значение свойства

string

Методы

ToFile()

Пытается конвертировать результат в файл.

public string ToFile()

Возвращает

string : Строка, представляющая путь к выходному файлу, если результат является файлом; в противном случае null.

ToStream()

Пытается конвертировать результат в объект потока.

public Stream ToStream()

Возвращает

Stream : Объект потока, представляющий выходные данные, если результат является потоком; в противном случае null.

ToString()

Пытается конвертировать результат в строку.

public override string ToString()

Возвращает

string : Строка, представляющая текстовое содержимое, если результат является строкой; в противном случае возвращает base.ToString().

Class OptimizeOptions

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← OptimizeOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IData),
• PluginBaseOptions.AddOutput(IData),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

OptimizeOptions()

Инициализирует новый экземпляр объекта Documentize.OptimizeOptions с параметрами по умолчанию. Линеаризует документ, чтобы:

• открыть первую страницу как можно быстрее;
• отобразить следующую страницу или перейти по ссылке на следующую страницу как можно быстрее;
• отображать страницу постепенно по мере поступления данных, когда данные для страницы передаются по медленному каналу (сначала выводятся наиболее полезные данные);
• позволить пользователю выполнять такие действия, как переход по ссылке, ещё до того, как вся страница будет получена и отображена.

public OptimizeOptions()

Class Optimizer

[Obsolete("Класс будет удален в ближайшее время. Пожалуйста, используйте класс PdfManager.")]
public static class Optimizer

Наследование

object ← Optimizer

Унаследованные члены

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Методы

Process(OptimizeOptions)

Запускает процесс Documentize.Optimizer с указанными параметрами.

public static ResultContainer Process(OptimizeOptions options)

Параметры

• options OptimizeOptions: Объект параметров, содержащий инструкции для операции.

Возвращает

ResultContainer : Объект, содержащий результат операции.

Process(RotateOptions)

Запускает процесс Documentize.Optimizer с указанными параметрами.

public static ResultContainer Process(RotateOptions options)

Параметры

• options RotateOptions: Объект параметров, содержащий инструкции для операции.

Возвращает

ResultContainer : Объект, содержащий результат операции.

Process(ResizeOptions)

Запускает процесс Documentize.Optimizer с указанными параметрами.

public static ResultContainer Process(ResizeOptions options)

Параметры

• options ResizeOptions: Объект параметров, содержащий инструкции для операции.

Возвращает

ResultContainer : Объект, содержащий результат операции.

Process(CompressOptions)

Запускает процесс Documentize.Optimizer с указанными параметрами.

public static ResultContainer Process(CompressOptions options)

Параметры

• options CompressOptions: Объект параметров, содержащий инструкции для операции.

Возвращает

ResultContainer : Объект, содержащий результат операции.

Class OptionsWithInput

public abstract class OptionsWithInput : IHaveInput

Наследование

object ← OptionsWithInput

Потомки

• ExtractPropertiesOptions,
• ExtractTextOptions

Реализует

• IHaveInput

Унаследованные члены

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Поля

• input

Значение поля

IData

Свойства

Input

Получает или задаёт входные данные.

public virtual IData Input { get; set; }

Значение свойства

IData

Class PageInfo

public class PageInfo : PageSize

Наследование

object ← PageSize ← PageInfo

Унаследованные члены

• PageSize.Width,
• PageSize.Height,
• PageSize.IsLandscape,
• PageSize.A0,
• PageSize.A1,
• PageSize.A2,
• PageSize.A3,
• PageSize.A4,
• PageSize.A5,
• PageSize.A6,
• PageSize.B5,
• PageSize.PageLetter,
• PageSize.PageLegal,
• PageSize.PageLedger,
• PageSize.P11x17,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

PageInfo()

Конструктор Documentize.PageInfo.

public PageInfo()

PageInfo(double, double)

Конструктор Documentize.PageInfo.

public PageInfo(double width, double height)

Параметры

• width double: Ширина страницы.
• height double: Высота страницы.

Свойства

MarginBottom

Получает или задает значение, указывающее нижний отступ.

public double MarginBottom { get; set; }

Значение свойства

double

MarginLeft

Получает или задает значение, указывающее левый отступ.

public double MarginLeft { get; set; }

Значение свойства

double

MarginRight

Получает или задает значение, указывающее правый отступ.

public double MarginRight { get; set; }

Значение свойства

double

MarginTop

Получает или задает значение, указывающее верхний отступ.

public double MarginTop { get; set; }

Значение свойства

double

Class PageSize

public class PageSize

Наследование

object ← PageSize

Производные

• PageInfo

Унаследованные члены

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

PageSize()

Конструктор Documentize.PageSize. Размер A4 по умолчанию.

public PageSize()

PageSize(double, double)

Конструктор Documentize.PageSize.

public PageSize(double width, double height)

Параметры

• width double: Ширина страницы.
• height double: Высота страницы.

Свойства

A0

Размер A0 (1189x840 мм).

public static PageSize A0 { get; }

Значение свойства

PageSize

A1

Размер A1 (840x594 мм).

public static PageSize A1 { get; }

Значение свойства

PageSize

A2

Размер A2 (594x420 мм).

public static PageSize A2 { get; }

Значение свойства

PageSize

A3

Размер A3 (420x297 мм).

public static PageSize A3 { get; }

Значение свойства

PageSize

A4

Размер A4 (297x210 мм).

public static PageSize A4 { get; }

Значение свойства

PageSize

A5

Размер A5 (210x148 мм).

public static PageSize A5 { get; }

Значение свойства

PageSize

A6

Размер A6 (148x105 мм).

public static PageSize A6 { get; }

Значение свойства

PageSize

B5

Размер B5 (250x176 мм).

public static PageSize B5 { get; }

Значение свойства

PageSize

Height

Получает или устанавливает высоту страницы.

public double Height { get; set; }

Значение свойства

double

IsLandscape

Получает ориентацию страницы. Возвращает true, если это альбомная ориентация, и false, если это портретная.

public bool IsLandscape { get; }

Значение свойства

bool

P11x17

Формат 11x17 дюймов.

public static PageSize P11x17 { get; }

Значение свойства

PageSize

PageLedger

Размер Ledger (432x279 мм).

public static PageSize PageLedger { get; }

Значение свойства

PageSize

PageLegal

Размер Legal (356x216 мм).

public static PageSize PageLegal { get; }

Значение свойства

PageSize

PageLetter

Размер Letter (279x216 мм).

public static PageSize PageLetter { get; }

Значение свойства

PageSize

Width

Получает или устанавливает ширину страницы.

public double Width { get; set; }

Значение свойства

double

Class PdfAConverter

[Obsolete("Класс будет удален вскоре. Пожалуйста, используйте класс PdfConverter.")]
public static class PdfAConverter

Унаследование

object ← PdfAConverter

Унаследованные члены

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Методы

Process(PdfToPdfAOptions)

Конвертирует PDF-документ в формат PDF/A.

public static ResultContainer Process(PdfToPdfAOptions options)

Параметры

• options PdfToPdfAOptions: Объект параметров, содержащий инструкции для операции.

Возвращает

ResultContainer : Объект, содержащий результат операции.

Исключения

ArgumentException

Если параметры не установлены.

Process(PdfAValidateOptions)

Проверяет PDF-документ на соответствие указанному формату PDF/A.

public static ResultContainer Process(PdfAValidateOptions options)

Параметры

• options PdfAValidateOptions: Объект параметров, содержащий инструкции для операции.

Возвращает

ResultContainer : Объект, содержащий результат операции.

Исключения

ArgumentException

Если параметры не установлены.

Class PdfAConvertOptions

public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions

Наследование

object ← PdfAOptionsBase ← PdfAConvertOptions

Реализует

• IPluginOptions

Унаследованные члены

• PdfAOptionsBase.AddInput(IDataSource),
• PdfAOptionsBase.Inputs,
• PdfAOptionsBase.PdfAVersion,
• PdfAOptionsBase.IsLowMemoryMode,
• PdfAOptionsBase.LogOutputSource,
• PdfAOptionsBase.ErrorAction,
• PdfAOptionsBase.SoftMaskAction,
• PdfAOptionsBase.CheckDifferentNamesInFontDictionaries,
• PdfAOptionsBase.AlignText,
• PdfAOptionsBase.OptimizeFileSize,
• PdfAOptionsBase.IccProfileFileName,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

PdfAConvertOptions()

public PdfAConvertOptions()

Свойства

Outputs

Получает коллекцию добавленных целевых объектов (файлы или потоки данных) для сохранения результатов операции.

public List<idatasource> Outputs { get; }

Значение свойства

List<IDataSource>

Методы

AddOutput(IDataSource)

Добавляет новую целевую для сохранения результатов.

public void AddOutput(IDataSource dataSource)

Параметры

• dataSource IDataSource: Цель (файл или поток данных) для сохранения результатов операции. :

Class PdfAOptionsBase

Представляет базовый класс для параметров плагина Documentize.PdfAConverter. Этот класс предоставляет свойства и методы для настройки процесса конвертации и проверки PDF/A.

public abstract class PdfAOptionsBase : IPluginOptions

Inheritance

object ← PdfAOptionsBase

Derived

• PdfAValidateOptions,
• PdfToPdfAOptions

Implements

• IPluginOptions

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

PdfAOptionsBase()

protected PdfAOptionsBase()

Properties

AlignText

Получает или задает значение, указывающее, необходимы ли дополнительные средства для сохранения выравнивания текста во время процесса конвертации PDF/A.

public bool AlignText { get; set; }

Property Value

bool

Remarks

Когда установлено в true, процесс конвертации попытается восстановить исходные границы сегментов текста. Для большинства документов нет необходимости менять это свойство от значения по умолчанию false, поскольку выравнивание текста не изменяется в процессе стандартной конвертации.

CheckDifferentNamesInFontDictionaries

Получает флаги, контролирующие конвертацию PDF/A в случаях, когда исходный PDF‑документ не соответствует спецификации PDF.

public bool CheckDifferentNamesInFontDictionaries { get; set; }

Property Value

bool

ErrorAction

Получает или задает действие, которое будет выполнено для объектов, которые нельзя сконвертировать.

public ConvertErrorAction ErrorAction { get; set; }

Property Value

ConvertErrorAction

IccProfileFileName

Получает или задает имя файла ICC‑профиля (International Color Consortium), который будет использоваться для конвертации PDF/A вместо профиля по умолчанию.

public string IccProfileFileName { get; set; }

Property Value

string

Inputs

Получает коллекцию данных.

public List<idata> Inputs { get; }

Property Value

List<IData>

IsLowMemoryMode

Получает или задает значение, указывающее, включён ли режим низкого потребления памяти во время процесса конвертации PDF/A.

public bool IsLowMemoryMode { get; set; }

Property Value

bool

LogOutputSource

Получает или задает источник данных для вывода журнала.

public IData LogOutputSource { get; set; }

Property Value

IData

OptimizeFileSize

Получает или задает значение, указывающее, следует ли пытаться уменьшить размер файла во время процесса конвертации PDF/A.

public bool OptimizeFileSize { get; set; }

Property Value

bool

Remarks

Когда установлено в true, процесс конвертации попытается минимизировать получаемый размер файла. Это может повлиять на производительность процесса конвертации.

PdfAVersion

Получает или задает версию стандарта PDF/A, которая будет использоваться для проверки или конвертации.

public PdfAStandardVersion PdfAVersion { get; set; }

Property Value

PdfAStandardVersion

Remarks

Версия стандарта PDF/A используется для определения уровня соответствия при проверке и конвертации PDF/A. Если версия установлена в Documentize.PdfAStandardVersion.Auto, система автоматически определит соответствующую версию стандарта PDF/A для проверки на основе метаданных документа. Для процесса конвертации PDF/A значение Documentize.PdfAStandardVersion.Auto по умолчанию соответствует версии стандарта PDF/A‑1b.

SoftMaskAction

Получает или задает действие, которое будет выполнено при конвертации изображений с мягкими масками.

public ConvertSoftMaskAction SoftMaskAction { get; set; }

Property Value

ConvertSoftMaskAction

Methods

AddInput(IData)

Добавляет новые данные в коллекцию

public void AddInput(IData data)

Parameters

• data IData: Входные данные. :

Class PdfAValidateOptions

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

Наследование

object ← PdfAOptionsBase ← PdfAValidateOptions

Реализует

• IPluginOptions

Унаследованные члены

• PdfAOptionsBase.AddInput(IData),
• PdfAOptionsBase.Inputs,
• PdfAOptionsBase.PdfAVersion,
• PdfAOptionsBase.IsLowMemoryMode,
• PdfAOptionsBase.LogOutputSource,
• PdfAOptionsBase.ErrorAction,
• PdfAOptionsBase.SoftMaskAction,
• PdfAOptionsBase.CheckDifferentNamesInFontDictionaries,
• PdfAOptionsBase.AlignText,
• PdfAOptionsBase.OptimizeFileSize,
• PdfAOptionsBase.IccProfileFileName,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

PdfAValidateOptions()

public PdfAValidateOptions()

Class PdfAValidationResult

public sealed class PdfAValidationResult

Наследование

object ← PdfAValidationResult

Унаследованные члены

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Поля

• Data Получает источник данных, который был проверен.

Значение поля

IData

IsValid

Получает значение, указывающее, была ли проверка успешной.

public readonly bool IsValid

Значение поля

bool

StandardVersion

Получает версию стандарта PDF/A, использованную для проверки.

public readonly PdfAStandardVersion StandardVersion

Значение поля

PdfAStandardVersion

Class PdfChatGpt

[Obsolete("Класс будет удален вскоре. Пожалуйста, используйте класс PdfManager.")]
public static class PdfChatGpt

Наследование

object ← PdfChatGpt

Унаследованные члены

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Примечания

Documentize.PdfChatGpt используется для отправки запросов к ChatGPT напрямую или добавляя источники PDF-файлов и сохраняя ответ в выходном источнике.

Методы

Process(IPluginOptions)

Метод не имеет синхронной версии. Вместо этого используйте метод ProcessAsync.

public static ResultContainer Process(IPluginOptions options)

Параметры

• options IPluginOptions: Объект параметров, содержащий инструкции для PdfChatGpt.

Возвращает

ResultContainer : #### Исключения

NotImplementedException

ProcessAsync(IPluginOptions)

Запускает обработку PdfChatGpt с указанными параметрами.

public static Task<resultcontainer> ProcessAsync(IPluginOptions options)

Параметры

• options IPluginOptions: Объект параметров, содержащий инструкции для PdfChatGpt.

Возвращает

Task<ResultContainer>

Объект задачи, представляющий асинхронную операцию.

Исключения

ArgumentException : InvalidOperationException

Class PdfChatGptOptions

public class PdfChatGptOptions : IPluginOptions

Наследование

object ← PdfChatGptOptions

Происходящие классы

• PdfChatGptRequestOptions

Реализует

• IPluginOptions

Унаследованные члены

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

PdfChatGptOptions()

Инициализирует новый экземпляр объекта Documentize.PdfChatGptOptions.

public PdfChatGptOptions()

Свойства

Inputs

public List<idatasource> Inputs { get; }

Значение свойства

List<IDataSource>

Outputs

public List<idatasource> Outputs { get; }

Значение свойства

List<IDataSource>

Методы

AddInput(IDataSource)

Добавляет новый источник данных в коллекцию данных плагина PdfChatGpt.

public void AddInput(IDataSource dataSource)

Параметры

• dataSource IDataSource: Исходный файл данных (файл или поток) для добавления.

AddOutput(IDataSource)

Добавляет новый источник данных для сохранения в коллекцию данных плагина PdfChatGpt.

public void AddOutput(IDataSource saveDataSource)

Параметры

• saveDataSource IDataSource: Исходный файл данных (файл или поток) для сохранения результатов операции. :

Class PdfChatGptRequestOptions

public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions

Наследование

object ← PdfChatGptOptions ← PdfChatGptRequestOptions

Реализует

• IPluginOptions

Унаследованные члены

• PdfChatGptOptions.AddInput(IDataSource),
• PdfChatGptOptions.AddOutput(IDataSource),
• PdfChatGptOptions.Inputs,
• PdfChatGptOptions.Outputs,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Конструкторы

PdfChatGptRequestOptions()

Инициализирует новый экземпляр объекта Documentize.PdfChatGptRequestOptions с параметрами по умолчанию.

public PdfChatGptRequestOptions()

PdfChatGptRequestOptions(string, string, string, string)

Инициализирует новый экземпляр объекта Documentize.PdfChatGptRequestOptions с заданными параметрами.

public PdfChatGptRequestOptions(string apiKey, string model, string apiUrl, string query)

Параметры

• apiKey string: Ключ для доступа к ChatGPT API.
• model string: Название модели ChatGPT. Модель по умолчанию: gpt-3.5-turbo-1106:
• apiUrl string: URL ChatGPT API. URL по умолчанию: https://api.openai.com/v1/chat/completions.
• query string: Строка запроса к ChatGPT.

Свойства

ApiKey

Получает или устанавливает ключ для доступа к ChatGPT API.

public string ApiKey { get; set; }

Значение свойства

string

ApiUrl

Получает или устанавливает URL ChatGPT API.

public string ApiUrl { get; set; }

Значение свойства

string

CancellationToken

Токен отмены.

public CancellationToken CancellationToken { get; set; }

Значение свойства

CancellationToken

MaxTokens

Максимальное количество токенов в ответе. Значение по умолчанию - null, что означает бесконечность.

public int? MaxTokens { get; set; }

Значение свойства

int?

Messages

Получает или устанавливает коллекцию объектов Documentize.Message.

public List<message> Messages { get; set; }

Значение свойства

List<Message>

Замечания

При добавлении нескольких сообщений в параметры порядок в коллекции сообщений следующий:

• Первое сообщение (если есть) идет из options.Query, перед которым добавляется сообщение с содержанием: “Вы - полезный помощник.”, и ролью “system”.
• Затем (если есть) добавляются сообщения из коллекции options.Messages.
• Сообщения из файловых источников (если есть) добавляются последними, по одному объекту сообщения для каждого документа с ролью “user”. Если не предоставлено ни одного сообщения, будет выброшено исключение ArgumentException.

Model

Устанавливает или получает ID модели для использования.

public string Model { get; set; }

Значение свойства

string

NumberOfChoices

Сколько вариантов завершения чата сгенерировать для каждого входного сообщения.

public int NumberOfChoices { get; set; }

Значение свойства

int

Query

Получает или устанавливает строку запроса к ChatGPT. Если не пусто, это первое сообщение в коллекции, которое будет отправлено в запросе.

public string Query { get; set; }

Значение свойства

string

Temperature

Какую температуру выборки использовать, от 0 до 2. Более высокие значения, такие как 0.8, сделают вывод более случайным, в то время как более низкие значения, такие как 0.2, сделают его более сосредоточенным и детерминированным. Значение по умолчанию - 1.

public double Temperature { get; set; }

Значение свойства

double

Class PdfConverter

Represents Documentize.PdfConverter plugin. Used to Convert PDF documents to another formats like DOCX/DOC, XLSX/XLS/CSV/XLSM/ODS, HTML, JPEG, PNG, TIFF, PDF/A. Also allows you to perform PDF/A Validation and Convert HTML to PDF.

public static class PdfConverter

Наследование

object ← PdfConverter

Унаследованные члены

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Примеры

Пример демонстрирует, как конвертировать PDF‑документ в формат Doc.

// Create PdfToDocOptions object to set instructions
var options = new PdfToDocOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_file.doc"));
// Perform the process
PdfConverter.Convert(options);

Пример демонстрирует, как конвертировать PDF‑документ в формат Doc с указанием режима.

// Create PdfToDocOptions object to set instructions
var options = new PdfToDocOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_file.doc"));
// Set Mode
options.Mode = DocConversionMode.Flow;
// Perform the process
PdfConverter.Convert(options);

Пример демонстрирует, как конвертировать PDF в документ XLSX.

// Create PdfToXlsOptions object to set instructions
var options = new PdfToXlsOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_xlsx_file.xlsx"));
// Perform the process
PdfConverter.Convert(options);

Пример демонстрирует, как конвертировать PDF в документ XLS.

// Create PdfToXlsOptions object to set instructions
var options = new PdfToXlsOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Specify XLS format
options.Format = PdfToXlsOptions.ExcelFormat.XMLSpreadSheet2003;
options.InsertBlankColumnAtFirst = true;
options.MinimizeTheNumberOfWorksheets = true;
// Set output file path
options.AddOutput(new FileData("path_to_result_xlsx_file.xls"));
// Perform the process
PdfConverter.Convert(options);

Пример демонстрирует, как конвертировать PDF в документ HTML.

// Create PdfToHtmlOptions object to set output data type as file with embedded resources
var options = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// Add input file path
options.AddInput(new FileData("path_to_input.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_output.html"));
//Perform the process
PdfConverter.Convert(options);

Пример демонстрирует, как конвертировать HTML в PDF‑документ.

// Create HtmlToPdfOptions
var options = new HtmlToPdfOptions();
// Add input file path
options.AddInput(new FileData("path_to_input.html"));
// Set output file path
options.AddOutput(new FileData("path_to_output.pdf"));
//Perform the process
PdfConverter.Convert(options);

Пример демонстрирует, как конвертировать PDF‑документ в формат JPEG.

// Create PdfToJpegOptions object to set instructions
var options = new PdfToJpegOptions();
// Add input File path
options.AddInput(new FileData("path_to_input.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Perform the process
PdfConverter.Convert(options);

Пример демонстрирует, как конвертировать PDF‑документ в формат JPEG с настройками страниц, разрешения и качества.

// Create PdfToJpegOptions object to set instructions
var options = new PdfToJpegOptions();
// Process only the first page
options.PageList = [1];
... // остальные строки оставлены без изменений

Пример демонстрирует, как конвертировать PDF‑документ в формат JPEG в потоки.

// Create PdfToJpegOptions object to set instructions
var options = new PdfToJpegOptions();
// Add input File path
options.AddInput(new FileData("path_to_input.pdf"));
// Perform the process
var results = PdfConverter.Convert(options);
// Get stream results
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Пример демонстрирует, как конвертировать PDF‑документ в формат PNG.

// Create PdfToPngOptions object to set instructions
var options = new PdfToPngOptions();
// Add input File path
options.AddInput(new FileData("path_to_input.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Perform the process
PdfConverter.Convert(options);

Пример демонстрирует, как конвертировать одну страницу PDF‑документа в формат PNG.

// Create PdfToPngOptions object to set instructions
var options = new PdfToPngOptions()
// Process only the first page
options.PageList = [1];
... // остальные строки оставлены без изменений

Пример демонстрирует, как конвертировать PDF‑документ в формат PNG в потоки.

// Create PdfToJpegOptions object to set instructions
var options = new PdfToPngOptions();
// Add input File path
options.AddInput(new FileData("path_to_input.pdf"));
// Perform the process
var results = PdfConverter.Convert(options);
// Get stream results
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Пример демонстрирует, как конвертировать PDF‑документ в формат TIFF.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Perform the process
PdfConverter.Convert(options);

Пример демонстрирует, как конвертировать PDF‑документ в формат TIFF с настройкой страниц и DPI.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Set Pages
options.PageList = [1, 3];
// Set result image Resolution
options.OutputResolution = 400;
// Perform the process
PdfConverter.Convert(options);

Пример демонстрирует, как конвертировать PDF‑документ в многостраничный TIFF.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Enable Multi-Page TIFF output
options.MultiPage = true;
// Perform the process
PdfConverter.Convert(options);

Пример демонстрирует, как конвертировать PDF‑документ в формат TIFF с настройкой сжатия и глубины цвета.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Set Compression and ColorDepth
options.Compression = TiffCompression.RLE;
options.ColorDepth = TiffColorDepth.Format24bpp;
// Perform the process
PdfConverter.Convert(options);

Пример демонстрирует, как конвертировать PDF‑документ в формат TIFF в потоки.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input File path
options.AddInput(new FileData("path_to_input.pdf"));
// Perform the process
var results = PdfConverter.Convert(options);
// Get stream results
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Пример демонстрирует, как преобразовать PDF‑документ в формат PDF/A (в данном случае PDF/A‑3b):

// Create the options class to set up the conversion process
var options = new PdfToPdfAOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_3B
};

// Add the source file
options.AddInput(new FileData("path_to_your_pdf_file.pdf")); // replace with your actual file path

// Add the path to save the converted file
options.AddOutput(new FileData("path_to_the_converted_file.pdf"));

// Run the conversion
PdfConverter.Convert(options);

Пример демонстрирует, как проверить соответствие PDF‑документа формату PDF/A (в данном случае PDF/A‑1a):

// Create the options class to set up the validation process
var options = new PdfAValidateOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_1A
};

// Add one or more files to be validated
options.AddInput(new FileData("path_to_your_first_pdf_file.pdf")); // replace with your actual file path
options.AddInput(new FileData("path_to_your_second_pdf_file.pdf"));
// add more files as needed

// Run the validation and get results
var resultContainer = PdfConverter.Validate(options);

// Check the resultContainer.ResultCollection property for validation results for each file:
for (var i = 0; i < resultContainer.ResultCollection.Count; i++)
{
    var result = resultContainer.ResultCollection[i];
    var validationResult = (PdfAValidationResult) result.Data;
    var isValid = validationResult.IsValid; // Validation result for the i-th document
}