Class Document
Namespace: Aspose.Pdf
Assembly: Aspose.PDF.dll
Класс, представляющий PDF-документ
public sealed class Document : IDisposableНаследование
Реализует
Унаследованные члены
object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Конструкторы
Document(Stream)
Инициализация нового экземпляра Document из input потока.
public Document(Stream input)Параметры
input Stream
Поток с PDF-документом.
Document(Stream, string, bool)
Инициализация нового экземпляра Document из input потока.
public Document(Stream input, string password, bool isManagedStream)Параметры
input Stream
Поток с PDF-документом.
password string
Пароль пользователя или владельца.
isManagedStream bool
Если установлено в true, внутренний поток закрывается перед выходом; в противном случае — нет.
Document(Stream, bool)
Инициализация нового экземпляра Document из input потока.
public Document(Stream input, bool isManagedStream)Параметры
input Stream
Поток с PDF-документом.
isManagedStream bool
Если установлено в true, внутренний поток закрывается перед выходом; в противном случае — нет.
Document(string)
Просто инициализируйте Document, используя filename. То же самое, что и Aspose.Pdf.Document.#ctor(System.IO.Stream).
public Document(string filename)Параметры
filename string
Имя файла PDF-документа.
Document(Stream, string)
Инициализация нового экземпляра Document из input потока.
public Document(Stream input, string password)Параметры
input Stream
Объект входного потока, соответствующий защищенному паролем PDF.
password string
Пароль пользователя или владельца.
Document()
Инициализирует пустой документ.
public Document()Document(string, string)
Инициализирует новый экземпляр класса Aspose.Pdf.Document для работы с зашифрованным документом.
public Document(string filename, string password)Параметры
filename string
Имя файла документа.
password string
Пароль пользователя или владельца.
Document(string, string, bool)
Инициализирует новый экземпляр класса Aspose.Pdf.Document для работы с зашифрованным документом.
public Document(string filename, string password, bool isManagedStream)Параметры
filename string
Имя файла документа.
password string
Пароль пользователя или владельца.
isManagedStream bool
Если установлено в true, внутренний поток закрывается перед выходом; в противном случае — нет.
Document(string, LoadOptions)
Открывает существующий документ из файла, предоставляя необходимые параметры конвертации для получения PDF-документа.
public Document(string filename, LoadOptions options)Параметры
filename string
Входной файл для конвертации в PDF-документ.
options LoadOptions
Представляет свойства для конвертации filename в PDF-документ.
Document(Stream, LoadOptions)
Открывает существующий документ из потока, предоставляя необходимые параметры конвертации для получения PDF-документа.
public Document(Stream input, LoadOptions options)Параметры
input Stream
Входной поток для конвертации в PDF-документ.
options LoadOptions
Представляет свойства для конвертации input в PDF-документ.
Поля
DefaultNodesNumInSubtrees
public const byte DefaultNodesNumInSubtrees = 10Значение поля
Свойства
Actions
Получает действия документа. Это свойство является экземпляром класса DocumentActions, который позволяет получать/устанавливать действия BeforClosing, BeforSaving и т.д.
public DocumentActionCollection Actions { get; }Значение свойства
DocumentActionCollection
Примеры
Этот пример демонстрирует, как получить действие после открытия документа:
Aspose.Pdf.Document document = new Aspose.Pdf.Document("d:\\work\\aspose\\aspose.pdf.kit.net.new\\trunk\\testdata\\Aspose.Pdf\\PdfWithOpenAction.pdf");
Aspose.Pdf.Annotations.DocumentActionCollection actions = document.Actions;
Aspose.Pdf.Annotations.PdfAction afterSavingAction = actions.AfterSaving;AllowReusePageContent
Позволяет объединять содержимое страниц для оптимизации размера документа. Если используется, то разные, но дублирующиеся страницы могут ссылаться на один и тот же объект содержимого. Обратите внимание, что этот режим может вызвать побочные эффекты, такие как изменение содержимого страницы, когда изменяется другая страница.
public bool AllowReusePageContent { get; set; }Значение свойства
Background
Получает или устанавливает цвет фона документа.
public Color Background { get; set; }Значение свойства
Color
CenterWindow
Получает или устанавливает флаг, указывающий, будет ли позиция окна документа центрирована на экране.
public bool CenterWindow { get; set; }Значение свойства
Примеры
Пример демонстрирует, как получить флаг CenterWindow:
Document document = new Document("sample.pdf");
bool value = document.CenterWindow;Collection
Получает коллекцию документа.
public Collection Collection { get; set; }Значение свойства
Collection
CryptoAlgorithm
Получает настройки безопасности, если документ зашифрован. Если документ не зашифрован, соответствующее исключение будет вызвано в .net 1.1 или CryptoAlgorithm будет равен null для других версий .net.
public CryptoAlgorithm? CryptoAlgorithm { get; }Значение свойства
CryptoAlgorithm?
Destinations
Получает коллекцию назначений. Устарело. Пожалуйста, используйте NamedDestinations.
public DestinationCollection Destinations { get; }Значение свойства
DestinationCollection
Direction
Получает или устанавливает порядок чтения текста: L2R (слева направо) или R2L (справа налево).
public Direction Direction { get; set; }Значение свойства
Direction
DisableFontLicenseVerifications
Многие операции с шрифтами не могут быть выполнены, если эти операции запрещены лицензией этого шрифта. Например, некоторые шрифты не могут быть встроены в PDF-документ, если правила лицензии запрещают встраивание для этого шрифта. Этот флаг используется для отключения любых лицензионных ограничений для всех шрифтов в текущем PDF-документе. Будьте осторожны при использовании этого флага. Когда он установлен, это означает, что лицо, которое устанавливает этот флаг, берет на себя всю ответственность за возможные нарушения лицензии/закона. Таким образом, он берет это на свой собственный риск. Настоятельно рекомендуется использовать этот флаг только тогда, когда вы полностью уверены, что не нарушаете авторское право. По умолчанию false.
public bool DisableFontLicenseVerifications { get; set; }Значение свойства
DisplayDocTitle
Получает или устанавливает флаг, указывающий, должно ли заголовок окна документа отображать заголовок документа.
public bool DisplayDocTitle { get; set; }Значение свойства
Примеры
Пример демонстрирует, как получить флаг DisplayDocTitle:
Document document = new Document("sample.pdf");
bool value = document.DisplayDocTitle;Duplex
Получает или устанавливает режим обработки дуплекса печати, который следует использовать при печати файла из диалогового окна печати.
public PrintDuplex Duplex { get; set; }Значение свойства
PrintDuplex
EmbedStandardFonts
Свойство, которое объявляет, что документ должен встраивать все стандартные шрифты Type1, у которых установлен флаг IsEmbedded в true. Все шрифты PDF могут быть встроены в документ, просто установив флаг IsEmbedded в true, но стандартные шрифты Type1 PDF являются исключением из этого правила. Встраивание стандартного шрифта Type1 требует много времени, поэтому для встраивания этих шрифтов необходимо не только установить флаг IsEmbedded в true для указанного шрифта, но также установить дополнительный флаг на уровне документа - EmbedStandardFonts = true; Это свойство может быть установлено только один раз для всех шрифтов. По умолчанию false.
public bool EmbedStandardFonts { get; set; }Значение свойства
EmbeddedFiles
Получает коллекцию файлов, встроенных в документ.
public EmbeddedFileCollection EmbeddedFiles { get; }Значение свойства
EmbeddedFileCollection
EnableObjectUnload
Получает или устанавливает флаг, который позволяет частично выгружать документ из памяти. Это позволяет снизить использование памяти, но может негативно сказаться на производительности.
public bool EnableObjectUnload { get; set; }Значение свойства
EnableSignatureSanitization
Получает или устанавливает флаг для управления санитарией полей подписи. Включено по умолчанию.
public bool EnableSignatureSanitization { get; set; }Значение свойства
FileName
Имя PDF-файла, который вызвал этот документ
public string FileName { get; }Значение свойства
FitWindow
Получает или устанавливает флаг, указывающий, должно ли окно документа быть изменено, чтобы соответствовать первой отображаемой странице.
public bool FitWindow { get; set; }Значение свойства
Примеры
Пример демонстрирует, как получить флаг FitWindow:
Document document = new Document("sample.pdf");
bool value = document.FitWindow;FontUtilities
Экземпляр IDocumentFontUtilities
public Document.IDocumentFontUtilities FontUtilities { get; }Значение свойства
Document.IDocumentFontUtilities
Form
Получает Acro Form документа.
public Form Form { get; }Значение свойства
Form
HandleSignatureChange
Выбрасывает исключение, если документ будет сохранен с изменениями и имеет подпись.
public bool HandleSignatureChange { get; set; }Значение свойства
HideMenubar
Получает или устанавливает флаг, указывающий, должна ли строка меню быть скрыта, когда документ активен.
public bool HideMenubar { get; set; }Значение свойства
Примеры
Пример демонстрирует, как получить флаг HideMenubar:
Document document = new Document("sample.pdf");
bool value = document.HideMenubar;HideToolBar
Получает или устанавливает флаг, указывающий, должна ли панель инструментов быть скрыта, когда документ активен.
public bool HideToolBar { get; set; }Значение свойства
Примеры
Пример демонстрирует, как получить флаг HideToolBar:
Document document = new Document("sample.pdf");
bool value = document.HideToolBar;HideWindowUI
Получает или устанавливает флаг, указывающий, должны ли элементы пользовательского интерфейса быть скрыты, когда документ активен.
public bool HideWindowUI { get; set; }Значение свойства
Примеры
Пример демонстрирует, как получить флаг HideWindowUI:
Document document = new Document("sample.pdf");
bool value = document.HideWindowUI;Id
Получает ID.
public Id Id { get; }Значение свойства
Id
IgnoreCorruptedObjects
Получает или устанавливает флаг игнорирования ошибок в исходных файлах. Когда страницы из исходного документа копируются в целевой документ, процесс копирования останавливается с исключением, если некоторые объекты в исходных файлах повреждены, когда этот флаг установлен в false. пример: dest.Pages.Add(src.Pages); Если этот флаг установлен в true, то поврежденные объекты будут заменены пустыми значениями. По умолчанию: true.
public bool IgnoreCorruptedObjects { get; set; }Значение свойства
Info
Получает информацию о документе.
public DocumentInfo Info { get; }Значение свойства
DocumentInfo
IsEncrypted
Получает статус шифрования документа. True, если документ зашифрован.
public bool IsEncrypted { get; }Значение свойства
IsLicensed
Получает лицензионное состояние системы. Возвращает true, если система работает в лицензионном режиме, и false в противном случае.
public static bool IsLicensed { get; }Значение свойства
IsLinearized
Получает или устанавливает значение, указывающее, является ли документ линейным.
public bool IsLinearized { get; set; }Значение свойства
IsPdfUaCompliant
Получает, является ли документ соответствующим стандарту pdfua.
public bool IsPdfUaCompliant { get; }Значение свойства
IsPdfaCompliant
Получает, является ли документ соответствующим стандарту pdfa.
public bool IsPdfaCompliant { get; }Значение свойства
IsXrefGapsAllowed
Получает или устанавливает, разрешены ли промежутки в Xref документа.
public bool IsXrefGapsAllowed { get; set; }Значение свойства
JavaScript
Коллекция JavaScript на уровне документа.
public JavaScriptCollection JavaScript { get; }Значение свойства
JavaScriptCollection
LogicalStructure
Получает логическую структуру документа.
public RootElement LogicalStructure { get; }Значение свойства
RootElement
Metadata
Метаданные документа. (Документ PDF может включать общую информацию, такую как заголовок документа, автор и даты создания и модификации. Такая глобальная информация о документе (в отличие от его содержимого или структуры) называется метаданными и предназначена для помощи в каталогизации и поиске документов во внешних базах данных.)
public Metadata Metadata { get; }Значение свойства
Metadata
NamedDestinations
Коллекция именованных назначений в документе.
public NamedDestinationCollection NamedDestinations { get; }Значение свойства
NamedDestinationCollection
NonFullScreenPageMode
Получает или устанавливает режим страницы, указывая, как отображать документ при выходе из полноэкранного режима.
public PageMode NonFullScreenPageMode { get; set; }Значение свойства
PageMode
OpenAction
Получает или устанавливает действие, выполняемое при открытии документа.
public IAppointment OpenAction { get; set; }Значение свойства
IAppointment
Примеры
Пример демонстрирует, как получить флаг CenterWindow:
Document document = new Document("sample.pdf");
IAppointment value = document.OpenAction;OptimizeSize
Получает или устанавливает флаг оптимизации. Когда страницы добавляются в документ, равные ресурсные потоки в результирующем файле объединяются в один объект PDF, если этот флаг установлен. Это позволяет уменьшить размер результирующего файла, но может привести к более медленной обработке и большему потреблению памяти. Значение по умолчанию: false.
public bool OptimizeSize { get; set; }Значение свойства
Outlines
Получает контуры документа.
public OutlineCollection Outlines { get; }Значение свойства
OutlineCollection
OutputIntents
Получает коллекцию выходных намерений в документе.
public OutputIntents OutputIntents { get; }Значение свойства
OutputIntents
PageInfo
Получает или устанавливает информацию о странице. (только для генератора, не заполняется при чтении документа)
public PageInfo PageInfo { get; set; }Значение свойства
PageInfo
PageLabels
Получает метки страниц в документе.
public PageLabelCollection PageLabels { get; }Значение свойства
PageLabelCollection
PageLayout
Получает или устанавливает макет страницы, который будет использоваться при открытии документа.
public PageLayout PageLayout { get; set; }Значение свойства
PageLayout
PageMode
Получает или устанавливает режим страницы, указывая, как документ должен отображаться при открытии.
public PageMode PageMode { get; set; }Значение свойства
PageMode
Pages
Получает или устанавливает коллекцию страниц документа. Обратите внимание, что страницы нумеруются с 1 в коллекции.
public PageCollection Pages { get; }Значение свойства
PageCollection
Примеры
Пример ниже демонстрирует, как работать со страницами документа: Как получить количество страниц и как получить прямоугольник начальной страницы документа.
Aspose.Pdf.Document document = new Aspose.Pdf.Document("sample.pdf");
Aspose.Pdf.PageCollection pages = document.Pages;
System.Console.WriteLine("Document contains " + pages.Count);
Page page = pages[1];
Rectangle rect = page.Rect;PdfFormat
Получает формат PDF.
public PdfFormat PdfFormat { get; }Значение свойства
PdfFormat
Permissions
Получает разрешения документа.
public int Permissions { get; }Значение свойства
PickTrayByPdfSize
Получает или устанавливает флаг, указывающий, должен ли размер страницы PDF использоваться для выбора входного лотка бумаги.
public bool PickTrayByPdfSize { get; set; }Значение свойства
PrintScaling
Получает или устанавливает опцию масштабирования страницы, которая будет выбрана, когда для этого документа будет отображен диалог печати.
public PrintScaling PrintScaling { get; set; }Значение свойства
PrintScaling
TaggedContent
Получает доступ к содержимому TaggedPdf.
public ITaggedContent TaggedContent { get; }Значение свойства
ITaggedContent
Примеры
Пример демонстрирует, как использовать тегированное содержимое для создания нового документа с заголовком, абзацами и изображениями.
// Создать новый документ
Document document = new Document();
// Получить тегированное содержимое
ITaggedContent taggedContent = document.TaggedContent;
// Установить язык для документа
taggedContent.SetLanguage("en-US");
// Установить заголовок для PDF-документа
taggedContent.SetTitle("Example document");
// Создание и добавление секции
SectElement sect = taggedContent.CreateSectElement();
taggedContent.RootElement.AppendChild(sect);
// Создать заголовок
HeaderElement h1 = taggedContent.CreateHeaderElement(1);
h1.SetText("The Header");
sect.AppendChild(h1);
// Создать абзац
ParagraphElement p = taggedContent.CreateParagraphElement();
p.SetTag("Paragraph");
p.SetText("The text of paragraph.");
sect.AppendChild(p);
// Создать иллюстрацию
IllustrationElement figure1 = taggedContent.CreateFigureElement();
sect.AppendChild(figure1);
figure1.AlternativeText = "Figure 1";
figure1.Title = "Image 1";
figure1.SetTag("Fig");
figure1.SetImage("path/of/image.jpg");
// Сохранить документ
document.Save("example.pdf");Version
Получает версию PDF из заголовка PDF-файла.
public string Version { get; }Значение свойства
Методы
BindXml(string)
Привязать XML к документу.
public void BindXml(string file)Параметры
file string
XML-файл.
BindXml(string, string)
Привязать XML/XSL к документу.
public void BindXml(string xmlFile, string xslFile)Параметры
xmlFile string
XML-файл.
xslFile string
XSL-файл, если используется XSLT.
BindXml(Stream, Stream)
Привязать XML/XSL к документу.
public void BindXml(Stream xmlStream, Stream xslStream)Параметры
xmlStream Stream
XML-поток.
xslStream Stream
XSL-поток, если используется XSLT.
BindXml(Stream, Stream, XmlReaderSettings)
Привязать XML/XSL к документу.
public void BindXml(Stream xmlStream, Stream xslStream, XmlReaderSettings settings)Параметры
xmlStream Stream
XML-поток.
xslStream Stream
XSL-поток, если используется XSLT.
settings XmlReaderSettings
Настройки XML-ридера.
BindXml(Stream)
Привязать XML к документу.
public void BindXml(Stream stream)Параметры
stream Stream
XML-поток.
ChangePasswords(string, string, string)
Изменяет пароли документа. Это действие можно выполнить только с помощью пароля владельца.
public void ChangePasswords(string ownerPassword, string newUserPassword, string newOwnerPassword)Параметры
ownerPassword string
Пароль владельца.
newUserPassword string
Новый пароль пользователя.
newOwnerPassword string
Новый пароль владельца.
Check(bool)
Валидация документа.
public bool Check(bool doRepair)Параметры
doRepair bool
Если true, найденные проблемы будут исправлены.
Возвращает
True - если документ исправлен; в противном случае false.
Convert(string, PdfFormat, ConvertErrorAction, ConvertTransparencyAction)
Конвертирует документ и сохраняет ошибки в указанный файл.
public bool Convert(string outputLogFileName, PdfFormat format, ConvertErrorAction action, ConvertTransparencyAction transparencyAction)Параметры
outputLogFileName string
Путь к файлу, в котором будут храниться комментарии.
format PdfFormat
Формат PDF.
action ConvertErrorAction
Действие для объектов, которые не могут быть преобразованы.
transparencyAction ConvertTransparencyAction
Действие для объектов с маской изображения.
Возвращает
Результат операции.
Convert(Stream, PdfFormat, ConvertErrorAction, ConvertTransparencyAction)
Конвертирует документ и сохраняет ошибки в указанный файл.
public bool Convert(Stream outputLogStream, PdfFormat format, ConvertErrorAction action, ConvertTransparencyAction transparencyAction)Параметры
outputLogStream Stream
Поток, в котором будут храниться комментарии.
format PdfFormat
Формат PDF.
action ConvertErrorAction
Действие для объектов, которые не могут быть преобразованы.
transparencyAction ConvertTransparencyAction
Действие для объектов с маской изображения.
Возвращает
Результат операции.
Convert(string, PdfFormat, ConvertErrorAction)
Конвертирует документ и сохраняет ошибки в указанный файл.
public bool Convert(string outputLogFileName, PdfFormat format, ConvertErrorAction action)Параметры
outputLogFileName string
Путь к файлу, в котором будут храниться комментарии.
format PdfFormat
Формат PDF.
action ConvertErrorAction
Действие для объектов, которые не могут быть преобразованы.
Возвращает
Результат операции.
Convert(PdfFormatConversionOptions)
Конвертирует документ, используя указанные параметры конвертации.
public bool Convert(PdfFormatConversionOptions options)Параметры
options PdfFormatConversionOptions
Набор параметров для конвертации PDF-документа.
Возвращает
Результат операции.
Convert(CallBackGetHocrWithPage, bool)
Распознает изображения внутри документа и добавляет строки hocr поверх них.
public bool Convert(Document.CallBackGetHocrWithPage callback, bool flattenImages = false)Параметры
callback Document.CallBackGetHocrWithPage
Действие для изображений, которые будут обработаны с помощью hocr.
flattenImages bool
Текст в изображениях PDF может быть окрашен с использованием механики масок, в этом случае изображения должны быть сплющены.
Возвращает
Результат операции. Если в документе нет изображений, возвращает false.
Convert(CallBackGetHocr, bool)
Распознает изображения внутри документа и добавляет строки hocr поверх них.
public bool Convert(Document.CallBackGetHocr callback, bool flattenImages = false)Параметры
callback Document.CallBackGetHocr
Действие для изображений, которые будут обработаны с помощью hocr.
flattenImages bool
Текст в изображениях PDF может быть окрашен с использованием механики масок, в этом случае изображения должны быть сплющены.
Возвращает
Результат операции. Если в документе нет изображений, возвращает false.
Convert(Stream, PdfFormat, ConvertErrorAction)
Конвертирует документ и сохраняет ошибки в указанный поток.
public bool Convert(Stream outputLogStream, PdfFormat format, ConvertErrorAction action)Параметры
outputLogStream Stream
Поток, в котором будут храниться комментарии.
format PdfFormat
Формат PDF.
action ConvertErrorAction
Действие для объектов, которые не могут быть преобразованы.
Возвращает
Результат операции.
Convert(Fixup, Stream, bool, object[])
Конвертирует документ, применяя Fixup.
public bool Convert(Fixup fixup, Stream outputLog, bool onlyValidation = false, object[] parameters = null)Параметры
fixup Fixup
Тип Fixup.
outputLog Stream
Журнал процесса.
onlyValidation bool
Только валидация документа.
parameters object[]
Свойства для Fixup, которые не могут быть установлены.
Возвращает
Результат операции.
Convert(Fixup, string, bool, object[])
Конвертирует документ, применяя Fixup.
public bool Convert(Fixup fixup, string outputLog, bool onlyValidation = false, object[] parameters = null)Параметры
fixup Fixup
Тип Fixup.
outputLog string
Журнал процесса.
onlyValidation bool
Только валидация документа.
parameters object[]
Свойства для Fixup, которые не могут быть установлены.
Возвращает
Результат операции.
Convert(string, LoadOptions, string, SaveOptions)
Конвертирует исходный файл в исходном формате в целевой файл в целевом формате.
public static void Convert(string srcFileName, LoadOptions loadOptions, string dstFileName, SaveOptions saveOptions)Параметры
srcFileName string
Имя исходного файла.
loadOptions LoadOptions
Формат исходного файла.
dstFileName string
Имя целевого файла.
saveOptions SaveOptions
Формат целевого файла.
Convert(Stream, LoadOptions, string, SaveOptions)
Конвертирует поток в исходном формате в целевой файл в целевом формате.
public static void Convert(Stream srcStream, LoadOptions loadOptions, string dstFileName, SaveOptions saveOptions)Параметры
srcStream Stream
Исходный поток.
loadOptions LoadOptions
Формат исходного потока.
dstFileName string
Имя целевого файла.
saveOptions SaveOptions
Формат целевого файла.
Convert(string, LoadOptions, Stream, SaveOptions)
Конвертирует исходный файл в исходном формате в поток в целевом формате.
public static void Convert(string srcFileName, LoadOptions loadOptions, Stream dstStream, SaveOptions saveOptions)Параметры
srcFileName string
Имя исходного файла.
loadOptions LoadOptions
Формат исходного файла.
dstStream Stream
Целевой поток.
saveOptions SaveOptions
Формат целевого потока.
Convert(Stream, LoadOptions, Stream, SaveOptions)
Конвертирует поток в исходном формате в поток в целевом формате.
public static void Convert(Stream srcStream, LoadOptions loadOptions, Stream dstStream, SaveOptions saveOptions)Параметры
srcStream Stream
Исходный поток.
loadOptions LoadOptions
Формат исходного потока.
dstStream Stream
Целевой поток.
saveOptions SaveOptions
Формат целевого файла.
ConvertPageToPNGMemoryStream(Page)
Конвертирует страницу в PNG для DSR, OMR, OCR потока изображений.
public MemoryStream ConvertPageToPNGMemoryStream(Page page)Параметры
page Page
Страница для конвертации.
Возвращает
Поток изображения.
Decrypt()
Расшифровывает документ. Затем вызовите Save, чтобы получить расшифрованную версию документа.
public void Decrypt()Dispose()
Закрывает все ресурсы, используемые этим документом.
public void Dispose()Encrypt(string, string, DocumentPrivilege, CryptoAlgorithm, bool)
Шифрует документ. Затем вызовите Save, чтобы получить зашифрованную версию документа.
public void Encrypt(string userPassword, string ownerPassword, DocumentPrivilege privileges, CryptoAlgorithm cryptoAlgorithm, bool usePdf20)Параметры
userPassword string
Пароль пользователя.
ownerPassword string
Пароль владельца.
privileges DocumentPrivilege
Разрешения документа, см. Aspose.Pdf.Document.Permissions для подробностей.
cryptoAlgorithm CryptoAlgorithm
Криптографический алгоритм, см. Aspose.Pdf.Document.CryptoAlgorithm для подробностей.
usePdf20 bool
Поддержка ревизии 6 (Расширение 8).
Encrypt(string, string, Permissions, CryptoAlgorithm)
Шифрует документ. Затем вызовите Save, чтобы получить зашифрованную версию документа.
public void Encrypt(string userPassword, string ownerPassword, Permissions permissions, CryptoAlgorithm cryptoAlgorithm)Параметры
userPassword string
Пароль пользователя.
ownerPassword string
Пароль владельца.
permissions Permissions
Разрешения документа, см. Aspose.Pdf.Document.Permissions для подробностей.
cryptoAlgorithm CryptoAlgorithm
Криптографический алгоритм, см. Aspose.Pdf.Document.CryptoAlgorithm для подробностей.
Encrypt(string, string, Permissions, CryptoAlgorithm, bool)
Шифрует документ. Затем вызовите Save, чтобы получить зашифрованную версию документа.
public void Encrypt(string userPassword, string ownerPassword, Permissions permissions, CryptoAlgorithm cryptoAlgorithm, bool usePdf20)Параметры
userPassword string
Пароль пользователя.
ownerPassword string
Пароль владельца.
permissions Permissions
Разрешения документа, см. Aspose.Pdf.Document.Permissions для подробностей.
cryptoAlgorithm CryptoAlgorithm
Криптографический алгоритм, см. Aspose.Pdf.Document.CryptoAlgorithm для подробностей.
usePdf20 bool
Поддержка ревизии 6 (Расширение 8).
ExportAnnotationsToXfdf(string)
Экспортирует все аннотации документа в файл XFDF.
public void ExportAnnotationsToXfdf(string fileName)Параметры
fileName string
Имя файла XFDF.
ExportAnnotationsToXfdf(Stream)
Экспортирует все аннотации документа в поток.
public void ExportAnnotationsToXfdf(Stream stream)Параметры
stream Stream
Поток, в котором будет храниться XFDF.
Flatten()
Удаляет все поля из документа и помещает их значения вместо этого.
public void Flatten()Flatten(FlattenSettings)
Удаляет все поля (и аннотации) из документа и помещает их значения вместо этого.
public void Flatten(Form.FlattenSettings flattenSettings)Параметры
flattenSettings Form.FlattenSettings
Настройки для процесса сглаживания.
FlattenTransparency()
Заменяет прозрачное содержимое неполупрозрачной растровой и векторной графикой.
public void FlattenTransparency()FreeMemory()
Очищает память.
public void FreeMemory()GetCatalogValue(string)
Возвращает значение элемента из словаря каталога.
public object GetCatalogValue(string key)Параметры
key string
Ключ элемента.
Возвращает
Значение элемента - если ключ был успешно найден; в противном случае null.
GetObjectById(string)
Получает объект с указанным ID в документе.
public object GetObjectById(string id)Параметры
id string
ID объекта.
Возвращает
Объект с указанным id. Null, если id не найден.
GetXmpMetadata(Stream)
Получает XMP-метаданные из документа.
public void GetXmpMetadata(Stream stream)Параметры
stream Stream
Поток, в котором будут храниться метаданные.
HasIncrementalUpdate()
Проверяет, был ли текущий PDF-документ сохранен с инкрементальными обновлениями.
public bool HasIncrementalUpdate()Возвращает
true, если PDF-документ имеет инкрементальные обновления; в противном случае false.
ImportAnnotationsFromXfdf(string)
Импортирует аннотации из файла XFDF в документ.
public void ImportAnnotationsFromXfdf(string fileName)Параметры
fileName string
Имя файла XFDF.
ImportAnnotationsFromXfdf(Stream)
Импортирует аннотации из потока в документ.
public void ImportAnnotationsFromXfdf(Stream stream)Параметры
stream Stream
Поток, содержащий данные XFDF.
LoadFrom(string, LoadOptions)
Загружает файл, конвертируя его в PDF.
public void LoadFrom(string filename, LoadOptions options)Параметры
filename string
Путь к открываемому файлу.
options LoadOptions
Параметры загрузки.
Исключения
PdfException
Если файл не может быть загружен.
Если файл не найден.
Merge(MergeOptions, params Document[])
Объединяет документы.
public void Merge(Document.MergeOptions mergeOptions, params Document[] documents)Параметры
mergeOptions Document.MergeOptions
Параметры объединения.
documents Document[]
Документы для объединения.
Merge(MergeOptions, params string[])
Объединяет документы.
public void Merge(Document.MergeOptions mergeOptions, params string[] files)Параметры
mergeOptions Document.MergeOptions
Параметры объединения.
files string[]
PDF-файлы для объединения.
Merge(params Document[])
Объединяет документы.
public void Merge(params Document[] documents)Параметры
documents Document[]
Документы для объединения.
Merge(params string[])
Объединяет PDF-файлы.
public void Merge(params string[] files)Параметры
files string[]
PDF-файлы для объединения.
MergeDocuments(MergeOptions, params string[])
Объединяет документы.
public static Document MergeDocuments(Document.MergeOptions mergeOptions, params string[] files)Параметры
mergeOptions Document.MergeOptions
Параметры объединения.
files string[]
PDF-файлы для объединения.
Возвращает
Объединенный документ.
MergeDocuments(MergeOptions, params Document[])
Объединяет документы.
public static Document MergeDocuments(Document.MergeOptions mergeOptions, params Document[] files)Параметры
mergeOptions Document.MergeOptions
files Document[]
Документы для объединения.
Возвращает
Объединенный документ.
MergeDocuments(params string[])
Объединяет PDF-файлы.
public static Document MergeDocuments(params string[] files)Параметры
files string[]
PDF-файлы для объединения.
Возвращает
Объединенный документ.
MergeDocuments(params Document[])
Объединяет документы.
public static Document MergeDocuments(params Document[] documents)Параметры
documents Document[]
Документы для объединения.
Возвращает
Объединенный документ.
Optimize()
Линейно упорядочивает документ для того, чтобы
- открыть первую страницу как можно быстрее;
- как можно быстрее отобразить следующую страницу или перейти по ссылке на следующую страницу;
- отображать страницу по мере поступления данных, когда данные для страницы передаются по медленному каналу (отображать наиболее полезные данные в первую очередь);
- разрешить взаимодействие с пользователем, например, переход по ссылке, которое может быть выполнено даже до того, как вся страница была получена и отображена. Вызов этого метода на самом деле не сохраняет документ. Напротив, документ только подготавливается к оптимизированной структуре, затем вызовите Save, чтобы получить оптимизированный документ.
public void Optimize()OptimizeResources()
Оптимизирует ресурсы в документе:
- Ресурсы, которые не используются на страницах документа, удаляются;
- Равные ресурсы объединяются в один объект;
- Неиспользуемые объекты удаляются.
public void OptimizeResources()OptimizeResources(OptimizationOptions)
Оптимизирует ресурсы в документе в соответствии с определенной стратегией оптимизации.
public void OptimizeResources(OptimizationOptions strategy)Параметры
strategy OptimizationOptions
Стратегия оптимизации.
PageNodesToBalancedTree(byte)
Организует узлы дерева страниц в документе в сбалансированное дерево. Только если документ имеет более nodesNumInSubtrees объектов страниц, в противном случае ничего не делает. Не вызывайте этот метод во время итерации по элементам Pages, это может привести к непредсказуемым результатам.
public void PageNodesToBalancedTree(byte nodesNumInSubtrees = 10)Параметры
nodesNumInSubtrees byte
Желаемое количество подузлов. Значение по умолчанию - десять.
ProcessParagraphs()
Обрабатывает абзацы для генератора.
public void ProcessParagraphs()RemoveMetadata()
Удаляет метаданные из документа.
public void RemoveMetadata()RemovePdfUaCompliance()
Удаляет соответствие pdfUa из документа.
public void RemovePdfUaCompliance()RemovePdfaCompliance()
Удаляет соответствие pdfa из документа.
public void RemovePdfaCompliance()Repair()
Исправляет поврежденный документ.
public void Repair()Save(Stream)
Сохраняет документ в поток.
public void Save(Stream output)Параметры
output Stream
Поток, в который документ будет сохранен.
Save(string)
Сохраняет документ в указанный файл.
public void Save(string outputFileName)Параметры
outputFileName string
Путь к файлу, в котором документ будет сохранен.
Save()
Сохраняет документ инкрементально (т.е. с использованием техники инкрементального обновления).
public void Save()Примечания
Для того чтобы сохранить документ инкрементально, мы должны открыть файл документа для записи. Поэтому Document должен быть инициализирован с помощью записываемого потока, как в следующем фрагменте кода: Document doc = new Document(new FileStream(“document.pdf”, FileMode.Open, FileAccess.ReadWrite)); // внесите некоторые изменения и сохраните документ инкрементально doc.Save();
Save(SaveOptions)
Сохраняет документ с параметрами сохранения.
public void Save(SaveOptions options)Параметры
options SaveOptions
Параметры сохранения.
Save(string, SaveFormat)
Сохраняет документ с новым именем вместе с форматом файла.
public void Save(string outputFileName, SaveFormat format)Параметры
outputFileName string
Путь к файлу, в котором документ будет сохранен.
format SaveFormat
Параметры формата.
Save(Stream, SaveFormat)
Сохраняет документ с новым именем вместе с форматом файла.
public void Save(Stream outputStream, SaveFormat format)Параметры
outputStream Stream
Поток, в котором документ будет сохранен.
format SaveFormat
Параметры формата.
Исключения
System.ArgumentException, когда Aspose.Pdf.HtmlSaveOptions передан методу. Сохранение документа в HTML-поток не поддерживается. Пожалуйста, используйте метод сохранения в файл.
Save(string, SaveOptions)
Сохраняет документ с новым именем, устанавливая его параметры сохранения.
public void Save(string outputFileName, SaveOptions options)Параметры
outputFileName string
Путь к файлу, в котором документ будет сохранен.
options SaveOptions
Параметры сохранения.
Save(Stream, SaveOptions)
Сохраняет документ в поток с параметрами сохранения.
public void Save(Stream outputStream, SaveOptions options)Параметры
outputStream Stream
Поток, в котором документ будет сохранен.
options SaveOptions
Параметры сохранения.
Исключения
System.ArgumentException, когда Aspose.Pdf.HtmlSaveOptions передан методу. Сохранение документа в HTML-поток не поддерживается. Пожалуйста, используйте метод сохранения в файл.
SaveAsync(Stream, CancellationToken)
Сохраняет документ в поток.
public Task SaveAsync(Stream output, CancellationToken cancellationToken)Параметры
output Stream
Поток, в котором документ будет сохранен.
cancellationToken CancellationToken
Токен отмены.
Возвращает
Асинхронная задача.
SaveAsync(string, CancellationToken)
Сохраняет документ в указанный файл.
public Task SaveAsync(string outputFileName, CancellationToken cancellationToken)Параметры
outputFileName string
Путь к файлу, в котором документ будет сохранен.
cancellationToken CancellationToken
Токен отмены.
Возвращает
Асинхронная задача.
SaveAsync(CancellationToken)
Сохраняет документ инкрементально (т.е. с использованием техники инкрементального обновления).
public Task SaveAsync(CancellationToken cancellationToken)Параметры
cancellationToken CancellationToken
Токен отмены.
Возвращает
Асинхронная задача.
Примечания
Для того чтобы сохранить документ инкрементально, мы должны открыть файл документа для записи. Поэтому Document должен быть инициализирован с помощью записываемого потока, как в следующем фрагменте кода: Document doc = new Document(new FileStream(“document.pdf”, FileMode.Open, FileAccess.ReadWrite)); // внесите некоторые изменения и сохраните документ инкрементально doc.Save();
SaveAsync(SaveOptions, CancellationToken)
Сохраняет документ с параметрами сохранения.
public Task SaveAsync(SaveOptions options, CancellationToken cancellationToken)Параметры
options SaveOptions
Параметры сохранения.
cancellationToken CancellationToken
Токен отмены.
Возвращает
Асинхронная задача.
SaveAsync(string, SaveFormat, CancellationToken)
Сохраняет документ с новым именем вместе с форматом файла.
public Task SaveAsync(string outputFileName, SaveFormat format, CancellationToken cancellationToken)Параметры
outputFileName string
Путь к файлу, в котором документ будет сохранен.
format SaveFormat
Параметры формата.
cancellationToken CancellationToken
Токен отмены.
Возвращает
Асинхронная задача.
SaveAsync(Stream, SaveFormat, CancellationToken)
Сохраняет документ с новым именем вместе с форматом файла.
public Task SaveAsync(Stream outputStream, SaveFormat format, CancellationToken cancellationToken)Параметры
outputStream Stream
Поток, в котором документ будет сохранен.
format SaveFormat
Параметры формата.
cancellationToken CancellationToken
Токен отмены.
Возвращает
Асинхронная задача.
Исключения
System.ArgumentException, когда Aspose.Pdf.HtmlSaveOptions передан методу. Сохранение документа в HTML-поток не поддерживается. Пожалуйста, используйте метод сохранения в файл.
SaveAsync(string, SaveOptions, CancellationToken)
Сохраняет документ с новым именем, устанавливая его параметры сохранения.
public Task SaveAsync(string outputFileName, SaveOptions options, CancellationToken cancellationToken)Параметры
outputFileName string
Путь к файлу, в котором документ будет сохранен.
options SaveOptions
Параметры сохранения.
cancellationToken CancellationToken
Токен отмены.
Возвращает
Асинхронная задача.
SaveAsync(Stream, SaveOptions, CancellationToken)
Сохраняет документ в поток с параметрами сохранения.
public Task SaveAsync(Stream outputStream, SaveOptions options, CancellationToken cancellationToken)Параметры
outputStream Stream
Поток, в котором документ будет сохранен.
options SaveOptions
Параметры сохранения.
cancellationToken CancellationToken
Токен отмены.
Возвращает
Асинхронная задача.
Исключения
System.ArgumentException, когда Aspose.Pdf.HtmlSaveOptions передан методу. Сохранение документа в HTML-поток не поддерживается. Пожалуйста, используйте метод сохранения в файл.
SaveXml(string)
Сохраняет документ в XML.
public void SaveXml(string file)Параметры
file [string](https://learn.microsoft
