RichTextBoxField

概要

RichTextBoxField は、.NET 用の Aspose.PDF FOSS にあるクラスです。継承元: TextBoxField。

リッチテキストフラグ（/Ff のビット 26）を保持する Tx フォームフィールド。

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

プロパティ

名前	型	アクセス	説明
`RichTextValue`	`string?`	読み取り/書き込み	フィールド値のリッチテキスト表現（PDF /RV エントリ）。
`FormattedValue`	`string?`	読み取り/書き込み	書式設定された（リッチテキスト）表現; RichTextValue の別名。
`Value`	`string?`	読み取り/書き込み	このフィールド（/V エントリ）によってレンダリングされるプレーンテキスト値。
`Style`	`string`	読み取り/書き込み	CSS-スタイルの文字列がリッチテキストのフラグメントに適用されます — 例：
`Justify`	`Aspose.Pdf.Annotations.Justification`	読み取り/書き込み	テキストの両端揃え.
`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`	読み取り/書き込み	Bit 25 of /Ff (Comb): 設定されていると、フィールドは MaxLen 個の等幅コンブに分割されます。
`Scrollable`	`bool`	読み取り/書き込み	/Ff のビット24の反転 (DoNotScroll)。
`SpellCheck`	`bool`	読み取り/書き込み	/Ff のビット23の反転 (DoNotSpellCheck)。
`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`	読み取り/書き込み	このフィールドが共有フィールドグループに属しているかどうか。
`IsSynchronized`	`bool`	読み取り	コレクションがスレッドセーフかどうか。
`SyncRoot`	`object`	読み取り	同期ルート; このインスタンスを返します。
`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 entry)。
`FieldValue`	`string?`	読み取り	フィールド値 (/V entry)。
`DefaultFieldValue`	`string?`	読み取り	デフォルトのフィールド値 (/DV エントリ)。
`FieldType`	`string?`	読み取り	フィールドタイプ（/FT エントリ）。
`InnerRect`	`Rectangle?`	読み取り	/RD（rectangle differences）エントリによってインセットされた注釈矩形 — 実際にRect内部に描画される領域。
`ActiveState`	`string?`	読み取り/書き込み	現在アクティブな外観状態（/ASエントリ）。
`Alignment`	`TextAlignment`	読み取り/書き込み	テキストの配置（リッチテキストを含むフリーテキスト/ウィジェット注釈用）。
`HorizontalAlignment`	`Aspose.Pdf.HorizontalAlignment`	読み取り/書き込み	水平配置（Alignment に加えて公開されます; 2 つは独立して設定可能です）。
`States`	`AppearanceDictionary`	読み取り	Appearance-state dictionary（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`	読み取り/書き込み	型指定された DateTime としての /M（modified）日付。
`AnnotationFlags`	`AnnotationFlags`	読み取り/書き込み	パブリックサーフェスに合わせ、AnnotationFlags をプロパティとして公開する Flags の型エイリアス.
`Action`	`PdfAction?`	読み取り/書き込み	この注釈に関連付けられたアクション (/A entry)。
`Author`	`string?`	読み取り	注釈の作成者 (/T entry)。
`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オーダーインデックス。

メソッド

シグネチャ	説明
`RichTextBoxField(page: Page, rect: Rectangle)`	指定されたページ矩形上にリッチテキストフィールドを作成する。
`TextBoxField(page: Page, rect: Rectangle)`	指定されたページに、指定された矩形で新しいテキストボックスフィールドを作成します。
`TextBoxField(doc: Document, rect: Rectangle)`	ドキュメントに関連付けられた新しいテキストボックスフィールドを作成します（ページは Form.Add を通じて割り当てられます）。
`TextBoxField(doc: Document)`	文書にバインドされたテキストボックス（矩形なし）。
`TextBoxField(page: Page, rects: Rectangle[])`	マルチウィジェットテキストフィールド — 最初の矩形はウィジェット辞書に使用され、追加の矩形はマルチウィジェット契約に従って /Kids に格納されます。
`TextBoxField()`	パラメータなしのctor — バインドされていないテキストボックスフィールドを作成します。
`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()`	このウィジェットの「オン」/「チェック」状態を表す外観状態名（通常は「Yes」）を返します。/AP/N 辞書のキーから検索されます（「Off」でないもの）。
`Accept(visitor: AnnotationSelector)`	この RichTextBoxField インスタンスで 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