Class Document
Namespace: Aspose.Pdf
Assembly: Aspose.PDF.dll
PDFドキュメントを表すクラス
public sealed class Document : IDisposable
継承
実装
継承されたメンバー
object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
コンストラクタ
Document(Stream)
input
ストリームから新しいDocumentインスタンスを初期化します。
public Document(Stream input)
パラメーター
input
Stream
PDFドキュメントを含むストリーム。
Document(Stream, string, bool)
input
ストリームから新しいDocumentインスタンスを初期化します。
public Document(Stream input, string password, bool isManagedStream)
パラメーター
input
Stream
PDFドキュメントを含むストリーム。
password
string
ユーザーまたはオーナーパスワード。
isManagedStream
bool
true
に設定されている場合、内部ストリームは終了前に閉じられます。それ以外の場合は閉じられません。
Document(Stream, bool)
input
ストリームから新しいDocumentインスタンスを初期化します。
public Document(Stream input, bool isManagedStream)
パラメーター
input
Stream
PDFドキュメントを含むストリーム。
isManagedStream
bool
true
に設定されている場合、内部ストリームは終了前に閉じられます。それ以外の場合は閉じられません。
Document(string)
filename
を使用してDocumentを初期化します。Aspose.Pdf.Document.#ctor(System.IO.Stream)と同じです。
public Document(string filename)
パラメーター
filename
string
PDFドキュメントファイルの名前。
Document(Stream, string)
input
ストリームから新しいDocumentインスタンスを初期化します。
public Document(Stream input, string password)
パラメーター
input
Stream
入力ストリームオブジェクト、対応するPDFはパスワード保護されています。
password
string
ユーザーまたはオーナーパスワード。
Document()
空のドキュメントを初期化します。
public Document()
Document(string, string)
暗号化されたドキュメントを操作するためのAspose.Pdf.Documentクラスの新しいインスタンスを初期化します。
public Document(string filename, string password)
パラメーター
filename
string
ドキュメントファイル名。
password
string
ユーザーまたはオーナーパスワード。
Document(string, string, bool)
暗号化されたドキュメントを操作するためのAspose.Pdf.Documentクラスの新しいインスタンスを初期化します。
public Document(string filename, string password, bool isManagedStream)
パラメーター
filename
string
ドキュメントファイル名。
password
string
ユーザーまたはオーナーパスワード。
isManagedStream
bool
true
に設定されている場合、内部ストリームは終了前に閉じられます。それ以外の場合は閉じられません。
Document(string, LoadOptions)
必要な変換オプションを提供してファイルから既存のドキュメントを開きます。
public Document(string filename, LoadOptions options)
パラメーター
filename
string
PDFドキュメントに変換するための入力ファイル。
options
LoadOptions
filename
をPDFドキュメントに変換するためのプロパティを表します。
Document(Stream, LoadOptions)
必要な変換を提供してストリームから既存のドキュメントを開きます。
public Document(Stream input, LoadOptions options)
パラメーター
input
Stream
PDFドキュメントに変換するための入力ストリーム。
options
LoadOptions
input
をPDFドキュメントに変換するためのプロパティを表します。
フィールド
DefaultNodesNumInSubtrees
public const byte DefaultNodesNumInSubtrees = 10
フィールド値
プロパティ
Actions
ドキュメントアクションを取得します。このプロパティは、BeforClosing、BeforSavingなどのアクションを取得/設定できるDocumentActionsクラスのインスタンスです。
public DocumentActionCollection Actions { get; }
プロパティ値
DocumentActionCollection
例
この例は、ドキュメントのオープンアクションを取得する方法を示しています:
Aspose.Pdf.Document document = new Aspose.Pdf.Document("d:\\work\\aspose\\aspose.pdf.kit.net.new\\trunk\\testdata\\Aspose.Pdf\\PdfWithOpenAction.pdf");
Aspose.Pdf.Annotations.DocumentActionCollection actions = document.Actions;
Aspose.Pdf.Annotations.PdfAction afterSavingAction = actions.AfterSaving;
AllowReusePageContent
ドキュメントサイズを最適化するためにページコンテンツをマージすることを許可します。使用される場合、異なるが重複したページは同じコンテンツオブジェクトを参照する可能性があります。このモードは、他のページが変更されたときにページコンテンツが変更されるなどの副作用を引き起こす可能性があることに注意してください。
public bool AllowReusePageContent { get; set; }
プロパティ値
Background
ドキュメントの背景色を取得または設定します。
public Color Background { get; set; }
プロパティ値
Color
CenterWindow
ドキュメントのウィンドウの位置が画面の中央に配置されるかどうかを指定するフラグを取得または設定します。
public bool CenterWindow { get; set; }
プロパティ値
例
CenterWindowフラグを取得する方法を示す例:
Document document = new Document("sample.pdf");
bool value = document.CenterWindow;
Collection
ドキュメントのコレクションを取得します。
public Collection Collection { get; set; }
プロパティ値
Collection
CryptoAlgorithm
ドキュメントが暗号化されている場合のセキュリティ設定を取得します。 ドキュメントが暗号化されていない場合、対応する例外が.NET 1.1で発生するか、他の.NETバージョンではCryptoAlgorithmが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; }
プロパティ値
DisplayDocTitle
ドキュメントのウィンドウタイトルバーにドキュメントタイトルを表示するかどうかを指定するフラグを取得または設定します。
public bool DisplayDocTitle { get; set; }
プロパティ値
例
DisplayDocTitleフラグを取得する方法を示す例:
Document document = new Document("sample.pdf");
bool value = document.DisplayDocTitle;
Duplex
印刷ダイアログからファイルを印刷する際に使用する印刷両面モードの処理オプションを取得または設定します。
public PrintDuplex Duplex { get; set; }
プロパティ値
PrintDuplex
EmbedStandardFonts
ドキュメントがすべての標準Type1フォントを埋め込む必要があることを宣言するプロパティ フラグIsEmbeddedがtrueに設定されている。すべてのPDFフォントは、 指定されたフォントのIsEmbeddedフラグをtrueに設定するだけでドキュメントに埋め込むことができますが、PDF標準Type1フォントはこのルールの例外です。 標準Type1フォントの埋め込みには多くの時間がかかるため、これらのフォントを埋め込むには、 指定されたフォントのIsEmbeddedフラグをtrueに設定するだけでなく、 ドキュメントレベルで追加のフラグ-EmbedStandardFonts = true;を設定する必要があります。 このプロパティはすべてのフォントに対して1回だけ設定できます。 デフォルトはfalseです。
public bool EmbedStandardFonts { get; set; }
プロパティ値
EmbeddedFiles
ドキュメントに埋め込まれたファイルのコレクションを取得します。
public EmbeddedFileCollection EmbeddedFiles { get; }
プロパティ値
EmbeddedFileCollection
EnableObjectUnload
メモリからドキュメントを部分的にアンロードできるフラグを取得または設定します。 これによりメモリ使用量を減らすことができますが、パフォーマンスに悪影響を及ぼす可能性があります。
public bool EnableObjectUnload { get; set; }
プロパティ値
EnableSignatureSanitization
署名フィールドのサニタイズを管理するフラグを取得または設定します。デフォルトで有効です。
public bool EnableSignatureSanitization { get; set; }
プロパティ値
FileName
このドキュメントを引き起こしたPDFファイルの名前
public string FileName { get; }
プロパティ値
FitWindow
ドキュメントウィンドウが最初に表示されるページに合わせてサイズ変更されるかどうかを指定するフラグを取得または設定します。
public bool FitWindow { get; set; }
プロパティ値
例
FitWindowフラグを取得する方法を示す例:
Document document = new Document("sample.pdf");
bool value = document.FitWindow;
FontUtilities
IDocumentFontUtilitiesインスタンス
public Document.IDocumentFontUtilities FontUtilities { get; }
プロパティ値
Document.IDocumentFontUtilities
Form
ドキュメントのAcroフォームを取得します。
public Form Form { get; }
プロパティ値
Form
HandleSignatureChange
ドキュメントが変更とともに保存される場合に例外をスローします。
public bool HandleSignatureChange { get; set; }
プロパティ値
HideMenubar
ドキュメントがアクティブなときにメニューバーを非表示にするかどうかを指定するフラグを取得または設定します。
public bool HideMenubar { get; set; }
プロパティ値
例
HideMenubarフラグを取得する方法を示す例:
Document document = new Document("sample.pdf");
bool value = document.HideMenubar;
HideToolBar
ドキュメントがアクティブなときにツールバーを非表示にするかどうかを指定するフラグを取得または設定します。
public bool HideToolBar { get; set; }
プロパティ値
例
HideToolBarフラグを取得する方法を示す例:
Document document = new Document("sample.pdf");
bool value = document.HideToolBar;
HideWindowUI
ユーザーインターフェース要素がドキュメントがアクティブなときに非表示にされるかどうかを指定するフラグを取得または設定します。
public bool HideWindowUI { get; set; }
プロパティ値
例
HideWindowUIフラグを取得する方法を示す例:
Document document = new Document("sample.pdf");
bool value = document.HideWindowUI;
Id
IDを取得します。
public Id Id { get; }
プロパティ値
Id
IgnoreCorruptedObjects
ソースファイル内のエラーを無視するフラグを取得または設定します。 ソースドキュメントからページが宛先ドキュメントにコピーされるとき、このフラグがfalseの場合、 ソースファイル内のオブジェクトが破損している場合、コピー処理は例外で停止します。 例: dest.Pages.Add(src.Pages); このフラグがtrueに設定されている場合、破損したオブジェクトは空の値で置き換えられます。 デフォルト: true。
public bool IgnoreCorruptedObjects { get; set; }
プロパティ値
Info
ドキュメント情報を取得します。
public DocumentInfo Info { get; }
プロパティ値
DocumentInfo
IsEncrypted
ドキュメントの暗号化状態を取得します。ドキュメントが暗号化されている場合はtrue。
public bool IsEncrypted { get; }
プロパティ値
IsLicensed
システムのライセンス状態を取得します。システムがライセンスモードで動作している場合はtrue、それ以外の場合はfalseを返します。
public static bool IsLicensed { get; }
プロパティ値
IsLinearized
ドキュメントが線形化されているかどうかを示す値を取得または設定します。
public bool IsLinearized { get; set; }
プロパティ値
IsPdfUaCompliant
ドキュメントがpdfua準拠であるかどうかを取得します。
public bool IsPdfUaCompliant { get; }
プロパティ値
IsPdfaCompliant
ドキュメントがpdfa準拠であるかどうかを取得します。
public bool IsPdfaCompliant { get; }
プロパティ値
IsXrefGapsAllowed
ドキュメントがpdfa準拠であるかどうかを取得または設定します。
public bool IsXrefGapsAllowed { get; set; }
プロパティ値
JavaScript
ドキュメントレベルのJavaScriptのコレクション。
public JavaScriptCollection JavaScript { get; }
プロパティ値
JavaScriptCollection
LogicalStructure
ドキュメントの論理構造を取得します。
public RootElement LogicalStructure { get; }
プロパティ値
RootElement
Metadata
ドキュメントメタデータ。 (PDFドキュメントには、ドキュメントのタイトル、著者、作成日、変更日などの一般的な情報が含まれる場合があります。 このようなドキュメントに関するグローバル情報(その内容や構造とは対照的に)はメタデータと呼ばれ、 外部データベースでドキュメントをカタログ化および検索するのを支援することを目的としています。)
public Metadata Metadata { get; }
プロパティ値
Metadata
NamedDestinations
ドキュメント内の名前付き目的地のコレクション。
public NamedDestinationCollection NamedDestinations { get; }
プロパティ値
NamedDestinationCollection
NonFullScreenPageMode
フルスクリーンモードを終了したときにドキュメントを表示する方法を指定するページモードを取得または設定します。
public PageMode NonFullScreenPageMode { get; set; }
プロパティ値
PageMode
OpenAction
ドキュメントを開くときに実行されるアクションを取得または設定します。
public IAppointment OpenAction { get; set; }
プロパティ値
IAppointment
例
CenterWindowフラグを取得する方法を示す例:
Document document = new Document("sample.pdf");
IAppointment value = document.OpenAction;
OptimizeSize
最適化フラグを取得または設定します。ページがドキュメントに追加されると、結果ファイル内の等しいリソースストリームは このフラグが設定されている場合に1つのPDFオブジェクトにマージされます。 これにより結果ファイルサイズを減少させることができますが、実行速度が遅くなり、メモリ要件が大きくなる可能性があります。 デフォルト値: false。
public bool OptimizeSize { get; set; }
プロパティ値
Outlines
ドキュメントのアウトラインを取得します。
public OutlineCollection Outlines { get; }
プロパティ値
OutlineCollection
OutputIntents
ドキュメント内の出力インテントのコレクションを取得します。
public OutputIntents OutputIntents { get; }
プロパティ値
OutputIntents
PageInfo
ページ情報を取得または設定します。(生成者専用、ドキュメントを読み取るときは入力されません)
public PageInfo PageInfo { get; set; }
プロパティ値
PageInfo
PageLabels
ドキュメント内のページラベルを取得します。
public PageLabelCollection PageLabels { get; }
プロパティ値
PageLabelCollection
PageLayout
ドキュメントが開かれたときに使用されるページレイアウトを取得または設定します。
public PageLayout PageLayout { get; set; }
プロパティ値
PageLayout
PageMode
ドキュメントが開かれたときに表示される方法を指定するページモードを取得または設定します。
public PageMode PageMode { get; set; }
プロパティ値
PageMode
Pages
ドキュメントページのコレクションを取得または設定します。 コレクション内のページは1から番号付けされていることに注意してください。
public PageCollection Pages { get; }
プロパティ値
PageCollection
例
以下の例は、ドキュメントページを操作する方法を示しています: ページ数を取得する方法と、ドキュメントの最初のページの矩形を取得する方法。
Aspose.Pdf.Document document = new Aspose.Pdf.Document("sample.pdf");
Aspose.Pdf.PageCollection pages = document.Pages;
System.Console.WriteLine("Document contains " + pages.Count);
Page page = pages[1];
Rectangle rect = page.Rect;
PdfFormat
PDFフォーマットを取得します。
public PdfFormat PdfFormat { get; }
プロパティ値
PdfFormat
Permissions
ドキュメントの権限を取得します。
public int Permissions { get; }
プロパティ値
PickTrayByPdfSize
PDFページサイズを使用して入力用紙トレイを選択するかどうかを指定するフラグを取得または設定します。
public bool PickTrayByPdfSize { get; set; }
プロパティ値
PrintScaling
このドキュメントの印刷ダイアログが表示されるときに選択されるページスケーリングオプションを取得または設定します。
public PrintScaling PrintScaling { get; set; }
プロパティ値
PrintScaling
TaggedContent
TaggedPdfコンテンツへのアクセスを取得します。
public ITaggedContent TaggedContent { get; }
プロパティ値
ITaggedContent
例
この例は、ヘッダー、段落、画像を含む新しいドキュメントを作成するためのタグ付きコンテンツの使用方法を示しています。
// 新しいドキュメントを作成
Document document = new Document();
// タグ付きコンテンツを取得
ITaggedContent taggedContent = document.TaggedContent;
// ドキュメントの言語を設定
taggedContent.SetLanguage("en-US");
// PDFドキュメントのタイトルを設定
taggedContent.SetTitle("Example document");
// セクションを作成して追加
SectElement sect = taggedContent.CreateSectElement();
taggedContent.RootElement.AppendChild(sect);
// ヘッダーを作成
HeaderElement h1 = taggedContent.CreateHeaderElement(1);
h1.SetText("The Header");
sect.AppendChild(h1);
// 段落を作成
ParagraphElement p = taggedContent.CreateParagraphElement();
p.SetTag("Paragraph");
p.SetText("The text of paragraph.");
sect.AppendChild(p);
// イラストを作成
IllustrationElement figure1 = taggedContent.CreateFigureElement();
sect.AppendChild(figure1);
figure1.AlternativeText = "Figure 1";
figure1.Title = "Image 1";
figure1.SetTag("Fig");
figure1.SetImage("path/of/image.jpg");
// ドキュメントを保存
document.Save("example.pdf");
Version
PDFファイルヘッダーからPDFのバージョンを取得します。
public string Version { get; }
プロパティ値
メソッド
BindXml(string)
XMLをドキュメントにバインドします。
public void BindXml(string file)
パラメーター
file
string
XMLファイル
BindXml(string, string)
XML/XSLをドキュメントにバインドします。
public void BindXml(string xmlFile, string xslFile)
パラメーター
xmlFile
string
XMLファイル。
xslFile
string
XSLTが使用されている場合のXSLファイル。
BindXml(Stream, Stream)
XML/XSLをドキュメントにバインドします。
public void BindXml(Stream xmlStream, Stream xslStream)
パラメーター
xmlStream
Stream
XMLストリーム。
xslStream
Stream
XSLTが使用されている場合のXSLストリーム。
BindXml(Stream, Stream, XmlReaderSettings)
XML/XSLをドキュメントにバインドします。
public void BindXml(Stream xmlStream, Stream xslStream, XmlReaderSettings settings)
パラメーター
xmlStream
Stream
XMLストリーム。
xslStream
Stream
XSLTが使用されている場合のXSLストリーム。
settings
XmlReaderSettings
XMLリーダー設定。
BindXml(Stream)
XMLをドキュメントにバインドします。
public void BindXml(Stream stream)
パラメーター
stream
Stream
XMLストリーム。
ChangePasswords(string, string, string)
ドキュメントのパスワードを変更します。この操作はオーナーパスワードを使用してのみ実行できます。
public void ChangePasswords(string ownerPassword, string newUserPassword, string newOwnerPassword)
パラメーター
ownerPassword
string
オーナーパスワード。
newUserPassword
string
新しいユーザーパスワード。
newOwnerPassword
string
新しいオーナーパスワード。
Check(bool)
ドキュメントを検証します。
public bool Check(bool doRepair)
パラメーター
doRepair
bool
trueの場合、見つかった問題は修復されます。
戻り値
ドキュメントが修復された場合はtrue、それ以外の場合はfalse。
Convert(string, PdfFormat, ConvertErrorAction, ConvertTransparencyAction)
ドキュメントを変換し、エラーを指定されたファイルに保存します。
public bool Convert(string outputLogFileName, PdfFormat format, ConvertErrorAction action, ConvertTransparencyAction transparencyAction)
パラメーター
outputLogFileName
string
コメントが保存されるファイルへのパス。
format
PdfFormat
PDFフォーマット。
action
ConvertErrorAction
変換できないオブジェクトのアクション
transparencyAction
ConvertTransparencyAction
画像マスクオブジェクトのアクション
戻り値
操作結果
Convert(Stream, PdfFormat, ConvertErrorAction, ConvertTransparencyAction)
ドキュメントを変換し、エラーを指定されたファイルに保存します。
public bool Convert(Stream outputLogStream, PdfFormat format, ConvertErrorAction action, ConvertTransparencyAction transparencyAction)
パラメーター
outputLogStream
Stream
コメントが保存されるストリーム。
format
PdfFormat
PDFフォーマット。
action
ConvertErrorAction
変換できないオブジェクトのアクション
transparencyAction
ConvertTransparencyAction
画像マスクオブジェクトのアクション
戻り値
操作結果
Convert(string, PdfFormat, ConvertErrorAction)
ドキュメントを変換し、エラーを指定されたファイルに保存します。
public bool Convert(string outputLogFileName, PdfFormat format, ConvertErrorAction action)
パラメーター
outputLogFileName
string
コメントが保存されるファイルへのパス。
format
PdfFormat
PDFフォーマット。
action
ConvertErrorAction
変換できないオブジェクトのアクション
戻り値
操作結果
Convert(PdfFormatConversionOptions)
指定された変換オプションを使用してドキュメントを変換します。
public bool Convert(PdfFormatConversionOptions options)
パラメーター
options
PdfFormatConversionOptions
PDFドキュメントを変換するためのオプションのセット
戻り値
操作結果
Convert(CallBackGetHocrWithPage, bool)
ドキュメント内の画像を認識し、その上にhocr文字列を追加します。
public bool Convert(Document.CallBackGetHocrWithPage callback, bool flattenImages = false)
パラメーター
callback
Document.CallBackGetHocrWithPage
hocr認識によって処理される画像のアクション。
flattenImages
bool
PDF画像内のテキストはマスクのメカニズムを使用して描画される可能性があり、その場合、画像はフラット化する必要があります。
戻り値
操作結果。ドキュメントに画像がない場合はfalseを返します。
Convert(CallBackGetHocr, bool)
ドキュメント内の画像を認識し、その上にhocr文字列を追加します。
public bool Convert(Document.CallBackGetHocr callback, bool flattenImages = false)
パラメーター
callback
Document.CallBackGetHocr
hocr認識によって処理される画像のアクション。
flattenImages
bool
PDF画像内のテキストはマスクのメカニズムを使用して描画される可能性があり、その場合、画像はフラット化する必要があります。
戻り値
操作結果。ドキュメントに画像がない場合はfalseを返します。
Convert(Stream, PdfFormat, ConvertErrorAction)
ドキュメントを変換し、エラーを指定されたストリームに保存します。
public bool Convert(Stream outputLogStream, PdfFormat format, ConvertErrorAction action)
パラメーター
outputLogStream
Stream
コメントが保存されるストリーム。
format
PdfFormat
PDFフォーマット。
action
ConvertErrorAction
変換できないオブジェクトのアクション
戻り値
操作結果
Convert(Fixup, Stream, bool, object[])
Fixupを適用してドキュメントを変換します。
public bool Convert(Fixup fixup, Stream outputLog, bool onlyValidation = false, object[] parameters = null)
パラメーター
fixup
Fixup
Fixupタイプ。
outputLog
Stream
処理のログ。
onlyValidation
bool
ドキュメントの検証のみ。
parameters
object[]
設定できないFixupのプロパティ。
戻り値
操作結果。
Convert(Fixup, string, bool, object[])
Fixupを適用してドキュメントを変換します。
public bool Convert(Fixup fixup, string outputLog, bool onlyValidation = false, object[] parameters = null)
パラメーター
fixup
Fixup
Fixupタイプ。
outputLog
string
処理のログ。
onlyValidation
bool
ドキュメントの検証のみ。
parameters
object[]
設定できないFixupのプロパティ。
戻り値
操作結果。
Convert(string, LoadOptions, string, SaveOptions)
ソースファイルをソースフォーマットで変換し、宛先ファイルを宛先フォーマットで作成します。
public static void Convert(string srcFileName, LoadOptions loadOptions, string dstFileName, SaveOptions saveOptions)
パラメーター
srcFileName
string
ソースファイル名。
loadOptions
LoadOptions
ソースファイルフォーマット。
dstFileName
string
宛先ファイル名。
saveOptions
SaveOptions
宛先ファイルフォーマット。
Convert(Stream, LoadOptions, string, SaveOptions)
ソースフォーマットのストリームを宛先ファイルの宛先フォーマットに変換します。
public static void Convert(Stream srcStream, LoadOptions loadOptions, string dstFileName, SaveOptions saveOptions)
パラメーター
srcStream
Stream
ソースストリーム。
loadOptions
LoadOptions
ソースストリームフォーマット。
dstFileName
string
宛先ファイル名。
saveOptions
SaveOptions
宛先ファイルフォーマット。
Convert(string, LoadOptions, Stream, SaveOptions)
ソースファイルをソースフォーマットで変換し、ストリームに宛先フォーマットで保存します。
public static void Convert(string srcFileName, LoadOptions loadOptions, Stream dstStream, SaveOptions saveOptions)
パラメーター
srcFileName
string
ソースファイル名。
loadOptions
LoadOptions
ソースファイルフォーマット。
dstStream
Stream
宛先ストリーム。
saveOptions
SaveOptions
宛先ストリームフォーマット。
Convert(Stream, LoadOptions, Stream, SaveOptions)
ソースフォーマットのストリームを宛先フォーマットのストリームに変換します。
public static void Convert(Stream srcStream, LoadOptions loadOptions, Stream dstStream, SaveOptions saveOptions)
パラメーター
srcStream
Stream
ソースストリーム。
loadOptions
LoadOptions
ソースストリームフォーマット。
dstStream
Stream
宛先ストリーム。
saveOptions
SaveOptions
宛先ファイルフォーマット。
ConvertPageToPNGMemoryStream(Page)
ページをPNGに変換してDSR、OMR、OCR画像ストリームを生成します。
public MemoryStream ConvertPageToPNGMemoryStream(Page page)
パラメーター
page
Page
変換するページ。
戻り値
画像ストリーム。
Decrypt()
ドキュメントの暗号を解除します。その後、保存を呼び出して暗号解除されたバージョンのドキュメントを取得します。
public void Decrypt()
Dispose()
このドキュメントで使用されるすべてのリソースを閉じます。
public void Dispose()
Encrypt(string, string, DocumentPrivilege, CryptoAlgorithm, bool)
ドキュメントを暗号化します。その後、保存を呼び出して暗号化されたバージョンのドキュメントを取得します。
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)
ドキュメントを暗号化します。その後、保存を呼び出して暗号化されたバージョンのドキュメントを取得します。
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)
ドキュメントを暗号化します。その後、保存を呼び出して暗号化されたバージョンのドキュメントを取得します。
public void Encrypt(string userPassword, string ownerPassword, Permissions permissions, CryptoAlgorithm cryptoAlgorithm, bool usePdf20)
パラメーター
userPassword
string
ユーザーパスワード。
ownerPassword
string
オーナーパスワード。
permissions
Permissions
ドキュメントの権限。詳細についてはAspose.Pdf.Document.Permissionsを参照してください。
cryptoAlgorithm
CryptoAlgorithm
暗号化アルゴリズム。詳細についてはAspose.Pdf.Document.CryptoAlgorithmを参照してください。
usePdf20
bool
改訂6(拡張8)をサポートします。
ExportAnnotationsToXfdf(string)
すべてのドキュメント注釈をXFDFファイルにエクスポートします。
public void ExportAnnotationsToXfdf(string fileName)
パラメーター
fileName
string
XFDFファイル名
ExportAnnotationsToXfdf(Stream)
すべてのドキュメント注釈をストリームにエクスポートします。
public void ExportAnnotationsToXfdf(Stream stream)
パラメーター
stream
Stream
XFDFを保存するストリーム。
Flatten()
ドキュメントからすべてのフィールドを削除し、その値を代わりに配置します。
public void Flatten()
Flatten(FlattenSettings)
ドキュメントからすべてのフィールド(および注釈)を削除し、その値を代わりに配置します。
public void Flatten(Form.FlattenSettings flattenSettings)
パラメーター
flattenSettings
Form.FlattenSettings
フラット化プロセスの設定。
FlattenTransparency()
透明なコンテンツを不透明なラスタおよびベクターグラフィックスに置き換えます。
public void FlattenTransparency()
FreeMemory()
メモリをクリアします。
public void FreeMemory()
GetCatalogValue(string)
カタログ辞書からアイテムの値を返します。
public object GetCatalogValue(string key)
パラメーター
key
string
アイテムのキー。
戻り値
アイテムの値 - キーが正常に見つかった場合。そうでない場合はnull。
GetObjectById(string)
ドキュメント内の指定されたIDを持つオブジェクトを取得します。
public object GetObjectById(string id)
パラメーター
id
string
オブジェクトID。
戻り値
指定されたIDを持つオブジェクト。IDが見つからない場合はnull。
GetXmpMetadata(Stream)
ドキュメントからXMPメタデータを取得します。
public void GetXmpMetadata(Stream stream)
パラメーター
stream
Stream
メタデータが保存されるストリーム。
HasIncrementalUpdate()
現在のPDFドキュメントが増分更新で保存されたかどうかをチェックします。
public bool HasIncrementalUpdate()
戻り値
true
の場合、PDFドキュメントに増分更新があります。それ以外の場合はfalse
。
ImportAnnotationsFromXfdf(string)
XFDFファイルからドキュメントに注釈をインポートします。
public void ImportAnnotationsFromXfdf(string fileName)
パラメーター
fileName
string
XFDFファイル名
ImportAnnotationsFromXfdf(Stream)
ストリームからドキュメントに注釈をインポートします。
public void ImportAnnotationsFromXfdf(Stream stream)
パラメーター
stream
Stream
XFDFデータを含むストリーム。
LoadFrom(string, LoadOptions)
ファイルを読み込み、PDFに変換します。
public void LoadFrom(string filename, LoadOptions options)
パラメーター
filename
string
開くファイルへのパス。
options
LoadOptions
読み込みオプション。
例外
PdfException
ファイルを読み込めない場合。
ファイルが見つからない場合。
Merge(MergeOptions, params Document[])
ドキュメントをマージします。
public void Merge(Document.MergeOptions mergeOptions, params Document[] documents)
パラメーター
mergeOptions
Document.MergeOptions
マージオプション。
documents
Document[]
マージするドキュメント。
Merge(MergeOptions, params string[])
ドキュメントをマージします。
public void Merge(Document.MergeOptions mergeOptions, params string[] files)
パラメーター
mergeOptions
Document.MergeOptions
マージオプション。
files
string[]
マージするPDFファイル。
Merge(params Document[])
ドキュメントをマージします。
public void Merge(params Document[] documents)
パラメーター
documents
Document[]
マージするドキュメント。
Merge(params string[])
PDFファイルをマージします。
public void Merge(params string[] files)
パラメーター
files
string[]
マージするPDFファイル。
MergeDocuments(MergeOptions, params string[])
ドキュメントをマージします。
public static Document MergeDocuments(Document.MergeOptions mergeOptions, params string[] files)
パラメーター
mergeOptions
Document.MergeOptions
マージオプション。
files
string[]
マージするPDFファイル。
戻り値
マージされたドキュメント。
MergeDocuments(MergeOptions, params Document[])
ドキュメントをマージします。
public static Document MergeDocuments(Document.MergeOptions mergeOptions, params Document[] files)
パラメーター
mergeOptions
Document.MergeOptions
files
Document[]
マージするドキュメント。
戻り値
マージされたドキュメント。
MergeDocuments(params string[])
PDFファイルをマージします。
public static Document MergeDocuments(params string[] files)
パラメーター
files
string[]
マージするPDFファイル。
戻り値
マージされたドキュメント。
MergeDocuments(params Document[])
ドキュメントをマージします。
public static Document MergeDocuments(params Document[] documents)
パラメーター
documents
Document[]
マージするドキュメント。
戻り値
マージされたドキュメント。
Optimize()
ドキュメントを線形化して、
- 最初のページをできるだけ早く開くため;
- 次のページまたは次のページへのリンクをできるだけ早く表示するため;
- ページのデータが遅いチャネルを介して配信されるときに、ページをインクリメンタルに表示するため(最も有用なデータを最初に表示);
- ユーザーの操作(たとえば、リンクのフォロー)を、ページ全体が受信され表示される前に実行できるようにします。 このメソッドを呼び出しても、実際にはドキュメントは保存されません。逆に、ドキュメントは最適化された構造を持つように準備されるだけであり、最適化されたドキュメントを取得するには保存を呼び出す必要があります。
public void Optimize()
OptimizeResources()
ドキュメント内のリソースを最適化します:
- ドキュメントページで使用されていないリソースが削除されます;
- 等しいリソースが1つのオブジェクトに結合されます;
- 使用されていないオブジェクトが削除されます。
public void OptimizeResources()
OptimizeResources(OptimizationOptions)
定義された最適化戦略に従ってドキュメント内のリソースを最適化します。
public void OptimizeResources(OptimizationOptions strategy)
パラメーター
strategy
OptimizationOptions
最適化戦略。
PageNodesToBalancedTree(byte)
ドキュメント内のページツリーノードをバランスの取れたツリーに整理します。 ドキュメントにnodesNumInSubtreesページオブジェクトが10個以上ある場合のみ、そうでない場合は何もしません。 Pages要素を反復処理している間にこのメソッドを呼び出さないでください。予測不可能な結果をもたらす可能性があります。
public void PageNodesToBalancedTree(byte nodesNumInSubtrees = 10)
パラメーター
nodesNumInSubtrees
byte
サブノードの希望数。デフォルト値は10です。
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
フォーマットオプション。
例外
Aspose.Pdf.HtmlSaveOptionsがメソッドに渡された場合、System.ArgumentExceptionが発生します。HTMLストリームにドキュメントを保存することはサポートされていません。ファイルに保存するメソッドを使用してください。
SaveAsync(Stream, CancellationToken)
ドキュメントをストリームに保存します。
public Task SaveAsync(Stream output, CancellationToken cancellationToken)
パラメーター
output
Stream
ドキュメントが保存されるストリーム。
cancellationToken
CancellationToken
キャンセルトークン。
戻り値
非同期タスク。
SaveAsync(string, CancellationToken)
指定されたファイルにドキュメントを保存します。
public Task SaveAsync(string outputFileName, CancellationToken cancellationToken)
パラメーター
outputFileName
string
ドキュメントが保存されるファイルへのパス。
cancellationToken
CancellationToken
キャンセルトークン。
戻り値
非同期タスク。
SaveAsync(CancellationToken)
ドキュメントを増分的に保存します(すなわち、増分更新技術を使用して)。
public Task SaveAsync(CancellationToken cancellationToken)
パラメーター
cancellationToken
CancellationToken
キャンセルトークン。
戻り値
非同期タスク。
備考
ドキュメントを増分的に保存するには、 ドキュメントファ