Form – Aspose FOSS API Reference

Form

概要

Form は Aspose.PDF の .NET 用 FOSS におけるクラスです。継承元: IDisposable。

フォームフィールド操作のファサードで、XML のインポート/エクスポートを含みます。

このクラスは .NET プログラムにおける Form オブジェクトの操作用に 55 のメソッドを提供します。利用可能なメソッドは BindPdf、Close、Dispose、ExportFdf、ExportJson、ExportXfdf、ExportXml、ExtractXfaData、FillBarcodeField、FillField、FillFields、FillImageField、および追加で 24 個です。すべての公開メンバーは、Aspose.PDF の .NET 用 FOSS パッケージをインストールした後、任意の .NET アプリケーションから利用可能です。プロパティ: ConvertTo、DestFileName、DestStream、Document、FieldNames、FormSubmitButtonNames、およびその他 3 件。

プロパティ

名前	型	アクセス	説明
`ImportResult`	`FormImportResult[]`	読み取り	最新の ImportFdf/ ImportXfdf/ImportXml 呼び出しからのフィールドごとの結果。
`Document`	`Document?`	読み取り	基礎となるドキュメント。
`FormSubmitButtonNames`	`string[]`	読み取り	フォーム内の送信ボタンの名前を取得します。
`SrcFileName`	`string?`	読み取り/書き込み	ソースファイル名。
`SrcStream`	`Stream?`	読み取り/書き込み	ソースストリーム。
`ConvertTo`	`Aspose.Pdf.PdfFormat`	読み取り/書き込み	保存された出力の対象 PDF/A または PDF バージョン。
`FieldNames`	`string[]`	読み取り	フォーム内のすべてのフィールド名を取得します。
`DestFileName`	`string?`	読み取り/書き込み	保存先のファイル名。
`DestStream`	`Stream?`	読み取り/書き込み	保存用の宛先ストリーム。

メソッド

シグネチャ	説明
`Form()`	バインドされていない Form ファサードを作成する。
`Form(document: Document)`	ドキュメントにバインドされた Form ファサードを作成する。
`Form(document: Document, destStream: Stream)`	Document をバインドし、パラメータなしの Save 用に出力ストリームを事前設定する。
`Form(document: Document, destFileName: string)`	ドキュメントをバインドし、パラメータなしの Save 用に出力ファイルパスを事前に設定します。
`Form(srcFileName: string, destFileName: string)`	入力および出力ファイルパスから Form ファサードを作成します。
`Form(srcFileName: string, destStream: Stream)`	入力ファイルから Form ファサードを作成し、Save 時にストリームへ書き込みます。
`Form(srcFileName: string)`	入力ファイルパスから Form ファサードを作成します。
`Form(srcStream: Stream)`	ストリームから Form ファサードを作成します。
`Form(srcStream: Stream, destStream: Stream)`	ソースストリームから Form ファサードを作成し、保存時に宛先ストリームへ書き込みます。
`Form(srcStream: Stream, destFileName: string)`	ソースストリームから Form ファサードを作成し、保存時に宛先ファイルへ書き込みます。
`BindPdf(path: string)`	このファサードに PDF ファイルをバインドします。
`BindPdf(doc: Document)`	このファサードにドキュメントをバインドしてください。
`BindPdf(stream: Stream)`	このファサードにPDFストリームをバインドしてください。
`GetFieldLimit(fieldName: string)`	名前でテキストフィールドの最大文字数を取得します。
`GetField(fieldName: string)`	名前でフィールドの値を取得します。
`FillField(fieldName: string, fieldValue: string)`	フィールドに値を設定します。
`FillField(fieldName: string, beChecked: bool)`	フィールドにブール値を設定します（チェックボックス/ラジオボタン用）。
`GetFieldType(fieldName: string)`	名前でフィールドの型を取得します。
`GetFieldTemplate(fieldName: string)`	名前付きフィールドの XFA テンプレートノードを返します（ドキュメントに XFA がない場合やフィールドが存在しない場合は null を返します）。
`GetFieldFacade(fieldName: string)`	フィールドの視覚的ファサードプロパティを取得します。
`GetButtonOptionCurrentValue(fieldName: string)`	ボタン（ラジオボタン）フィールドの現在の値を取得します。
`GetButtonOptionValues(fieldName: string)`	ボタン（ラジオボタン）フィールドのオプション値を取得します。
`GetFullFieldName(fieldName: string)`	完全修飾フィールド名を取得します。
`FlattenField(fieldName: string)`	名前で特定のフィールドをフラット化します — 静的コンテンツとして描画し、インタラクティブな状態を削除します。
`FlattenAllFields()`	文書内のすべてのフォームフィールドをフラット化し、静的コンテンツとしてレンダリングし、AcroForm を削除します。
`ImportXml(inputXmlStream: Stream, IgnoreFormTemplateChanges: bool)`	フォームフィールドの値を XML ストリームからインポートします。
`ImportXfdf(inputXfdfStream: Stream)`	XFDF ストリームからフォームフィールドデータをインポートします。
`ImportFdf(inputFdfStream: Stream)`	FDF ストリームからフォームフィールドデータをインポートします。
`ExportXml(outputXmlStream: Stream)`	フォームフィールドの値をXMLストリームにエクスポートします。
`ExportFdf(outputFdfStream: Stream)`	フォームフィールドの値をFDFとしてストリームにエクスポートします。
`ExportXfdf(outputXfdfStream: Stream)`	フォームフィールドの値をXFDFとしてストリームにエクスポートします。
`ExportJson(outputJsonStream: Stream, indented: bool)`	ドキュメント内のすべてのフィールドの内容をJSONストリームにエクスポートします。
`ImportJson(inputJsonStream: Stream)`	バインドされたドキュメントに、JSON ストリームからフィールド値をインポートし、フィールドをフルネームで照合します。
`HasField(fullName: string)`	バインドされたフォームに、指定されたフルネームのフィールドが存在する場合は True。
`Save()`	変更されたドキュメントを保存します。
`Save(destFile: string)`	特定のパスに保存します。
`Save(destStream: Stream)`	修正したドキュメントをストリームに保存します。
`SaveBytes()`	修正したドキュメントを保存し、バイト列を返します。
`Close()`	ファサードを閉じます。
`Dispose()`	この Form インスタンスで Dispose を呼び出します。
`ExtractXfaData(outputXmlStream: Stream)`	ドキュメントの XFA データセット XML をストリームへ抽出する。
`SetXfaData(inputXmlStream: Stream)`	ストリームからドキュメントの XFA データセット XML を置き換えます。
`FillBarcodeField(fieldName: string, data: string)`	名前で指定されたバーコードフィールドにデータを入力します。
`FillField(fieldName: string, value: string, fitFontSize: bool)`	提供された値でテキストフィールドに入力し、必要に応じてフォントサイズをボックスに合わせます。
`FillField(fieldName: string, index: int)`	選択されたオプションのインデックス（0 ベース）で選択肢またはラジオフィールドに入力します。
`FillField(fieldName: string, fieldValues: string[])`	提供された複数選択値でリストボックスフィールドを埋めます。
`FillFields(fieldNames: string[], fieldValues: string[], output: Stream)`	複数のフィールド値を適用し、結果として得られる PDF をストリームとして返します。
`FillImageField(fieldName: string, imageStream: Stream)`	画像フィールドを、画像をフィールドウィジェットの標準外観（/AP/N）として埋め込み、各ウィジェットの矩形を埋めるようにスケーリングして入力します。
`FillImageField(fieldName: string, imageFileName: string)`	ファイルパスから画像フィールドを埋めます。
`GetFieldFlag(fieldName: string)`	フィールドに設定された PropertyFlag を取得します（ReadOnly / Required / NoExport）。
`GetRichText(fieldName: string)`	フィールドのリッチテキスト内容（/RV エントリ）を返します。存在しない場合は null を返します。
`GetSubmitFlags(fieldName: string)`	送信ボタンフィールドに記録された SubmitFormFlag を返します。これは /A submit-form アクションの /Flags ビットマスクから読み取ります。
`IsRequiredField(fieldName: string)`	フィールドに Required フラグが設定されている場合は true です。
`RenameField(fieldName: string, newFieldName: string)`	フォームフィールドの名前を変更する。
`ImportXml(inputXmlStream: Stream)`	フォームフィールドの値をXMLストリームからインポートする（パラメータなしのオーバーロード — ImportXml(Stream, bool) と同じで、ignoreFormTemplateChanges=false）。

参照

Aspose.PDF for .NET — Enterprise API Reference