TextBoxField

概要

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

このクラスは .NET プログラムで TextBoxField オブジェクトを操作するための 33 の methods を提供します。利用可能な methods は: Accept, AddBarcode, AddImage, ChangeAfterResize, Clone, CopyTo, ExecuteFieldJavaScript, ExportToJson, ExportValueToJson, Field, Flatten, GetCheckedStateName と、さらに 10 の methods です。すべての public members は、Aspose.PDF FOSS for .NET パッケージをインストールした後、任意の .NET アプリケーションからアクセス可能です。プロパティ: Action, Actions, ActiveState, Alignment, AlternateName, AnnotationFlags と、さらに 82 件があります。

プロパティ

名前	型	アクセス	説明
`MaxFontSize`	`double`	読み取り/書き込み	すべての新規作成された TextBoxFields の自動フィット外観に適用される静的デフォルト。
`MinFontSize`	`double`	読み取り/書き込み	すべての新規作成された TextBoxFields の自動フィット外観に適用される静的デフォルト — 自動サイズフォントの下限.
`FitIntoRectangle`	`bool`	読み取り/書き込み	新規に作成されたすべてのTextBoxFieldsのFitIntoRectangleフラグに適用される静的デフォルト。
`Width`	`double`	読み取り/書き込み	フィールドがレイアウトコンテナ（テーブルセル、段落）内に配置されたときのレイアウト幅。
`Height`	`double`	読み取り/書き込み	フィールドがレイアウトコンテナ内に配置されたときのレイアウト高さ。
`Multiline`	`bool`	読み取り/書き込み	マルチラインフラグ（/Ff のビット 13）。
`MaxLen`	`int`	読み取り/書き込み	最大長を取得または設定します。
`IsMultiline`	`bool`	読み取り	マルチラインかどうかを取得します。
`IsPassword`	`bool`	読み取り	パスワードかどうかを取得します。
`TextVerticalAlignment`	`VerticalAlignment`	読み取り/書き込み	フィールドの外観内のテキストの垂直揃え。
`IsRichText`	`bool`	読み取り	Tx フィールドにリッチテキストフラグ（/Ff のビット 26）が設定されている場合は true。
`Justification`	`int`	読み取り	テキストの配置: 0 = 左, 1 = 中央, 2 = 右.
`ForceCombs`	`bool`	読み取り/書き込み	/Ff のビット25（Comb）：設定されていると、フィールドは MaxLen 個の等幅コンブに分割されます。
`Scrollable`	`bool`	読み取り/書き込み	/Ff のビット24の逆（DoNotScroll）。
`SpellCheck`	`bool`	読み取り/書き込み	/Ff のビット23の反転 (DoNotSpellCheck)。
`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 基準のタブ位置 — 配列の順序がページのタブ順序です。
`IsGroup`	`bool`	読み取り	このフィールドが子フィールドのコンテナ／グループかどうか。
`IsSharedField`	`bool`	読み取り/書き込み	このフィールドが shared-fields グループに属するかどうか。
`IsSynchronized`	`bool`	読み取り	コレクションがスレッドセーフかどうか。
`SyncRoot`	`object`	読み取り	同期ルート; このインスタンスを返します。
`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 内に描画される領域です。
`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 エントリ、円/正方形/線の注釈用）。
`Title`	`string?`	読み取り/書き込み	注釈のタイトル（マークアップ注釈の場合は作者）。
`Name`	`string?`	読み取り/書き込み	注釈名（ユニーク識別子 — /NM エントリ）。
`Subject`	`string?`	読み取り/書き込み	アノテーションの件名 (/Subj エントリ)。
`ModifiedDate`	`string?`	読み取り	変更日。
`Modified`	`DateTime`	読み取り/書き込み	/M (modified) 日を DateTime として入力されたもの。
`AnnotationFlags`	`AnnotationFlags`	読み取り/書き込み	Flags の型エイリアスで、公開インターフェースに一致し、AnnotationFlags をプロパティとして公開します。
`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 インデックス。

メソッド

シグネチャ	説明
`TextBoxField(page: Page, rect: Rectangle)`	指定されたページに、指定された矩形で新しいテキストボックスフィールドを作成します。
`TextBoxField(doc: Document, rect: Rectangle)`	ドキュメントに関連付けられた新しいテキストボックスフィールドを作成します（ページは Form.Add によって割り当てられます）。
`TextBoxField(doc: Document)`	矩形がないドキュメントにバインドされたテキストボックス。
`TextBoxField(page: Page, rects: Rectangle[])`	マルチウィジェットテキストフィールド — 最初の矩形はウィジェット辞書に使用されます；追加の矩形はマルチウィジェット契約に従って /Kids に格納されます。
`TextBoxField()`	パラメータなしコンストラクタ — バインドされていないテキストボックスフィールドを作成します。
`AddBarcode(code: string)`	コードをプレースホルダバーコードとしてフィールド値にエンコードします。
`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)`	この TextBoxField インスタンスで 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