Enum ConvertErrorAction

public enum ConvertErrorAction

Поля

• Delete = 0
• None = 1

Enum ConvertSoftMaskAction

public enum ConvertSoftMaskAction

Fields

• ConvertToStencilMask = 1: Мягкая маска будет преобразована в трафаретную маску.
• Default = 0: Использовать стратегию по умолчанию.

Enum HtmlMediaType

public enum HtmlMediaType

Поля

• Print = 0: Печать.
• Screen = 1: Экран.

Enum HtmlPageLayoutOption

public enum HtmlPageLayoutOption

Fields

• FitToWidestContentWidth = 3: Указывает, что ширина страницы определяется исходя из размера содержимого, а не из указанной ширины страницы.
• None = 0: Значение по умолчанию, которое указывает, что HtmlPageLayoutOption не повлияет на размеры и макеты страниц.
• ScaleToPageWidth = 256: Указывает, что содержимое документа будет масштабироваться, чтобы соответствовать странице.

Enum PdfAStandardVersion

public enum PdfAStandardVersion

Поля

• Auto = 0: Версия стандарта PDF/A определяется автоматически.
• PDF_A_1A = 1: Указывает версию стандарта PDF/A-1a.
• PDF_A_1B = 2: Указывает версию стандарта PDF/A-1b.
• PDF_A_2A = 3: Указывает версию стандарта PDF/A-2a.
• PDF_A_2B = 4: Указывает версию стандарта PDF/A-2b.
• PDF_A_2U = 5: Указывает версию стандарта PDF/A-2u.
• PDF_A_3A = 6: Указывает версию стандарта PDF/A-3a.
• PDF_A_3B = 7: Указывает версию стандарта PDF/A-3b.
• PDF_A_3U = 8: Указывает версию стандарта PDF/A-3u.

Enum PdfToHtmlOptions.SaveDataType

public enum PdfToHtmlOptions.SaveDataType

Поля

• FileWithEmbeddedResources = 1: Сохранить HTMl в файл с встроенными ресурсами
• FileWithExternalResources = 0: Сохранить HTMl в файл с внешними ресурсами
• StreamWithEmbeddedResources = 2: Сохранить HTMl в поток файла с встроенными ресурсами

Enum PdfToXlsOptions.ExcelFormat

Позволяет указать формат файла .xlsx, .xls/xml или csv. Значение по умолчанию - XLSX.

public enum PdfToXlsOptions.ExcelFormat

Fields

• CSV = 2: Формат файла с разделителями запятыми (CSV).
• ODS = 4: Электронная таблица Open Document.
• XLSM = 3: Формат файла Office Open XML с поддержкой макросов (.xlsm).
• XLSX = 1: Формат файла Office Open XML (.xlsx).
• XMLSpreadSheet2003 = 0: Формат файла Excel 2003 XML (.xls).

Enum Role

public enum Role

Поля

• Assistant = 2
• System = 1
• User = 0

Enum TextExtractorOptions.TextFormattingMode

public enum TextExtractorOptions.TextFormattingMode

Поля

• Plain = 2: Представляет текстовое содержимое PDF, учитывая относительное расположение текстовых фрагментов, но без добавления лишних пробелов.
• Pure = 0: Представляет текстовое содержимое PDF с незначительными форматирующими процедурами. Это включает учет относительных позиций и добавление лишних пробелов для выравнивания текста по ширине страницы.
• Raw = 1: Представляет содержимое PDF как есть, т.е. без форматирования.

Безопасность класса

public sealed class Security

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

object ← Security

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

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

Примеры

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

// создать Security 
var plugin = new Security();
// создать объект EncryptionOptions для установки инструкций
var opt = new EncryptionOptions("123456", "qwerty");
// добавить путь к входному файлу
opt.AddInput(new FileDataSource(inputPath));
// установить путь к выходному файлу
opt.AddOutput(new FileDataSource(outputPath));
// выполнить процесс
plugin.Process(opt);

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

// создать Security 
var plugin = new Security();
// создать объект DecryptionOptions для установки инструкций
var opt = new DecryptionOptions("123456"));
// добавить путь к входному файлу
opt.AddInput(new FileDataSource(inputPath));
// установить путь к выходному файлу
opt.AddOutput(new FileDataSource(outputPath));
// выполнить процесс
plugin.Process(opt);

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

Security()

public Security()

Методы

Process(IPluginOptions)

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

public ResultContainer Process(IPluginOptions options)

Параметры

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

Возвращает

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

Исключения

InvalidOperationException

Интерфейс IDataSource

public interface IDataSource

Свойства

DataType

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

DataType DataType { get; }

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

DataType

Интерфейс IOperationResult

public interface IOperationResult

Свойства

Data

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

object Data { get; }

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

object

IsFile

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

bool IsFile { get; }

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

bool

IsStream

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

bool IsStream { get; }

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

bool

IsString

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

bool IsString { get; }

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

bool

Методы

ToFile()

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

string ToFile()

Возвращает

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

ToStream()

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

Stream ToStream()

Возвращает

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

Интерфейс IPluginOptions

public interface IPluginOptions

Информация о классе

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

Каталог 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

Класс 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: Учетные данные базовой аутентификации, имя пользователя и пароль объединены в строку “имя_пользователя:пароль”. (Необязательно).

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: Учетные данные базовой аутентификации, имя пользователя и пароль объединены в строку “имя_пользователя:пароль”. (Необязательно).

Класс 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()  

Класс 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

Класс 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 opt = new PdfToDocOptions();
// добавляем путь к входному файлу
opt.AddInput(new FileDataSource(inputPath));
// задаем путь к выходному файлу
opt.AddOutput(new FileDataSource(outputPath)];
// выполняем процесс
plugin.Process(opt);

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

DocConverter()

public DocConverter()

Методы

Dispose()

Реализация IDisposable.

public void Dispose()

Process(PdfToDocOptions)

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

public ResultContainer Process(PdfToDocOptions options)

Параметры

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

Возвращает

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

Класс 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

Класс 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

Класс 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.

Класс HtmlConverter

public sealed class HtmlConverter : IDisposable

Унаследованность

object ← HtmlConverter

Реализует

• IDisposable

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

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

Примеры

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

// создать HtmlConverter
var plugin = new HtmlConverter();
// создать объект PdfToHtmlOptions для установки выходного типа данных как файл с встраиваемыми ресурсами
var opt = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// добавить путь к входному файлу
opt.AddInput(new FileDataSource(inputPath));
// установить путь к выходному файлу
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);

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

// создать HtmlConverter
var plugin = new HtmlConverter();
// создать HtmlToPdfOptions
var opt = new HtmlToPdfOptions();
// добавить путь к входному файлу
opt.AddInput(new FileDataSource(inputPath));
// установить путь к выходному файлу
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);

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

HtmlConverter()

public HtmlConverter()

Методы

Dispose()

Реализация IDisposable.

public void Dispose()

Process(IPluginOptions)

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

public ResultContainer Process(IPluginOptions options)

Параметры

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

Возвращает

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

Класс 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

Класс ImageExtractor

public class ImageExtractor : PdfExtractor, IDisposable

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

object ← PdfExtractor ← ImageExtractor

Реализует

• IDisposable

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

• PdfExtractor.Process(IPluginOptions),
• PdfExtractor.Dispose(),
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Примеры

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

// создать объект ImageExtractor для извлечения изображений
using (var plugin = new ImageExtractor())
{
    // создать ImageExtractorOptions
    var opt = new ImageExtractorOptions();

    // добавить путь к входному файлу
    opt.AddInput(new FileDataSource(inputPath));
    // установить выходной каталог
    opt.AddInput(new FileDataSource("D:\\"));

    // выполнить процесс извлечения
    var resultContainer = plugin.Process(opt);

    // получить изображение из объекта ResultContainer
    var imageExtracted = resultContainer.ResultCollection[0].ToFile();
}

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

ImageExtractor()

public ImageExtractor()

Класс ImageExtractorOptions

public sealed class ImageExtractorOptions : PdfExtractorOptions, IPluginOptions  

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

object ←
PdfExtractorOptions ←
ImageExtractorOptions

Реализует

• IPluginOptions

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

• PdfExtractorOptions.AddInput(IDataSource),
• PdfExtractorOptions.Inputs,
• PdfExtractorOptions.OperationName,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Замечания

Он унаследует функции для добавления данных (файлов, потоков), представляющих входные PDF-документы.

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

ImageExtractorOptions()

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

public ImageExtractorOptions()  

Свойства

OperationName

Возвращает имя операции.

public override string OperationName { get; }  

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

string

Класс JpegConverter

public sealed class JpegConverter

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

object ← JpegConverter

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

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

Примеры

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

// создать JpegConverter
var plugin = new JpegConverter();
// создать объект PdfToJpegOptions для установки инструкций
var opt = new PdfToJpegOptions();
// добавить путь к входному файлу
opt.AddInput(new FileDataSource(inputPath));
// установить путь к выходному файлу
opt.AddOutput(new DirectoryDataSource(outputPath));
// выполнить процесс
plugin.Process(opt);

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

JpegConverter()

public JpegConverter()

Методы

Process(PdfToJpegOptions)

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

public ResultContainer Process(PdfToJpegOptions options)

Параметры

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

Возвращает

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

Класс 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()

Класс 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().

Класс 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()  

Класс 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

Класс 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, содержащий результат обработки.

Класс 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: Цель (файл или потоковый источник данных) для сохранения результатов операции. :

Класс 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:

Класс 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()

Класс 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

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

PdfAStandardVersion

Класс 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: Токен отмены. :

Класс 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()

Свойства

Входы

public List<idatasource> Inputs { get; }

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

List<IDataSource>

Выходы

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: Источник данных (файл или поток) для сохранения результатов операций. :

Класс 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: Ключ доступа к 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

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

Класс PdfConverterOptions

public abstract class PdfConverterOptions : IPluginOptions  

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

object ←
PdfConverterOptions

Производные

• PdfToDocOptions,
• PdfToHtmlOptions,
• 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

Класс PdfExtractor

public abstract class PdfExtractor : IDisposable

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

object ← PdfExtractor

Производные

• ImageExtractor,
• TextExtractor

Реализует

• IDisposable

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

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

Примеры

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

// создание объекта TextExtractor для извлечения содержимого PDF
using (TextExtractor extractor = new TextExtractor())
{
    // создание объекта TextExtractorOptions для установки инструкций
    textExtractorOptions = new TextExtractorOptions();

    // добавление пути к входному файлу
    textExtractorOptions.AddInput(new FileDataSource(inputPath));

    // выполнение процесса извлечения
    ResultContainer resultContainer = extractor.Process(textExtractorOptions);

    // получение извлеченного текста из объекта ResultContainer
    string textExtracted = resultContainer.ResultCollection[0].ToString();
}

Замечания

Объект Documentize.TextExtractor используется для извлечения текста, а Documentize.ImageExtractor — для извлечения изображений.

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

PdfExtractor()

protected PdfExtractor()

Методы

Dispose()

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

public void Dispose()

Process(IPluginOptions)

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

public ResultContainer Process(IPluginOptions pdfExtractorOptions)

Параметры

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

Возвращает

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

Класс PdfExtractorOptions

public abstract class PdfExtractorOptions : IPluginOptions

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

object ← PdfExtractorOptions

Производные

• ImageExtractorOptions,
• TextExtractorOptions

Реализует

• IPluginOptions

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

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

Замечания

Documentize.PdfExtractorOptions содержит базовые функции для добавления данных (файлов, потоков), представляющих входные PDF-документы. Пожалуйста, создайте Documentize.TextExtractorOptions или ImageExtractorOptions вместо этого.

Свойства

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

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

public List<idatasource> Inputs { get; }

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

List<IDataSource>

Название операции

Возвращает название операции.

public virtual string OperationName { get; }

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

string

Методы

AddInput(IDataSource)

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

public void AddInput(IDataSource dataSource)

Параметры

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

Класс 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()  

Класс PdfToHtmlOptions

public sealed class PdfToHtmlOptions : PdfConverterOptions, IPluginOptions

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

object ← PdfConverterOptions ← PdfToHtmlOptions

Реализует

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

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

PdfToHtmlOptions()

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

public PdfToHtmlOptions()

PdfToHtmlOptions(SaveDataType)

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

public PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType outputDataType)

Параметры

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

Свойства

OutputDataType

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

public PdfToHtmlOptions.SaveDataType OutputDataType { get; }

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

PdfToHtmlOptions.SaveDataType

Класс 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

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

public int Quality { get; set; }

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

int

Класс 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>

Класс 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()

Свойства

MultiPage

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

public bool MultiPage { get; set; }

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

bool

OutputResolution

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

public int OutputResolution { get; set; }

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

int

PageList

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

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

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

List<int>

Класс 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

Класс PluginBaseOptions

public class PluginBaseOptions : IPluginOptions

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

object ← PluginBaseOptions

Происходящие

• AddTimestampOptions,
• CompressOptions,
• DecryptionOptions,
• EncryptionOptions,
• HtmlToPdfOptions,
• MergeOptions,
• OptimizeOptions,
• PdfToJpegOptions,
• PdfToPngOptions,
• PdfToTiffOptions,
• ResizeOptions,
• RotateOptions,
• SignOptions,
• SplitOptions,
• TableOptions

Реализует

• 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: Данные для добавления. :

Класс PngConverter

public sealed class PngConverter

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

object ← PngConverter

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

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

Примеры

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

// создать PngConverter
var plugin = new PngConverter();
// создать объект PdfToPngOptions для установки инструкций
var opt = new PdfToPngOptions();
// добавить путь к входному файлу
opt.AddInput(new FileDataSource(inputPath));
// установить путь к выходному файлу
opt.AddOutput(new DirectoryDataSource(outputPath));
// выполнить процесс
plugin.Process(opt);

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

PngConverter()

public PngConverter()

Методы

Process(PdfToPngOptions)

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

public ResultContainer Process(PdfToPngOptions options)

Параметры

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

Возвращает

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

Класс 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

Класс ResultContainer

public class ResultContainer

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

object ← ResultContainer

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

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

Свойства

ResultCollection

Получает коллекцию результатов операции

public List<ioperationresult> ResultCollection { get; }

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

List<IOperationResult>

Класс RotateOptions

public sealed class RotateOptions : PluginBaseOptions, IPluginOptions  

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

object ←
PluginBaseOptions ←
RotateOptions

Реализует

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

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

RotateOptions()

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

public RotateOptions()  

Свойства

Rotation

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

public Rotation Rotation { get; set; }  

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

Rotation

Класс SignOptions

public sealed class SignOptions : PluginBaseOptions, IPluginOptions  

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

object ←
PluginBaseOptions ←
SignOptions

Реализует

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

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

SignOptions(string, string)

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

public SignOptions(string pfx, string password)  

Параметры

• pfx string: Путь к файлу pfx.
• password string: Пароль к файлу pfx.

SignOptions(Stream, string)

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

public SignOptions(Stream pfx, string password)  

Параметры

• pfx Stream: Поток с файлом pfx.
• password string: Пароль к файлу pfx.

Свойства

Contact

Контакт подписи.

public string Contact { get; set; }  

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

string

Location

Местоположение подписи.

public string Location { get; set; }  

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

string

Name

Имя существующего поля подписи.
Null для создания нового поля.

public string Name { get; set; }  

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

string

PageNumber

Номер страницы, на которой сделана подпись.

public int PageNumber { get; set; }  

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

int

Reason

Причина подписи.

public string Reason { get; set; }  

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

string

Rectangle

Прямоугольник подписи.

public Rectangle Rectangle { get; set; }  

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

Rectangle

Visible

Видимость подписи.

public bool Visible { get; set; }  

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

bool

Класс SplitOptions

public sealed class SplitOptions : PluginBaseOptions, IPluginOptions

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

object ← PluginBaseOptions ← SplitOptions

Реализует

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

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

SplitOptions()

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

public SplitOptions()

Класс StreamDataSource

public sealed class StreamDataSource : IDataSource

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

object ← StreamDataSource

Реализует

• IDataSource

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

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

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

StreamDataSource(Stream)

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

public StreamDataSource(Stream data)

Параметры

• data Stream: объект потока

Свойства

Data

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

public Stream Data { get; }

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

Stream

DataType

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

public DataType DataType { get; }

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

DataType

Класс StreamResult

public sealed class StreamResult : IOperationResult  

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

object ←
StreamResult

Реализует

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

Класс StringResult

public sealed class StringResult : IOperationResult

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

object ← StringResult

Реализует

• 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

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

Класс TableCellBuilder

public class TableCellBuilder : TableRowBuilder

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

object ← TableBuilder ← TableRowBuilder ← TableCellBuilder

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

• TableRowBuilder.AddCell(),
• TableRowBuilder.AddRow(),
• TableBuilder.AddRow(),
• TableBuilder.AddTable(),
• TableBuilder.InsertPageAfter(int),
• TableBuilder.InsertPageBefore(int),
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Методы

AddCell()

Добавить ячейку в таблицу.

public override TableCellBuilder AddCell()

Возвращает

TableCellBuilder : Экземпляр текущего Documentize.TableCellBuilder.

AddParagraph(params string[])

Добавить абзацы в ячейку таблицы.

public TableCellBuilder AddParagraph(params string[] paragraphs)

Параметры

• paragraphs string[]: Текст для абзацев.

Возвращает

TableCellBuilder : Экземпляр текущего Documentize.TableCellBuilder.

Класс TableGenerator

public sealed class TableGenerator