Class Document

Класс Document

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

public sealed class Document : IDisposable

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

Имя	Описание
Document()	Инициализирует пустой документ.
Document(PdfVersion)	Инициализирует пустой документ по версии.
Document(Stream)	Инициализирует новый экземпляр Document из входного потока.
Document(string)	Просто инициализирует Document, используя имя файла. То же самое, что и Document.
Document(Stream, bool)	Инициализирует новый экземпляр Document из входного потока.
Document(Stream, LoadOptions)	Открывает существующий документ из потока, предоставляя необходимые параметры для преобразования в PDF-документ.
Document(Stream, string)	Инициализирует новый экземпляр Document из входного потока.
Document(string, bool)	Просто инициализирует Document, используя имя файла. То же самое, что и Document.
Document(string, LoadOptions)	Открывает существующий документ из файла, предоставляя необходимые параметры для преобразования в PDF-документ.
Document(string, string)	Инициализирует новый экземпляр класса Document для работы с зашифрованным документом.
Document(Stream, string, bool)	Инициализирует новый экземпляр Document из входного потока.
Document(string, string, bool)	Инициализирует новый экземпляр класса Document для работы с зашифрованным документом.

Свойства

Имя	Описание
Actions { get; }	Получает действия документа. Это свойство является экземпляром класса DocumentActions, который позволяет получать/устанавливать действия BeforClosing, BeforSaving и т.д.
AllowReusePageContent { get; set; }	Позволяет объединять содержимое страниц для оптимизации размера документа. Если используется, то разные, но дублирующиеся страницы могут ссылаться на один и тот же объект содержимого. Обратите внимание, что этот режим может вызвать побочные эффекты, такие как изменение содержимого страницы, когда изменяется другая страница.
Background { get; set; }	Получает или устанавливает цвет фона документа.
CenterWindow { get; set; }	Получает или устанавливает флаг, указывающий, будет ли позиция окна документа центрирована на экране.
Collection { get; set; }	Получает коллекцию документа.
CryptoAlgorithm { get; }	Получает настройки безопасности, если документ зашифрован. Если документ не зашифрован, то соответствующее исключение будет вызвано в .net 1.1 или CryptoAlgorithm будет равен null для других версий .net.
Destinations { get; }	Получает коллекцию назначений. Устарело. Пожалуйста, используйте NamedDestinations.
Direction { get; set; }	Получает или устанавливает порядок чтения текста: L2R (слева направо) или R2L (справа налево).
DisableFontLicenseVerifications { get; set; }	Многие операции с шрифтами не могут быть выполнены, если эти операции запрещены лицензией этого шрифта. Например, некоторые шрифты не могут быть встроены в PDF-документ, если правила лицензии отключают встраивание для этого шрифта. Этот флаг используется для отключения любых лицензионных ограничений для всех шрифтов в текущем PDF-документе. Будьте осторожны при использовании этого флага. Когда он установлен, это означает, что лицо, которое устанавливает этот флаг, берет на себя всю ответственность за возможные нарушения лицензии/закона. Поэтому он берет это на свой собственный риск. Настоятельно рекомендуется использовать этот флаг только тогда, когда вы полностью уверены, что не нарушаете закон об авторском праве. По умолчанию false.
DisplayDocTitle { get; set; }	Получает или устанавливает флаг, указывающий, должен ли заголовок окна документа отображать название документа.
Duplex { get; set; }	Получает или устанавливает параметр обработки режима дуплекса печати, который будет использоваться при печати файла из диалогового окна печати.
EmbeddedFiles { get; }	Получает коллекцию файлов, встроенных в документ.
EmbedStandardFonts { get; set; }	Свойство, которое объявляет, что документ должен встраивать все стандартные шрифты Type1, у которых установлен флаг IsEmbedded в true. Все PDF-шрифты могут быть встроены в документ просто путем установки флага IsEmbedded в true, но стандартные шрифты Type1 являются исключением из этого правила. Встраивание стандартных шрифтов Type1 требует много времени, поэтому для встраивания этих шрифтов необходимо не только установить флаг IsEmbedded в true для указанного шрифта, но и установить дополнительный флаг на уровне документа - EmbedStandardFonts = true; Это свойство может быть установлено только один раз для всех шрифтов. По умолчанию false.
EnableObjectUnload { get; set; }	Получает или устанавливает флаг, который позволяет частично выгружать документ из памяти. Это позволяет уменьшить использование памяти, но может негативно сказаться на производительности.
EnableSignatureSanitization { get; set; }	Получает или устанавливает флаг для управления очисткой полей подписи. Включено по умолчанию.
FileName { get; }	Имя PDF-файла, который вызвал этот документ
FitWindow { get; set; }	Получает или устанавливает флаг, указывающий, должно ли окно документа быть изменено по размеру, чтобы соответствовать первой отображаемой странице.
FontUtilities { get; }	Экземпляр IDocumentFontUtilities
Form { get; }	Получает Acro Form документа.
HandleSignatureChange { get; set; }	Вызывает исключение, если документ будет сохранен с изменениями и имеет подпись
HideMenubar { get; set; }	Получает или устанавливает флаг, указывающий, должен ли меню скрываться, когда документ активен.
HideToolBar { get; set; }	Получает или устанавливает флаг, указывающий, должен ли панель инструментов скрываться, когда документ активен.
HideWindowUI { get; set; }	Получает или устанавливает флаг, указывающий, должны ли элементы пользовательского интерфейса скрываться, когда документ активен.
Id { get; }	Получает ID.
IgnoreCorruptedObjects { get; set; }	Получает или устанавливает флаг игнорирования ошибок в исходных файлах. Когда страницы из исходного документа копируются в целевой документ, процесс копирования останавливается с исключением, если некоторые объекты в исходных файлах повреждены, когда этот флаг равен false. пример: dest.Pages.Add(src.Pages); Если этот флаг установлен в true, то поврежденные объекты будут заменены пустыми значениями. По умолчанию: true.
Info { get; }	Получает информацию о документе.
IsEncrypted { get; }	Получает статус шифрования документа. True, если документ зашифрован.
IsLinearized { get; set; }	Получает или устанавливает значение, указывающее, является ли документ линейным.
IsPdfaCompliant { get; }	Получает, соответствует ли документ стандарту pdfa.
IsPdfUaCompliant { get; }	Получает, соответствует ли документ стандарту pdfua.
IsXrefGapsAllowed { get; set; }	Получает или устанавливает, соответствует ли документ стандарту pdfa.
JavaScript { get; }	Коллекция JavaScript на уровне документа.
LogicalStructure { get; }	Получает логическую структуру документа.
Metadata { get; }	Метаданные документа. (PDF-документ может включать общую информацию, такую как название документа, автор и даты создания и изменения. Такая глобальная информация о документе (в отличие от его содержимого или структуры) называется метаданными и предназначена для помощи в каталогизации и поиске документов во внешних базах данных.)
NamedDestinations { get; }	Коллекция именованных назначений в документе.
NonFullScreenPageMode { get; set; }	Получает или устанавливает режим страницы, указывающий, как отображать документ при выходе из полноэкранного режима.
OpenAction { get; set; }	Получает или устанавливает действие, выполняемое при открытии документа.
OptimizeSize { get; set; }	Получает или устанавливает флаг оптимизации. Когда страницы добавляются в документ, равные потоки ресурсов в результирующем файле объединяются в один PDF-объект, если этот флаг установлен. Это позволяет уменьшить размер результирующего файла, но может вызвать более медленное выполнение и большие требования к памяти. Значение по умолчанию: false.
Outlines { get; }	Получает контуры документа.
OutputIntents { get; }	Получает коллекцию выходных намерений в документе.
PageInfo { get; set; }	Получает или устанавливает информацию о странице. (только для генератора, не заполняется при чтении документа)
PageLabels { get; }	Получает метки страниц в документе.
PageLayout { get; set; }	Получает или устанавливает макет страницы, который будет использоваться при открытии документа.
PageMode { get; set; }	Получает или устанавливает режим страницы, указывающий, как документ должен отображаться при открытии.
Pages { get; }	Получает или устанавливает коллекцию страниц документа. Обратите внимание, что страницы нумеруются с 1 в коллекции.
PdfFormat { get; }	Получает формат PDF
Permissions { get; }	Получает разрешения документа.
PickTrayByPdfSize { get; set; }	Получает или устанавливает флаг, указывающий, следует ли использовать размер страницы PDF для выбора входного лотка бумаги.
PrintScaling { get; set; }	Получает или устанавливает параметр масштабирования страницы, который будет выбран, когда диалоговое окно печати отображается для этого документа.
TaggedContent { get; }	Получает доступ к содержимому TaggedPdf.
Version { get; }	Получает версию PDF из заголовка PDF-файла.
static FileSizeLimitToMemoryLoading { get; set; }	Получает и устанавливает предел размера файла для загрузки всего файла в память. Значение устанавливается в мегабайтах. Значение по умолчанию - 210 Мб.
static IsLicensed { get; }	Получает лицензионное состояние системы. Возвращает true, если система работает в лицензионном режиме, и false в противном случае.

Методы

Имя	Описание
static MergeDocuments(params Document[])	Объединяет документы.
static MergeDocuments(params string[])	Объединяет PDF-файлы.
static MergeDocuments(MergeOptions, params Document[])	Объединяет документы.
static MergeDocuments(MergeOptions, params string[])	Объединяет документы.
BindXml(Stream)	Привязывает XML к документу
BindXml(string)	Привязывает XML к документу
BindXml(Stream, Stream)	Привязывает XML/XSL к документу
BindXml(string, string)	Привязывает XML/XSL к документу
BindXml(Stream, Stream, XmlReaderSettings)	Привязывает XML/XSL к документу
ChangePasswords(string, string, string)	Изменяет пароли документа. Это действие можно выполнить только с использованием пароля владельца.
Check(bool)	Проверяет документ.
Convert(PdfFormatConversionOptions)	Преобразует документ с использованием указанных параметров преобразования
Convert(CallBackGetHocr, bool)	Распознает изображения внутри документа и добавляет строки hocr поверх них.
Convert(CallBackGetHocrWithPage, bool)	Распознает изображения внутри документа и добавляет строки hocr поверх них.
Convert(Stream, PdfFormat, ConvertErrorAction)	Преобразует документ и сохраняет ошибки в указанный поток.
Convert(string, PdfFormat, ConvertErrorAction)	Преобразует документ и сохраняет ошибки в указанный файл.
Convert(Fixup, Stream, bool, object[])	Преобразует документ, применяя Fixup.
Convert(Fixup, string, bool, object[])	Преобразует документ, применяя Fixup.
Convert(Stream, PdfFormat, ConvertErrorAction, ConvertTransparencyAction)	Преобразует документ и сохраняет ошибки в указанный файл.
Convert(string, PdfFormat, ConvertErrorAction, ConvertTransparencyAction)	Преобразует документ и сохраняет ошибки в указанный файл.
ConvertPageToPNGMemoryStream(Page)	Преобразует страницу в PNG для DSR, OMR, потока изображений OCR.
Decrypt()	Расшифровывает документ. Затем вызовите Save, чтобы получить расшифрованную версию документа.
Dispose()	Закрывает все ресурсы, используемые этим документом.
Encrypt(string, string, Permissions, CryptoAlgorithm)	Шифрует документ. Затем вызовите Save, чтобы получить зашифрованную версию документа.
Encrypt(string, string, DocumentPrivilege, CryptoAlgorithm, bool)	Шифрует документ. Затем вызовите Save, чтобы получить зашифрованную версию документа.
Encrypt(string, string, Permissions, CryptoAlgorithm, bool)	Шифрует документ. Затем вызовите Save, чтобы получить зашифрованную версию документа.
ExportAnnotationsToXfdf(Stream)	Экспортирует все аннотации документа в поток.
ExportAnnotationsToXfdf(string)	Экспортирует все аннотации документа в файл XFDF
Flatten()	Удаляет все поля из документа и помещает их значения вместо этого.
Flatten(FlattenSettings)	Удаляет все поля (и аннотации) из документа и помещает их значения вместо этого.
FlattenTransparency()	Заменяет прозрачное содержимое непроницаемой растровой и векторной графикой.
FreeMemory()	Очищает память
GetCatalogValue(string)	Возвращает значение элемента из словаря каталога.
GetObjectById(string)	Получает объект с указанным ID в документе.
GetXmpMetadata(Stream)	Получает XMP-метаданные из документа.
HasIncrementalUpdate()	Проверяет, был ли текущий PDF-документ сохранен с инкрементальными обновлениями.
ImportAnnotationsFromXfdf(Stream)	Импортирует аннотации из потока в документ.
ImportAnnotationsFromXfdf(string)	Импортирует аннотации из файла XFDF в документ.
IsRepairNeeded(out RepairOptions)	Проверяет, требует ли документ вызова метода Repair.
LoadFrom(string, LoadOptions)	Загружает файл, преобразуя его в PDF.
Merge(params Document[])	Объединяет документы.
Merge(params string[])	Объединяет PDF-файлы.
Merge(MergeOptions, params Document[])	Объединяет документы.
Merge(MergeOptions, params string[])	Объединяет документы.
Optimize()	Линейно упорядочивает документ, чтобы - открыть первую страницу как можно быстрее; - отобразить следующую страницу или перейти по ссылке на следующую страницу как можно быстрее; - отображать страницу по мере поступления данных, когда данные для страницы передаются по медленному каналу (сначала отображать наиболее полезные данные); - разрешить взаимодействие пользователя, такое как переход по ссылке, даже до того, как вся страница будет получена и отображена. Вызов этого метода фактически не сохраняет документ. Напротив, документ только подготавливается к оптимизированной структуре, затем вызовите Save, чтобы получить оптимизированный документ.
OptimizeResources()	Оптимизирует ресурсы в документе: 1. Ресурсы, которые не используются на страницах документа, удаляются; 2. Равные ресурсы объединяются в один объект; 3. Неиспользуемые объекты удаляются.
OptimizeResources(OptimizationOptions)	Оптимизирует ресурсы в документе в соответствии с определенной стратегией оптимизации.
PageNodesToBalancedTree(byte)	Организует узлы дерева страниц в документе в сбалансированное дерево. Только если в документе больше, чем nodesNumInSubtrees объектов страниц, в противном случае ничего не делает. Не вызывайте этот метод во время итерации по элементам Pages, это может дать непредсказуемые результаты
ProcessParagraphs()	Обрабатывает абзацы для генератора.
RemoveMetadata()	Удаляет метаданные из документа.
RemovePdfaCompliance()	Удаляет соответствие pdfa из документа
RemovePdfUaCompliance()	Удаляет соответствие pdfUa из документа
Repair(RepairOptions)	Ремонтирует поврежденный документ.
Save()	Сохраняет документ инкрементально (т.е. с использованием техники инкрементального обновления).
Save(SaveOptions)	Сохраняет документ с параметрами сохранения.
Save(Stream)	Сохраняет документ в поток.
Save(string)	Сохраняет документ в указанный файл.
Save(Stream, SaveFormat)	Сохраняет документ с новым именем вместе с форматом файла.
Save(Stream, SaveOptions)	Сохраняет документ в поток с параметрами сохранения.
Save(string, SaveFormat)	Сохраняет документ с новым именем вместе с форматом файла.
Save(string, SaveOptions)	Сохраняет документ с новым именем, устанавливая его параметры сохранения.
SaveAsync(CancellationToken)	Сохраняет документ инкрементально (т.е. с использованием техники инкрементального обновления).
SaveAsync(SaveOptions, CancellationToken)	Сохраняет документ с параметрами сохранения.
SaveAsync(Stream, CancellationToken)	Сохраняет документ в поток.
SaveAsync(string, CancellationToken)	Сохраняет документ в указанный файл.
SaveAsync(Stream, SaveFormat, CancellationToken)	Сохраняет документ с новым именем вместе с форматом файла.
SaveAsync(Stream, SaveOptions, CancellationToken)	Сохраняет документ в поток с параметрами сохранения.
SaveAsync(string, SaveFormat, CancellationToken)	Сохраняет документ с новым именем вместе с форматом файла.
SaveAsync(string, SaveOptions, CancellationToken)	Сохраняет документ с новым именем, устанавливая его параметры сохранения.
SaveXml(string)	Сохраняет документ в XML.
SendTo(DocumentDevice, Stream)	Отправляет весь документ на устройство документа для обработки.
SendTo(DocumentDevice, string)	Отправляет весь документ на устройство документа для обработки.
SendTo(DocumentDevice, int, int, Stream)	Отправляет определенные страницы документа на устройство документа для обработки.
SendTo(DocumentDevice, int, int, string)	Отправляет весь документ на устройство документа для обработки.
SetTitle(string)	Устанавливает заголовок для PDF-документа
SetXmpMetadata(Stream)	Устанавливает XMP-метаданные документа.
Validate(PdfFormatConversionOptions)	Проверяет документ в указанный файл.
Validate(Stream, PdfFormat)	Проверяет документ в указанный файл.
Validate(string, PdfFormat)	Проверяет документ в указанный файл.
static Convert(Stream, LoadOptions, Stream, SaveOptions)	Преобразует поток в исходном формате в поток в целевом формате.
static Convert(Stream, LoadOptions, string, SaveOptions)	Преобразует поток в исходном формате в целевой файл в целевом формате.
static Convert(string, LoadOptions, Stream, SaveOptions)	Преобразует исходный файл в исходном формате в поток в целевом формате.
static Convert(string, LoadOptions, string, SaveOptions)	Преобразует исходный файл в исходном формате в целевой файл в целевом формате.
static SetDefaultFileSizeLimitToMemoryLoading()	Устанавливает предел размера файла для загрузки всего файла в память на значение по умолчанию, равное 210 Мб.

Поля

Имя	Описание
const DefaultNodesNumInSubtrees

События

Имя	Описание
event FontSubstitution	Происходит, когда шрифт заменяет другой шрифт в документе.

Другие члены

Имя	Описание
delegate CallBackGetHocr
delegate CallBackGetHocrWithPage
delegate FontSubstitutionHandler	Представляет метод, который будет обрабатывать событие FontSubstitution.
interface IDocumentFontUtilities	Содержит функциональность для настройки шрифтов
class MergeOptions	Представляет параметры для методов объединения.
class RepairOptions	Представляет параметры для ремонта PDF-документа.

См. также

• namespace Aspose.Pdf
• assembly Aspose.PDF