Class Document

Class Document

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

Klasa reprezentująca dokument PDF

public sealed class Document : IDisposable

Dziedziczenie

objectDocument

Implementuje

IDisposable

Członkowie dziedziczeni

object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Konstruktory

Document(Stream)

Inicjalizuje nową instancję Document z strumienia input.

public Document(Stream input)

Parametry

input Stream

Strumień z dokumentem pdf.

Document(Stream, string, bool)

Inicjalizuje nową instancję Document z strumienia input.

public Document(Stream input, string password, bool isManagedStream)

Parametry

input Stream

Strumień z dokumentem pdf.

password string

Hasło użytkownika lub właściciela.

isManagedStream bool

Jeśli ustawione na true, wewnętrzny strumień jest zamykany przed wyjściem; w przeciwnym razie nie jest.

Document(Stream, bool)

Inicjalizuje nową instancję Document z strumienia input.

public Document(Stream input, bool isManagedStream)

Parametry

input Stream

Strumień z dokumentem pdf.

isManagedStream bool

Jeśli ustawione na true, wewnętrzny strumień jest zamykany przed wyjściem; w przeciwnym razie nie jest.

Document(string)

Inicjalizuje Document używając filename. To samo co Aspose.Pdf.Document.#ctor(System.IO.Stream).

public Document(string filename)

Parametry

filename string

Nazwa pliku dokumentu pdf.

Document(Stream, string)

Inicjalizuje nową instancję Document z strumienia input.

public Document(Stream input, string password)

Parametry

input Stream

Obiekt strumienia wejściowego, odpowiadający pdf, jest chroniony hasłem.

password string

Hasło użytkownika lub właściciela.

Document()

Inicjalizuje pusty dokument.

public Document()

Document(string, string)

Inicjalizuje nową instancję klasy Aspose.Pdf.Document do pracy z zaszyfrowanym dokumentem.

public Document(string filename, string password)

Parametry

filename string

Nazwa pliku dokumentu.

password string

Hasło użytkownika lub właściciela.

Document(string, string, bool)

Inicjalizuje nową instancję klasy Aspose.Pdf.Document do pracy z zaszyfrowanym dokumentem.

public Document(string filename, string password, bool isManagedStream)

Parametry

filename string

Nazwa pliku dokumentu.

password string

Hasło użytkownika lub właściciela.

isManagedStream bool

Jeśli ustawione na true, wewnętrzny strumień jest zamykany przed wyjściem; w przeciwnym razie nie jest.

Document(string, LoadOptions)

Otwiera istniejący dokument z pliku, dostarczając niezbędne opcje konwersji, aby uzyskać dokument pdf.

public Document(string filename, LoadOptions options)

Parametry

filename string

Plik wejściowy do konwersji na dokument pdf.

options LoadOptions

Reprezentuje właściwości do konwersji filename na dokument pdf.

Document(Stream, LoadOptions)

Otwiera istniejący dokument z strumienia, dostarczając niezbędne opcje konwersji, aby uzyskać dokument pdf.

public Document(Stream input, LoadOptions options)

Parametry

input Stream

Strumień wejściowy do konwersji na dokument pdf.

options LoadOptions

Reprezentuje właściwości do konwersji input na dokument pdf.

Pola

DefaultNodesNumInSubtrees

public const byte DefaultNodesNumInSubtrees = 10

Wartość pola

byte

Właściwości

Actions

Pobiera akcje dokumentu. Ta właściwość jest instancją klasy DocumentActions, która pozwala na uzyskanie/ustawienie akcji BeforClosing, BeforSaving itd.

public DocumentActionCollection Actions { get; }

Wartość właściwości

DocumentActionCollection

Przykłady

Ten przykład demonstruje, jak uzyskać akcję po otwarciu 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

Pozwala na łączenie zawartości stron, aby zoptymalizować rozmiar dokumentu. Jeśli używane, to różne, ale zduplikowane strony mogą odnosić się do tego samego obiektu zawartości. Należy pamiętać, że ten tryb może powodować skutki uboczne, takie jak zmiana zawartości strony, gdy inna strona jest zmieniana.

public bool AllowReusePageContent { get; set; }

Wartość właściwości

bool

Background

Pobiera lub ustawia kolor tła dokumentu.

public Color Background { get; set; }

Wartość właściwości

Color

CenterWindow

Pobiera lub ustawia flagę określającą, czy pozycja okna dokumentu ma być wyśrodkowana na ekranie.

public bool CenterWindow { get; set; }

Wartość właściwości

bool

Przykłady

Przykład demonstruje, jak uzyskać flagę CenterWindow:

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

Collection

Pobiera kolekcję dokumentów.

public Collection Collection { get; set; }

Wartość właściwości

Collection

CryptoAlgorithm

Pobiera ustawienia zabezpieczeń, jeśli dokument jest zaszyfrowany. Jeśli dokument nie jest zaszyfrowany, to odpowiedni wyjątek zostanie zgłoszony w .net 1.1 lub CryptoAlgorithm będzie nullem dla innych wersji .net.

public CryptoAlgorithm? CryptoAlgorithm { get; }

Wartość właściwości

CryptoAlgorithm?

Destinations

Pobiera kolekcję miejsc docelowych. Przestarzałe. Proszę użyć NamedDestinations.

public DestinationCollection Destinations { get; }

Wartość właściwości

DestinationCollection

Direction

Pobiera lub ustawia kolejność odczytu tekstu: L2R (lewo do prawo) lub R2L (prawo do lewo).

public Direction Direction { get; set; }

Wartość właściwości

Direction

DisableFontLicenseVerifications

Wiele operacji z czcionkami nie może być wykonywanych, jeśli te operacje są zabronione przez licencję tej czcionki. Na przykład niektóre czcionki nie mogą być osadzone w dokumencie PDF, jeśli zasady licencji wyłączają osadzanie dla tej czcionki. Ta flaga jest używana do wyłączenia wszelkich ograniczeń licencyjnych dla wszystkich czcionek w bieżącym dokumencie PDF. Bądź ostrożny przy używaniu tej flagi. Gdy jest ustawiona, oznacza to, że osoba, która ustawia tę flagę, bierze na siebie pełną odpowiedzialność za możliwe naruszenia licencji/prawa. Zatem bierze to na własne ryzyko. Zdecydowanie zaleca się używanie tej flagi tylko wtedy, gdy jesteś całkowicie pewny, że nie łamiesz prawa autorskiego. Domyślnie false.

public bool DisableFontLicenseVerifications { get; set; }

Wartość właściwości

bool

DisplayDocTitle

Pobiera lub ustawia flagę określającą, czy pasek tytułowy okna dokumentu powinien wyświetlać tytuł dokumentu.

public bool DisplayDocTitle { get; set; }

Wartość właściwości

bool

Przykłady

Przykład demonstruje, jak uzyskać flagę DisplayDocTitle:

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

Duplex

Pobiera lub ustawia opcję obsługi trybu druku duplex, która ma być używana podczas drukowania pliku z dialogu drukowania.

public PrintDuplex Duplex { get; set; }

Wartość właściwości

PrintDuplex

EmbedStandardFonts

Właściwość, która deklaruje, że dokument musi osadzić wszystkie standardowe czcionki Type1, które mają flagę IsEmbedded ustawioną na true. Wszystkie czcionki PDF mogą być osadzone w dokumencie po prostu przez ustawienie flagi IsEmbedded na true, ale standardowe czcionki Type1 są wyjątkiem od tej zasady. Osadzenie standardowej czcionki Type1 wymaga dużo czasu, więc aby osadzić te czcionki, konieczne jest nie tylko ustawienie flagi IsEmbedded na true dla określonej czcionki, ale także ustawienie dodatkowej flagi na poziomie dokumentu - EmbedStandardFonts = true; Ta właściwość może być ustawiona tylko raz dla wszystkich czcionek. Domyślnie false.

public bool EmbedStandardFonts { get; set; }

Wartość właściwości

bool

EmbeddedFiles

Pobiera kolekcję plików osadzonych w dokumencie.

public EmbeddedFileCollection EmbeddedFiles { get; }

Wartość właściwości

EmbeddedFileCollection

EnableObjectUnload

Pobiera lub ustawia flagę, która umożliwia częściowe usunięcie dokumentu z pamięci. To pozwala na zmniejszenie zużycia pamięci, ale może mieć negatywny wpływ na wydajność.

public bool EnableObjectUnload { get; set; }

Wartość właściwości

bool

EnableSignatureSanitization

Pobiera lub ustawia flagę do zarządzania sanitacją pól podpisów. Włączone domyślnie.

public bool EnableSignatureSanitization { get; set; }

Wartość właściwości

bool

FileName

Nazwa pliku PDF, który spowodował ten dokument.

public string FileName { get; }

Wartość właściwości

string

FitWindow

Pobiera lub ustawia flagę określającą, czy okno dokumentu ma być zmieniane, aby dopasować pierwszą wyświetlaną stronę.

public bool FitWindow { get; set; }

Wartość właściwości

bool

Przykłady

Przykład demonstruje, jak uzyskać flagę FitWindow:

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

FontUtilities

Instancja IDocumentFontUtilities

public Document.IDocumentFontUtilities FontUtilities { get; }

Wartość właściwości

Document.IDocumentFontUtilities

Form

Pobiera formularz Acro dokumentu.

public Form Form { get; }

Wartość właściwości

Form

HandleSignatureChange

Zgłasza wyjątek, jeśli dokument będzie zapisywany ze zmianami i ma podpis.

public bool HandleSignatureChange { get; set; }

Wartość właściwości

bool

HideMenubar

Pobiera lub ustawia flagę określającą, czy pasek menu powinien być ukryty, gdy dokument jest aktywny.

public bool HideMenubar { get; set; }

Wartość właściwości

bool

Przykłady

Przykład demonstruje, jak uzyskać flagę HideMenubar:

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

HideToolBar

Pobiera lub ustawia flagę określającą, czy pasek narzędzi powinien być ukryty, gdy dokument jest aktywny.

public bool HideToolBar { get; set; }

Wartość właściwości

bool

Przykłady

Przykład demonstruje, jak uzyskać flagę HideToolBar:

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

HideWindowUI

Pobiera lub ustawia flagę określającą, czy elementy interfejsu użytkownika powinny być ukryte, gdy dokument jest aktywny.

public bool HideWindowUI { get; set; }

Wartość właściwości

bool

Przykłady

Przykład demonstruje, jak uzyskać flagę HideWindowUI:

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

Id

Pobiera ID.

public Id Id { get; }

Wartość właściwości

Id

IgnoreCorruptedObjects

Pobiera lub ustawia flagę ignorowania błędów w plikach źródłowych. Gdy strony z dokumentu źródłowego są kopiowane do dokumentu docelowego, proces kopiowania jest zatrzymywany z wyjątkiem, jeśli niektóre obiekty w plikach źródłowych są uszkodzone, gdy ta flaga jest fałszywa. Przykład: dest.Pages.Add(src.Pages); Jeśli ta flaga jest ustawiona na true, uszkodzone obiekty zostaną zastąpione pustymi wartościami. Domyślnie: true.

public bool IgnoreCorruptedObjects { get; set; }

Wartość właściwości

bool

Info

Pobiera informacje o dokumencie.

public DocumentInfo Info { get; }

Wartość właściwości

DocumentInfo

IsEncrypted

Pobiera status szyfrowania dokumentu. True, jeśli dokument jest zaszyfrowany.

public bool IsEncrypted { get; }

Wartość właściwości

bool

IsLicensed

Pobiera stan licencji systemu. Zwraca true, jeśli system działa w trybie licencjonowanym, a false w przeciwnym razie.

public static bool IsLicensed { get; }

Wartość właściwości

bool

IsLinearized

Pobiera lub ustawia wartość wskazującą, czy dokument jest zlinearizowany.

public bool IsLinearized { get; set; }

Wartość właściwości

bool

IsPdfUaCompliant

Pobiera, czy dokument jest zgodny z pdfua.

public bool IsPdfUaCompliant { get; }

Wartość właściwości

bool

IsPdfaCompliant

Pobiera, czy dokument jest zgodny z pdfa.

public bool IsPdfaCompliant { get; }

Wartość właściwości

bool

IsXrefGapsAllowed

Pobiera lub ustawia, czy dokument jest zgodny z pdfa.

public bool IsXrefGapsAllowed { get; set; }

Wartość właściwości

bool

JavaScript

Kolekcja JavaScript na poziomie dokumentu.

public JavaScriptCollection JavaScript { get; }

Wartość właściwości

JavaScriptCollection

LogicalStructure

Pobiera logiczną strukturę dokumentu.

public RootElement LogicalStructure { get; }

Wartość właściwości

RootElement

Metadata

Metadane dokumentu. (Dokument PDF może zawierać ogólne informacje, takie jak tytuł dokumentu, autor oraz daty utworzenia i modyfikacji. Takie globalne informacje o dokumencie (w przeciwieństwie do jego treści lub struktury) nazywane są metadanymi i mają na celu pomoc w katalogowaniu i wyszukiwaniu dokumentów w zewnętrznych bazach danych.)

public Metadata Metadata { get; }

Wartość właściwości

Metadata

NamedDestinations

Kolekcja nazwanych miejsc docelowych w dokumencie.

public NamedDestinationCollection NamedDestinations { get; }

Wartość właściwości

NamedDestinationCollection

NonFullScreenPageMode

Pobiera lub ustawia tryb strony, określając, jak wyświetlać dokument po wyjściu z trybu pełnoekranowego.

public PageMode NonFullScreenPageMode { get; set; }

Wartość właściwości

PageMode

OpenAction

Pobiera lub ustawia akcję wykonaną przy otwieraniu dokumentu.

public IAppointment OpenAction { get; set; }

Wartość właściwości

IAppointment

Przykłady

Przykład demonstruje, jak uzyskać flagę CenterWindow:

Document document = new Document("sample.pdf");
IAppointment value = document.OpenAction;

OptimizeSize

Pobiera lub ustawia flagę optymalizacji. Gdy strony są dodawane do dokumentu, równe strumienie zasobów w rezultacie pliku są łączone w jeden obiekt PDF, jeśli ta flaga jest ustawiona. To pozwala na zmniejszenie rozmiaru rezultatu pliku, ale może powodować wolniejsze wykonanie i większe wymagania pamięci. Wartość domyślna: false.

public bool OptimizeSize { get; set; }

Wartość właściwości

bool

Outlines

Pobiera zarysy dokumentu.

public OutlineCollection Outlines { get; }

Wartość właściwości

OutlineCollection

OutputIntents

Pobiera kolekcję intencji wyjściowych w dokumencie.

public OutputIntents OutputIntents { get; }

Wartość właściwości

OutputIntents

PageInfo

Pobiera lub ustawia informacje o stronie (tylko dla generatora, nie wypełniane podczas odczytu dokumentu).

public PageInfo PageInfo { get; set; }

Wartość właściwości

PageInfo

PageLabels

Pobiera etykiety stron w dokumencie.

public PageLabelCollection PageLabels { get; }

Wartość właściwości

PageLabelCollection

PageLayout

Pobiera lub ustawia układ strony, który ma być używany po otwarciu dokumentu.

public PageLayout PageLayout { get; set; }

Wartość właściwości

PageLayout

PageMode

Pobiera lub ustawia tryb strony, określając, jak dokument powinien być wyświetlany po otwarciu.

public PageMode PageMode { get; set; }

Wartość właściwości

PageMode

Pages

Pobiera lub ustawia kolekcję stron dokumentu. Należy pamiętać, że strony są numerowane od 1 w kolekcji.

public PageCollection Pages { get; }

Wartość właściwości

PageCollection

Przykłady

Przykład poniżej demonstruje, jak operować na stronach dokumentu: Jak uzyskać liczbę stron i jak uzyskać prostokąt początkowej strony dokumentu.

Aspose.Pdf.Document document = new Aspose.Pdf.Document("sample.pdf");
Aspose.Pdf.PageCollection pages = document.Pages;
System.Console.WriteLine("Dokument zawiera " + pages.Count);
Page page = pages[1];
Rectangle rect = page.Rect;

PdfFormat

Pobiera format PDF.

public PdfFormat PdfFormat { get; }

Wartość właściwości

PdfFormat

Permissions

Pobiera uprawnienia dokumentu.

public int Permissions { get; }

Wartość właściwości

int

PickTrayByPdfSize

Pobiera lub ustawia flagę określającą, czy rozmiar strony PDF ma być używany do wyboru podajnika papieru.

public bool PickTrayByPdfSize { get; set; }

Wartość właściwości

bool

PrintScaling

Pobiera lub ustawia opcję skalowania strony, która ma być wybrana, gdy wyświetlany jest dialog drukowania dla tego dokumentu.

public PrintScaling PrintScaling { get; set; }

Wartość właściwości

PrintScaling

TaggedContent

Pobiera dostęp do zawartości TaggedPdf.

public ITaggedContent TaggedContent { get; }

Wartość właściwości

ITaggedContent

Przykłady

Przykład demonstruje, jak używać zawartości tagowanej do tworzenia nowego dokumentu z nagłówkiem, akapitami i obrazami.

// Utwórz nowy dokument
Document document = new Document();

// Uzyskaj zawartość tagowaną
ITaggedContent taggedContent = document.TaggedContent;

// Ustaw język dla dokumentu
taggedContent.SetLanguage("en-US");

// Ustaw tytuł dla dokumentu PDF
taggedContent.SetTitle("Dokument przykładowy");

// Tworzenie i dodawanie elementu sekcji
SectElement sect = taggedContent.CreateSectElement();
taggedContent.RootElement.AppendChild(sect);

// Utwórz nagłówek
HeaderElement h1 = taggedContent.CreateHeaderElement(1);
h1.SetText("Nagłówek");
sect.AppendChild(h1);

// Utwórz akapit
ParagraphElement p = taggedContent.CreateParagraphElement();
p.SetTag("Akapit");
p.SetText("Tekst akapitu.");
sect.AppendChild(p);

// Utwórz ilustrację
IllustrationElement figure1 = taggedContent.CreateFigureElement();
sect.AppendChild(figure1);
figure1.AlternativeText = "Rysunek 1";
figure1.Title = "Obraz 1";
figure1.SetTag("Fig");
figure1.SetImage("ścieżka/do/obrazu.jpg");

// Zapisz dokument
document.Save("example.pdf");

Version

Pobiera wersję PDF z nagłówka pliku PDF.

public string Version { get; }

Wartość właściwości

string

Metody

BindXml(string)

Łączy xml z dokumentem.

public void BindXml(string file)

Parametry

file string

Plik xml.

BindXml(string, string)

Łączy xml/xsl z dokumentem.

public void BindXml(string xmlFile, string xslFile)

Parametry

xmlFile string

Plik xml.

xslFile string

Plik xsl, jeśli używane jest XSLT.

BindXml(Stream, Stream)

Łączy xml/xsl z dokumentem.

public void BindXml(Stream xmlStream, Stream xslStream)

Parametry

xmlStream Stream

Strumień xml.

xslStream Stream

Strumień xsl, jeśli używane jest XSLT.

BindXml(Stream, Stream, XmlReaderSettings)

Łączy xml/xsl z dokumentem.

public void BindXml(Stream xmlStream, Stream xslStream, XmlReaderSettings settings)

Parametry

xmlStream Stream

Strumień xml.

xslStream Stream

Strumień xsl, jeśli używane jest XSLT.

settings XmlReaderSettings

Ustawienia czytnika xml.

BindXml(Stream)

Łączy xml z dokumentem.

public void BindXml(Stream stream)

Parametry

stream Stream

Strumień xml.

ChangePasswords(string, string, string)

Zmienia hasła dokumentu. Ta akcja może być wykonana tylko przy użyciu hasła właściciela.

public void ChangePasswords(string ownerPassword, string newUserPassword, string newOwnerPassword)

Parametry

ownerPassword string

Hasło właściciela.

newUserPassword string

Nowe hasło użytkownika.

newOwnerPassword string

Nowe hasło właściciela.

Check(bool)

Weryfikuje dokument.

public bool Check(bool doRepair)

Parametry

doRepair bool

Jeśli true, znalezione problemy zostaną naprawione.

Zwraca

bool

True - jeśli dokument został naprawiony; w przeciwnym razie false.

Convert(string, PdfFormat, ConvertErrorAction, ConvertTransparencyAction)

Konwertuje dokument i zapisuje błędy w określonym pliku.

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

Parametry

outputLogFileName string

Ścieżka do pliku, w którym będą przechowywane komentarze.

format PdfFormat

Format pdf.

action ConvertErrorAction

Akcja dla obiektów, które nie mogą być konwertowane.

transparencyAction ConvertTransparencyAction

Akcja dla obiektów z maskami obrazów.

Zwraca

bool

Wynik operacji.

Convert(Stream, PdfFormat, ConvertErrorAction, ConvertTransparencyAction)

Konwertuje dokument i zapisuje błędy w określonym pliku.

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

Parametry

outputLogStream Stream

Strumień, w którym będą przechowywane komentarze.

format PdfFormat

Format pdf.

action ConvertErrorAction

Akcja dla obiektów, które nie mogą być konwertowane.

transparencyAction ConvertTransparencyAction

Akcja dla obiektów z maskami obrazów.

Zwraca

bool

Wynik operacji.

Convert(string, PdfFormat, ConvertErrorAction)

Konwertuje dokument i zapisuje błędy w określonym pliku.

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

Parametry

outputLogFileName string

Ścieżka do pliku, w którym będą przechowywane komentarze.

format PdfFormat

Format pdf.

action ConvertErrorAction

Akcja dla obiektów, które nie mogą być konwertowane.

Zwraca

bool

Wynik operacji.

Convert(PdfFormatConversionOptions)

Konwertuje dokument przy użyciu określonych opcji konwersji.

public bool Convert(PdfFormatConversionOptions options)

Parametry

options PdfFormatConversionOptions

Zestaw opcji do konwersji dokumentu PDF.

Zwraca

bool

Wynik operacji.

Convert(CallBackGetHocrWithPage, bool)

Rozpoznaje obrazy wewnątrz dokumentu i dodaje nad nimi ciągi hocr.

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

Parametry

callback Document.CallBackGetHocrWithPage

Akcja dla obrazów, które będą przetwarzane przez rozpoznawanie hocr.

flattenImages bool

Tekst w obrazach pdf może być malowany przy użyciu mechaniki masek, w takim przypadku obrazy muszą być spłaszczone.

Zwraca

bool

Wynik operacji. Jeśli w dokumencie nie ma obrazów, zwraca false.

Convert(CallBackGetHocr, bool)

Rozpoznaje obrazy wewnątrz dokumentu i dodaje nad nimi ciągi hocr.

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

Parametry

callback Document.CallBackGetHocr

Akcja dla obrazów, które będą przetwarzane przez rozpoznawanie hocr.

flattenImages bool

Tekst w obrazach pdf może być malowany przy użyciu mechaniki masek, w takim przypadku obrazy muszą być spłaszczone.

Zwraca

bool

Wynik operacji. Jeśli w dokumencie nie ma obrazów, zwraca false.

Convert(Stream, PdfFormat, ConvertErrorAction)

Konwertuje dokument i zapisuje błędy w określonym strumieniu.

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

Parametry

outputLogStream Stream

Strumień, w którym będą przechowywane komentarze.

format PdfFormat

Format pdf.

action ConvertErrorAction

Akcja dla obiektów, które nie mogą być konwertowane.

Zwraca

bool

Wynik operacji.

Convert(Fixup, Stream, bool, object[])

Konwertuje dokument, stosując Fixup.

public bool Convert(Fixup fixup, Stream outputLog, bool onlyValidation = false, object[] parameters = null)

Parametry

fixup Fixup

Typ Fixup.

outputLog Stream

Log procesu.

onlyValidation bool

Tylko walidacja dokumentu.

parameters object[]

Właściwości dla Fixup, które nie mogą być ustawione.

Zwraca

bool

Wynik operacji.

Convert(Fixup, string, bool, object[])

Konwertuje dokument, stosując Fixup.

public bool Convert(Fixup fixup, string outputLog, bool onlyValidation = false, object[] parameters = null)

Parametry

fixup Fixup

Typ Fixup.

outputLog string

Log procesu.

onlyValidation bool

Tylko walidacja dokumentu.

parameters object[]

Właściwości dla Fixup, które nie mogą być ustawione.

Zwraca

bool

Wynik operacji.

Convert(string, LoadOptions, string, SaveOptions)

Konwertuje plik źródłowy w formacie źródłowym na plik docelowy w formacie docelowym.

public static void Convert(string srcFileName, LoadOptions loadOptions, string dstFileName, SaveOptions saveOptions)

Parametry

srcFileName string

Nazwa pliku źródłowego.

loadOptions LoadOptions

Format pliku źródłowego.

dstFileName string

Nazwa pliku docelowego.

saveOptions SaveOptions

Format pliku docelowego.

Convert(Stream, LoadOptions, string, SaveOptions)

Konwertuje strumień w formacie źródłowym na plik docelowy w formacie docelowym.

public static void Convert(Stream srcStream, LoadOptions loadOptions, string dstFileName, SaveOptions saveOptions)

Parametry

srcStream Stream

Strumień źródłowy.

loadOptions LoadOptions

Format strumienia źródłowego.

dstFileName string

Nazwa pliku docelowego.

saveOptions SaveOptions

Format pliku docelowego.

Convert(string, LoadOptions, Stream, SaveOptions)

Konwertuje plik źródłowy w formacie źródłowym na strumień w formacie docelowym.

public static void Convert(string srcFileName, LoadOptions loadOptions, Stream dstStream, SaveOptions saveOptions)

Parametry

srcFileName string

Nazwa pliku źródłowego.

loadOptions LoadOptions

Format pliku źródłowego.

dstStream Stream

Strumień docelowy.

saveOptions SaveOptions

Format strumienia docelowego.

Convert(Stream, LoadOptions, Stream, SaveOptions)

Konwertuje strumień w formacie źródłowym na strumień w formacie docelowym.

public static void Convert(Stream srcStream, LoadOptions loadOptions, Stream dstStream, SaveOptions saveOptions)

Parametry

srcStream Stream

Strumień źródłowy.

loadOptions LoadOptions

Format strumienia źródłowego.

dstStream Stream

Strumień docelowy.

saveOptions SaveOptions

Format pliku docelowego.

ConvertPageToPNGMemoryStream(Page)

Konwertuje stronę na PNG do strumienia obrazu DSR, OMR, OCR.

public MemoryStream ConvertPageToPNGMemoryStream(Page page)

Parametry

page Page

Strona do konwersji.

Zwraca

MemoryStream

Strumień obrazu.

Decrypt()

Deszyfruje dokument. Następnie wywołaj Save, aby uzyskać odszyfrowaną wersję dokumentu.

public void Decrypt()

Dispose()

Zamyka wszystkie zasoby używane przez ten dokument.

public void Dispose()

Encrypt(string, string, DocumentPrivilege, CryptoAlgorithm, bool)

Szyfruje dokument. Następnie wywołaj Save, aby uzyskać zaszyfrowaną wersję dokumentu.

public void Encrypt(string userPassword, string ownerPassword, DocumentPrivilege privileges, CryptoAlgorithm cryptoAlgorithm, bool usePdf20)

Parametry

userPassword string

Hasło użytkownika.

ownerPassword string

Hasło właściciela.

privileges DocumentPrivilege

Uprawnienia dokumentu, zobacz Aspose.Pdf.Document.Permissions dla szczegółów.

cryptoAlgorithm CryptoAlgorithm

Algorytm kryptograficzny, zobacz Aspose.Pdf.Document.CryptoAlgorithm dla szczegółów.

usePdf20 bool

Wsparcie dla rewizji 6 (Rozszerzenie 8).

Encrypt(string, string, Permissions, CryptoAlgorithm)

Szyfruje dokument. Następnie wywołaj Save, aby uzyskać zaszyfrowaną wersję dokumentu.

public void Encrypt(string userPassword, string ownerPassword, Permissions permissions, CryptoAlgorithm cryptoAlgorithm)

Parametry

userPassword string

Hasło użytkownika.

ownerPassword string

Hasło właściciela.

permissions Permissions

Uprawnienia dokumentu, zobacz Aspose.Pdf.Document.Permissions dla szczegółów.

cryptoAlgorithm CryptoAlgorithm

Algorytm kryptograficzny, zobacz Aspose.Pdf.Document.CryptoAlgorithm dla szczegółów.

Encrypt(string, string, Permissions, CryptoAlgorithm, bool)

Szyfruje dokument. Następnie wywołaj Save, aby uzyskać zaszyfrowaną wersję dokumentu.

public void Encrypt(string userPassword, string ownerPassword, Permissions permissions, CryptoAlgorithm cryptoAlgorithm, bool usePdf20)

Parametry

userPassword string

Hasło użytkownika.

ownerPassword string

Hasło właściciela.

permissions Permissions

Uprawnienia dokumentu, zobacz Aspose.Pdf.Document.Permissions dla szczegółów.

cryptoAlgorithm CryptoAlgorithm

Algorytm kryptograficzny, zobacz Aspose.Pdf.Document.CryptoAlgorithm dla szczegółów.

usePdf20 bool

Wsparcie dla rewizji 6 (Rozszerzenie 8).

ExportAnnotationsToXfdf(string)

Eksportuje wszystkie adnotacje dokumentu do pliku XFDF.

public void ExportAnnotationsToXfdf(string fileName)

Parametry

fileName string

Nazwa pliku XFDF.

ExportAnnotationsToXfdf(Stream)

Eksportuje wszystkie adnotacje dokumentu do strumienia.

public void ExportAnnotationsToXfdf(Stream stream)

Parametry

stream Stream

Strumień, w którym przechowywane będą dane XFDF.

Flatten()

Usuwa wszystkie pola z dokumentu i umieszcza ich wartości zamiast.

public void Flatten()

Flatten(FlattenSettings)

Usuwa wszystkie pola (i adnotacje) z dokumentu i umieszcza ich wartości zamiast.

public void Flatten(Form.FlattenSettings flattenSettings)

Parametry

flattenSettings Form.FlattenSettings

Ustawienia dla procesu spłaszczania.

FlattenTransparency()

Zastępuje przezroczystą zawartość nieprzezroczystą grafiką rastrową i wektorową.

public void FlattenTransparency()

FreeMemory()

Oczyszcza pamięć.

public void FreeMemory()

GetCatalogValue(string)

Zwraca wartość elementu z katalogu.

public object GetCatalogValue(string key)

Parametry

key string

Klucz elementu.

Zwraca

object

Wartość elementu - jeśli klucz został pomyślnie znaleziony; w przeciwnym razie null.

GetObjectById(string)

Pobiera obiekt o określonym ID w dokumencie.

public object GetObjectById(string id)

Parametry

id string

ID obiektu.

Zwraca

object

Obiekt o określonym ID. Null, jeśli ID nie zostało znalezione.

GetXmpMetadata(Stream)

Pobiera metadane XMP z dokumentu.

public void GetXmpMetadata(Stream stream)

Parametry

stream Stream

Strumień, w którym będą przechowywane metadane.

HasIncrementalUpdate()

Sprawdza, czy bieżący dokument PDF został zapisany z inkrementalnymi aktualizacjami.

public bool HasIncrementalUpdate()

Zwraca

bool

true, jeśli dokument PDF ma inkrementalne aktualizacje; w przeciwnym razie false.

ImportAnnotationsFromXfdf(string)

Importuje adnotacje z pliku XFDF do dokumentu.

public void ImportAnnotationsFromXfdf(string fileName)

Parametry

fileName string

Nazwa pliku XFDF.

ImportAnnotationsFromXfdf(Stream)

Importuje adnotacje z strumienia do dokumentu.

public void ImportAnnotationsFromXfdf(Stream stream)

Parametry

stream Stream

Strumień zawierający dane XFDF.

LoadFrom(string, LoadOptions)

Ładowanie pliku, konwertując go na PDF.

public void LoadFrom(string filename, LoadOptions options)

Parametry

filename string

Ścieżka do pliku do otwarcia.

options LoadOptions

Opcje ładowania.

Wyjątki

PdfException

Jeśli plik nie może zostać załadowany.

FileNotFoundException

Jeśli plik nie zostanie znaleziony.

Merge(MergeOptions, params Document[])

Łączy dokumenty.

public void Merge(Document.MergeOptions mergeOptions, params Document[] documents)

Parametry

mergeOptions Document.MergeOptions

Opcje łączenia.

documents Document[]

Dokumenty do połączenia.

Merge(MergeOptions, params string[])

Łączy dokumenty.

public void Merge(Document.MergeOptions mergeOptions, params string[] files)

Parametry

mergeOptions Document.MergeOptions

Opcje łączenia.

files string[]

Pliki pdf do połączenia.

Merge(params Document[])

Łączy dokumenty.

public void Merge(params Document[] documents)

Parametry

documents Document[]

Dokumenty do połączenia.

Merge(params string[])

Łączy pliki pdf.

public void Merge(params string[] files)

Parametry

files string[]

Pliki pdf do połączenia.

MergeDocuments(MergeOptions, params string[])

Łączy dokumenty.

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

Parametry

mergeOptions Document.MergeOptions

Opcje łączenia.

files string[]

Pliki pdf do połączenia.

Zwraca

Document

Połączony dokument.

MergeDocuments(MergeOptions, params Document[])

Łączy dokumenty.

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

Parametry

mergeOptions Document.MergeOptions

files Document[]

Dokumenty do połączenia.

Zwraca

Document

Połączony dokument.

MergeDocuments(params string[])

Łączy pliki pdf.

public static Document MergeDocuments(params string[] files)

Parametry

files string[]

Pliki pdf do połączenia.

Zwraca

Document

Połączony dokument.

MergeDocuments(params Document[])

Łączy dokumenty.

public static Document MergeDocuments(params Document[] documents)

Parametry

documents Document[]

Dokumenty do połączenia.

Zwraca

Document

Połączony dokument.

Optimize()

Linearizuje dokument w celu

  • jak najszybszego otwarcia pierwszej strony;
  • jak najszybszego wyświetlenia następnej strony lub podążania za linkiem do następnej strony;
  • wyświetlania strony inkrementalnie w miarę jej przybywania, gdy dane dla strony są dostarczane przez wolny kanał (wyświetlanie najbardziej użytecznych danych jako pierwszych);
  • umożliwienia interakcji użytkownika, takiej jak podążanie za linkiem, nawet przed całkowitym odebraniem i wyświetleniem strony. Wywołanie tej metody nie zapisuje faktycznie dokumentu. Wręcz przeciwnie, dokument jest tylko przygotowywany do posiadania zoptymalizowanej struktury, następnie wywołaj Save, aby uzyskać zoptymalizowany dokument.
public void Optimize()

OptimizeResources()

Optymalizuje zasoby w dokumencie:

  1. Zasoby, które nie są używane na stronach dokumentu, są usuwane;
  2. Równe zasoby są łączone w jeden obiekt;
  3. Nie używane obiekty są usuwane.
public void OptimizeResources()

OptimizeResources(OptimizationOptions)

Optymalizuje zasoby w dokumencie zgodnie z określoną strategią optymalizacji.

public void OptimizeResources(OptimizationOptions strategy)

Parametry

strategy OptimizationOptions

Strategia optymalizacji.

PageNodesToBalancedTree(byte)

Organizuje węzły drzew stron w dokumencie w zbalansowane drzewo. Tylko jeśli dokument ma więcej niż nodesNumInSubtrees obiektów strony, w przeciwnym razie nic nie robi. Nie wywołuj tej metody podczas iteracji po elementach Pages, może to dać nieprzewidywalne wyniki.

public void PageNodesToBalancedTree(byte nodesNumInSubtrees = 10)

Parametry

nodesNumInSubtrees byte

Pożądana liczba podwęzłów. Wartość domyślna to dziesięć.

ProcessParagraphs()

Przetwarza akapity dla generatora.

public void ProcessParagraphs()

RemoveMetadata()

Usuwa metadane z dokumentu.

public void RemoveMetadata()

RemovePdfUaCompliance()

Usuwa zgodność pdfUa z dokumentu.

public void RemovePdfUaCompliance()

RemovePdfaCompliance()

Usuwa zgodność pdfa z dokumentu.

public void RemovePdfaCompliance()

Repair()

Naprawia uszkodzony dokument.

public void Repair()

Save(Stream)

Przechowuje dokument w strumieniu.

public void Save(Stream output)

Parametry

output Stream

Strumień, w którym dokument ma być przechowywany.

Save(string)

Zapisuje dokument do określonego pliku.

public void Save(string outputFileName)

Parametry

outputFileName string

Ścieżka do pliku, w którym dokument będzie przechowywany.

Save()

Zapisuje dokument inkrementalnie (tj. przy użyciu techniki inkrementalnej aktualizacji).

public void Save()

Uwagi

Aby zapisać dokument inkrementalnie, musimy otworzyć plik dokumentu do zapisu. Dlatego Document musi być zainicjalizowany z zapisywalnym strumieniem, jak w następującym fragmencie kodu: Document doc = new Document(new FileStream(“document.pdf”, FileMode.Open, FileAccess.ReadWrite)); // dokonaj zmian i zapisz dokument inkrementalnie doc.Save();

Save(SaveOptions)

Zapisuje dokument z opcjami zapisu.

public void Save(SaveOptions options)

Parametry

options SaveOptions

Opcje zapisu.

Save(string, SaveFormat)

Zapisuje dokument z nową nazwą wraz z formatem pliku.

public void Save(string outputFileName, SaveFormat format)

Parametry

outputFileName string

Ścieżka do pliku, w którym dokument będzie przechowywany.

format SaveFormat

Opcje formatu.

Save(Stream, SaveFormat)

Zapisuje dokument z nową nazwą wraz z formatem pliku.

public void Save(Stream outputStream, SaveFormat format)

Parametry

outputStream Stream

Strumień, w którym dokument będzie przechowywany.

format SaveFormat

Opcje formatu.

Wyjątki

ArgumentException

System.ArgumentException, gdy Aspose.Pdf.HtmlSaveOptions jest przekazywana do metody. Zapis dokumentu do strumienia html nie jest obsługiwany. Proszę użyć metody zapisz do pliku.

Save(string, SaveOptions)

Zapisuje dokument z nową nazwą, ustawiając jego opcje zapisu.

public void Save(string outputFileName, SaveOptions options)

Parametry

outputFileName string

Ścieżka do pliku, w którym dokument będzie przechowywany.

options SaveOptions

Opcje zapisu.

Save(Stream, SaveOptions)

Zapisuje dokument do strumienia z opcjami zapisu.

public void Save(Stream outputStream, SaveOptions options)

Parametry

outputStream Stream

Strumień, w którym dokument będzie przechowywany.

options SaveOptions

Opcje zapisu.

Wyjątki

ArgumentException

System.ArgumentException, gdy Aspose.Pdf.HtmlSaveOptions jest przekazywana do metody. Zapis dokumentu do strumienia html nie jest obsługiwany. Proszę użyć metody zapisz do pliku.

SaveAsync(Stream, CancellationToken)

Przechowuje dokument w strumieniu.

public Task SaveAsync(Stream output, CancellationToken cancellationToken)

Parametry

output Stream

Strumień, w którym dokument ma być przechowywany.

cancellationToken CancellationToken

Token anulowania.

Zwraca

Task

Zadanie asynchroniczne.

SaveAsync(string, CancellationToken)

Zapisuje dokument do określonego pliku.

public Task SaveAsync(string outputFileName, CancellationToken cancellationToken)

Parametry

outputFileName string

Ścieżka do pliku, w którym dokument będzie przechowywany.

cancellationToken CancellationToken

Token anulowania.

Zwraca

Task

Zadanie asynchroniczne.

SaveAsync(CancellationToken)

Zapisuje dokument inkrementalnie (tj. przy użyciu techniki inkrementalnej aktualizacji).

public Task SaveAsync(CancellationToken cancellationToken)

Parametry

cancellationToken CancellationToken

Token anulowania.

Zwraca

Task

Zadanie asynchroniczne.

Uwagi

Aby zapisać dokument inkrementalnie, musimy otworzyć plik dokumentu do zapisu. Dlatego Document musi być zainicjalizowany z zapisywalnym strumieniem, jak w następującym fragmencie kodu: Document doc = new Document(new FileStream(“document.pdf”, FileMode.Open, FileAccess.ReadWrite)); // dokonaj zmian i zapisz dokument inkrementalnie doc.Save();

SaveAsync(SaveOptions, CancellationToken)

Zapisuje dokument z opcjami zapisu.

public Task SaveAsync(SaveOptions options, CancellationToken cancellationToken)

Parametry

options SaveOptions

Opcje zapisu.

cancellationToken CancellationToken

Token anulowania.

Zwraca

Task

Zadanie asynchroniczne.

SaveAsync(string, SaveFormat, CancellationToken)

Zapisuje dokument z nową nazwą wraz z

 Polski