TextElement クラス

定義

また、抽象 Block クラスと Inline クラスの基底クラスとして使用される抽象クラス。 TextElement では、XAML テキスト オブジェクト モデルに関連するクラス (テキスト サイズ、フォント ファミリなどを制御するプロパティなど) の共通 API がサポートされています。

public ref class TextElement : DependencyObject
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.WinUIContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class TextElement : DependencyObject
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.WinUIContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class TextElement : DependencyObject
Public Class TextElement
Inherits DependencyObject
継承
Object Platform::Object IInspectable DependencyObject TextElement
派生
属性

注釈

TextElement によって定義されるさまざまなプロパティは、XAML テキスト オブジェクト モデルに関連するクラスの共通 API をサポートしています。 最もよく使用されるプロパティの一覧を次に示します。

TextElement プロパティを設定すると、ブロック内とインラインの両方で、テキストに共通のテキスト書式設定プロパティを適用できます。 テキストの書式を設定する他の方法もありますが、これらは TextElement では直接サポートされていません。 代わりに、 Typography クラスの添付プロパティを使用できます。 文字体裁 添付プロパティは、通常、フォント レベルで定義されている文字体裁機能にアクセスするなど、すべてのフォントで必ずしもサポートされていない高度な文字体裁機能や規則をサポートします。 たとえば、 Typography.Variants を任意のテキスト ブロックまたはインラインの添付プロパティとして設定できます。これにより、そのテキスト要素に FontFamily を設定するために選択した特定のフォントで有効になっているフォントバリアントの動作に影響します。

TextElement では、XAML ビジュアル ツリーへの接続ポイントは本質的に定義されません。 言い換えると、TextElement はそのテキスト内でテキストおよびテキスト オブジェクト モデルを定義しますが、UI 内でそのテキストの表示はまだ有効になっていません。 そのためには、 UIElement の子孫であり、XAML ツリーとアプリ ウィンドウのルート ビジュアルに接続できるコントロールまたは要素のいずれかを使用する必要があります。 Windows ランタイムには、次の 2 つの要素があります。

  • TextBlock: Inlines コレクションでのみインラインのテキスト オブジェクト モデルをサポートします。
  • RichTextBlock: Blocks コレクションを使用してブロック テキスト オブジェクト モデルをサポートします。 ブロックには、ブロックとインラインを含めることができます。

注意

PasswordBoxRichEditBoxおよび TextBox では、TextElement に基づくテキスト オブジェクト モデルはサポートされていません。 RichEditBox を使用すると、 ITextDocument インターフェイスを介して別のテキスト オブジェクト モデルにプログラムでアクセスできます。

TextElement は、XAML の解析後にテキスト オブジェクト モデルをプログラミング オブジェクトとして調べることをサポートする API を定義します。 特に TextElement はFrameworkElement で同じ名前の並列プロパティである Name と Language を実装します。 TextElement には、 FindName (初期 XAML で Name がどのように設定されたかに基づいて実行時にオブジェクトを検索するためのユーティリティ メソッド) と OnDisconnectVisualChildren (高度なシナリオとデザイナーのサポート用) も実装されています。

TextElement には、テキスト内から TextPointer オブジェクトへのアクセスを提供する 4 つのプロパティがあります。 これらのプロパティは、 ContentStartContentEndElementStartElementEnd ですWindows ランタイム TextPointer オブジェクトは、コンテンツのトラバーサルのエントリ ポイントを提供します。 詳細については、「 TextPointer」を参照してください。

TextElement は DependencyObject から派生したクラスです。 つまり、依存関係プロパティを定義でき、TextElement の各読み取り/書き込みプロパティは依存関係プロパティであり、そのプロパティ識別子も TextElement によって定義されます。 有効な依存関係プロパティの詳細については、「 依存関係プロパティの概要」を参照してください。

TextElement 派生クラス

TextElement は、テキスト オブジェクト モデルを ブロックインラインの 2 つのテキスト使用規則に分割する 2 つの派生クラスの親クラスです。 ブロックインライン はどちらも基底クラスと見なされ (通常は XAML にタグは表示 <Block> されません)、主に他の実用的なテキスト要素の親クラスとして階層内に存在します。 たとえば、 BlockParagraph の親クラスです。 ブロック要素とインライン要素の使用方法の詳細については、「 テキスト ブロック」を参照してください。

プロパティ

AccessKey

この要素のアクセス キーを取得または設定します。

AccessKeyProperty

AccessKey 依存関係プロパティを識別します。

AccessKeyScopeOwner

ソース要素のビジュアル ツリーにない場合でも、この要素のアクセス キー スコープを提供するソース要素を取得または設定します。

AccessKeyScopeOwnerProperty

AccessKeyScopeOwner 依存関係プロパティを識別します。

AllowFocusOnInteraction

ユーザーが操作するときに要素が自動的にフォーカスを取得するかどうかを示す値を取得または設定します。

AllowFocusOnInteractionProperty

AllowFocusOnInteraction 依存関係プロパティを識別します。

CharacterSpacing

em の 1/1000 単位の文字間の均一な間隔を取得または設定します。

CharacterSpacingProperty

CharacterSpacing 依存関係プロパティを識別します。

ContentEnd

要素内のコンテンツの末尾を表す TextPointer を取得します。

ContentStart

要素内のコンテンツの開始位置を表す TextPointer を取得します。

Dispatcher

常に Windows アプリ SDK アプリで を返しますnull。 代わりに DispatcherQueue を使用してください。

(継承元 DependencyObject)
DispatcherQueue

このオブジェクトが DispatcherQueue 関連付けられている を取得します。 は DispatcherQueue 、コードが UI 以外のスレッドによって開始された場合でも、UI スレッド上の にアクセス DependencyObject できる機能を表します。

(継承元 DependencyObject)
ElementEnd

要素の末尾の直後の位置を表す TextPointer を取得します。

ElementStart

要素の開始直前の位置を表す TextPointer を取得します。

ExitDisplayModeOnAccessKeyInvoked

アクセス キーが呼び出されたときにアクセス キーの表示を閉じるかどうかを示す値を取得または設定します。

ExitDisplayModeOnAccessKeyInvokedProperty

ExitDisplayModeOnAccessKeyInvoked 依存関係プロパティを識別します。

FontFamily

要素のコンテンツに対して、優先される最上位レベルのフォント ファミリを取得または設定します。

FontFamilyProperty

FontFamily 依存関係プロパティを識別します。

FontSize

要素のコンテンツのフォント サイズを取得または設定します。

FontSizeProperty

FontSize 依存関係プロパティを識別します。

FontStretch

選択するファミリ内のフォントのグリフ幅を取得または設定します。

FontStretchProperty

FontStretch 依存関係プロパティを識別します。

FontStyle

この要素のコンテンツのフォント スタイルを取得または設定します。

FontStyleProperty

FontStyle 依存関係プロパティを識別します。

FontWeight

この要素のコンテンツのフォント ファミリから選択する最上位レベルのフォントの太さを取得または設定します。

FontWeightProperty

FontWeight 依存関係プロパティを識別します。

Foreground

この要素のコンテンツに適用する Brush を取得または設定します。

ForegroundProperty

Foreground 依存関係プロパティを識別します。

IsAccessKeyScope

要素が独自のアクセス キー スコープを定義するかどうかを示す値を取得または設定します。

IsAccessKeyScopeProperty

IsAccessKeyScope 依存関係プロパティを識別します。

IsTextScaleFactorEnabled

システム のテキスト サイズ設定を反映するように、自動テキストの拡大を有効にするかどうかを取得または設定します。

IsTextScaleFactorEnabledProperty

IsTextScaleFactorEnabled 依存関係プロパティを識別します。

KeyTipHorizontalOffset

テキスト要素に対してキーヒントを配置する距離を示す値を取得または設定します。

KeyTipHorizontalOffsetProperty

KeyTipHorizontalOffset 依存関係プロパティを識別します。

KeyTipPlacementMode

テキスト要素に対する KeyTip の配置場所を示す値を取得または設定します。

KeyTipPlacementModeProperty

KeyTipPlacementMode 依存関係プロパティを識別します。

KeyTipVerticalOffset

テキスト要素に対するキーヒントの配置距離を示す値を取得または設定します。

KeyTipVerticalOffsetProperty

KeyTipVerticalOffset 依存関係プロパティを識別します。

Language

TextElement に適用されるローカライズ/グローバリゼーション言語情報を取得または設定します。

LanguageProperty

Language 依存関係プロパティを識別します。

Name

オブジェクトの一意の ID を取得または設定します。 名前は、XAML の初期解析からのみ設定できます。

TextDecorations

テキストに適用される装飾を示す値を取得または設定します。

TextDecorationsProperty

TextDecorations 依存関係プロパティを識別します。

XamlRoot

この要素が表示される XamlRoot を取得または設定します。

メソッド

ClearValue(DependencyProperty)

依存関係プロパティのローカル値をクリアします。

(継承元 DependencyObject)
FindName(String)

オブジェクトの x:Name または Name 属性値を参照して、オブジェクト モデル/ランタイム オブジェクト グラフ内のオブジェクトを取得 します

GetAnimationBaseValue(DependencyProperty)

依存関係プロパティに対して確立された基本値を返します。これは、アニメーションがアクティブでない場合に適用されます。

(継承元 DependencyObject)
GetValue(DependencyProperty)

DependencyObject から依存関係プロパティの現在の有効な値を返します。

(継承元 DependencyObject)
OnDisconnectVisualChildren()

クラス固有のコンテンツまたは子プロパティから項目が削除されたときにレイアウトとロジックがどのように動作するかを実装するには、このメソッドをオーバーライドします。

ReadLocalValue(DependencyProperty)

ローカル値が設定されている場合は、依存関係プロパティのローカル値を返します。

(継承元 DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)

この DependencyObject インスタンスの特定の DependencyProperty に対する変更をリッスンするための通知関数を登録します。

(継承元 DependencyObject)
SetValue(DependencyProperty, Object)

DependencyObject の依存関係プロパティのローカル値を設定します。

(継承元 DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)

RegisterPropertyChangedCallback を呼び出して以前に登録した変更通知を取り消します。

(継承元 DependencyObject)

イベント

AccessKeyDisplayDismissed

アクセス キー のビジュアルを非表示にする必要があることをコントロールに通知するためにアクセス キー シーケンスが完了したときに発生します。

AccessKeyDisplayRequested

アクセス キー のビジュアルを表示する必要があることをコントロールに通知するためにアクセス キー シーケンスが開始されたときに発生します。

AccessKeyInvoked

ユーザーがアクセス キー シーケンスを完了して、アクセス キー アクションを呼び出す必要があることを要素に通知するときに発生します。

適用対象

こちらもご覧ください