ChoiceField
概要
ChoiceField は Aspose.PDF の .NET 用 FOSS におけるクラスです。継承元: Field。
このクラスは .NET プログラムで ChoiceField オブジェクトを操作するための 32 のメソッドを提供します。利用可能なメソッドは Accept、AddOption、ChangeAfterResize、ChoiceField、Clone、CopyTo、DeleteOption、ExecuteFieldJavaScript、ExportToJson、ExportValueToJson、Field、Flatten、および追加の 10 個のメソッドです。Aspose.PDF の .NET 用 FOSS パッケージをインストールした後、すべての公開メンバーは任意の .NET アプリケーションから利用可能です。プロパティ: Action、Actions、ActiveState、Alignment、AlternateName、AnnotationFlags、およびさらに 83 件。
プロパティ
| 名前 | 型 | アクセス | 説明 |
|---|---|---|---|
IsCombo | bool | 読み取り | コンボかどうかを取得します。 |
IsEditable | bool | 読み取り | 編集可能かどうかを取得します。 |
IsMultiSelect | bool | 読み取り | マルチ選択かどうかを取得します。 |
IsSorted | bool | 読み取り | ソートされているかを取得します。 |
MultiSelect | bool | 読み取り/書き込み | 取得/設定 MultiSelect (/Ff ビット 22 — 0ベース 21). |
CommitImmediately | bool | 読み取り/書き込み | 取得/設定 CommitOnSelChange (/Ff ビット 27 — 0ベース 26). |
SelectedItems | int[] | 読み取り/書き込み | 0ベースの選択オプションインデックス (public-API 形 int[] SelectedIndices の兄弟; セッターは一致するオプションから /V を書き換えます)。 |
SelectedValues | IReadOnlyList<string> | 読み取り/書き込み | 現在選択されている値。 |
SelectedIndices | IReadOnlyList<int> | 読み取り | Options リスト内の選択された値の0ベースインデックス。 |
Options | OptionCollection | 読み取り | 選択肢のコレクション。 |
Selected | int | 読み取り/書き込み | 現在選択されているオプションの1ベースインデックス、またはオプションが選択されていない、あるいは選択がオプションリストと一致しない場合は -1。 |
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 | 読み取り | 常に 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 | 読み取り/書き込み | 注釈が変換された文書に保存される際に、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オーダーインデックス。 |
メソッド
| シグネチャ | 説明 |
|---|---|
ChoiceField(doc: Document) | この ChoiceField インスタンスで ChoiceField(doc) を呼び出します。 |
ChoiceField(doc: Document, rect: Rectangle) | この ChoiceField インスタンスで ChoiceField(doc, rect) を呼び出します。 |
ChoiceField(page: Page, rect: Rectangle) | この ChoiceField インスタンスで 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を介して入れ子になる可能性あり)またはそれらの配列 — そして、dotted path が 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 dict のキーから検索されます(“Off” 以外のもの)。 |
Accept(visitor: AnnotationSelector) | この ChoiceField インスタンスで 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() | 浅いクローン — スカラー/参照共有状態をコピーします。 |