FormEditor
概要
FormEditor は Aspose.PDF の FOSS for .NET におけるクラスです。継承元: IDisposable。
フォーム操作のファサード: フィールドの入力、フォームの平坦化、データのインポート/エクスポート。
このクラスは、.NET プログラムにおける FormEditor オブジェクトの操作のために 64 のメソッドを提供します。利用可能なメソッドは AddCheckBox, AddField, AddFieldScript, AddListItem, AddSubmitBtn, AddTextField, BindPdf, CheckField, Close, CopyInnerField, CopyOuterField, DecorateField、および追加の 34 メソッドです。すべての公開メンバーは、Aspose.PDF の FOSS for .NET パッケージをインストールした後、任意の .NET アプリケーションからアクセス可能です。プロパティ: ConvertTo, DestFileName, DestStream, Document, ExportItems, Facade、その他 7 件。
プロパティ
| 名前 | 型 | アクセス | 説明 |
|---|---|---|---|
Document | Document | 読み取り | このエディタにバインドされたドキュメントで、別のファサードにチェーンできるように公開されています。 |
SrcFileName | string? | 読み取り/書き込み | パラメータなし ctor + Save フローで使用されるソースファイルパス。 |
SrcStream | Stream? | 読み取り/書き込み | パラメータなし ctor と Save フローで使用されるソース ストリーム。 |
DestFileName | string? | 読み取り/書き込み | パラメータなし Save() によって書き込まれる宛先ファイル パス。 |
DestStream | Stream? | 読み取り/書き込み | パラメータなし Save() によって書き込まれる宛先ストリーム。 |
ConvertTo | PdfFormat | 読み取り/書き込み | 保存された出力の対象となる PDF/A または PDF バージョン。 |
Facade | FormFieldFacade | 読み取り/書き込み | 視覚的外観は AddField と DecorateField() によって適用されます。 |
Items | string[]? | 読み取り/書き込み | AddField が ListBox / ComboBox フィールドを作成する際に使用するデフォルトの項目リスト。 |
ExportItems | string[][]? | 読み取り/書き込み | エクスポート値ペアがアイテムとペアになっています。 |
RadioButtonItemSize | double | 読み取り/書き込み | ラジオボタングループのレイアウト時に使用される、ラジオボタン項目のエッジ長さ(ポイント単位)。 |
RadioGap | float | 読み取り/書き込み | グループ内のラジオボタン項目間の間隔(ポイント単位)。 |
RadioHoriz | bool | 読み取り/書き込み | true の場合、ラジオボタン項目は横方向に配置されます。そうでなければ縦方向に配置されます。 |
SubmitFlag | SubmitFormFlag | 読み取り/書き込み | AddSubmitBtn と SetSubmitFlag が使用する送信形式。 |
メソッド
| シグネチャ | 説明 |
|---|---|
FormEditor() | ステートレスな byte[] ベースの API のデフォルトコンストラクタ。 |
FormEditor(document: Document) | エディタをドキュメントにバインドして、インプレース操作を行います。 |
FormEditor(document: Document, destStream: Stream) | ドキュメントをバインドし、パラメータなし Save 用に出力ストリームを事前設定します。 |
FormEditor(document: Document, destFileName: string) | ドキュメントをバインドし、パラメータなし Save 用に出力ファイルパスを事前設定します。 |
FormEditor(srcStream: Stream, destStream: Stream) | 入力ストリームから開き、保存時に出力ストリームへ書き込みます。 |
FormEditor(srcFileName: string, destFileName: string) | 入力ファイルから開き、保存時に出力ファイルへ書き込みます。 |
BindPdf(path: string) | パスでPDFファイルをバインドして編集します。 |
BindPdf(pdfData: byte[]) | バイトバッファからPDFをバインドします。 |
BindPdf(stream: Stream) | ストリームからPDFをバインドします。 |
BindPdf(document: Document) | 既に開かれているドキュメントから PDF をバインドする。 |
Save(path: string) | バインドされたドキュメントをファイルパスに保存する。 |
Save(destStream: Stream) | バインドされたドキュメントをストリームに保存する。 |
Save() | バインドされたドキュメントを設定された宛先(DestFileName または DestStream)に保存する。 |
Close() | バインドされたドキュメントを閉じて解放してください。 |
Dispose() | この FormEditor インスタンスに対して Dispose を呼び出します。 |
SetField(fieldName: string, value: string) | 名前でフィールドの値を設定する。 |
CheckField(fieldName: string) | 名前でチェックボックスフィールドをチェックします。 |
UncheckField(fieldName: string) | 名前でチェックボックスフィールドのチェックを外します。 |
AddTextField(fieldName: string, pageNumber: int, llx: double, lly: double, urx: double, ury: double) | バインドされたドキュメントにテキストフィールドを追加します。 |
AddCheckBox(fieldName: string, pageNumber: int, llx: double, lly: double, urx: double, ury: double, isChecked: bool) | バインドされたドキュメントにチェックボックスフィールドを追加します。 |
AddField(fieldType: FieldType, fieldName: string, pageNum: int, llx: float, lly: float, urx: float, ury: float) | 指定された fieldType のフィールドを、pageNum の要求された矩形領域に追加します。 |
AddField(fieldType: FieldType, fieldName: string, initValue: string?, pageNum: int, llx: float, lly: float, urx: float, ury: float) | 初期値を持つフィールドを追加します(テキストフィールドとコンボボックス)。 |
AddListItem(fieldName: string, itemName: string) | 単一のアイテムを ListBox / ComboBox フィールドに追加します。 |
AddListItem(fieldName: string, exportName: string[]) | エクスポート値ペア([display, export];単一要素配列は両方を意味します)を持つ単一のアイテムを追加します。 |
DelListItem(fieldName: string, itemName: string) | 単一のアイテムを ListBox / ComboBox フィールドから削除します。 |
AddSubmitBtn(fieldName: string, page: int, label: string, url: string, llx: float, lly: float, urx: float, ury: float) | Submit ボタンを追加します。 |
AddFieldScript(fieldName: string, script: string) | フィールドに JavaScript アクションスクリプトを添付します。 |
SetFieldScript(fieldName: string, script: string) | フィールドの JavaScript アクションスクリプトを置き換えます。 |
CopyInnerField(fieldName: string, newFieldName: string, pageNum: int) | バインドされたドキュメント内のフィールドを別のページにコピーします。 |
CopyInnerField(fieldName: string, newFieldName: string, pageNum: int, abscissa: float, ordinate: float) | バインドされたドキュメント内のフィールドを、指定された座標の別ページにコピーします。 |
CopyOuterField(srcFileName: string, fieldName: string) | 別の PDF ファイルからフィールドをコピーし、結合されたドキュメントの同じ位置に配置します。 |
CopyOuterField(srcFileName: string, fieldName: string, pageNum: int) | 別のPDFファイルからフィールドをコピーし、指定されたページにバインドされたドキュメントへ挿入します。 |
CopyOuterField(srcFileName: string, fieldName: string, pageNum: int, abscissa: float, ordinate: float) | 別のPDFファイルからフィールドを、明示的な座標でコピーします。 |
DecorateField() | ドキュメント内のすべてのフィールドにFacadeを適用します。 |
DecorateField(fieldType: FieldType) | 指定されたタイプのすべてのフィールドにFacadeを適用します。 |
DecorateField(fieldName: string) | Facade を単一の名前付きフィールドに適用します。 |
ResetFacade() | Facade のすべてのプロパティをリセットします。 |
ResetInnerFacade() | ResetFacade のエイリアスで、ネストされた facade 呼び出し元をカバーします。 |
MoveField(fieldName: string, llx: float, lly: float, urx: float, ury: float) | フィールドのバウンディングボックスを移動します。 |
RenameField(fieldName: string, newFieldName: string) | フォームフィールドの名前を変更する。 |
RemoveField(fieldName: string) | 名前でフィールドを削除する。 |
RemoveFieldAction(fieldName: string) | フィールドに付随するアクションを削除する。 |
SetFieldAlignment(fieldName: string, alignment: int) | フィールドの値の水平揃えを設定します。 |
SetFieldAlignmentV(fieldName: string, alignment: int) | フィールドの値の垂直方向の配置を設定します。 |
SetFieldAppearance(fieldName: string, flags: AnnotationFlags) | フィールドの表示 / 読み取り専用 / 必須フラグを設定します。 |
GetFieldAppearance(fieldName: string) | フィールドの visibility / read-only / required フラグを返します。 |
SetFieldAttribute(fieldName: string, flag: PropertyFlag) | 設定 ReadOnly / 必須 / NoExport。 |
SetFieldCombNumber(fieldName: string, combNumber: int) | テキストフィールドのコンブセル数を設定します(PDF 1.5+)。 |
SetFieldLimit(fieldName: string, fieldLimit: int) | 名前でテキストフィールドの最大文字数を設定します。 |
SetSubmitFlag(fieldName: string, submitFormFlag: SubmitFormFlag) | ボタンフィールドに SubmitForm アクションフラグを設定します。 |
SetSubmitUrl(fieldName: string, url: string) | ボタンフィールドの SubmitForm アクションのターゲット URL を設定します。 |
Single2Multiple(fieldName: string) | 単一行テキストフィールドを複数行フィールドに変換します。 |
FlattenAllFields() | 結合されたドキュメント内のすべてのフォームフィールドをフラット化します。 |
FillFields(input: byte[], fieldValues: Dictionary<string, string>) | フォームフィールドに指定された値を入力します(フィールド名 → 値)。 |
FillField(input: byte[], fieldName: string, value: string) | 名前で指定した単一のフォームフィールドに入力します。 |
FlattenForm(input: byte[]) | フォームをフラット化します — フィールドを静的コンテンツとしてレンダリングし、AcroForm を削除します。 |
GetFieldNames(input: byte[]) | ドキュメントのフォーム内のすべてのフィールド名を取得します。 |
GetFieldValue(input: byte[], fieldName: string) | 特定のフィールドの値を取得します。 |
GetFieldType(input: byte[], fieldName: string) | 特定のフィールドの型を取得します。 |
HasForm(input: byte[]) | 文書にフォームがあるか確認してください。 |
GetFieldCount(input: byte[]) | フォームフィールドの総数を取得します。 |
ExportFormData(input: byte[]) | フォームデータを辞書としてエクスポートする(フィールド名 → 値)。 |
ImportFormData(input: byte[], data: Dictionary<string, string>) | 辞書からフォームデータをインポートします。 |
RenameField(input: byte[], oldName: string, newPartialName: string) | 提供されたバイト列のフォームフィールドをリネームします。 |