Document

概要

Document は Aspose.PDF の Go 用 FOSS の型です。

Document は PDF ドキュメントです。

この型は、Go プログラムで Document オブジェクトを操作するための 88 のメソッドを提供します。利用可能なメソッドは、AddBlankPage、AddBlankPageFromFormat、AddLayer、AddSVGObjectWatermark、AddSVGWatermark、AddSVGWatermarkFromStream、AddStamp、AddTextWatermark、Append、ApplyRedactions、Booklet、ChangePassword、および追加の 76 メソッドです。Aspose.PDF の FOSS for Go パッケージをインストールすれば、すべての公開メンバーに任意の Go アプリケーションからアクセスできます。

メソッド

シグネチャ	説明
`PageCount()` → `int`	PageCount はドキュメント内のページ数を返します。
`Pages()` → `[]*Page`	Pages はドキュメント内のすべてのページのライブビューを返します。
`Page(n: int)` → `(*Page, error)`	Page は、指定された 1 から始まる番号のページのライブビューを返します。
`Append(others: ...*Document)`	Append は、他のドキュメントからすべてのページをこのドキュメントに追加し、オブジェクトをマージします。
`RemoveUnusedObjects()` → `int`	RemoveUnusedObjects は、任意のページから到達できないドキュメント内のオブジェクトを削除します。
`SetPassword(userPassword: string)`	SetPassword は、保存時にドキュメントが暗号化されるように設定します。
`SetPermissions(p: Permissions)`	SetPermissions は、暗号化されたドキュメントに対してビューアが許可する操作（印刷、コピー、変更など）を設定します。
`Permissions()` → `(Permissions, bool)`	Permissions は、このドキュメントに現在設定されているビューア権限設定と、ドキュメントが暗号化されているかどうかを示すブール値を返します。
`RemoveEncryption()`	RemoveEncryption は、以前に設定された暗号化（パスワードと権限）をすべてクリアし、次の保存でプレーンテキストの PDF が生成されます。
`ChangePassword(newUserPassword: string)` → `error`	ChangePassword は、次の保存時に新しいパスワードでドキュメントを再暗号化し、現在の暗号化アルゴリズムと権限はそのまま保持します。
`SetEncryption(opts: EncryptionOptions)`	SetEncryption は、EncryptionOptions 構造体からすべての暗号化関連設定を一括で構成します。
`WriteTo(w: io.Writer)` → `(int64, error)`	WriteTo は、ドキュメントを w に書き込みます。
`Save(outputPath: string)` → `error`	Save はドキュメントを outputPath に書き込みます。
`AddBlankPage(width: float64)` → `error`	AddBlankPage はドキュメントの末尾に空白ページを追加します。
`AddBlankPageFromFormat(format: PageFormat)` → `error`	AddBlankPageFromFormat は事前定義されたページ形式を使用して空白ページを追加します。
`InsertBlankPage(position: int, width: float64)` → `error`	InsertBlankPage は指定された 1 ベースの位置に空白ページを挿入します。
`InsertBlankPageFromFormat(position: int, format: PageFormat)` → `error`	InsertBlankPageFromFormat は、事前定義されたページフォーマットを使用して、指定された位置に空白ページを挿入します。
`Rotate(angle: RotationAngle, pageNums: ...int)` → `error`	Rotate は選択されたページを角度 (Rotate90、Rotate180、または Rotate270) で時計回りに回転させます。
`SetRotation(angle: RotationAngle, pageNums: ...int)` → `error`	SetRotation は、選択されたページを正確に角度 (Rotate0、Rotate90、Rotate180、または Rotate270) に設定し、既存の回転を置き換えます。
`Reorder(order: []int)` → `error`	Reorder は、order（1ベースのページ番号のスライス）に従ってページを再配置します。
`DeletePage(n: int)` → `error`	DeletePage は、指定された 1 ベースの番号のページを削除します。
`DeletePages(pageNums: ...int)` → `error`	DeletePages は、指定された 1 から始まるページ番号のページを削除します。
`Split()` → `([]*Document, error)`	Split は、ドキュメントの各ページを個別の *Document として返します。
`Extract(ranges: ...PageRange)` → `(*Document, error)`	Extract は、指定された範囲のページのみを含む新しい Document を返します。
`EmbeddedFiles()` → `*EmbeddedFiles`	EmbeddedFiles は、ドキュメントレベルの埋め込みファイルコレクションを返します。
`Flatten()` → `error`	Flatten はドキュメントのインタラクティブなフォームフィールドを静的なページコンテンツに焼き込み、AcroForm を削除します。その結果は同一に表示されますが、もはや入力可能ではなくなります。
`NewFlow(opts: FlowOptions)` → `*Flow`	NewFlow はフローを作成し、それがドキュメント d にレンダリングされます。
`LoadFont(path: string)` → `(Font, error)`	LoadFont は TTF ファイルを読み取り、解析し、ドキュメントに埋め込み、TextStyle.Font で使用できる Font を返します。
`LoadFontFromStream(r: io.Reader)` → `(Font, error)`	LoadFontFromStream は LoadFont と似ていますが、io.Reader から読み取ります。
`LoadFontByName(family: string, bold: bool)` → `(Font, error)`	LoadFontByName は、FontRepository を介してフォントファミリ名（オプションでボールド／イタリックスタイル）でフォントを解決し、まず AddFontFolder / AddFontFile に登録されたフォルダとファイル、次に OS のフォントディレクトリを検索します — マッチしたフォントを文書に埋め込み、TextStyle.Font で使用できる Font を返します。
`SubsetFonts()` → `(int, error)`	SubsetFonts は、埋め込まれたすべての TTF（LoadFont 経由でロードされた）を実際に描画されるグリフだけに縮小し、各 /FontFile2 を再構築されたサブセットプログラムに置き換え、CIDFont の /CIDToGIDMap を /Identity から、元のグリフ ID（コンテンツストリームで CID としてそのまま使用される）をコンパクトなサブセットグリフ ID にマッピングするストリームに切り替えます。
`Form()` → `*Form`	Form は文書の AcroForm を返します。
`CreateForm(width: float64)` → `*XForm`	CreateForm は、指定されたサイズ（ポイント）の空の Form XObject を作成します。
`ImportForm(form: XForm)` → `(XForm, error)`	ImportForm は、別のドキュメントから Form XObject（およびフォント、画像、入れ子フォームなどのリソース全体）をこのドキュメントにコピーし、Page.AddForm で配置できる新しい XForm を返します。
`ConvertToGrayscale()` → `error`	ConvertToGrayscale は、ドキュメントをその場でグレースケールに変換します。コンテンツストリーム内で設定されたすべてのデバイスカラー（テキスト、ベクターグラフィック）、すべてのラスタ画像、シェーディングおよび注釈のカラーは、輝度のグレーにマッピングされます。
`SaveHTML(outputPath: string, opts: ...HTMLSaveOptions)` → `error`	SaveHTML はドキュメントを書き出します。HTML ファイルとして — デフォルトでは自己完結型です；ResourceDir/ResourceWriter を使用すると、重い部分が外部ファイルになり、SplitPages を使用すると、各ページがそれぞれ _p.html になります。
`WriteHTML(w: io.Writer, opts: ...HTMLSaveOptions)` → `error`	WriteHTML はドキュメントを書き出します。単一の自己完結型 HTML ファイルとして w: に、各ページごとにテキスト層の下にラスタ背景（HTMLModeFaithful では透明、HTMLModeText では可視）とリンク注釈オーバーレイを含みます。
`ExtractImages()` → `([][]Image, error)`	ExtractImages はすべてのページから画像を返します（ページあたり1スライス）。
`ImageInfos()` → `([][]ImageInfo, error)`	ImageInfos はすべてのページの画像メタデータを、ピクセルデータをデコードせずに（ページあたり1スライス）返します。
`OptimizeImages(opts: OptimizeImageOptions)` → `(int, error)`	OptimizeImages はドキュメント内のすべての画像を最適化し、ファイルサイズを削減します。
`NUp(opts: NUpOptions)` → `(*Document, error)`	NUp は新しい Document を返し、このドキュメントのページを Rows×Cols グリッドの大きな用紙に配置します（例として.
`Booklet(opts: BookletOptions)` → `(*Document, error)`	Booklet は新しい Document を返し、このドキュメントのページを 2-up で配置し、サドルステッチ綴じ用に順序を入れ替えます：両面印刷し、スタックを半分に折り、ページを順番に読めるようにします。
`JavaScript()` → `*JavaScriptCollection`	JavaScript はドキュメントレベルの JavaScript コレクションを返します。
`SaveLinearized(outputPath: string)` → `error`	SaveLinearized はドキュメントを outputPath にリニアライズされた（「fast web view」）PDF（ISO 32000-1 Annex F）として書き込みます。最初のページのオブジェクトとヒントテーブルが先頭に配置されるため、ビューアはファイル全体がダウンロードされる前にページ 1 をレンダリングできます。
`WriteToLinearized(w: io.Writer)` → `(int64, error)`	WriteToLinearized はドキュメントをリニアライズされた PDF として w に書き込みます（io.WriterTo スタイルの契約を実装）。
`Info()` → `(DocumentInfo, error)`	Info はこのドキュメントから Info-dictionary メタデータを返します。
`SetInfo(info: DocumentInfo)`	SetInfo はドキュメントの Info 辞書を指定されたメタデータに置き換えます。
`ClearInfo()`	ClearInfo は Info ディクショナリを完全に削除します。
`NamedDestinations()` → `*NamedDestinations`	NamedDestinations は文書の名前付きデスティネーションコレクションを返します。
`OpenAction()` → `Action`	OpenAction は、文書が開かれたときにビューアが実行するアクション（ISO 32000-1 §12.3.2 / §12.6.1 に基づく /Catalog/OpenAction）を返します。設定されていない場合は nil を返します。
`SetOpenAction(act: Action)`	SetOpenAction は文書が開かれたときに実行されるアクションを設定します。
`RemoveOpenAction()`	RemoveOpenAction は /Catalog/OpenAction をすべてクリアします。
`AddLayer(name: string)` → `*Layer`	AddLayer は、name という名前の新しいレイヤー（OCG）を作成し、ドキュメントのオプショナルコンテンツプロパティに登録します。
`Layers()` → `[]*Layer`	Layers は、/OCProperties/OCGs の順序でドキュメントのレイヤー（OCG）を返します。
`Outlines()` → `*OutlineItemCollection`	Outlines は、ドキュメントのルートアウトラインコレクションを返します。
`SetPageLabels(ranges: []PageLabelRange)` → `error`	SetPageLabels は、ドキュメントの /PageLabels 番号ツリーをインストールし、PDF ビューアがナビゲーションペインやページインジケータに「i, ii, 1, 2, …」といったラベルを表示できるようにします。
`ClearPageLabels()`	ClearPageLabels はドキュメントの /PageLabels エントリを削除します。
`Paragraphs()` → `([]PageMarkup, error)`	Paragraphs は各ページの構造化テキストを返します。
`ConvertToPDFA(format: PDFAFormat)` → `(*PDFAValidationReport, error)`	ConvertToPDFA はドキュメントを PDF/A の「b」レベル適合プロファイルに調整し、残っている違反を記述した検証レポートを返します。
`ValidateRedactions()` → `error`	ValidateRedactions は、少なくとも1つの RedactAnnotation を含むすべてのページに対して、事前フライトのドライラン可解析性チェックを実行します。
`ApplyRedactions()` → `error`	ApplyRedactions は、すべての /Redact アノテーションの /QuadPoints（または /QuadPoints が空の場合は /Rect）内のコンテンツ（テキストグリフ、画像 XObject、パス）を破壊的に削除します。
`RenderImage(pageNum: int, opts: RenderOptions)` → `(image.Image, error)`	RenderImage は、1 から始まるページ番号を画像としてレンダリングします。
`RenderTIFF(w: io.Writer, opts: RenderOptions, pageNums: ...int)` → `error`	RenderTIFF は、ドキュメントを単一のマルチページ TIFF にレンダリングし、w に書き込みます。
`ReplaceText(old: string, opts: ...ReplaceOptions)` → `(int, error)`	ReplaceText は、すべてのページで old のすべての出現箇所を replacement に置き換え、置換総数を返します。
`Sign(opts: SignOptions)` → `error`	Sign は、次の Save/WriteTo に適用されるデジタル署名を設定します。
`VerifySignatures()` → `([]SignatureVerification, error)`	VerifySignatures は文書内のすべてのデジタル署名を検証し、署名フィールドごとに文書順で 1 つの結果を返します。
`AddStamp(s: Stamp, pageNums: ...int)` → `error`	AddStamp は指定された 1 から始まるページ（指定がない場合はすべてのページ）にスタンプを描画します — ウォーターマーク、ヘッダー、フッター、ページ番号に便利です。
`LoadSVG(path: string)` → `(*SVG, error)`	LoadSVG は SVG ファイルを一度読み込み解析し、再解析せずに Page.AddSVGObject または Document.AddSVGObjectWatermark に複数回渡すことができる *SVG を返します。
`LoadSVGFromStream(r: io.Reader)` → `(*SVG, error)`	LoadSVGFromStream は LoadSVG の io.Reader バリアントです。
`AddSVGWatermark(path: string, pageNums: ...int)` → `error`	AddSVGWatermark は、すべてのページ（pageNums が空の場合）または指定された 1 ベースのページ番号に SVG ウォーターマークを適用します。
`AddSVGWatermarkFromStream(r: io.Reader, pageNums: ...int)` → `error`	AddSVGWatermarkFromStream は AddSVGWatermark の io.Reader バリアントです。
`SetSVGFontResolver(fn: SVGFontResolver)`	SetSVGFontResolver はカスタムリゾルバをインストールします。
`AddSVGObjectWatermark(svg: *SVG, pageNums: ...int)` → `error`	AddSVGObjectWatermark は透かしコンテンツに事前にパースされた *SVG を使用します。
`TaggedContent()` → `*TaggedContent`	TaggedContent はドキュメントのタグ付けコンテンツファサードを返し、最初の呼び出し時に構造ツリーと /MarkInfo、 /ViewerPreferences、 /StructTreeRoot カタログエントリを作成します。
`ExtractText(opts: ...TextExtractOptions)` → `([]string, error)`	ExtractText は、各ページのテキストコンテンツを返します（ページごとに1つのエントリ、0ベースインデックス）。
`AddTextWatermark(text: string, style: TextStyle, pageNums: ...int)` → `error`	AddTextWatermark は、ドキュメントの選択されたページにテキスト透かしを追加します。
`ExtractTextWithLayout()` → `([][]TextLine, error)`	ExtractTextWithLayout は、各ページの構造化テキスト行を返します。
`SearchText(query: string, opts: ...SearchOptions)` → `([]TextMatch, error)`	SearchText は、ドキュメント全ページにわたるクエリのすべての出現箇所を検索し、読み順にページごとに一致結果を返します。
`GenerateTOC(opts: ...TOCOptions)` → `(int, error)`	GenerateTOCは、ドキュメントのアウトライン（ブックマーク）ツリーから目次を作成し、ドキュメントの先頭に新しいページとして挿入します。
`ValidatePDFA(format: PDFAFormat)` → `*PDFAValidationReport`	ValidatePDFAは、ドキュメントをPDF/Aの「b」レベル適合プロファイルと照合し、違反のレポートを返します。
`ValidatePDFUA()` → `*PDFUAValidationReport`	ValidatePDFUAは、ドキュメントをPDF/UA-1（ISO 14289-1、ユニバーサルアクセシビリティ）のサブセットと照合し、違反のレポートを返します。
`CreateTilingPattern(width: float64)` → `*TilingPattern`	CreateTilingPatternは、セルが幅×高さポイントの空のタイルパターンを作成します。
`XMP()` → `(XMPMetadata, error)`	XMP は /Catalog/Metadata ストリームから解析されたドキュメントの XMP メタデータを返します。
`XMPRaw()` → `([]byte, error)`	XMPRaw は /Catalog/Metadata から取得した XMP パケットの生バイト列を返します。ドキュメントに XMP ストリームがない場合は nil を返します。
`SetXMP(meta: XMPMetadata)` → `error`	SetXMP は meta を標準的な XMP パケットにシリアライズし、/Catalog/Metadata ストリームとして保存します（非圧縮、/Type /Metadata /Subtype /XML は ISO 32000-1 §14.3.2 に従います）。
`SetXMPRaw(data: []byte)` → `error`	SetXMPRaw はデータをそのまま /Catalog/Metadata ストリームに保存します — 独自の XMP パケットを生成する呼び出し側のためのエスケープハッチです。
`ClearXMP()`	ClearXMP は /Catalog/Metadata エントリを削除します。
`SyncInfoToXMP()` → `error`	SyncInfoToXMP は、ドキュメントの現在の /Info 辞書から XMP パケットを作成し、インストールします。これにより、2 つのメタデータストアが一致します (ISO 32000-1 §14.3.2 は、両方が存在する場合の一貫性を推奨しています)。

参照

Aspose.PDF — Enterprise API Reference