Class Document

Class Document

Namespace: Aspose.Pdf
Assembly: Aspose.PDF.dll

کلاسی که نمایانگر سند PDF است

public sealed class Document : IDisposable

وراثت

objectDocument

پیاده‌سازی‌ها

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

مقدار فیلد

byte

ویژگی‌ها

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

مقدار ویژگی

bool

Background

رنگ پس‌زمینه سند را دریافت یا تنظیم می‌کند.

public Color Background { get; set; }

مقدار ویژگی

Color

CenterWindow

پرچم مشخص می‌کند که آیا موقعیت پنجره سند باید در صفحه نمایش مرکز قرار گیرد یا خیر.

public bool CenterWindow { get; set; }

مقدار ویژگی

bool

مثال‌ها

مثال نشان می‌دهد که چگونه پرچم CenterWindow را دریافت کنید:

Document document = new Document("sample.pdf");
bool value = document.CenterWindow;

Collection

مجموعه‌ای از سند را دریافت می‌کند.

public Collection Collection { get; set; }

مقدار ویژگی

Collection

CryptoAlgorithm

تنظیمات امنیتی را دریافت می‌کند اگر سند رمزگذاری شده باشد. اگر سند رمزگذاری نشده باشد، در .net 1.1 استثنای مربوطه ایجاد می‌شود یا CryptoAlgorithm برای نسخه‌های دیگر .net برابر با null خواهد بود.

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

مقدار ویژگی

bool

DisplayDocTitle

پرچم مشخص می‌کند که آیا نوار عنوان پنجره سند باید عنوان سند را نمایش دهد یا خیر.

public bool DisplayDocTitle { get; set; }

مقدار ویژگی

bool

مثال‌ها

مثال نشان می‌دهد که چگونه پرچم 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; }

مقدار ویژگی

bool

EmbeddedFiles

مجموعه‌ای از فایل‌های جاسازی شده در سند را دریافت می‌کند.

public EmbeddedFileCollection EmbeddedFiles { get; }

مقدار ویژگی

EmbeddedFileCollection

EnableObjectUnload

پرچم را دریافت یا تنظیم می‌کند که اجازه می‌دهد سند به طور جزئی از حافظه تخلیه شود. این کار باعث کاهش استفاده از حافظه می‌شود اما ممکن است تأثیر منفی بر عملکرد داشته باشد.

public bool EnableObjectUnload { get; set; }

مقدار ویژگی

bool

EnableSignatureSanitization

پرچم را دریافت یا تنظیم می‌کند تا مدیریت تصفیه میدان‌های امضا را انجام دهد. به طور پیش‌فرض فعال است.

public bool EnableSignatureSanitization { get; set; }

مقدار ویژگی

bool

FileName

نام فایل PDF که این سند را ایجاد کرده است

public string FileName { get; }

مقدار ویژگی

string

FitWindow

پرچم را دریافت یا تنظیم می‌کند که مشخص می‌کند آیا پنجره سند باید برای تناسب با اولین صفحه نمایش داده شده تغییر اندازه دهد یا خیر.

public bool FitWindow { get; set; }

مقدار ویژگی

bool

مثال‌ها

مثال نشان می‌دهد که چگونه پرچم FitWindow را دریافت کنید:

Document document = new Document("sample.pdf");
bool value = document.FitWindow;

FontUtilities

نمونه IDocumentFontUtilities

public Document.IDocumentFontUtilities FontUtilities { get; }

مقدار ویژگی

Document.IDocumentFontUtilities

Form

فرم Acro سند را دریافت می‌کند.

public Form Form { get; }

مقدار ویژگی

Form

HandleSignatureChange

استثنا را پرتاب می‌کند اگر سند با تغییرات ذخیره شود و دارای امضا باشد.

public bool HandleSignatureChange { get; set; }

مقدار ویژگی

bool

HideMenubar

پرچم را دریافت یا تنظیم می‌کند که مشخص می‌کند آیا نوار منو باید هنگام فعال بودن سند پنهان شود یا خیر.

public bool HideMenubar { get; set; }

مقدار ویژگی

bool

مثال‌ها

مثال نشان می‌دهد که چگونه پرچم HideMenubar را دریافت کنید:

Document document = new Document("sample.pdf");
bool value = document.HideMenubar;

HideToolBar

پرچم را دریافت یا تنظیم می‌کند که مشخص می‌کند آیا نوار ابزار باید هنگام فعال بودن سند پنهان شود یا خیر.

public bool HideToolBar { get; set; }

مقدار ویژگی

bool

مثال‌ها

مثال نشان می‌دهد که چگونه پرچم HideToolBar را دریافت کنید:

Document document = new Document("sample.pdf");
bool value = document.HideToolBar;

HideWindowUI

پرچم را دریافت یا تنظیم می‌کند که مشخص می‌کند آیا عناصر رابط کاربری باید هنگام فعال بودن سند پنهان شوند یا خیر.

public bool HideWindowUI { get; set; }

مقدار ویژگی

bool

مثال‌ها

مثال نشان می‌دهد که چگونه پرچم HideWindowUI را دریافت کنید:

Document document = new Document("sample.pdf");
bool value = document.HideWindowUI;

Id

شناسه را دریافت می‌کند.

public Id Id { get; }

مقدار ویژگی

Id

IgnoreCorruptedObjects

پرچم را دریافت یا تنظیم می‌کند که خطاها در فایل‌های منبع را نادیده می‌گیرد. زمانی که صفحات از سند منبع به سند مقصد کپی می‌شوند، فرآیند کپی با استثنا متوقف می‌شود اگر برخی از اشیاء در فایل‌های منبع آسیب‌دیده باشند وقتی که این پرچم false باشد. مثال: dest.Pages.Add(src.Pages); اگر این پرچم به true تنظیم شود، اشیاء آسیب‌دیده با مقادیر خالی جایگزین خواهند شد. به طور پیش‌فرض: true.

public bool IgnoreCorruptedObjects { get; set; }

مقدار ویژگی

bool

Info

اطلاعات سند را دریافت می‌کند.

public DocumentInfo Info { get; }

مقدار ویژگی

DocumentInfo

IsEncrypted

وضعیت رمزگذاری سند را دریافت می‌کند. اگر سند رمزگذاری شده باشد، true است.

public bool IsEncrypted { get; }

مقدار ویژگی

bool

IsLicensed

وضعیت مجوز سیستم را دریافت می‌کند. اگر سیستم در حالت مجوزی کار کند، true و در غیر این صورت false برمی‌گرداند.

public static bool IsLicensed { get; }

مقدار ویژگی

bool

IsLinearized

یک مقدار را دریافت یا تنظیم می‌کند که مشخص می‌کند آیا سند خطی‌سازی شده است یا خیر.

public bool IsLinearized { get; set; }

مقدار ویژگی

bool

IsPdfUaCompliant

وضعیت انطباق سند با PDF/UA را دریافت می‌کند.

public bool IsPdfUaCompliant { get; }

مقدار ویژگی

bool

IsPdfaCompliant

وضعیت انطباق سند با PDF/A را دریافت می‌کند.

public bool IsPdfaCompliant { get; }

مقدار ویژگی

bool

IsXrefGapsAllowed

یک مقدار را دریافت یا تنظیم می‌کند که مشخص می‌کند آیا فاصله‌های Xref مجاز است یا خیر.

public bool IsXrefGapsAllowed { get; set; }

مقدار ویژگی

bool

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

مقدار ویژگی

bool

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

مقدار ویژگی

int

PickTrayByPdfSize

پرچم را دریافت یا تنظیم می‌کند که مشخص می‌کند آیا اندازه صفحه PDF باید برای انتخاب سینی ورودی استفاده شود یا خیر.

public bool PickTrayByPdfSize { get; set; }

مقدار ویژگی

bool

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

مقدار ویژگی

string

متدها

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 باشد، مشکلات پیدا شده تعمیر خواهند شد.

بازگشت

bool

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

عملی برای اشیای تصویر ماسک‌دار.

بازگشت

bool

نتیجه عملیات

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

عملی برای اشیای تصویر ماسک‌دار.

بازگشت

bool

نتیجه عملیات

Convert(string, PdfFormat, ConvertErrorAction)

سند را تبدیل کرده و خطاها را در فایل مشخص شده ذخیره می‌کند.

public bool Convert(string outputLogFileName, PdfFormat format, ConvertErrorAction action)

پارامترها

outputLogFileName string

مسیر به فایلی که نظرات در آن ذخیره خواهند شد.

format PdfFormat

فرمت PDF.

action ConvertErrorAction

عملی برای اشیایی که نمی‌توانند تبدیل شوند.

بازگشت

bool

نتیجه عملیات

Convert(PdfFormatConversionOptions)

سند را با استفاده از گزینه‌های تبدیل مشخص شده تبدیل می‌کند.

public bool Convert(PdfFormatConversionOptions options)

پارامترها

options PdfFormatConversionOptions

مجموعه‌ای از گزینه‌ها برای تبدیل سند PDF

بازگشت

bool

نتیجه عملیات

Convert(CallBackGetHocrWithPage, bool)

تصاویر داخل سند را شناسایی کرده و رشته‌های hocr را بر روی آن اضافه می‌کند.

public bool Convert(Document.CallBackGetHocrWithPage callback, bool flattenImages = false)

پارامترها

callback Document.CallBackGetHocrWithPage

عملی برای تصاویری که توسط شناسایی hocr پردازش خواهند شد.

flattenImages bool

متن در تصاویر PDF می‌تواند با استفاده از مکانیک ماسک‌ها نقاشی شود، در این صورت تصاویر باید صاف شوند.

بازگشت

bool

نتیجه عملیات. اگر در سند هیچ تصویری وجود نداشته باشد، false برمی‌گرداند.

Convert(CallBackGetHocr, bool)

تصاویر داخل سند را شناسایی کرده و رشته‌های hocr را بر روی آن اضافه می‌کند.

public bool Convert(Document.CallBackGetHocr callback, bool flattenImages = false)

پارامترها

callback Document.CallBackGetHocr

عملی برای تصاویری که توسط شناسایی hocr پردازش خواهند شد.

flattenImages bool

متن در تصاویر PDF می‌تواند با استفاده از مکانیک ماسک‌ها نقاشی شود، در این صورت تصاویر باید صاف شوند.

بازگشت

bool

نتیجه عملیات. اگر در سند هیچ تصویری وجود نداشته باشد، false برمی‌گرداند.

Convert(Stream, PdfFormat, ConvertErrorAction)

سند را تبدیل کرده و خطاها را در جریان مشخص شده ذخیره می‌کند.

public bool Convert(Stream outputLogStream, PdfFormat format, ConvertErrorAction action)

پارامترها

outputLogStream Stream

جریانی که نظرات در آن ذخیره خواهند شد.

format PdfFormat

فرمت PDF.

action ConvertErrorAction

عملی برای اشیایی که نمی‌توانند تبدیل شوند.

بازگشت

bool

نتیجه عملیات

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 که نمی‌توانند تنظیم شوند.

بازگشت

bool

نتیجه عملیات.

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 که نمی‌توانند تنظیم شوند.

بازگشت

bool

نتیجه عملیات.

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

صفحه‌ای که باید تبدیل شود.

بازگشت

MemoryStream

جریان تصویر.

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

کلید آیتم.

بازگشت

object

مقدار آیتم - اگر کلید با موفقیت پیدا شده باشد؛ در غیر این صورت، null.

GetObjectById(string)

شیء با شناسه مشخص شده را در سند دریافت می‌کند.

public object GetObjectById(string id)

پارامترها

id string

شناسه شیء.

بازگشت

object

شیء با شناسه مشخص شده. Null اگر شناسه پیدا نشود.

GetXmpMetadata(Stream)

متاداده XMP را از سند دریافت می‌کند.

public void GetXmpMetadata(Stream stream)

پارامترها

stream Stream

جریانی که متاداده در آن ذخیره خواهد شد.

HasIncrementalUpdate()

بررسی می‌کند که آیا سند PDF فعلی با به‌روزرسانی‌های افزایشی ذخیره شده است یا خیر.

public bool HasIncrementalUpdate()

بازگشت

bool

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

اگر فایل نتواند بارگذاری شود.

FileNotFoundException

اگر فایل پیدا نشود.

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 که باید ادغام شوند.

بازگشت

Document

سند ادغام‌شده.

MergeDocuments(MergeOptions, params Document[])

سندها را ادغام می‌کند.

public static Document MergeDocuments(Document.MergeOptions mergeOptions, params Document[] files)

پارامترها

mergeOptions Document.MergeOptions

files Document[]

سندهایی که باید ادغام شوند.

بازگشت

Document

سند ادغام‌شده.

MergeDocuments(params string[])

فایل‌های PDF را ادغام می‌کند.

public static Document MergeDocuments(params string[] files)

پارامترها

files string[]

فایل‌های PDF که باید ادغام شوند.

بازگشت

Document

سند ادغام‌شده.

MergeDocuments(params Document[])

سندها را ادغام می‌کند.

public static Document MergeDocuments(params Document[] documents)

پارامترها

documents Document[]

سندهایی که باید ادغام شوند.

بازگشت

Document

سند ادغام‌شده.

Optimize()

سند را خطی‌سازی می‌کند به طوری که

  • صفحه اول به سرعت باز شود؛
  • صفحه بعدی یا پیوند به صفحه بعدی به سرعت نمایش داده شود؛
  • صفحه به تدریج نمایش داده شود در حالی که داده‌های صفحه از طریق یک کانال کند ارسال می‌شود (نمایش داده‌های مفید‌تر در ابتدا)؛
  • اجازه می‌دهد تا تعامل کاربر، مانند دنبال کردن یک پیوند، حتی قبل از اینکه کل صفحه دریافت و نمایش داده شده باشد، انجام شود. فراخوانی این متد در واقع سند را ذخیره نمی‌کند. برعکس، سند فقط برای داشتن ساختار بهینه‌سازی شده آماده می‌شود، سپس برای دریافت سند بهینه‌سازی شده، Save را فراخوانی کنید.
public void Optimize()

OptimizeResources()

منابع را در سند بهینه‌سازی می‌کند:

  1. منابعی که در صفحات سند استفاده نمی‌شوند حذف می‌شوند؛
  2. منابع برابر به یک شیء ملحق می‌شوند؛
  3. اشیاء غیرقابل استفاده حذف می‌شوند.
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

گزینه‌های فرمت.

استثناها

ArgumentException

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

گزینه‌های ذخیره‌سازی.

استثناها

ArgumentException

System.ArgumentException زمانی که Aspose.Pdf.HtmlSaveOptions به یک متد منتقل می‌شود. ذخیره یک سند در جریان HTML پشتیبانی نمی‌شود. لطفاً از متد ذخیره به فایل استفاده کنید.

SaveAsync(Stream, CancellationToken)

سند را در جریان ذخیره می‌کند.

public Task SaveAsync(Stream output, CancellationToken cancellationToken)

پارامترها

output Stream

جریانی که سند در آن ذخیره خواهد شد.

cancellationToken CancellationToken

توکن لغو.

بازگشت

Task

وظیفه غیرهمزمان.

SaveAsync(string, CancellationToken)

سند را در فایل مشخص شده ذخیره می‌کند.

public Task SaveAsync(string outputFileName, CancellationToken cancellationToken)

پارامترها

outputFileName string

مسیر به فایلی که سند در آن ذخیره خواهد شد.

cancellationToken CancellationToken

توکن لغو.

بازگشت

Task

وظیفه غیرهمزمان.

SaveAsync(CancellationToken)

سند را به صورت افزایشی ذخیره می‌کند (یعنی با استفاده از تکنیک به‌روزرسانی افزایشی).

public Task SaveAsync(CancellationToken cancellationToken)

پارامترها

cancellationToken CancellationToken

توکن لغو.

بازگشت

Task

وظیفه غیرهمزمان.

توضیحات

برای ذخیره سند به صورت افزایشی، باید فایل سند را برای نوشتن باز کنیم. بنابراین 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

توکن لغو.

بازگشت

Task

وظیفه غیرهمزمان.

SaveAsync(string, SaveFormat, CancellationToken)

سند را با نام جدید همراه با فرمت فایل ذخیره می‌کند.

public Task SaveAsync(string outputFileName, SaveFormat format, CancellationToken cancellationToken)

پارامترها

outputFileName string

مسیر به فایلی که سند در آن ذخیره خواهد شد.

format SaveFormat

گزینه‌های فرمت.

cancellationToken CancellationToken

توکن لغو.

بازگشت

Task

وظیفه غیرهمزمان.

SaveAsync(Stream, SaveFormat, CancellationToken)

سند را با نام جدید همراه با فرمت فایل ذخیره می‌کند.

public Task SaveAsync(Stream outputStream, SaveFormat format, CancellationToken cancellationToken)

پارامترها

outputStream Stream

جریانی که سند در آن ذخیره خواهد شد.

format SaveFormat

گزینه‌های فرمت.

cancellationToken CancellationToken

توکن لغو.

بازگشت

Task

وظیفه غیرهمزمان.

استثناها

ArgumentException

System.ArgumentException زمانی که Aspose.Pdf.HtmlSaveOptions به یک

 فارسی