ListBoxField

概要

ListBoxField は Aspose.PDF の FOSS（.NET 用）におけるクラスです。継承元: ChoiceField。

リストボックスフォームフィールド — コンボフラグのない ChoiceField。

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

プロパティ

名前	型	アクセス	説明
`SelectedItems`	`int[]`	読み取り/書き込み	selected-items 配列を設定専用にします。
`Selected`	`int`	読み取り/書き込み	選択されたオプションの 1 ベースインデックス（なしの場合は -1）。設定すると、その単一オプションが選択されます。
`TopIndex`	`int`	読み取り/書き込み	リストがスクロールされたときに最初に表示されるオプションの0ベースインデックス。
`IsCombo`	`bool`	読み取り	コンボかどうかを取得します。
`IsEditable`	`bool`	読み取り	編集可能かどうかを取得します。
`IsMultiSelect`	`bool`	読み取り	マルチ選択かどうかを取得します。
`IsSorted`	`bool`	読み取り	is sorted を取得します。
`MultiSelect`	`bool`	読み取り/書き込み	取得/設定 MultiSelect (/Ff ビット 22 — 0ベース 21).
`CommitImmediately`	`bool`	読み取り/書き込み	取得/設定 CommitOnSelChange (/Ff ビット 27 — 0ベース 26).
`SelectedValues`	`IReadOnlyList<string>`	読み取り/書き込み	現在選択されている値。
`SelectedIndices`	`IReadOnlyList<int>`	読み取り	Options リスト内の選択された値の 0 から始まるインデックス。
`Options`	`OptionCollection`	読み取り	選択肢のコレクション。
`Value`	`string?`	読み取り/書き込み	フィールド値 (/V)。
`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 エントリ）。
`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`	読み取り	常にウィジェットです。
`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 の各状態ごとのサブ辞書、e.g.）。
`UpdateAppearanceOnConvert`	`bool`	読み取り/書き込み	注釈が変換されたドキュメントに保存されるときに、外観ストリームを再生成するかどうか。
`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`	読み取り/書き込み	型付けされた DateTime としての /M (modified) 日付。
`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オーダーインデックス。

メソッド

シグネチャ	説明
`ListBoxField()`	パラメータなしのctor（呼び出し側は後でページにバインドします）。
`ListBoxField(page: Page, rect: Rectangle)`	指定されたページ上に、与えられた矩形で新しいリストボックスフィールドを作成します。
`ListBoxField(doc: Document, rect: Rectangle)`	ドキュメントに関連付けられた新しいリストボックスフィールドを作成します（ページは Form.Add を通じて割り当てられます）。
`ChoiceField(doc: Document)`	この ListBoxField インスタンス上で ChoiceField(doc) を呼び出します。
`ChoiceField(doc: Document, rect: Rectangle)`	この ListBoxField インスタンスで ChoiceField(doc, rect) を呼び出します。
`ChoiceField(page: Page, rect: Rectangle)`	この ListBoxField インスタンスで ChoiceField(page, rect) を呼び出します。
`AddOption(optionName: string)`	選択フィールドにオプションを追加します。
`AddOption(export: string, name: string)`	エクスポート値と表示値が別々のオプションを追加します。
`DeleteOption(optionName: string)`	optionName に一致する最初のオプションを削除します（PdfString のまま、または [export, name] ペアの表示側として）。
`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 — ドキュメントのリーダーに関連付けられたベアなウィジェット注釈を作成します。
`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)`	この ListBoxField インスタンスで 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