Class AddTimestampOptions

public class AddTimestampOptions : PluginBaseOptions, IPluginOptions

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

object ← PluginBaseOptions ← AddTimestampOptions

Реализует

• 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()

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

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 CompressOptions

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

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

object ← PluginBaseOptions ← CompressOptions

Реализует

• 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()

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

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 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

public sealed class DocConverter

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

object ← DocConverter

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

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

Примеры

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

// Инициализировать DocConverter
var plugin = new DocConverter();
// Создать объект PdfToDocOptions для задания инструкций
var options = new PdfToDocOptions();
// Добавить путь к входному файлу
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Установить путь к выходному файлу
options.AddOutput(new FileDataSource("path_to_input.doc"));
// Выполнить процесс
plugin.Process(options);

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

DocConverter()

public DocConverter()

Методы

Dispose()

Реализация интерфейса IDisposable.

public void Dispose()

Process(PdfToDocOptions)

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

public 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 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 FormExporter

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()

Примеры

Пример демонстрирует, как экспортировать значения форм в файл CSV.

// Создаем объект FormExportToDsvOptions для задания параметров
var options = new FormExportToDsvOptions(',', true);
// Добавляем путь к входному файлу
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Устанавливаем путь к выходному файлу
options.AddOutput(new FileDataSource("path_to_result_csv_file.csv"));
// Выполняем процесс
FormExporter.Process(options);

Методы

Process(FormExportToDsvOptions)

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

public static ResultContainer Process(FormExportToDsvOptions options)

Параметры

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

Возвращает

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

Исключения

ArgumentException

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

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

public static class FormFlattener

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

object ← FormFlattener

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

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

Примеры

Пример демонстрирует, как упрощать поля в PDF-файле.

// Создать объект FormFlattenerOptions для установки инструкций
var options = new FormFlattenerOptions();
// Добавить путь к входному файлу
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Установить путь к выходному файлу
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Выполнить процесс
FormFlattener.Process(options);

Пример демонстрирует, как упрощать поля в PDF-файле и пропускать первое поле.

// Получить имена полей
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");
// Создать объект FormFlattenerOptions для установки инструкций
var options = new FormFlattenerOptions();
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Пропустить 1 поле.
options.SkipFields.Add(fieldNames[0]);
// Выполнить процесс
FormFlattener.Process(options);

Пример демонстрирует, как получить имена полей из PDF-файла.

// Получить имена полей
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");

Методы

GetFieldNames(string)

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

public static List<string> GetFieldNames(string path)

Параметры

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

Возвращает

List<string>

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

GetFieldNames(Stream) : Получить имена полей в PDF-документе.

public static List<string> GetFieldNames(Stream stream)

Параметры

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

Возвращает

List<string>

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

Process(FormFlattenerOptions) : Уплотнить поля формы в PDF-документе.

public static ResultContainer Process(FormFlattenerOptions options)

Параметры

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

Возвращает

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 HtmlConverter

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()

Примеры

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

// Создать объект PdfToHtmlOptions для установки типа данных выходного файла с встраиваемыми ресурсами
var options = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// Добавить путь к входному файлу
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Установить путь к выходному файлу
options.AddOutput(new FileDataSource("path_to_output.html"));
// Выполнить процесс
HtmlConverter.Process(options);

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

// Создать HtmlToPdfOptions
var options = new HtmlToPdfOptions();
// Добавить путь к входному файлу
options.AddInput(new FileDataSource("path_to_input.html"));
// Установить путь к выходному файлу
options.AddOutput(new FileDataSource("path_to_output.pdf"));
// Выполнить процесс
HtmlConverter.Process(options);

Методы

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

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

object ← PluginBaseOptions ← HtmlToPdfOptions

Реализует

• 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()

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

HtmlToPdfOptions()

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

public HtmlToPdfOptions()

Свойства

BasePath

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

public string BasePath { get; set; }

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

string

HtmlMediaType

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

public HtmlMediaType HtmlMediaType { get; set; }

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

HtmlMediaType

IsRenderToSinglePage

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

public bool IsRenderToSinglePage { get; set; }

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

bool

PageInfo

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

public PageInfo PageInfo { get; set; }

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

PageInfo

PageLayoutOption

Получает или устанавливает вариант макета.

public HtmlPageLayoutOption PageLayoutOption { get; set; }

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

HtmlPageLayoutOption

Class ImageExtractor

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()

Примеры

Пример демонстрирует, как извлечь изображения из PDF-документа.

// Create ImageExtractorOptions to set instructions
var options = new ImageExtractorOptions();
// Add input file path
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryDataSource("path_to_results_directory"));
// Perform the process
var results = ImageExtractor.Process(options);
// Get path to image result
var imageExtracted = results.ResultCollection[0].ToFile();

Методы

Process(ImageExtractorOptions)

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

public static ResultContainer Process(ImageExtractorOptions options)

Параметры

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

Возвращает

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

Продукт

Название продукта.

public const string Product = "Documentize"

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

string

Class JpegConverter

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()

Примеры

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

// Создать объект PdfToJpegOptions для установки инструкций
var options = new PdfToJpegOptions();
// Добавить путь к входному файлу
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Установить путь к выходному каталогу
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Выполнить процесс
JpegConverter.Process(options);

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

// Создать объект PdfToJpegOptions для установки инструкций
var options = new PdfToJpegOptions();
// Обработать только первую страницу
options.PageList = [1];
// Установить разрешение на выходе 200 DPI
options.OutputResolution = 200;
// Установить качество на выходе 50
options.Quality = 50;
// Добавить путь к входному файлу
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Установить путь к выходному каталогу
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Выполнить процесс
JpegConverter.Process(options);

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

// Создать объект PdfToJpegOptions для установки инструкций
var options = new PdfToJpegOptions();
// Добавить путь к входному файлу
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Выполнить процесс
var results = JpegConverter.Process(options);
// Получить результаты потоков
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Методы

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(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()

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

MergeOptions()

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

public MergeOptions()

Class Merger

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()

Примеры

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

// Создайте объект MergeOptions, чтобы установить инструкции
var options = new MergeOptions();
// Добавьте пути к входным файлам
options.AddInput(new FileDataSource("path_to_your_pdf_file_1.pdf"));
options.AddInput(new FileDataSource("path_to_your_pdf_file_2.pdf"));
// Установите путь к выходному файлу
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Выполните процесс
Merger.Process(options);

Методы

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

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

object ← PluginBaseOptions ← OptimizeOptions

Реализует

• 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()

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

OptimizeOptions()

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

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

public OptimizeOptions()

Class Optimizer

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()

Примеры

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

// Создать объект OptimizeOptions для установки инструкций
var options = new OptimizeOptions();
// Добавить путь к входному файлу
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Установить путь к выходному файлу
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Выполнить процесс
Optimizer.Process(options);

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

// Создать объект RotateOptions для установки инструкций
var options = new RotateOptions();
// Установить новое вращение
options.Rotation = Rotation.On90;
// Добавить путь к входному файлу
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Установить путь к выходному файлу
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Выполнить процесс
Optimizer.Process(options);

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

// Создать объект ResizeOptions для установки инструкций
var options = new ResizeOptions();
// Установить новый размер страницы
options.PageSize = PageSize.A3;
// Добавить путь к входному файлу
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Установить путь к выходному файлу
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Выполнить процесс
Optimizer.Process(options);

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

// Создать объект CompressOptions для установки инструкций
var options = new CompressOptions();
// Добавить путь к входному файлу
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Установить путь к выходному файлу
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Выполнить процесс
Optimizer.Process(options);

Методы

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 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

public sealed class PdfAConverter

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

object ← PdfAConverter

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

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

Примеры

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

// Создание класса параметров для настройки процесса валидации
var options = new PdfAValidateOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_1A
};

// Добавьте один или несколько файлов для валидации
options.AddInput(new FileDataSource("path_to_your_first_pdf_file.pdf")); // замените на фактический путь к вашему файлу
options.AddInput(new FileDataSource("path_to_your_second_pdf_file.pdf"));
// добавьте больше файлов по мере необходимости

// Создание экземпляра плагина
var plugin = new PdfAConverter();

// Запуск валидации и получение результатов
var resultContainer = plugin.Process(options);

// Проверьте свойство resultContainer.ResultCollection для получения результатов валидации для каждого файла:
for (var i = 0; i < resultContainer.ResultCollection.Count; i++)
{
    var result = resultContainer.ResultCollection[i];
    var validationResult = (PdfAValidationResult) result.Data;
    var isValid = validationResult.IsValid; // Результат валидации для i-го документа
}

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

// Создание класса параметров для настройки процесса конвертации
var options = new PdfAConvertOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_3B
};

// Добавление исходного файла
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf")); // замените на фактический путь к вашему файлу

// Добавьте путь для сохранения конвертированного файла
options.AddOutput(new FileDataSource("path_to_the_converted_file.pdf"));

// Создание экземпляра плагина
var plugin = new PdfAConverter();

// Запуск конвертации
plugin.Process(options);

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

PdfAConverter()

public PdfAConverter()

Методы

Process(IPluginOptions)

Начинает процесс конвертации или валидации PDF/A с заданными параметрами.

public ResultContainer Process(IPluginOptions options)

Параметры

• options IPluginOptions: Объект параметров, содержащий инструкции для плагина. Должен быть экземпляром класса Documentize.PdfAConvertOptions или Documentize.PdfAValidateOptions.

Возвращает

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

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

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

object ← PdfAOptionsBase

Производные

• PdfAConvertOptions,
• PdfAValidateOptions

Реализует

• IPluginOptions

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

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

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

PdfAOptionsBase()

protected PdfAOptionsBase()

Свойства

AlignText

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

public bool AlignText { get; set; }

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

bool

Замечания

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

CheckDifferentNamesInFontDictionaries

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

public bool CheckDifferentNamesInFontDictionaries { get; set; }

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

bool

ErrorAction

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

public ConvertErrorAction ErrorAction { get; set; }

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

ConvertErrorAction

IccProfileFileName

Получает или задает имя файла профиля ICC (Международного консорциума по цвету), используемого для конвертации PDF/A вместо профиля по умолчанию.

public string IccProfileFileName { get; set; }

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

string

Inputs

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

public List<idatasource> Inputs { get; }

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

List<IDataSource>

IsLowMemoryMode

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

public bool IsLowMemoryMode { get; set; }

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

bool

LogOutputSource

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

public IDataSource LogOutputSource { get; set; }

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

IDataSource

OptimizeFileSize

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

public bool OptimizeFileSize { get; set; }

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

bool

Замечания

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

PdfAVersion

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

public PdfAStandardVersion PdfAVersion { get; set; }

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

PdfAStandardVersion

Замечания

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

SoftMaskAction

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

public ConvertSoftMaskAction SoftMaskAction { get; set; }

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

ConvertSoftMaskAction

Методы

AddInput(IDataSource)

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

public void AddInput(IDataSource dataSource)

Параметры

• dataSource IDataSource:

Class PdfAValidateOptions

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

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

object ← PdfAOptionsBase ← PdfAValidateOptions

Реализует

• 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()

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

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()

Поля

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

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

IDataSource

IsValid

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

public readonly bool IsValid

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

bool

StandardVersion

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

public readonly PdfAStandardVersion StandardVersion

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

PdAStandardVersion

Class PdfChatGpt

public sealed class PdfChatGpt : IDisposable

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

object ← PdfChatGpt

Реализует

• IDisposable

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

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

Примеры

Пример демонстрирует, как использовать плагин PdfChatGpt, добавляя сообщения в запрос.

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Добавьте путь к выходному файлу.
    options.ApiKey = "Ваш API ключ."; // Вам нужно предоставить ключ для доступа к API.
    options.MaxTokens = 1000; // Максимальное количество токенов для генерации в завершении чата.

    // Добавьте сообщения запроса.
    options.Messages.Add(new Message
    {
        Content = "Вы полезный помощник.",
        Role = Role.System
    });
    options.Messages.Add(new Message
    {
        Content = "Какой самый большой диаметр пиццы когда-либо сделанной?",
        Role = Role.User
    });

    // Обработайте запрос.
    var result = await plugin.ProcessAsync(options);

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // Объект завершения чата API ChatGPT.
}

Пример демонстрирует, как использовать плагин PdfChatGpt, добавляя одно сообщение в запрос.

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Добавьте путь к выходному файлу.
    options.ApiKey = "Ваш API ключ."; // Вам нужно предоставить ключ для доступа к API.
    options.MaxTokens = 1000; // Максимальное количество токенов для генерации в завершении чата.

    // Добавьте сообщение запроса.
    // В этом случае системное сообщение с Content = "Вы полезный помощник." добавляется по умолчанию.
    // Роль сообщения запроса по умолчанию "пользователь".
    options.Query = "Какова самая низкая температура, зарегистрированная на Земле?";

    // Обработайте запрос.
    var result = await plugin.ProcessAsync(options);

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // Объект завершения чата API ChatGPT.
}

Пример демонстрирует, как использовать плагин PdfChatGpt, добавляя файл(ы) в качестве источника(ов) сообщений.

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Добавьте путь к выходному файлу.

    // Добавьте текстовый источник PDF.
    // В случае нескольких источников текст из каждого документа будет добавлен в коллектор сообщений запроса
    // как отдельное сообщение с ролью "пользователь".
    options.AddInput(new FileDataSource("TextSource.pdf"));

    options.ApiKey = "Ваш API ключ."; // Вам нужно предоставить ключ для доступа к API.
    options.MaxTokens = 1000; // Максимальное количество токенов для генерации в завершении чата.

    // Добавьте сообщение запроса.
    // В этом случае системное сообщение с Content = "Вы полезный помощник." добавляется по умолчанию.
    // Роль сообщения запроса по умолчанию "пользователь".
    options.Query = "Сколько букв в предоставленном тексте?";

    // Обработайте запрос.
    var result = await plugin.ProcessAsync(options);

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // Объект завершения чата API ChatGPT.
}

Заметки

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

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

PdfChatGpt()

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

public PdfChatGpt()

Методы

Dispose()

Реализация IDisposable. На самом деле, это не обязательно для PdfChatGpt.

public void Dispose()

Process(IPluginOptions)

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

public ResultContainer Process(IPluginOptions options)

Параметры

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

Возвращает

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

NotImplementedException

ProcessAsync(IPluginOptions)

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

public Task<resultcontainer> ProcessAsync(IPluginOptions options)

Параметры

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

Возвращает

Task<ResultContainer>

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

Исключения

ArgumentException : InvalidOperationException

SetCancellationToken(CancellationToken)

Устанавливает токен отмены.

public void SetCancellationToken(CancellationToken cancellationToken)

Параметры

• cancellationToken CancellationToken: Токен отмены. :

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

MaxTokens

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

public int? MaxTokens { get; set; }

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

int?

Messages

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

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

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

List<Message>

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 PdfConverterOptions

public abstract class PdfConverterOptions : IPluginOptions

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

object ← PdfConverterOptions

Производные

• PdfToDocOptions,
• PdfToXlsOptions

Реализует

• IPluginOptions

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

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

Свойства

Входные данные

Возвращает коллекцию данных плагина PdfConverterOptions.

public List<idatasource> Inputs { get; }

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

List<IDataSource>

Выходные данные

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

public List<idatasource> Outputs { get; }

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

List<IDataSource>

Методы

AddInput(IDataSource)

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

public void AddInput(IDataSource dataSource)

Параметры

• dataSource IDataSource: Источник данных для добавления.

AddOutput(IDataSource)

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

public void AddOutput(IDataSource saveDataSource)

Параметры

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

Исключения

NotImplementedException

Class PdfToDocOptions

public sealed class PdfToDocOptions : PdfConverterOptions, IPluginOptions

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

object ← PdfConverterOptions ← PdfToDocOptions

Реализует

• IPluginOptions

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

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

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

PdfToDocOptions()

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

public PdfToDocOptions()

Class PdfToHtmlOptions

public sealed class PdfToHtmlOptions : PluginBaseOptions, IPluginOptions

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

object ← PluginBaseOptions ← PdfToHtmlOptions

Реализует

• 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()

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

PdfToHtmlOptions(SaveDataType)

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

public PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType outputDataType = SaveDataType.FileWithExternalResources)

Параметры

• outputDataType PdfToHtmlOptions.SaveDataType: Тип выходных данных.

Свойства

OutputDataType

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

public PdfToHtmlOptions.SaveDataType OutputDataType { get; }

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

PdfToHtmlOptions.SaveDataType

Class PdfToJpegOptions

public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions

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

object ← PluginBaseOptions ← PdfToJpegOptions

Реализует

• 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()

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

PdfToJpegOptions()

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

public PdfToJpegOptions()

Свойства

OutputResolution

Получает или задает значение разрешения результирующих изображений.

public int OutputResolution { get; set; }

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

int

PageList

Получает или задает список страниц для обработки.

public List<int> PageList { get; set; }

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

List<int>

Quality

Получает и устанавливает качество выхода. Указывает уровень сжатия для изображения. Диапазон полезных значений для качества составляет от 0 до 100. Чем ниже указанное число, тем выше сжатие и, следовательно, ниже качество изображения. Ноль даст вам изображение самого низкого качества, а 100 — самого высокого.

public int Quality { get; set; }

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

int

Class PdfToPngOptions

public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions

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

object ← PluginBaseOptions ← PdfToPngOptions

Реализует

• 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()

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

PdfToPngOptions()

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

public PdfToPngOptions()

Свойства

OutputResolution

Получает или задает значение разрешения полученных изображений.

public int OutputResolution { get; set; }

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

int

PageList

Получает или задает список страниц для обработки.

public List<int> PageList { get; set; }

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

List<int>

Class PdfToTiffOptions

public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions  

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

object ←
PluginBaseOptions ←
PdfToTiffOptions

Реализация

• 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()

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

PdfToTiffOptions()

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

public PdfToTiffOptions()  

Свойства

ColorDepth

Получает или задает глубину цвета.

public TiffColorDepth ColorDepth { get; set; }  

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

TiffColorDepth

Примечания

Значение по умолчанию - Documentize.TiffColorDepth.Format32bpp.

Compression

Получает или задает тип сжатия.

public TiffCompression Compression { get; set; }  

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

TiffCompression

Примечания

Значение по умолчанию - Documentize.TiffCompression.LZW.

MultiPage

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

Значение по умолчанию - false.

public bool MultiPage { get; set; }  

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

bool

OutputResolution

Получает или задает значение разрешения результирующих изображений.

public int OutputResolution { get; set; }  

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

int

PageList

Получает или задает список страниц для обработки.

public List<int> PageList { get; set; }  

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

List<int>

Class PdfToXlsOptions

public sealed class PdfToXlsOptions : PdfConverterOptions, IPluginOptions

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

object ← PdfConverterOptions ← PdfToXlsOptions

Реализует

• IPluginOptions

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

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

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

PdfToXlsOptions()

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

public PdfToXlsOptions()

Свойства

Format

Формат вывода.

public PdfToXlsOptions.ExcelFormat Format { get; set; }

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

PdfToXlsOptions.ExcelFormat

InsertBlankColumnAtFirst

Установите true, если вам необходимо вставить пустой столбец в качестве первого столбца листа. Значение по умолчанию — false; это означает, что пустой столбец не будет вставлен.

public bool InsertBlankColumnAtFirst { get; set; }

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

bool

MinimizeTheNumberOfWorksheets

Установите true, если вам нужно минимизировать количество листов в результирующей книге. Значение по умолчанию — false; это означает сохранение каждой страницы PDF как отдельного листа.

public bool MinimizeTheNumberOfWorksheets { get; set; }

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

bool

Class PluginBaseOptions

public class PluginBaseOptions : IPluginOptions

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

object ← PluginBaseOptions

Производные

• AddTimestampOptions,
• CompressOptions,
• DecryptionOptions,
• EncryptionOptions,
• FormExportToDsvOptions,
• FormFlattenerOptions,
• HtmlToPdfOptions,
• ImageExtractorOptions,
• MergeOptions,
• OptimizeOptions,
• PdfToHtmlOptions,
• PdfToJpegOptions,
• PdfToPngOptions,
• PdfToTiffOptions,
• ResizeOptions,
• RotateOptions,
• SignOptions,
• SplitOptions,
• TableOptions,
• TocOptions

Реализует

• IPluginOptions

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

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

Свойства

CloseInputStreams

Закрыть входные потоки после завершения операции.

public bool CloseInputStreams { get; set; }

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

bool

CloseOutputStreams

Закрыть выходные потоки после завершения операции.

public bool CloseOutputStreams { get; set; }

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

bool

Inputs

Возвращает данные Inputs для операции.

public List<idatasource> Inputs { get; }

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

List<IDataSource>

Outputs

Возвращает данные Outputs для операции.

public List<idatasource> Outputs { get; }

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

List<IDataSource>

Методы

AddInput(IDataSource)

Добавляет новые данные в Inputs.

public void AddInput(IDataSource dataSource)

Параметры

• dataSource IDataSource: Данные для добавления.

AddOutput(IDataSource)

Добавляет новые данные в Outputs.

public void AddOutput(IDataSource saveDataSource)

Параметры

• saveDataSource IDataSource: Данные для добавления.

Class PngConverter

public static class PngConverter

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

object ← PngConverter

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

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

Примеры

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

// Создать объект PdfToPngOptions для установки инструкций
var options = new PdfToPngOptions();
// Добавить путь к входному файлу
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Установить путь к выходной директории
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Выполнить процесс
PngConverter.Process(options);

Пример демонстрирует, как преобразовать 1 страницу PDF-документа в формат PNG.

// Создать объект PdfToPngOptions для установки инструкций
var options = new PdfToPngOptions()
// Обработать только первую страницу
options.PageList = [1];
// Установить разрешение на выходе 200 DPI
options.OutputResolution = 200;
// Добавить путь к входному файлу
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Установить путь к выходной директории
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Выполнить процесс
PngConverter.Process(options);

Пример демонстрирует, как преобразовать PDF-документ в формат PNG для потоков.

// Создать объект PdfToJpegOptions для установки инструкций
var options = new PdfToPngOptions();
// Добавить путь к входному файлу
options.AddInput(new FileDataSource("path_to_input.pdf"));
// Выполнить процесс
var results = PngConverter.Process(options);
// Получить потоковые результаты
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Методы

Process(PdfToPngOptions)

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

public static ResultContainer Process(PdfToPngOptions options)

Параметры

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

Возвращает

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

Исключения

ArgumentException

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

Class Rectangle

public class Rectangle

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

object ← Rectangle

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

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

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

Rectangle(double, double, double, double)

Конструктор прямоугольника.

public Rectangle(double llx, double lly, double urx, double ury)

Параметры

• llx double: X нижнего левого угла.
• lly double: Y нижнего левого угла.
• urx double: X верхнего правого угла.
• ury double: Y верхнего правого угла.

Class ResizeOptions

public sealed class ResizeOptions : PluginBaseOptions, IPluginOptions

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

object ← PluginBaseOptions ← ResizeOptions

Реализует

• 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()

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

ResizeOptions()

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

public ResizeOptions()

Свойства

PageSize

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

public PageSize PageSize { get; set; }

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

PageSize