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 з вхідного потоку.
public Document(Stream input)Параметри
input Stream
Потік з pdf документом.
Document(Stream, string, bool)
Ініціалізує новий екземпляр Document з вхідного потоку.
public Document(Stream input, string password, bool isManagedStream)Параметри
input Stream
Потік з pdf документом.
password string
Пароль користувача або власника.
isManagedStream bool
якщо встановлено true, внутрішній потік закривається перед виходом; в іншому випадку - ні.
Document(Stream, bool)
Ініціалізує новий екземпляр Document з вхідного потоку.
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 з вхідного потоку.
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 є винятком з цього правила. Вбудовування стандартних шрифтів 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("Документ містить " + 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("Приклад документу");
// Створення та додавання секції
SectElement sect = taggedContent.CreateSectElement();
taggedContent.RootElement.AppendChild(sect);
// Створити заголовок
HeaderElement h1 = taggedContent.CreateHeaderElement(1);
h1.SetText("Заголовок");
sect.AppendChild(h1);
// Створити абзац
ParagraphElement p = taggedContent.CreateParagraphElement();
p.SetTag("Абзац");
p.SetText("Текст абзацу.");
sect.AppendChild(p);
// Створити ілюстрацію
IllustrationElement figure1 = taggedContent.CreateFigureElement();
sect.AppendChild(figure1);
figure1.AlternativeText = "Фігура 1";
figure1.Title = "Зображення 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)Параметри
`
