Class Document
Namespace: Aspose.Pdf
Assembly: Aspose.PDF.dll
Třída představující PDF dokument
public sealed class Document : IDisposable
Dědičnost
Implementuje
Děděné členy
object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Konstruktor
Document(Stream)
Inicializuje novou instanci Document z input
streamu.
public Document(Stream input)
Parametry
input
Stream
Stream s PDF dokumentem.
Document(Stream, string, bool)
Inicializuje novou instanci Document z input
streamu.
public Document(Stream input, string password, bool isManagedStream)
Parametry
input
Stream
Stream s PDF dokumentem.
password
string
Uživatelské nebo vlastnické heslo.
isManagedStream
bool
Pokud je nastaveno na true
, vnitřní stream je uzavřen před odchodem; jinak není.
Document(Stream, bool)
Inicializuje novou instanci Document z input
streamu.
public Document(Stream input, bool isManagedStream)
Parametry
input
Stream
Stream s PDF dokumentem.
isManagedStream
bool
Pokud je nastaveno na true
, vnitřní stream je uzavřen před odchodem; jinak není.
Document(string)
Jednoduše inicializuje Document pomocí filename
. To samé jako Aspose.Pdf.Document.#ctor(System.IO.Stream).
public Document(string filename)
Parametry
filename
string
Název souboru PDF dokumentu.
Document(Stream, string)
Inicializuje novou instanci Document z input
streamu.
public Document(Stream input, string password)
Parametry
input
Stream
Objekt vstupního streamu, odpovídající PDF je chráněn heslem.
password
string
Uživatelské nebo vlastnické heslo.
Document()
Inicializuje prázdný dokument.
public Document()
Document(string, string)
Inicializuje novou instanci třídy Aspose.Pdf.Document pro práci s šifrovaným dokumentem.
public Document(string filename, string password)
Parametry
filename
string
Název souboru dokumentu.
password
string
Uživatelské nebo vlastnické heslo.
Document(string, string, bool)
Inicializuje novou instanci třídy Aspose.Pdf.Document pro práci s šifrovaným dokumentem.
public Document(string filename, string password, bool isManagedStream)
Parametry
filename
string
Název souboru dokumentu.
password
string
Uživatelské nebo vlastnické heslo.
isManagedStream
bool
Pokud je nastaveno na true
, vnitřní stream je uzavřen před odchodem; jinak není.
Document(string, LoadOptions)
Otevře existující dokument ze souboru, poskytující potřebné možnosti převodu pro získání PDF dokumentu.
public Document(string filename, LoadOptions options)
Parametry
filename
string
Vstupní soubor k převodu na PDF dokument.
options
LoadOptions
Představuje vlastnosti pro převod filename
na PDF dokument.
Document(Stream, LoadOptions)
Otevře existující dokument ze streamu, poskytující potřebné možnosti převodu pro získání PDF dokumentu.
public Document(Stream input, LoadOptions options)
Parametry
input
Stream
Vstupní stream k převodu na PDF dokument.
options
LoadOptions
Představuje vlastnosti pro převod input
na PDF dokument.
Pole
DefaultNodesNumInSubtrees
public const byte DefaultNodesNumInSubtrees = 10
Hodnota pole
Vlastnosti
Actions
Získá akce dokumentu. Tato vlastnost je instancí třídy DocumentActions, která umožňuje získat/nastavit akce BeforClosing, BeforSaving, atd.
public DocumentActionCollection Actions { get; }
Hodnota vlastnosti
DocumentActionCollection
Příklady
Tento příklad ukazuje, jak získat akci po otevření dokumentu:
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
Umožňuje sloučit obsah stránek pro optimalizaci velikosti dokumentu. Pokud je použit, různorodé, ale duplicitní stránky mohou odkazovat na stejný objekt obsahu. Upozorňujeme, že tento režim může způsobit vedlejší efekty, jako je změna obsahu stránky, když je změněna jiná stránka.
public bool AllowReusePageContent { get; set; }
Hodnota vlastnosti
Background
Získá nebo nastaví barvu pozadí dokumentu.
public Color Background { get; set; }
Hodnota vlastnosti
Color
CenterWindow
Získá nebo nastaví příznak určující, zda bude pozice okna dokumentu vycentrována na obrazovce.
public bool CenterWindow { get; set; }
Hodnota vlastnosti
Příklady
Příklad ukazuje, jak získat příznak CenterWindow:
Document document = new Document("sample.pdf");
bool value = document.CenterWindow;
Collection
Získá kolekci dokumentu.
public Collection Collection { get; set; }
Hodnota vlastnosti
Collection
CryptoAlgorithm
Získá bezpečnostní nastavení, pokud je dokument šifrován. Pokud dokument není šifrován, pak bude odpovídající výjimka vyvolána v .net 1.1 nebo CryptoAlgorithm bude null pro ostatní verze .net.
public CryptoAlgorithm? CryptoAlgorithm { get; }
Hodnota vlastnosti
CryptoAlgorithm?
Destinations
Získá kolekci cílů. Zastaralé. Použijte prosím NamedDestinations.
public DestinationCollection Destinations { get; }
Hodnota vlastnosti
DestinationCollection
Direction
Získá nebo nastaví pořadí čtení textu: L2R (zleva doprava) nebo R2L (zprava doleva).
public Direction Direction { get; set; }
Hodnota vlastnosti
Direction
DisableFontLicenseVerifications
Mnoho operací s písmem nemůže být prováděno, pokud jsou tyto operace zakázány licencí tohoto písma. Například některá písma nemohou být vložena do PDF dokumentu, pokud licenční pravidla zakazují vložení pro toto písmo. Tento příznak se používá k deaktivaci jakýchkoli licenčních omezení pro všechna písma v aktuálním PDF dokumentu. Buďte opatrní při používání tohoto příznaku. Když je nastaven, znamená to, že osoba, která tento příznak nastavuje, přebírá veškerou odpovědnost za možné porušení licencí/zákonů na sebe. Takže to bere na vlastní riziko. Doporučuje se používat tento příznak pouze tehdy, když jste si jisti, že neporušujete autorské právo. Ve výchozím stavu false.
public bool DisableFontLicenseVerifications { get; set; }
Hodnota vlastnosti
DisplayDocTitle
Získá nebo nastaví příznak určující, zda by měl být název okna dokumentu zobrazen v titulním pruhu.
public bool DisplayDocTitle { get; set; }
Hodnota vlastnosti
Příklady
Příklad ukazuje, jak získat příznak DisplayDocTitle:
Document document = new Document("sample.pdf");
bool value = document.DisplayDocTitle;
Duplex
Získá nebo nastaví možnost zpracování režimu duplex tisku, která se má použít při tisku souboru z dialogu tisku.
public PrintDuplex Duplex { get; set; }
Hodnota vlastnosti
PrintDuplex
EmbedStandardFonts
Vlastnost, která deklaruje, že dokument musí vložit všechna standardní písma Type1, která mají příznak IsEmbedded nastaven na true. Všechna PDF písma mohou být vložena do dokumentu jednoduše nastavením příznaku IsEmbedded na true, ale standardní písma Type1 jsou výjimkou z tohoto pravidla. Vložení standardního písma Type1 vyžaduje hodně času, takže pro vložení těchto písem je nutné nejen nastavit příznak IsEmbedded na true pro specifikované písmo, ale také nastavit další příznak na úrovni dokumentu - EmbedStandardFonts = true; Tato vlastnost může být nastavena pouze jednou pro všechna písma. Ve výchozím stavu false.
public bool EmbedStandardFonts { get; set; }
Hodnota vlastnosti
EmbeddedFiles
Získá kolekci souborů vložených do dokumentu.
public EmbeddedFileCollection EmbeddedFiles { get; }
Hodnota vlastnosti
EmbeddedFileCollection
EnableObjectUnload
Získá nebo nastaví příznak, který umožňuje částečné uvolnění dokumentu z paměti. To umožňuje snížit využití paměti, ale může mít negativní vliv na výkon.
public bool EnableObjectUnload { get; set; }
Hodnota vlastnosti
EnableSignatureSanitization
Získá nebo nastaví příznak pro správu sanitizace polí podpisu. Ve výchozím stavu povoleno.
public bool EnableSignatureSanitization { get; set; }
Hodnota vlastnosti
FileName
Název PDF souboru, který způsobil tento dokument.
public string FileName { get; }
Hodnota vlastnosti
FitWindow
Získá nebo nastaví příznak určující, zda by okno dokumentu mělo být změněno tak, aby se vešlo na první zobrazenou stránku.
public bool FitWindow { get; set; }
Hodnota vlastnosti
Příklady
Příklad ukazuje, jak získat příznak FitWindow:
Document document = new Document("sample.pdf");
bool value = document.FitWindow;
FontUtilities
Instance IDocumentFontUtilities
public Document.IDocumentFontUtilities FontUtilities { get; }
Hodnota vlastnosti
Document.IDocumentFontUtilities
Form
Získá Acro Form dokumentu.
public Form Form { get; }
Hodnota vlastnosti
Form
HandleSignatureChange
Vyvolá výjimku, pokud bude dokument uložen se změnami a má podpis.
public bool HandleSignatureChange { get; set; }
Hodnota vlastnosti
HideMenubar
Získá nebo nastaví příznak určující, zda by měla být nabídka skryta, když je dokument aktivní.
public bool HideMenubar { get; set; }
Hodnota vlastnosti
Příklady
Příklad ukazuje, jak získat příznak HideMenubar:
Document document = new Document("sample.pdf");
bool value = document.HideMenubar;
HideToolBar
Získá nebo nastaví příznak určující, zda by měla být lišta nástrojů skryta, když je dokument aktivní.
public bool HideToolBar { get; set; }
Hodnota vlastnosti
Příklady
Příklad ukazuje, jak získat příznak HideToolBar:
Document document = new Document("sample.pdf");
bool value = document.HideToolBar;
HideWindowUI
Získá nebo nastaví příznak určující, zda by měly být prvky uživatelského rozhraní skryty, když je dokument aktivní.
public bool HideWindowUI { get; set; }
Hodnota vlastnosti
Příklady
Příklad ukazuje, jak získat příznak HideWindowUI:
Document document = new Document("sample.pdf");
bool value = document.HideWindowUI;
Id
Získá ID.
public Id Id { get; }
Hodnota vlastnosti
Id
IgnoreCorruptedObjects
Získá nebo nastaví příznak ignorování chyb ve zdrojových souborech. Když jsou stránky ze zdrojového dokumentu kopírovány do cílového dokumentu, proces kopírování je zastaven s výjimkou, pokud jsou některé objekty ve zdrojových souborech poškozené, když je tento příznak false. příklad: dest.Pages.Add(src.Pages); Pokud je tento příznak nastaven na true, pak budou poškozené objekty nahrazeny prázdnými hodnotami. Ve výchozím stavu: true.
public bool IgnoreCorruptedObjects { get; set; }
Hodnota vlastnosti
Info
Získá informace o dokumentu.
public DocumentInfo Info { get; }
Hodnota vlastnosti
DocumentInfo
IsEncrypted
Získá šifrovaný stav dokumentu. True, pokud je dokument šifrován.
public bool IsEncrypted { get; }
Hodnota vlastnosti
IsLicensed
Získá licenční stav systému. Vrací true, pokud systém funguje v licencovaném režimu, a false jinak.
public static bool IsLicensed { get; }
Hodnota vlastnosti
IsLinearized
Získá nebo nastaví hodnotu určující, zda je dokument linearizován.
public bool IsLinearized { get; set; }
Hodnota vlastnosti
IsPdfUaCompliant
Získá, zda je dokument pdfua kompatibilní.
public bool IsPdfUaCompliant { get; }
Hodnota vlastnosti
IsPdfaCompliant
Získá, zda je dokument pdfa kompatibilní.
public bool IsPdfaCompliant { get; }
Hodnota vlastnosti
IsXrefGapsAllowed
Získá nebo nastaví, zda jsou mezery v xref povoleny.
public bool IsXrefGapsAllowed { get; set; }
Hodnota vlastnosti
JavaScript
Kolekce JavaScriptu na úrovni dokumentu.
public JavaScriptCollection JavaScript { get; }
Hodnota vlastnosti
JavaScriptCollection
LogicalStructure
Získá logickou strukturu dokumentu.
public RootElement LogicalStructure { get; }
Hodnota vlastnosti
RootElement
Metadata
Metadata dokumentu. (PDF dokument může zahrnovat obecné informace, jako je název dokumentu, autor a data vytvoření a úpravy. Takové globální informace o dokumentu (na rozdíl od jeho obsahu nebo struktury) se nazývají metadata a mají za cíl pomoci při katalogizaci a vyhledávání dokumentů v externích databázích.)
public Metadata Metadata { get; }
Hodnota vlastnosti
Metadata
NamedDestinations
Kolekce pojmenovaných cílů v dokumentu.
public NamedDestinationCollection NamedDestinations { get; }
Hodnota vlastnosti
NamedDestinationCollection
NonFullScreenPageMode
Získá nebo nastaví režim stránky, který určuje, jak se má dokument zobrazit po opuštění režimu celé obrazovky.
public PageMode NonFullScreenPageMode { get; set; }
Hodnota vlastnosti
PageMode
OpenAction
Získá nebo nastaví akci prováděnou při otevírání dokumentu.
public IAppointment OpenAction { get; set; }
Hodnota vlastnosti
IAppointment
Příklady
Příklad ukazuje, jak získat příznak CenterWindow:
Document document = new Document("sample.pdf");
IAppointment value = document.OpenAction;
OptimizeSize
Získá nebo nastaví optimalizační příznak. Když jsou stránky přidány do dokumentu, stejné zdrojové streamy v výsledném souboru jsou sloučeny do jednoho PDF objektu, pokud je tento příznak nastaven. To umožňuje snížit velikost výsledného souboru, ale může způsobit pomalejší provádění a větší požadavky na paměť. Výchozí hodnota: false.
public bool OptimizeSize { get; set; }
Hodnota vlastnosti
Outlines
Získá obrysy dokumentu.
public OutlineCollection Outlines { get; }
Hodnota vlastnosti
OutlineCollection
OutputIntents
Získá kolekci výstupních záměrů v dokumentu.
public OutputIntents OutputIntents { get; }
Hodnota vlastnosti
OutputIntents
PageInfo
Získá nebo nastaví informace o stránce (pouze pro generátor, není vyplněno při čtení dokumentu).
public PageInfo PageInfo { get; set; }
Hodnota vlastnosti
PageInfo
PageLabels
Získá štítky stránek v dokumentu.
public PageLabelCollection PageLabels { get; }
Hodnota vlastnosti
PageLabelCollection
PageLayout
Získá nebo nastaví rozložení stránky, které se má použít při otevření dokumentu.
public PageLayout PageLayout { get; set; }
Hodnota vlastnosti
PageLayout
PageMode
Získá nebo nastaví režim stránky, který určuje, jak by měl být dokument zobrazen při otevření.
public PageMode PageMode { get; set; }
Hodnota vlastnosti
PageMode
Pages
Získá nebo nastaví kolekci stránek dokumentu. Poznámka: stránky jsou číslovány od 1 v kolekci.
public PageCollection Pages { get; }
Hodnota vlastnosti
PageCollection
Příklady
Příklad níže ukazuje, jak pracovat se stránkami dokumentu: Jak získat počet stránek a jak získat obdélník počáteční stránky dokumentu.
Aspose.Pdf.Document document = new Aspose.Pdf.Document("sample.pdf");
Aspose.Pdf.PageCollection pages = document.Pages;
System.Console.WriteLine("Dokument obsahuje " + pages.Count);
Page page = pages[1];
Rectangle rect = page.Rect;
PdfFormat
Získá PDF formát.
public PdfFormat PdfFormat { get; }
Hodnota vlastnosti
PdfFormat
Permissions
Získá oprávnění dokumentu.
public int Permissions { get; }
Hodnota vlastnosti
PickTrayByPdfSize
Získá nebo nastaví příznak určující, zda by měla být velikost stránky PDF použita k výběru vstupního papírového zásobníku.
public bool PickTrayByPdfSize { get; set; }
Hodnota vlastnosti
PrintScaling
Získá nebo nastaví možnost měřítka stránky, která by měla být vybrána, když je zobrazen dialog tisku pro tento dokument.
public PrintScaling PrintScaling { get; set; }
Hodnota vlastnosti
PrintScaling
TaggedContent
Získá přístup k obsahu TaggedPdf.
public ITaggedContent TaggedContent { get; }
Hodnota vlastnosti
ITaggedContent
Příklady
Příklad ukazuje, jak použít označený obsah k vytvoření nového dokumentu s hlavičkou, odstavci a obrázky.
// Vytvoření nového dokumentu
Document document = new Document();
// Získání označeného obsahu
ITaggedContent taggedContent = document.TaggedContent;
// Nastavení jazyka pro dokument
taggedContent.SetLanguage("en-US");
// Nastavení názvu pro PDF dokument
taggedContent.SetTitle("Příklad dokumentu");
// Vytvoření a přidání sekce
SectElement sect = taggedContent.CreateSectElement();
taggedContent.RootElement.AppendChild(sect);
// Vytvoření hlavičky
HeaderElement h1 = taggedContent.CreateHeaderElement(1);
h1.SetText("Hlavička");
sect.AppendChild(h1);
// Vytvoření odstavce
ParagraphElement p = taggedContent.CreateParagraphElement();
p.SetTag("Paragraph");
p.SetText("Text odstavce.");
sect.AppendChild(p);
// Vytvoření ilustrace
IllustrationElement figure1 = taggedContent.CreateFigureElement();
sect.AppendChild(figure1);
figure1.AlternativeText = "Obrázek 1";
figure1.Title = "Obrázek 1";
figure1.SetTag("Fig");
figure1.SetImage("cesta/k/obrazku.jpg");
// Uložení dokumentu
document.Save("example.pdf");
Version
Získá verzi PDF z hlavičky PDF souboru.
public string Version { get; }
Hodnota vlastnosti
Metody
BindXml(string)
Připojí XML k dokumentu.
public void BindXml(string file)
Parametry
file
string
XML soubor.
BindXml(string, string)
Připojí XML/XSL k dokumentu.
public void BindXml(string xmlFile, string xslFile)
Parametry
xmlFile
string
XML soubor.
xslFile
string
XSL soubor, pokud je použito XSLT.
BindXml(Stream, Stream)
Připojí XML/XSL k dokumentu.
public void BindXml(Stream xmlStream, Stream xslStream)
Parametry
xmlStream
Stream
XML stream.
xslStream
Stream
XSL stream, pokud je použito XSLT.
BindXml(Stream, Stream, XmlReaderSettings)
Připojí XML/XSL k dokumentu.
public void BindXml(Stream xmlStream, Stream xslStream, XmlReaderSettings settings)
Parametry
xmlStream
Stream
XML stream.
xslStream
Stream
XSL stream, pokud je použito XSLT.
settings
XmlReaderSettings
Nastavení XML čtečky.
BindXml(Stream)
Připojí XML k dokumentu.
public void BindXml(Stream stream)
Parametry
stream
Stream
XML stream.
ChangePasswords(string, string, string)
Změní hesla dokumentu. Tato akce může být provedena pouze pomocí vlastnického hesla.
public void ChangePasswords(string ownerPassword, string newUserPassword, string newOwnerPassword)
Parametry
ownerPassword
string
Vlastnické heslo.
newUserPassword
string
Nové uživatelské heslo.
newOwnerPassword
string
Nové vlastnické heslo.
Check(bool)
Validuje dokument.
public bool Check(bool doRepair)
Parametry
doRepair
bool
Pokud je true, nalezené problémy budou opraveny.
Vrací
True - pokud byl dokument opraven; jinak false.
Convert(string, PdfFormat, ConvertErrorAction, ConvertTransparencyAction)
Převede dokument a uloží chyby do určeného souboru.
public bool Convert(string outputLogFileName, PdfFormat format, ConvertErrorAction action, ConvertTransparencyAction transparencyAction)
Parametry
outputLogFileName
string
Cesta k souboru, kde budou uloženy komentáře.
format
PdfFormat
PDF formát.
action
ConvertErrorAction
Akce pro objekty, které nelze převést.
transparencyAction
ConvertTransparencyAction
Akce pro objekty s maskovanými obrázky.
Vrací
Výsledek operace.
Convert(Stream, PdfFormat, ConvertErrorAction, ConvertTransparencyAction)
Převede dokument a uloží chyby do určeného souboru.
public bool Convert(Stream outputLogStream, PdfFormat format, ConvertErrorAction action, ConvertTransparencyAction transparencyAction)
Parametry
outputLogStream
Stream
Stream, kde budou uloženy komentáře.
format
PdfFormat
PDF formát.
action
ConvertErrorAction
Akce pro objekty, které nelze převést.
transparencyAction
ConvertTransparencyAction
Akce pro objekty s maskovanými obrázky.
Vrací
Výsledek operace.
Convert(string, PdfFormat, ConvertErrorAction)
Převede dokument a uloží chyby do určeného souboru.
public bool Convert(string outputLogFileName, PdfFormat format, ConvertErrorAction action)
Parametry
outputLogFileName
string
Cesta k souboru, kde budou uloženy komentáře.
format
PdfFormat
PDF formát.
action
ConvertErrorAction
Akce pro objekty, které nelze převést.
Vrací
Výsledek operace.
Convert(PdfFormatConversionOptions)
Převede dokument pomocí zadaných možností převodu.
public bool Convert(PdfFormatConversionOptions options)
Parametry
options
PdfFormatConversionOptions
Sada možností pro převod PDF dokumentu.
Vrací
Výsledek operace.
Convert(CallBackGetHocrWithPage, bool)
Rozpozná obrázky uvnitř dokumentu a přidá nad ně hocr řetězce.
public bool Convert(Document.CallBackGetHocrWithPage callback, bool flattenImages = false)
Parametry
callback
Document.CallBackGetHocrWithPage
Akce pro obrázky, které budou zpracovány pomocí hocr rozpoznávání.
flattenImages
bool
Text v PDF obrázcích může být malován pomocí mechaniky masek, v takovém případě musí být obrázky zploštěny.
Vrací
Výsledek operace. Pokud v dokumentu nejsou žádné obrázky, vrátí false.
Convert(CallBackGetHocr, bool)
Rozpozná obrázky uvnitř dokumentu a přidá nad ně hocr řetězce.
public bool Convert(Document.CallBackGetHocr callback, bool flattenImages = false)
Parametry
callback
Document.CallBackGetHocr
Akce pro obrázky, které budou zpracovány pomocí hocr rozpoznávání.
flattenImages
bool
Text v PDF obrázcích může být malován pomocí mechaniky masek, v takovém případě musí být obrázky zploštěny.
Vrací
Výsledek operace. Pokud v dokumentu nejsou žádné obrázky, vrátí false.
Convert(Stream, PdfFormat, ConvertErrorAction)
Převede dokument a uloží chyby do určeného streamu.
public bool Convert(Stream outputLogStream, PdfFormat format, ConvertErrorAction action)
Parametry
outputLogStream
Stream
Stream, kde budou uloženy komentáře.
format
PdfFormat
PDF formát.
action
ConvertErrorAction
Akce pro objekty, které nelze převést.
Vrací
Výsledek operace.
Convert(Fixup, Stream, bool, object[])
Převede dokument použitím Fixupu.
public bool Convert(Fixup fixup, Stream outputLog, bool onlyValidation = false, object[] parameters = null)
Parametry
fixup
Fixup
Typ Fixupu.
outputLog
Stream
Protokol procesu.
onlyValidation
bool
Pouze validace dokumentu.
parameters
object[]
Vlastnosti pro Fixup, které nelze nastavit.
Vrací
Výsledek operace.
Convert(Fixup, string, bool, object[])
Převede dokument použitím Fixupu.
public bool Convert(Fixup fixup, string outputLog, bool onlyValidation = false, object[] parameters = null)
Parametry
fixup
Fixup
Typ Fixupu.
outputLog
string
Protokol procesu.
onlyValidation
bool
Pouze validace dokumentu.
parameters
object[]
Vlastnosti pro Fixup, které nelze nastavit.
Vrací
Výsledek operace.
Convert(string, LoadOptions, string, SaveOptions)
Převede zdrojový soubor ve zdrojovém formátu do cílového souboru v cílovém formátu.
public static void Convert(string srcFileName, LoadOptions loadOptions, string dstFileName, SaveOptions saveOptions)
Parametry
srcFileName
string
Název zdrojového souboru.
loadOptions
LoadOptions
Formát zdrojového souboru.
dstFileName
string
Název cílového souboru.
saveOptions
SaveOptions
Formát cílového souboru.
Convert(Stream, LoadOptions, string, SaveOptions)
Převede stream ve zdrojovém formátu do cílového souboru v cílovém formátu.
public static void Convert(Stream srcStream, LoadOptions loadOptions, string dstFileName, SaveOptions saveOptions)
Parametry
srcStream
Stream
Zdrojový stream.
loadOptions
LoadOptions
Formát zdrojového streamu.
dstFileName
string
Název cílového souboru.
saveOptions
SaveOptions
Formát cílového souboru.
Convert(string, LoadOptions, Stream, SaveOptions)
Převede zdrojový soubor ve zdrojovém formátu do streamu v cílovém formátu.
public static void Convert(string srcFileName, LoadOptions loadOptions, Stream dstStream, SaveOptions saveOptions)
Parametry
srcFileName
string
Název zdrojového souboru.
loadOptions
LoadOptions
Formát zdrojového souboru.
dstStream
Stream
Cílový stream.
saveOptions
SaveOptions
Formát cílového streamu.
Convert(Stream, LoadOptions, Stream, SaveOptions)
Převede stream ve zdrojovém formátu do streamu v cílovém formátu.
public static void Convert(Stream srcStream, LoadOptions loadOptions, Stream dstStream, SaveOptions saveOptions)
Parametry
srcStream
Stream
Zdrojový stream.
loadOptions
LoadOptions
Formát zdrojového streamu.
dstStream
Stream
Cílový stream.
saveOptions
SaveOptions
Formát cílového souboru.
ConvertPageToPNGMemoryStream(Page)
Převede stránku na PNG pro DSR, OMR, OCR obrazový stream.
public MemoryStream ConvertPageToPNGMemoryStream(Page page)
Parametry
page
Page
Stránka k převodu.
Vrací
Obrazový stream.
Decrypt()
Dešifruje dokument. Poté zavolejte Save, abyste získali dešifrovanou verzi dokumentu.
public void Decrypt()
Dispose()
Uzavře všechny prostředky používané tímto dokumentem.
public void Dispose()
Encrypt(string, string, DocumentPrivilege, CryptoAlgorithm, bool)
Šifruje dokument. Poté zavolejte Save, abyste získali šifrovanou verzi dokumentu.
public void Encrypt(string userPassword, string ownerPassword, DocumentPrivilege privileges, CryptoAlgorithm cryptoAlgorithm, bool usePdf20)
Parametry
userPassword
string
Uživatelské heslo.
ownerPassword
string
Vlastnické heslo.
privileges
DocumentPrivilege
Oprávnění dokumentu, viz Aspose.Pdf.Document.Permissions pro podrobnosti.
cryptoAlgorithm
CryptoAlgorithm
Kryptografický algoritmus, viz Aspose.Pdf.Document.CryptoAlgorithm pro detaily.
usePdf20
bool
Podpora revize 6 (Rozšíření 8).
Encrypt(string, string, Permissions, CryptoAlgorithm)
Šifruje dokument. Poté zavolejte Save, abyste získali šifrovanou verzi dokumentu.
public void Encrypt(string userPassword, string ownerPassword, Permissions permissions, CryptoAlgorithm cryptoAlgorithm)
Parametry
userPassword
string
Uživatelské heslo.
ownerPassword
string
Vlastnické heslo.
permissions
Permissions
Oprávnění dokumentu, viz Aspose.Pdf.Document.Permissions pro podrobnosti.
cryptoAlgorithm
CryptoAlgorithm
Kryptografický algoritmus, viz Aspose.Pdf.Document.CryptoAlgorithm pro detaily.
Encrypt(string, string, Permissions, CryptoAlgorithm, bool)
Šifruje dokument. Poté zavolejte Save, abyste získali šifrovanou verzi dokumentu.
public void Encrypt(string userPassword, string ownerPassword, Permissions permissions, CryptoAlgorithm cryptoAlgorithm, bool usePdf20)
Parametry
userPassword
string
Uživatelské heslo.
ownerPassword
string
Vlastnické heslo.
permissions
Permissions
Oprávnění dokumentu, viz Aspose.Pdf.Document.Permissions pro podrobnosti.
cryptoAlgorithm
CryptoAlgorithm
Kryptografický algoritmus, viz Aspose.Pdf.Document.CryptoAlgorithm pro detaily.
usePdf20
bool
Podpora revize 6 (Rozšíření 8).
ExportAnnotationsToXfdf(string)
Exportuje všechny anotace dokumentu do XFDF souboru.
public void ExportAnnotationsToXfdf(string fileName)
Parametry
fileName
string
Název XFDF souboru.
ExportAnnotationsToXfdf(Stream)
Exportuje všechny anotace dokumentu do streamu.
public void ExportAnnotationsToXfdf(Stream stream)
Parametry
stream
Stream
Stream, kde budou uloženy XFDF.
Flatten()
Odstraní všechna pole z dokumentu a umístí jejich hodnoty místo toho.
public void Flatten()
Flatten(FlattenSettings)
Odstraní všechna pole (a anotace) z dokumentu a umístí jejich hodnoty místo toho.
public void Flatten(Form.FlattenSettings flattenSettings)
Parametry
flattenSettings
Form.FlattenSettings
Nastavení pro proces zploštění.
FlattenTransparency()
Nahrazuje transparentní obsah netransparentními rastrovými a vektorovými grafikami.
public void FlattenTransparency()
FreeMemory()
Vyčistí paměť.
public void FreeMemory()
GetCatalogValue(string)
Vrátí hodnotu položky z katalogového slovníku.
public object GetCatalogValue(string key)
Parametry
key
string
Klíč položky.
Vrací
Hodnota položky - pokud byl klíč úspěšně nalezen; jinak null.
GetObjectById(string)
Získá objekt se zadaným ID v dokumentu.
public object GetObjectById(string id)
Parametry
id
string
ID objektu.
Vrací
Objekt se zadaným ID. Null, pokud ID nebylo nalezeno.
GetXmpMetadata(Stream)
Získá XMP metadata z dokumentu.
public void GetXmpMetadata(Stream stream)
Parametry
stream
Stream
Stream, kde budou uložena metadata.
HasIncrementalUpdate()
Kontroluje, zda byl aktuální PDF dokument uložen s inkrementálními aktualizacemi.
public bool HasIncrementalUpdate()
Vrací
true
, pokud PDF dokument má inkrementální aktualizace; jinak false
.
ImportAnnotationsFromXfdf(string)
Importuje anotace z XFDF souboru do dokumentu.
public void ImportAnnotationsFromXfdf(string fileName)
Parametry
fileName
string
Název XFDF souboru.
ImportAnnotationsFromXfdf(Stream)
Importuje anotace ze streamu do dokumentu.
public void ImportAnnotationsFromXfdf(Stream stream)
Parametry
stream
Stream
Stream obsahující XFDF data.
LoadFrom(string, LoadOptions)
Načte soubor, převádějící ho na PDF.
public void LoadFrom(string filename, LoadOptions options)
Parametry
filename
string
Cesta k souboru, který se má otevřít.
options
LoadOptions
Možnosti načítání.
Výjimky
PdfException
Pokud nelze soubor načíst.
Pokud soubor nebyl nalezen.
Merge(MergeOptions, params Document[])
Spojí dokumenty.
public void Merge(Document.MergeOptions mergeOptions, params Document[] documents)
Parametry
mergeOptions
Document.MergeOptions
Možnosti sloučení.
documents
Document[]
Dokumenty k sloučení.
Merge(MergeOptions, params string[])
Spojí dokumenty.
public void Merge(Document.MergeOptions mergeOptions, params string[] files)
Parametry
mergeOptions
Document.MergeOptions
Možnosti sloučení.
files
string[]
PDF soubory k sloučení.
Merge(params Document[])
Spojí dokumenty.
public void Merge(params Document[] documents)
Parametry
documents
Document[]
Dokumenty k sloučení.
Merge(params string[])
Spojí PDF soubory.
public void Merge(params string[] files)
Parametry
files
string[]
PDF soubory k sloučení.
MergeDocuments(MergeOptions, params string[])
Spojí dokumenty.
public static Document MergeDocuments(Document.MergeOptions mergeOptions, params string[] files)
Parametry
mergeOptions
Document.MergeOptions
Možnosti sloučení.
files
string[]
PDF soubory k sloučení.
Vrací
Sloučený dokument.
MergeDocuments(MergeOptions, params Document[])
Spojí dokumenty.
public static Document MergeDocuments(Document.MergeOptions mergeOptions, params Document[] files)
Parametry
mergeOptions
Document.MergeOptions
files
Document[]
Dokumenty k sloučení.
Vrací
Sloučený dokument.
MergeDocuments(params string[])
Spojí PDF soubory.
public static Document MergeDocuments(params string[] files)
Parametry
files
string[]
PDF soubory k sloučení.
Vrací
Sloučený dokument.
MergeDocuments(params Document[])
Spojí dokumenty.
public static Document MergeDocuments(params Document[] documents)
Parametry
documents
Document[]
Dokumenty k sloučení.
Vrací
Sloučený dokument.
Optimize()
Linearizuje dokument, aby
- otevřel první stránku co nejrychleji;
- zobrazil další stránku nebo následoval odkaz na další stránku co nejrychleji;
- zobrazil stránku inkrementálně, jakmile data pro stránku dorazí přes pomalý kanál (zobrazit nejvíce užitečná data jako první);
- umožnil uživatelskou interakci, jako je následování odkazu, provádět i před tím, než byla celá stránka přijata a zobrazena. Vyvolání této metody vlastně dokument neukládá. Naopak, dokument je pouze připraven mít optimalizovanou strukturu, poté zavolejte Save, abyste získali optimalizovaný dokument.
public void Optimize()
OptimizeResources()
Optimalizuje prostředky v dokumentu:
- Pro prostředky, které se nepoužívají na stránkách dokumentu, jsou odstraněny;
- Stejné prostředky jsou spojeny do jednoho objektu;
- Nepoužívané objekty jsou smazány.
public void OptimizeResources()
OptimizeResources(OptimizationOptions)
Optimalizuje prostředky v dokumentu podle definované optimalizační strategie.
public void OptimizeResources(OptimizationOptions strategy)
Parametry
strategy
OptimizationOptions
Optimalizační strategie.
PageNodesToBalancedTree(byte)
Organizuje uzly stránek v dokumentu do vyváženého stromu. Pouze pokud dokument má více než nodesNumInSubtrees objektů stránek, jinak nedělá nic. Nehledejte tuto metodu při iteraci přes prvky Pages, může to dát nepředvídatelné výsledky.
public void PageNodesToBalancedTree(byte nodesNumInSubtrees = 10)
Parametry
nodesNumInSubtrees
byte
Požadovaný počet poduzlů. Výchozí hodnota je deset.
ProcessParagraphs()
Zpracovává odstavce pro generátor.
public void ProcessParagraphs()
RemoveMetadata()
Odstraní metadata z dokumentu.
public void RemoveMetadata()
RemovePdfUaCompliance()
Odstraní pdfUa shodu z dokumentu.
public void RemovePdfUaCompliance()
RemovePdfaCompliance()
Odstraní pdfa shodu z dokumentu.
public void RemovePdfaCompliance()
Repair()
Opravy poškozeného dokumentu.
public void Repair()
Save(Stream)
Uloží dokument do streamu.
public void Save(Stream output)
Parametry
output
Stream
Stream, kde bude dokument uložen.
Save(string)
Uloží dokument do určeného souboru.
public void Save(string outputFileName)
Parametry
outputFileName
string
Cesta k souboru, kde bude dokument uložen.
Save()
Uloží dokument inkrementálně (tj. pomocí techniky inkrementální aktualizace).
public void Save()
Poznámky
Abychom uložili dokument inkrementálně, musíme otevřít soubor dokumentu pro zápis. Proto musí být dokument inicializován s zapisovatelným streamem, jako v následujícím úryvku kódu: Document doc = new Document(new FileStream(“document.pdf”, FileMode.Open, FileAccess.ReadWrite)); // proveďte nějaké změny a uložte dokument inkrementálně doc.Save();
Save(SaveOptions)
Uloží dokument s možnostmi ukládání.
public void Save(SaveOptions options)
Parametry
options
SaveOptions
Možnosti ukládání.
Save(string, SaveFormat)
Uloží dokument s novým názvem spolu s formátem souboru.
public void Save(string outputFileName, SaveFormat format)
Parametry
outputFileName
string
Cesta k souboru, kde bude dokument uložen.
format
SaveFormat
Možnosti formátu.
Save(Stream, SaveFormat)
Uloží dokument s novým názvem spolu s formátem souboru.
public void Save(Stream outputStream, SaveFormat format)
Parametry
outputStream
Stream
Stream, kde bude dokument uložen.
format
SaveFormat
Možnosti formátu.
Výjimky
System.ArgumentException, když je Aspose.Pdf.HtmlSaveOptions předán metodě. Uložení dokumentu do HTML streamu není podporováno. Použijte prosím metodu uložení do souboru.
Save(string, SaveOptions)
Uloží dokument s novým názvem nastavením jeho možností ukládání.
public void Save(string outputFileName, SaveOptions options)
Parametry
outputFileName
string
Cesta k souboru, kde bude dokument uložen.
options
SaveOptions
Možnosti ukládání.
Save(Stream, SaveOptions)
Uloží dokument do streamu s možnostmi ukládání.
public void Save(Stream outputStream, SaveOptions options)
Parametry
outputStream
Stream
Stream, kde bude dokument uložen.
options
SaveOptions
Možnosti ukládání.
Výjimky
System.ArgumentException, když je Aspose.Pdf.HtmlSaveOptions předán metodě. Uložení dokumentu do HTML streamu není podporováno. Použijte prosím metodu uložení do souboru.
SaveAsync(Stream, CancellationToken)
Uloží dokument do streamu.
public Task SaveAsync(Stream output, CancellationToken cancellationToken)
Parametry
output
Stream
Stream, kde bude dokument uložen.
cancellationToken
CancellationToken
Token pro zrušení.
Vrací
Asynchronní úkol.
SaveAsync(string, CancellationToken)
Uloží dokument do určeného souboru.
public Task SaveAsync(string outputFileName, CancellationToken cancellationToken)
Parametry
outputFileName
string
Cesta k souboru, kde bude dokument uložen.
cancellationToken
CancellationToken
Token pro zrušení.
Vrací
Asynchronní úkol.
SaveAsync(CancellationToken)
Uloží dokument inkrementálně (tj. pomocí techniky inkrementální aktualizace).
public Task SaveAsync(CancellationToken cancellationToken)
Parametry
cancellationToken
CancellationToken
Token pro zrušení.
Vrací
Asynchronní úkol.
Poznámky
Abychom uložili dokument inkrementálně, musíme otevřít soubor dokumentu pro zápis. Proto musí být dokument inicializován s zapisovatelným streamem, jako v následujícím úryvku kódu: Document doc = new Document(new FileStream(“document.pdf”, FileMode.Open, FileAccess.ReadWrite)); // proveďte nějaké změny a uložte dokument inkrementálně doc.Save();
SaveAsync(SaveOptions, CancellationToken)
Uloží dokument s možnostmi ukládání.
public Task SaveAsync(SaveOptions options, CancellationToken cancellationToken)
Parametry
options
SaveOptions
Možnosti ukládání.
cancellationToken
CancellationToken
Token pro zrušení.
Vrací
Asynchronní úkol.
SaveAsync(string, SaveFormat, CancellationToken)
Uloží dokument s novým názvem spolu s formátem souboru.
public Task SaveAsync(string outputFileName, SaveFormat format, CancellationToken cancellationToken)
Parametry
outputFileName
string
Cesta k souboru, kde bude dokument uložen.
format
SaveFormat
Možnosti formátu.
cancellationToken
CancellationToken
Token pro zrušení.
Vrací
Asynchronní úkol.
SaveAsync(Stream, SaveFormat, CancellationToken)
Uloží dokument s novým názvem spolu s formátem souboru.
public Task SaveAsync(Stream outputStream, SaveFormat format, CancellationToken cancellationToken)
Parametry
outputStream
Stream
Stream, kde bude dokument uložen.
format
SaveFormat
Možnosti formátu.
cancellationToken
CancellationToken
Token pro zrušení.
Vrací
Asynchronní úkol.
Výjimky
System.ArgumentException, když je Aspose.Pdf.HtmlSaveOptions předán metodě. Uložení dokumentu do HTML streamu není podporováno. Pou