Field

概要

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

フォームフィールドを表します。

このクラスは、.NET プログラムにおける Field オブジェクトの操作用に 26 のメソッドを提供します。利用可能なメソッドは Accept, ChangeAfterResize, Clone, CopyTo, ExecuteFieldJavaScript, ExportToJson, ExportValueToJson, Field, Flatten, GetCheckedStateName, GetEnumerator, GetRectangle、および追加の 7 メソッドです。Aspose.PDF の .NET 用 FOSS パッケージをインストールすれば、すべてのパブリックメンバーは任意の .NET アプリケーションからアクセス可能です。プロパティ: Action, Actions, ActiveState, Alignment, AlternateName, AnnotationFlags、その他 72 件。

プロパティ

名前	型	アクセス	説明
`Type`	`FieldType`	読み取り	フィールドタイプ。
`FullName`	`string?`	読み取り	完全修飾フィールド名。
`TextHorizontalAlignment`	`Aspose.Pdf.HorizontalAlignment`	読み取り/書き込み	フィールドのウィジェット外観に適用される、テキスト固有の水平揃えのオーバーライド。
`PageIndex`	`int`	読み取り	このフィールドのウィジェットが属するページの1ベースインデックス。
`PartialName`	`string?`	読み取り/書き込み	部分的なフィールド名 (/T)。
`NormalAppearance`	`XForm?`	読み取り	フィールドの「Normal」外観（/AP /N エントリ）。
`Appearance`	`Aspose.Pdf.Annotations.AppearanceDictionary`	読み取り	フィールドウィジェットの外観ストリーム（/AP エントリ）、外観名でキーが付けられています。
`OnActivated`	`Annotations.PdfAction?`	読み取り/書き込み	このフィールドがアクティブ化されたときにトリガーされるアクション（/A エントリ）。
`Value`	`string?`	読み取り/書き込み	フィールドの値 (/V)。
`Count`	`int`	読み取り	このフィールドの /Kids 配列に含まれる子要素の数 — 子フィールド（階層ノード）またはウィジェット注釈（複数の視覚的ウィジェットを持つターミナルフィールド、たとえばグループ化されたチェックボックス/ラジオ）。
`Fields`	`Field[]`	読み取り	このフィールドのフィールド型子要素をスナップショット配列として取得 — フォーム上の Fields を鏡像する便利なアクセサー。
`DefaultValue`	`string?`	読み取り	デフォルト値 (/DV)。
`AlternateName`	`string?`	読み取り/書き込み	代替フィールド名 / ツールチップ (/TU エントリ)。
`Flags`	`Aspose.Pdf.Annotations.AnnotationFlags`	読み取り/書き込み	ウィジェット注釈フラグ（/F エントリ）、例：
`TabOrder`	`int`	読み取り/書き込み	このフィールドのタブ順インデックス。
`IsReadOnly`	`bool`	読み取り	フィールドが読み取り専用かどうか。
`ReadOnly`	`bool`	読み取り/書き込み	フィールドが読み取り専用かどうか（API パリティの設定可能エイリアス）。
`IsRequired`	`bool`	読み取り	フィールドが必須かどうか。
`Characteristics`	`Aspose.Pdf.Annotations.Characteristics`	読み取り	外観の特性（ボーダー / 背景色、ウィジェットの回転）。
`DefaultAppearance`	`Aspose.Pdf.Annotations.DefaultAppearance`	読み取り/書き込み	フィールドのデフォルト外観（フォント、サイズ、色）— WidgetAnnotation のフィールドレベルの対応物です。
`Rect`	`Rectangle?`	読み取り/書き込み	フィールド矩形。
`Color`	`Color`	読み取り/書き込み	フィールドの色（/DA デフォルト外観文字列に RGB として格納）。
`AnnotationIndex`	`int`	読み取り/書き込み	このフィールドのウィジェットがページの /Annots 配列内で占める 1 ベースのタブ位置 — 配列の順序がページのタブ順序になります。
`FitIntoRectangle`	`bool`	読み取り/書き込み	グローバルフラグ: true の場合、フィールドの値はウィジェット矩形に合わせて自動的にサイズ変更されます。
`IsGroup`	`bool`	読み取り	このフィールドが子フィールドのコンテナ/グループであるかどうか。
`IsSharedField`	`bool`	読み取り/書き込み	このフィールドが shared-fields グループに属しているかどうか。
`IsSynchronized`	`bool`	読み取り	コレクションがスレッドセーフであるかどうか。
`SyncRoot`	`object`	読み取り	同期ルート; このインスタンスを返します。
`MaxFontSize`	`double`	読み取り/書き込み	フィールドの外観自動調整で使用される最大フォントサイズ。
`MinFontSize`	`double`	読み取り/書き込み	フィールドの外観自動調整で使用される最小フォントサイズ。
`MappingName`	`string?`	読み取り/書き込み	外部スクリプトがフィールドを識別するために使用するマッピング名。
`AnnotationType`	`AnnotationType`	読み取り	常に Widget。
`Border`	`Border?`	読み取り/書き込み	ボーダー幅、スタイル、ダッシュパターンはウィジェットの BS 辞書から解決されます（フォームフィールドはボーダーをそこに持ち、/Border には持ちません）。
`Actions`	`AnnotationActionCollection`	読み取り	ウィジェットの /AA ツリー用アクションスロット。
`Exportable`	`bool`	読み取り/書き込み	フォーム送信時にウィジェットの値をエクスポートするかどうか。
`Highlighting`	`HighlightingMode`	読み取り/書き込み	ユーザーがウィジェットをクリックしたときに使用されるビジュアルハイライトモード（/H エントリ）。
`Parent`	`Forms.Field?`	読み取り	このウィジェットが AcroForm フィールドの視覚的な子である場合の親フィールド。
`Required`	`bool`	読み取り/書き込み	送信前にウィジェットを入力する必要があるかどうか (/Ff ビット 2)。
`HighlightMode`	`string`	読み取り	ハイライトモード (/H エントリ)。
`DefaultAppearanceString`	`string?`	読み取り	デフォルト外観文字列 (/DA エントリ)。
`FieldValue`	`string?`	読み取り	フィールド値 (/V エントリ)。
`DefaultFieldValue`	`string?`	読み取り	デフォルトのフィールド値 (/DV エントリ)。
`FieldType`	`string?`	読み取り	フィールドタイプ (/FT エントリ)。
`InnerRect`	`Rectangle?`	読み取り	/RD (rectangle differences) エントリによってインセットされたアノテーション矩形 — 実際に Rect の内部に描画される領域。
`Width`	`double`	読み取り/書き込み	注釈矩形の幅。
`Height`	`double`	読み取り/書き込み	注釈矩形の高さ。
`ActiveState`	`string?`	読み取り/書き込み	現在アクティブな外観状態（/AS エントリ）。
`Alignment`	`TextAlignment`	読み取り/書き込み	テキストの配置（リッチテキストを含むフリーテキスト/ウィジェット注釈用）。
`HorizontalAlignment`	`Aspose.Pdf.HorizontalAlignment`	読み取り/書き込み	水平配置（Alignment に加えて公開されます；この二つは独立して設定可能です）。
`States`	`AppearanceDictionary`	読み取り	外観状態辞書（AP/N の各状態ごとのサブ辞書、例）.
`UpdateAppearanceOnConvert`	`bool`	読み取り/書き込み	注釈が変換された文書に保存される際に、外観ストリームを再生成するかどうか。
`UseFontSubset`	`bool`	読み取り/書き込み	埋め込みフォント（ある場合）がサブセット化されるべきかどうか。
`Contents`	`string?`	読み取り/書き込み	注釈の内容（テキスト）。
`Opacity`	`double`	読み取り/書き込み	注釈の不透明度（0.0 = 透明、1.0 = 不透明）。
`InteriorColor`	`Color?`	読み取り/書き込み	注釈の内部色（/IC entry、円形/四角形/線の注釈用）。
`Title`	`string?`	読み取り/書き込み	アノテーションのタイトル（マークアップアノテーションの場合は作者）。
`Name`	`string?`	読み取り/書き込み	アノテーション名（一意の識別子 — /NM エントリ）。
`Subject`	`string?`	読み取り/書き込み	アノテーションの件名（/Subj エントリ）。
`ModifiedDate`	`string?`	読み取り	変更日時。
`Modified`	`DateTime`	読み取り/書き込み	/M（modified）日付をDateTimeとして入力。
`AnnotationFlags`	`AnnotationFlags`	読み取り/書き込み	公開インターフェースに一致し、AnnotationFlags をプロパティとして公開する Flags の型エイリアス。
`Action`	`PdfAction?`	読み取り/書き込み	このアノテーションに関連付けられたアクション (/A エントリ)。
`Author`	`string?`	読み取り	アノテーションの作成者 (/T エントリ)。
`AnnotationState`	`string?`	読み取り	アノテーション状態（/State エントリ）、例として.
`AnnotationStateModel`	`string?`	読み取り	アノテーション状態モデル（/StateModel エントリ）、例として.
`ReplyType`	`string?`	読み取り	返信タイプ（/RT エントリ）、例として.
`InReplyTo`	`Annotation?`	読み取り/書き込み	この注釈が返信している注釈（/IRT エントリ）。
`QuadPoints`	`Point[]`	読み取り/書き込み	QuadPoints を Point 値の配列として。
`Page`	`Page?`	読み取り	この注釈を所有するページ、解決できない場合は null（例:
`VerticalAlignment`	`VerticalAlignment`	読み取り/書き込み	この段落に垂直揃えが適用されています。
`Margin`	`MarginInfo`	読み取り/書き込み	この段落に外側余白情報が適用されています。
`IsFirstParagraphInColumn`	`bool`	読み取り/書き込み	段落を新しい列の先頭に強制的に開始させる。
`IsKeptWithNext`	`bool`	読み取り/書き込み	この段落を次の段落と同じページに保ってください。
`IsInNewPage`	`bool`	読み取り/書き込み	段落を新しいページから開始させる。
`IsInLineParagraph`	`bool`	読み取り/書き込み	インライン段落フラグ（新しい行を開始しません）。
`HyperlinkText`	`string?`	読み取り/書き込み	レガシーな文字列型ハイパーリンクターゲット。
`Hyperlink`	`Hyperlink?`	読み取り/書き込み	段落に適用された型付きハイパーリンク装飾。
`ZIndex`	`int`	読み取り/書き込み	DOM レンダラーで使用される Z-order インデックス。

メソッド

シグネチャ	説明
`Field(doc: Document)`	ドキュメントにバインドされたフィールドを作成する。
`GetEnumerator()`	このフィールドの /Kids 配列内の子要素に対してウィジェット注釈を反復処理する。
`CopyTo(array: Aspose.Pdf.Annotations.WidgetAnnotation[], index: int)`	ウィジェット注釈をインデックスから開始する配列にコピーする。
`CopyTo(array: Field[], index: int)`	このフィールドの子要素（Field インスタンスとして）を、インデックスから始まる配列にコピーします。
`ExecuteFieldJavaScript(javaScriptAction: Aspose.Pdf.Annotations.JavascriptAction)`	提供された JavaScript アクションをこのフィールドに対して実行します。
`ExportToJson(stream: Stream)`	提供されたストリームを介して、このフィールドを JSON（単一の FieldExportingData オブジェクト）にシリアライズします。
`ExportToJson(fileName: string)`	このフィールドを JSON ファイルにシリアライズします。
`ExportToJson(stream: Stream, options: ExportFieldsToJsonOptions?)`	提供されたストリームを介してこのフィールドを JSON にシリアライズします。
`ExportToJson(fileName: string, options: ExportFieldsToJsonOptions?)`	このフィールドをJSONファイルにシリアライズします。
`ExportValueToJson(outputJsonStream: Stream, indented: bool)`	フィールド名、フラグ、値をJSONストリームに書き込みます。
`Flatten()`	このフィールドをフラット化し、その値を静的ページコンテンツに変換します。
`GetWidgetEnumerator()`	列挙子の型はWidgetAnnotationです。
`ImportValueFromJson(inputJsonStream: Stream)`	このフィールドの値をJSONストリームから読み取ります。
`ImportValueFromJson(inputJsonStream: Stream, fieldFullNameInJSON: string)`	JSONストリームから名前付きフィールドの値を読み取ります — 単一のフィールドオブジェクト（ChildFieldsを介して入れ子になる可能性あり）またはそれらの配列 — そして、ドット区切りのパスがfieldFullNameInJSONと一致するエントリの値を適用します。
`Recalculate()`	計算スクリプトからフィールドの値を再計算します。
`SetPosition(point: Aspose.Pdf.Point)`	フィールドの最初のウィジェット矩形を指定された点（左上隅）へ移動します。
`WidgetAnnotation(doc: Document)`	Programmatic ctor — ドキュメントのリーダーに関連付けられた、素のウィジェット注釈を作成します。
`ExportToJson(stream: System.IO.Stream)`	このウィジェットのフィールドを JSON としてストリームにシリアライズします。
`ExportToJson(stream: System.IO.Stream, options: ExportFieldsToJsonOptions?)`	このウィジェットのフィールドを、単一の FieldExportingData JSON オブジェクトとしてストリームにシリアライズします。
`GetCheckedStateName()`	このウィジェットの「on」/「checked」状態を表す外観状態名（通常は「Yes」）を返します。これは /AP/N 辞書のキーから検索されます（「Off」以外のもの）。
`Accept(visitor: AnnotationSelector)`	この Field インスタンスで Accept(visitor) を呼び出します。
`GetRectangle(considerRotation: bool)`	considerRotation を考慮して調整された境界矩形。
`ChangeAfterResize(transform: Matrix)`	ユーザーがページまたはホスト矩形のサイズを変更した後、アノテーションのジオメトリを調整します。
`UpdateAppearances()`	アノテーションの現在のジオメトリと色から通常の外観ストリーム (/AP /N) を再生成します。
`WriteXfdf(writer: System.Xml.XmlWriter)`	このアノテーションを XFDF 要素として writer にシリアライズします (PDF 32000 §12.7.8 / XFDF 3.0)。
`Clone()`	浅いクローン — スカラー/参照共有状態をコピーします。

参照

Aspose.PDF for .NET — Enterprise API Reference