Form – Aspose FOSS API Reference

Form

概要

Form は Aspose.PDF の .NET 用 FOSS におけるクラスです。継承元: ICollection<Aspose.Pdf.Annotations.WidgetAnnotation>。

PDF ドキュメントのインタラクティブフォーム（AcroForm）を表します。

このクラスは、.NET プログラム内の Form オブジェクトを操作するための 37 のメソッドを提供します。利用可能なメソッドは、Add、AddFieldAppearance、AssignXfa、CopyTo、Delete、ExportFdf、ExportToJson、ExportXfdf、FindByName、FindField、Flatten、Form、および追加の 15 メソッドです。すべてのパブリックメンバーは、Aspose.PDF の .NET 用 FOSS パッケージをインストールした後、任意の .NET アプリケーションから利用可能です。プロパティ: AutoRecalculate、AutoRestoreForm、CalculatedFields、Count、DefaultAppearance、DefaultResources、およびその他 14 件。

プロパティ

名前	型	アクセス	説明
`HasXfa`	`bool`	読み取り	フォームに XFA パートが含まれている場合は True。
`AutoRecalculate`	`bool`	読み取り/書き込み	True の場合、依存関係が変わるたびに計算フィールドを再計算します。
`AutoRestoreForm`	`bool`	読み取り/書き込み	フォームが AcroForm /Fields エントリが欠落または空の場合に、ページウィジェットからフィールドを再構築するかどうか（デフォルトは true）。
`CalculatedFields`	`IEnumerable<Field>?`	読み取り/書き込み	計算パスを駆動するために使用されるフィールドの順序。
`DefaultAppearance`	`Aspose.Pdf.Annotations.DefaultAppearance`	読み取り/書き込み	独自の /DA を持たないフィールドに適用されるデフォルトの外観。
`DefaultResources`	`Aspose.Pdf.Resources?`	読み取り	フォームで使用されるデフォルトのフォント / カラースペースリソース。
`IsSynchronized`	`bool`	読み取り	基になるコレクションがスレッドセーフかどうか。
`NeedsRendering`	`bool`	読み取り	フォームに NeedsAppearances フラグが設定されている場合は True。
`RemovePermission`	`bool`	読み取り/書き込み	true の場合、保存する前にドキュメントのパーミッションビットが削除されます。
`SignaturesAppendOnly`	`bool`	読み取り/書き込み	true の場合、ライターは署名バイパスの変更を無視します。
`SyncRoot`	`object`	読み取り	IsSynchronized の同期ルートオブジェクト。
`Type`	`FormType`	読み取り/書き込み	フォームタイプ（Standard、Static、Dynamic）。
`IsXfa`	`bool`	読み取り	このフォームが XFA フォームかどうか。
`XFA`	`XFA?`	読み取り	XFA アクセサが、基礎となる XML パケット（template、datasets、…）を公開します。
`Fields`	`Field[]`	読み取り	フォームフィールドをスナップショット配列として返します。
`IgnoreNeedsRendering`	`bool`	読み取り/書き込み	true の場合、フォームの NeedAppearances エントリが抑制されるため、Acrobat は開く時にウィジェットの外観を再構築しません。
`EmulateRequierdGroups`	`bool`	読み取り/書き込み	true の場合、フォームの flatten step は、XFA スタイルの ‘requiredGroups’ で「少なくとも1つが必須」という制約が満たされていない場合に、合成された Required マーカーを追加します。
`Count`	`int`	読み取り	ROOT フォームフィールドの数 — AcroForm の /Fields 配列のエントリ（field-/Parent が null のフィールド）。
`RadioGroups`	`IReadOnlyList<RadioButtonGroup>`	読み取り	フォーム内のすべてのラジオボタングループ。
`SignaturesExist`	`bool`	読み取り/書き込み	このフォームに、/V が null でない署名辞書を持つ署名フィールドが存在する場合は true。

メソッド

シグネチャ	説明
`GetEnumerator()`	この Form インスタンスで GetEnumerator を呼び出します。
`Add(field: Field, partialName: string, pageNumber: int)`	フィールドを新しい部分名の下でフォームにコピーし、そのウィジェットを pageNumber にバインドします。
`AddFieldAppearance(field: Field, pageNumber: int, rect: Rectangle)`	特定のページの矩形内にあるフィールドへ新しいウィジェット外観を追加します。
`AssignXfa(xml: XmlDocument)`	指定された XmlDocument から XFA データセットを置き換えます。
`CopyTo(array: Field[], index: int)`	提供された配列のインデックスからフィールドをコピーします。
`Delete(field: Field)`	提供されたフィールドをフォームから削除します。
`ExportToJson(stream: Stream)`	提供されたストリームを介して、フォームのフィールドをJSONにシリアライズします。
`ExportToJson(fileName: string)`	ファイルにフォームのフィールドをJSONとしてシリアライズします。
`ExportToJson(stream: Stream, options: ExportFieldsToJsonOptions?)`	提供されたストリームを介して、フォームのフィールドをJSONにシリアライズします。
`ExportToJson(fileName: string, options: ExportFieldsToJsonOptions?)`	フォームのフィールドをJSONとしてファイルにシリアライズします。
`GetFieldsInRect(rect: Rectangle)`	提供された矩形と交差するフィールドを返します。
`HasField(field: Field)`	提供されたフィールドがこのフォームに属している場合は true。
`ImportFromJson(stream: Stream)`	フォームフィールドの値をJSONストリームから読み取り、適用します。
`ImportFromJson(fileName: string)`	フォームフィールドの値をJSONファイルから読み取り、適用します。
`MakeFormAnnotationsIndependent(page: Page)`	フォームアノテーションをフィールドツリーから切り離し、ページ間で独立して移動できるようにします。
`RemoveFieldAppearance(field: Field, appearanceIndex: int)`	フィールドから特定の外観エントリを削除します。
`GetXfaDatasetsXml()`	XFA データセット XML を取得します。XFA フォームでない場合は null を返します。
`ExportFdf()`	PDF 仕様 §12.7.7 に従って、FDF (Forms Data Format) でフォームフィールドデータをエクスポートします。
`ImportFdf(fdfData: byte[])`	FDF バイトからフォームフィールドデータをインポートします。
`ExportXfdf()`	XFDF (XML Forms Data Format) でフォームフィールドデータをエクスポートします。
`ImportXfdf(xfdfXml: string)`	XFDF XML 文字列からフォームフィールドデータをインポートします。
`GetXfaFieldValue(path: string)`	データセット XML の中で、ドット区切りのパスにより XFA フィールドの値を取得します。
`SetXfaFieldValue(path: string, value: string)`	データセット XML のドット区切りパスで XFA フィールドの値を設定します。
`SetXfaFieldValues(values: IReadOnlyList<KeyValuePair<string, string>>)`	1つのデータセットの解析/シリアライズサイクルで複数の XFA フィールド値を設定します。
`SetXfaFieldImage(path: string, base64: string, contentType: string)`	パス用に XFA データセットノードに base64 画像を書き込み、指定された contentType でタグ付けします（例：
`Flatten()`	すべてのフォームフィールドをフラット化します — 視覚的な外観をページコンテンツにレンダリングし、インタラクティブなフォームを削除します。
`Flatten(document: Document)`	すべてのフォームフィールドをフラット化 — 視覚的外観をページコンテンツにレンダリングし、インタラクティブなフォームを削除します。
`Form(document: Document)`	ドキュメントにバインドされたフォームを作成します。
`Delete(fieldName: string)`	名前でフォームフィールドを削除します。
`Add(field: Field)`	指定されたページのフォームにフィールドを追加します。
`Add(field: Field, pageNumber: int)`	追加するフィールド。
`findField(fullName: string)`	名前でフィールドを検索します; 見つからない場合は null を返します。
`FindField(fullName: string)`	PascalCase は findField のエイリアスです。
`ToObject()`	すべてのフィールド値を辞書としてエクスポートします（フィールド名 → 値）。
`HasField(fieldName: string)`	指定された完全名を持つフィールドが AcroForm に存在する場合は True。
`HasField(fieldName: string, searchChildren: bool)`	指定された名前を持つフィールドが存在する場合は True。
`FindByName(fullName: string)`	完全名、または静的 XFA フォームの場合は XFA パスでフィールドを検索します。

参照

Aspose.PDF for .NET — Enterprise API Reference