CheckboxField

概要

CheckboxField は Aspose.PDF の .NET 用 FOSS のクラスです。継承元: Field。

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

プロパティ

名前	型	アクセス	説明
`Style`	`BoxStyle`	読み取り/書き込み	レンダリングされたチェックボックスグリフのビジュアルスタイル (/MK /CA)：Cross は X を描き、Check はチェックマークを描きます。その他のスタイルは X にフォールバックします。
`ExportValue`	`string`	読み取り/書き込み	フォーム送信時に FDF/XFDF に出力されるエクスポート値。
`ActiveState`	`string`	読み取り/書き込み	現在選択されている外観状態。
`AllowedStates`	`System.Collections.Generic.List<string>`	読み取り	すべての外観状態キーは /AP/N の下に宣言されています。
`Value`	`string`	読み取り/書き込み	チェックボックスの値（/V エントリ、名前入力）。
`OnValue`	`string`	読み取り	「On」状態名を取得します（「Off」ではない外観状態キー）。
`IsChecked`	`bool`	読み取り/書き込み	取得または設定します。チェックされているかどうか。
`Checked`	`bool`	読み取り/書き込み	チェック状態を取得または設定します。
`Type`	`FieldType`	読み取り	フィールドタイプ。
`FullName`	`string?`	読み取り	完全修飾フィールド名。
`TextHorizontalAlignment`	`Aspose.Pdf.HorizontalAlignment`	読み取り/書き込み	フィールドのウィジェット外観に適用される、テキスト固有の水平揃えオーバーライド。
`PageIndex`	`int`	読み取り	このフィールドのウィジェットが属するページの1ベースのインデックス。
`PartialName`	`string?`	読み取り/書き込み	部分フィールド名 (/T)。
`NormalAppearance`	`XForm?`	読み取り	フィールドの「Normal」外観 (the /AP /N entry)。
`Appearance`	`Aspose.Pdf.Annotations.AppearanceDictionary`	読み取り	フィールドウィジェットの外観ストリーム（/AP エントリ）は、外観名でキー付けされています。
`OnActivated`	`Annotations.PdfAction?`	読み取り/書き込み	このフィールドがアクティブ化されたときにトリガーされるアクション（/A エントリ）。
`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`	読み取り/書き込み	このフィールドが共有フィールドグループに属しているかどうか。
`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`	読み取り/書き込み	注釈矩形の高さ。
`Alignment`	`TextAlignment`	読み取り/書き込み	テキストの配置（リッチテキストを含むフリーテキスト/ウィジェット注釈用）。
`HorizontalAlignment`	`Aspose.Pdf.HorizontalAlignment`	読み取り/書き込み	水平配置（Alignment に加えて公開されます；二つは独立して設定可能です）。
`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`	読み取り/書き込み	公開サーフェスに一致し、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インデックス。

メソッド

シグネチャ	説明
`CheckboxField()`	バインドされていないチェックボックスフィールドをデフォルト構築する。
`CheckboxField(doc: Document)`	ドキュメントにバインドされたチェックボックスを作成する。
`CheckboxField(doc: Document, rect: Rectangle)`	指定されたウィジェット矩形で、ドキュメントにバインドされたチェックボックスを作成する。
`CheckboxField(page: Page, rect: Rectangle)`	指定された矩形にページ上のチェックボックスを作成する。
`AddOption(optionName: string)`	optionName をこのチェックボックスに新しい選択可能な状態として追加します（ラジオボタンのように動作するグループ化されたチェックボックスで使用）。
`AddOption(optionName: string, rect: Rectangle)`	明示的なウィジェット矩形を持つオプションを追加します。
`AddOption(optionName: string, page: int, rect: Rectangle)`	指定されたページ番号とウィジェット矩形を対象としたオプションを追加します。
`Clone()`	フィールドの浅いクローン。
`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)`	プログラム的な ctor — doc のリーダーに関連付けられたベアなウィジェットアノテーションを作成します。
`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)`	この CheckboxField インスタンスで 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)。

参照

Aspose.PDF for .NET — Enterprise API Reference