ButtonField

概要

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

プッシュボタンフォームフィールド（FT=Btn、Pushbutton フラグが設定）。

このクラスは、.NET プログラム内で ButtonField オブジェクトを操作するための 30 のメソッドを提供します。利用可能なメソッドは、Accept、AddImage、ButtonField、ChangeAfterResize、Clone、CopyTo、ExecuteFieldJavaScript、ExportToJson、ExportValueToJson、Field、Flatten、GetCheckedStateName、および追加の 9 件のメソッドです。すべてのパブリックメンバーは、Aspose.PDF の .NET 用 FOSS パッケージをインストールした後、任意の .NET アプリケーションからアクセス可能です。プロパティ: Action、Actions、ActiveState、Alignment、AlternateCaption、AlternateIcon、およびさらに 80 件。

プロパティ

名前	型	アクセス	説明
`NormalCaption`	`string?`	読み取り/書き込み	通常状態のボタンに表示されるキャプション (MK dict /CA エントリ)。
`AlternateCaption`	`string?`	読み取り/書き込み	ユーザーがマウスボタンを押し続けているときに表示されるキャプション (/MK /AC)。
`RolloverCaption`	`string?`	読み取り/書き込み	カーソルをホバーしたときに表示されるキャプション (/MK /RC)。
`NormalIcon`	`XForm?`	読み取り/書き込み	通常状態のアイコンとして使用される Form XObject (/MK /I)。
`RolloverIcon`	`XForm?`	読み取り/書き込み	ロールオーバーアイコンとして使用される Form XObject (/MK /RI)。
`AlternateIcon`	`XForm?`	読み取り/書き込み	Form XObject をダウン/代替アイコンとして使用 (/MK /IX)。
`ICPosition`	`IconCaptionPosition`	読み取り/書き込み	アイコンに対するキャプションの位置 (/MK /TP)。
`IconFit`	`IconFit`	読み取り	アイコンのスケーリングパラメータ (/MK /IF)。
`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`	読み取り/書き込み	1ベースのタブ位置は、このフィールドのウィジェットがページの /Annots 配列内で占める位置です — 配列の順序がページのタブ順序になります。
`FitIntoRectangle`	`bool`	読み取り/書き込み	グローバルフラグ: true の場合、フィールドの値はウィジェット矩形に合わせて自動的にサイズ変更されます。
`IsGroup`	`bool`	読み取り	このフィールドが子フィールドのコンテナ/グループであるかどうか。
`IsSharedField`	`bool`	読み取り/書き込み	このフィールドが共有フィールドグループに属しているかどうか。
`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 に加えて公開されます; 2 つは独立して設定可能です）。
`States`	`AppearanceDictionary`	読み取り	外観状態辞書（AP/N の各状態サブ辞書、例：
`UpdateAppearanceOnConvert`	`bool`	読み取り/書き込み	変換された文書に注釈が保存される際に、appearance stream を再生成するかどうか。
`UseFontSubset`	`bool`	読み取り/書き込み	埋め込みフォント（ある場合）がサブセット化されるべきかどうか。
`Contents`	`string?`	読み取り/書き込み	注釈の内容（テキスト）。
`Opacity`	`double`	読み取り/書き込み	注釈の不透明度（0.0 = 透明、1.0 = 不透明）。
`InteriorColor`	`Color?`	読み取り/書き込み	注釈の内部色（/IC エントリ、円形/四角形/直線注釈用）。
`Title`	`string?`	読み取り/書き込み	注釈タイトル（マークアップ注釈の場合は作者）。
`Name`	`string?`	読み取り/書き込み	注釈名（ユニーク識別子 — /NM エントリ）。
`Subject`	`string?`	読み取り/書き込み	注釈の件名（/Subj エントリ）。
`ModifiedDate`	`string?`	読み取り	変更日付。
`Modified`	`DateTime`	読み取り/書き込み	/M（modified）日付を型付けされた DateTime として。
`AnnotationFlags`	`AnnotationFlags`	読み取り/書き込み	public surface に一致し、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 オーダーインデックス。

メソッド

シグネチャ	説明
`ButtonField()`	この ButtonField インスタンスで ButtonField を呼び出します。
`ButtonField(doc: Document, rect: Rectangle)`	この ButtonField インスタンスで ButtonField(doc, rect) を呼び出します。
`ButtonField(page: Page, rect: Rectangle)`	この ButtonField インスタンスで ButtonField(page, rect) を呼び出します。
`AddImage(image: System.Drawing.Image)`	画像をボタンの通常アイコンとして添付します。
`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)`	この ButtonField インスタンスで Accept(visitor) を呼び出します。
`GetRectangle(considerRotation: bool)`	バウンディング矩形は considerRotation によって調整されます。
`ChangeAfterResize(transform: Matrix)`	ユーザーがページまたはホスト矩形のサイズを変更した後、アノテーションのジオメトリを調整します。
`UpdateAppearances()`	アノテーションの現在のジオメトリと色から通常の外観ストリーム (/AP /N) を再生成します。
`WriteXfdf(writer: System.Xml.XmlWriter)`	このアノテーションを XFDF 要素としてライターにシリアライズします (PDF 32000 §12.7.8 / XFDF 3.0)。
`Clone()`	浅いクローン — スカラー/参照共有状態をコピーします。

参照

Aspose.PDF for .NET — Enterprise API Reference