DioDocs for PDF
GcPdfDocument クラス メンバ
フィールド  プロパティ  メソッド  イベント

DS.Documents.Pdf アセンブリ > GrapeCity.Documents.Pdf 名前空間 : GcPdfDocument クラス

GcPdfDocumentデータ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ
 名前解説
Public コンストラクタGcPdfDocument クラスの新しいインスタンスを作成し、 オプションでライセンスキーを指定します。  
トップ
パブリック フィールド
 名前解説
Public フィールドstatic (Shared in Visual Basic)内部使用。GrapeCity.Documents.Pdf.Log.Log は、PDFパーサー操作を記録するために使用されます。デフォルトでは、このフィールドはnullです。可能なパーサ警告、情報メッセージなどを取得したい場合は、GrapeCity.Documents.Pdf.Log.Log のインスタンスに設定します。  
トップ
パブリック プロパティ
 名前解説
Public プロパティこのドキュメント内の AcroForm の共通プロパティを定義する GrapeCity.Documents.Pdf.AcroForms.AcroForm を取得します。  
Public プロパティGrapeCity.Documents.Pdf.Articles.ArticleThread オブジェクトのリストを取得します。  
Public プロパティドキュメント全体に関連付けられている埋め込みファイルのコレクションを取得します。通常は、どの埋め込みファイルがPDFドキュメントのソースであるかを識別するために使用されます。  
Public プロパティstatic (Shared in Visual Basic)リッチテキストコンテンツを含む注釈の外観ストリームを生成するかどうかを示す値を取得または設定します (GrapeCity.Documents.Pdf.Annotations.FreeTextAnnotation, GrapeCity.Documents.Pdf.Annotations.LineAnnotation). このプロパティのデフォルト値はfalseです。

現在、一つの制限があることにご注意ください:ーこのプロパティがtrue に設定されている場合、リッチテキストの外観ストリームが生成され、すべてのリッチテキスト書式設定が無視されます。

 
Public プロパティstatic (Shared in Visual Basic)ICMapProvider インターフェイスを実装するオブジェクトを取得または設定します。 PDFファイルに名前で指定する場合は、GcPdfDocument はそのインターフェイスを使用して GrapeCity.Documents.Pdf.Text.CMap.CMap を取得します。

デフォルトでは、GcPdfは、オプションのGrapeCity.Documents.Pdf.Resourcesパッケージに定義する CMapProvider.Instanceを使用して、 GcPdfDocumentのコンストラクタにこのプロパティを自動的に初期化しようとします(この場合、アプリケーションによって明示的に参照する必要があります)。

 
Public プロパティ圧縮レベルを取得または設定します。 デフォルト値は System.IO.Compression.CompressionLevel.Fastest.です。  
Public プロパティPDF/A 適合レベルを取得または設定します。

デフォルトは None(ドキュメントは PDF/A に適合していない)です。

 
Public プロパティドキュメントカタログの Dests エントリで定義された名前付き宛先の辞書を取得します。  
Public プロパティName Dictionary の Dests エントリで定義された名前付き宛先の辞書を取得します。  
Public プロパティこのドキュメントに関する情報(作成者、タイトルなど)を含む DocumentInfo オブジェクトを取得または設定します。

メモ:このプロパティは、デフォルト(GcPdfDocument が作成されたとき)では null ではありませんが、 ロードされたドキュメントにドキュメント情報オブジェクトがない場合は、 Load(Stream,String) の呼び出し後に null になります。

 
Public プロパティドキュメントレベルの添付ファイルの辞書を取得します。  
Public プロパティこの PDF ドキュメントの ID を定義する FileID オブジェクトを取得または設定します。 Clear メソッドが呼び出されると、この ID は自動的に更新されます。  
Public プロパティstatic (Shared in Visual Basic)内部使用。 PDF ストリームに書き込まれる float 値に適用される書式文字列を取得または設定します。  
Public プロパティGcPdfDocumentGrapeCity.Documents.Text.Font を見つける必要があるとき(たとえば、PDFに埋め込まれていない場合)に使用される GrapeCity.Documents.Text.IFontCollection オブジェクトを取得または設定します。このプロパティがnull(デフォルト)の場合は、 GrapeCity.Documents.Text.FontCollection.SystemFonts が使用されます。  
Public プロパティフォント埋め込みモードを取得または設定します。

デフォルトはFontEmbedMode.EmbedSubset です。

メモ:このプロパティは 14 個の標準 PDF フォントには影響せず、埋め込みは StandardFontEmbedMode プロパティから決定します。

また、GcPdfDocument が PDF/A として保存され、このプロパティの値が FontEmbedMode.NotEmbed である場合、フォントが FontEmbedMode.EmbedSubset モードを使用して埋め込まれます。

 
Public プロパティ現在のドキュメントに関連付けられているフォントハンドラのコレクションを取得します。  
Public プロパティAcroFormsで使用されるフォントの埋め込みフォントサブセットに含めるUnicode文字を指定するGrapeCity.Documents.Text.Utf32CodeSetオブジェクトを取得または設定します。

この値は、フォントハンドラーのFontHandler.Utf32CodeSetがnullの場合に使用されます。

フォントのFontHandler.Utf32CodeSetがnull、FormEmbedUtf32CodeSetがnull、またそのフォントがAcroFormで使用されている場合、FontHandler.EmbedModeまたはFontEmbedModeで部分的な埋め込みが指定されていても、このフォント全体が埋め込まれます。.

 
Public プロパティ現在のドキュメントに関連付けられているGrapeCity.Documents.Pdf.Graphics.Images.PdfImageHandlerオブジェクトのコレクションを取得します。  
Public プロパティ現在のドキュメントで画像を処理する方法を制御するオプションを含む ImageOptions オブジェクトを取得します。  
Public プロパティドキュメントを保存するときに圧縮を使用するかどうかを示す値を取得します。  
Public プロパティ現在のドキュメントが完全ライセンスされているかどうかを示す値を取得します。  
Public プロパティ新しく追加されたページが横方向かどうかを示す値を取得または設定します。  
Public プロパティ構造要素またはマークされたコンテンツに対して言語仕様によってオーバーライドする場合を除き、ドキュメント内にすべてのテキストの自然言語を指定する言語識別子を取得または設定します。このエントリがない場合、その言語は不明と見なされます。  
Public プロパティこのGcPdfDocumentにロードされたPDFがリニアライズド(「高速Webビュー」)かどうかを示す値を取得します。

この値は、ロードされた元のPDFの線形化のみを示すことに注意してください。現在のドキュメントが保存されている場合、その線形化はこのプロパティの影響を受けません。 現在のドキュメントをリニアライズドPDFとして保存するには、次のいずれかの保存方法を使用してPDFを保存するときにSaveMode.Linearizedを渡します。

 
Public プロパティこのドキュメントのロードに使用されたLoad()メソッドに渡されたSystem.IO.Streamオブジェクトを取得します。また、Load()が呼び出されなかった場合はnullを取得します。  
Public プロパティ構造化PDFドキュメントの特別な用途に関連する追加情報を提供する GrapeCity.Documents.Pdf.Structure.MarkInfo オブジェクトを取得します。  
Public プロパティこのドキュメントに関連付けられているメタデータを取得または設定します。  
Public プロパティ現在のドキュメント内に定義されている名前付き宛先の辞書を取得します。  
Public プロパティドキュメントが開かれるときに表示される DestinationBase または 実行される GrapeCity.Documents.Pdf.Actions.ActionBase を取得または設定します。  
Public プロパティこのドキュメントのオプションのPDFコンテンツ(レイヤー)に関する情報を含むGrapeCity.Documents.Pdf.Layers.OptionalContentPropertiesオブジェクトを取得します。  
Public プロパティ現在のドキュメントアウトラインのコレクションを取得します。  
Public プロパティ現在のドキュメントに関連付けられているOutputIntentオブジェクトのリストを取得します。

ドキュメントがPDF/Aとして保存され(PdfAConformanceLevelを参照)、このコレクションが空の場合、デフォルトの出力インテントが自動的に追加されることに注意してください。

 
Public プロパティPageLabelingRange オブジェクトの辞書を取得します。この辞書の各キーは、ラベル付け範囲の最初のページのインデックスです。  
Public プロパティドキュメントを開くときに使用されるページレイアウトを取得または設定します。  
Public プロパティドキュメントを開いたときにどのように表示するかを取得または設定します。  
Public プロパティ現在のページの面を表す四角形を取得します(ポイント単位)。  
Public プロパティドキュメントを構成する Page オブジェクトのコレクションを取得します。  
Public プロパティドキュメントのデフォルトのページサイズをポイント単位で取得または設定します。  
Public プロパティドキュメントのページサイズを取得または設定します。  
Public プロパティドキュメントが PDF/A 適合かどうかを示す値を取得または設定します。  
Public プロパティ生成されるドキュメントの PDF バージョンを取得または設定します。

デフォルトでは、ドキュメントで使用されている機能に基づいて自動的にバージョンが決定されます。 このプロパティを書式 "1.X" の null 以外の文字列(X は 0 〜 9 の数字)に 設定すると、自動設定された値は指定した値でオーバーライドされます。

このプロパティを null または空の文字列に設定すると、デフォルトの動作に戻ります。

 
Public プロパティページテキストマップを作成するときにPDFコンテンツ認識に使用されるアルゴリズムのタイプを取得または設定します(Page.GetTextMapを参照)。

このプロパティは、GetText(Boolean)FindTextGrapeCity.Documents.Pdf.TextMap.ITextMap.FindTextメソッド、およびテキストマップに依存するその他のAPIなどのメソッドの動作に影響します。

 
Public プロパティ

内部使用。

テキストマップの作成に使用されるオプションを指定するGrapeCity.Documents.Pdf.Recognition.RecognitionOptionsオブジェクトを取得または設定します(GrapeCity.Documents.Pdf.TextMap.ITextMap)。  
Public プロパティ現在のドキュメントのセキュリティ(パスワードなど)を管理する GrapeCity.Documents.Pdf.Security オブジェクトを取得します。  
Public プロパティこのドキュメントに関連付けられているGrapeCity.Documents.Pdf.Security.DocumentSecurityStoreオブジェクトを取得します。  
Public プロパティ14 個の標準 PDF フォントのフォント埋め込みモードを取得または設定します。

デフォルトは FontEmbedMode.NotEmbedです。

メモ: GcPdfDocument が PDF/A として保存され、このプロパティの値が FontEmbedMode.NotEmbed, である場合、標準フォントが FontEmbedMode.EmbedSubset モードを使用して埋め込まれます。

 
Public プロパティPDFの構造タグで定義された現在のドキュメントの構造ツリーを表す GrapeCity.Documents.Pdf.Structure.StructTreeRootオブジェクトを取得します。  
Public プロパティ内部使用。 1 つの操作を使用してストリームを圧縮するかどうかを示す値を 取得または設定します。  
Public プロパティ現在のドキュメントを表示する方法を指定する情報を含む ViewerPreferences を取得します。  
Public プロパティ生成される PDF ファイルにコメントとオプションの改行を追加するかどうかを示す値を取得または設定します。 主にデバッグで便利です。  
Public プロパティ内部使用。NamedDestinations 辞書の DestinationBase オブジェクトをDocument CatalogのNamesサブ辞書のDestsエントリに保存するかどうかを示す値を取得または設定します。メモ:ロードされたドキュメントに名前付きの宛先が含まれている場合、このフラグは使用されません。  
トップ
パブリック メソッド
 名前解説
Public メソッドドキュメントをクリアします。これは、すべてのコンテンツを削除し、すべてのプロパティと設定を初期のデフォルト値にリセットします。  
Public メソッド指定されたテキストを現在のドキュメントのすべてのページから削除します。

結果は、RecognitionAlgorithm プロパティの現在の値の影響をを受けます。

 
Public メソッドシーケンシャルモードのドキュメントの生成を終了します。 この呼び出しの前に、 StartDocを呼び出す必要があります。  
Public メソッドオーバーロードされます。 ドキュメントのフォームデータを FDF 形式でストリームにエクスポートします。  
Public メソッドオーバーロードされます。 ドキュメントのフォームデータを XFDF 形式でストリームにエクスポートします。  
Public メソッドオーバーロードされます。 ドキュメントのフォームデータを XML 形式でストリームにエクスポートします。  
Public メソッドドキュメントのページの範囲内ですべてのテキストを検索します。

結果は、RecognitionAlgorithmプロパティの値の影響を受けます。

 
Public メソッド内部使用。 現在のPDFを説明する統計を取得します。  
Public メソッドこの GcPdfDocument でのフォントのリストを取得します。  
Public メソッドオーバーロードされます。 このGcPdfDocument での画像のリストを取得します。

大きなドキュメントの場合、このメソッドはドキュメント内のすべてのページのコンテンツストリームを列挙するため、時間がかかります。

 
Public メソッドオーバーロードされます。 PDFの構造ツリー(StructTreeRootプロパティによって返される)を解析し、ドキュメントの論理構造を表すGrapeCity.Documents.Pdf.Recognition.Structure.LogicalStructureオブジェクトを作成します。

現在のドキュメントに構造ツリーがない場合はnullを返します。

 
Public メソッド内部使用。指定されたPDFストリームオブジェクトのデータを表す System.IO.Stream オブジェクトを返します。指定されたIDのオブジェクトが存在しない場合はnullを返します。  
Public メソッドオーバーロードされます。 現在のドキュメントからすべてのテキストを抽出して返します。  
Public メソッドオーバーロードされます。 キー/値コレクションからドキュメントのフォームデータをインポートします。

キーはフィールド名、また値はフィールド値のコレクションです。

ネストしたフィールドの場合、フィールドの名前には、ドットで区切られたすべての親の名前を含める必要があります。 TopParent.Parent.MyField.

本メソッドは、Webページから送信されたフォームのデータをインポートするときに特に役立ちます。

 
Public メソッドオーバーロードされます。 ドキュメントのフォームデータを FDF 形式でストリームからインポートします。  
Public メソッドオーバーロードされます。 ドキュメントのフォームデータを XFDF 形式でストリームからインポートします。  
Public メソッドオーバーロードされます。 ドキュメントのフォームデータを XML 形式でストリームからインポートします。  
Public メソッドオーバーロードされます。 指定された入力ストリームからドキュメントを読み取り、 現在のドキュメントの内容を上書きします。 ストリームは有効な PDF データを含み、 ドキュメントのレンダリング中または変更中に開いたままである必要があります。 ドキュメントが変更された場合は、Save(String,Boolean) または Save(Stream,Boolean) メソッドを使用して保存できます。  
Public メソッド指定された GcPdfDocument のすべてまたは一部のページを現在のドキュメントに結合します。  
Public メソッドドキュメントに空のページを追加します。

新しいページのサイズは、 PageSize プロパティの値で定義されます。

新しいページを残りのドキュメントと異なるサイズにする場合は、 新しいページを作成してから、 Page.Size プロパティを設定します。

 
Public メソッドオーバーロードされます。 同じフォントのサブセットを結合し、重複した未使用のフォントを削除することにより、フォントの使用を最適化します。

このメソッドは、OptimizeFontsOptionsのデフォルト値を使用します。.

 
Public メソッドオーバーロードされます。 すべてのGrapeCity.Documents.Pdf.Annotations.RedactAnnotationを現在のドキュメントに適用します。  
Public メソッド間接 PDF オブジェクトを現在のドキュメントに登録し、オブジェクトの ID を GrapeCity.Documents.Pdf.Spec.PdfObjID として返します。  
Public メソッド現在のドキュメントから埋め込みフォントを削除します。

メモ:埋め込みフォントを削除すると、PDF が正しく表示されなくなる場合があります。

 
Public メソッド現在のドキュメントのすべてのページで、指定されたテキストを置き換えます。

結果は、RecognitionAlgorithm プロパティの現在の値の影響を受けます。

 
Public メソッドオーバーロードされます。 デフォルトモードを使用して、現在のPDFドキュメントをファイルに保存します。  
Public メソッドオーバーロードされます。 ドキュメントのページ(出力ファイルあたりの1ページ)をBMP 形式の画像として保存します。

filePath パラメータは、.NET 書式指定の文字列として使用され、現在のページ番号(1から始まる)が書式される値として渡されます。filePath に書式項目("{0}"など)が含まれていない場合は、すべてのページが同じファイル名で保存し、最後のページがそれ以外のすべてを上書きします。

 
Public メソッドオーバーロードされます。 ドキュメントのページ(出力ファイルあたりの1ページ)をGIF 形式の画像として保存します。

filePath パラメータは、.NET 書式指定の文字列として使用され、現在のページ番号(1から始まる)が書式される値として渡されます。filePath に書式項目("{0}"など)が含まれていない場合は、すべてのページが同じファイル名で保存し、最後のページがそれ以外のすべてを上書きします。

 
Public メソッドオーバーロードされます。 ドキュメントページを反復処理し、pageRangeの各ページに対してGrapeCity.Documents.Imaging.GcBitmapを生成します。  
Public メソッドオーバーロードされます。 ドキュメントのページ(出力ファイルあたりの1ページ)をJPEG 形式の画像として保存します。

filePath パラメータは、.NET 書式指定の文字列として使用され、現在のページ番号(1から始まる)が書式される値として渡されます。filePath に書式項目("{0}"など)が含まれていない場合は、すべてのページが同じファイル名で保存し、最後のページがそれ以外のすべてを上書きします。

 
Public メソッドオーバーロードされます。 ドキュメントのページ(出力ファイルあたりの1ページ)をPNG 形式の画像として保存します。

filePath パラメータは、.NET 書式指定の文字列として使用され、現在のページ番号(1から始まる)が書式される値として渡されます。filePath に書式項目("{0}"など)が含まれていない場合は、すべてのページが同じファイル名で保存し、最後のページがそれ以外のすべてを上書きします。

 
Public メソッドオーバーロードされます。 ドキュメントのページ(出力ファイルあたりの1ページ)をSVG 形式の画像として保存します。

filePath パラメータは、.NET 書式指定の文字列として使用され、現在のページ番号(1から始まる)が書式される値として渡されます。filePath に書式項目("{0}"など)が含まれていない場合は、すべてのページが同じファイル名で保存し、最後のページがそれ以外のすべてを上書きします。

 
Public メソッドオーバーロードされます。 ドキュメントのページ(フレームあたりの1ページ)をTIFF 形式の画像としてストリームに保存します。  
Public メソッドstatic (Shared in Visual Basic)ライセンスキーを設定します。  
Public メソッドオーバーロードされます。 現在のドキュメントに署名してファイルに保存します。 stream は読み取り操作とシーク操作をサポートする必要があります。  
Public メソッドシーケンシャルモードのドキュメントの生成を開始します。

このモードでは、ドキュメントのコンテンツを作成したら、一次ファイルを使用せずに、 直接すぐに基になるストリームに書き込みます。 すべてのコンテンツを追加したら、 EndDoc を呼び出してドキュメントの作成を完了します。

 
Public メソッドオーバーロードされます。 ドキュメントのタイムスタンプを追加し、現在のドキュメントをストリームに保存します。  
トップ
パブリック イベント
 名前解説
Public イベントドキュメントが保存またはエクスポートされているときに定期的に発生します。 進行状況インジケーターを実装するために使用できます。  
トップ
参照

GcPdfDocument クラス
GrapeCity.Documents.Pdf 名前空間