リサイズはクリックかドラッグ

基本的な使い方

このトピックでは、IME 管理コンポーネントの基本的な使い方について解説します。

概要

IME 管理コンポーネントは、テキストコントロールや標準のテキストボックス等のコントロールに、日本語 IME による入力プロセス中に使用可能な読み取り文字列の取得、IME 状態の取得や保持といった機能を提供する拡張コンポーネントです。

IME 管理コンポーネントには ReadingString、ReadingStringKanaMode、ReadingStringOutputMode の 3 つの添付プロパティがあり、これによってターゲット要素上の読み取り文字列を管理します。

ふりがなの自動取得

WPF のデータバインディング機能と IME 管理コンポーネントを組み合わせることで、コントロールに入力された変換文字列に対する読み取り文字列を、指定したコントロールへ自動的に表示することができます。

入力された読み取り文字列は、ReadingString 添付プロパティにて取得します。Binding オブジェクトの Path プロパティに ReadingString 添付プロパティを設定することで、漢字の入力が行われるたびに指定したコントロールにて読み取り文字列が表示されるようになります。

取得される読み取り文字列のかなモードは、ReadingStringKanaMode 添付プロパティを使用して指定します。ReadingStringKanaMode 添付プロパティには、以下の３つの設定値があります。

プロパティ値説明
KanaMode.KatakanaHalf日本語の文字を半角カタカナに変換します。
KanaMode.Katakana日本語の文字を全角カタカナに変換します。
KanaMode.Hiragana日本語の文字をひらがなに変換します。

また、ReadingStringOutputMode 添付プロパティを使用して、読み取り文字列の出力形式を指定します。ReadingStringOutputMode 添付プロパティには、以下の３つの設定値があります。

プロパティ値説明
ReadingStringOutputMode.NoneReadingString 添付プロパティに読み取り文字列を反映させません。
ReadingStringOutputMode.AppendReadingString 添付プロパティの内容の末尾に読み取り文字列を追加します。
ReadingStringOutputMode.ReplaceReadingString 添付プロパティの内容を新たな読み取り文字列で上書きします。

以下のサンプルコードは、氏名フィールドに入力された氏名に対するふりがなを半角カタカナで表示する XAML コードです。

XAML
コピー
<StackPanel>
    <im:GcTextBox WatermarkDisplayNull="ここにふりがなが表示されます" WatermarkDisplayNullForeground="LightSteelBlue">
        <im:GcTextBox.Text>
            <Binding Mode="TwoWay" ElementName="GcTextBox1" Path="(im:GcImeManager.ReadingString)" />
        </im:GcTextBox.Text>
    </im:GcTextBox>
    <im:GcTextBox Name="GcTextBox1" im:GcImeManager.ReadingStringKanaMode="KatakanaHalf" im:GcImeManager.ReadingStringOutputMode="Append"
        WatermarkDisplayNull="氏名を入力してください。" WatermarkDisplayNullForeground="LightSteelBlue" />
</StackPanel>
IME 状態の保持

AllowSaveImeStatus 添付プロパティを true に設定することで、指定した要素の IME 状態を保存することができます。このとき、実際には以下の処理が行われます。

  • 日本語 IME バーの状態の変更を監視し、状態が変更された場合に現在の IME バーの状態をターゲット要素に適用します。
  • 要素がフォーカスを取得したときに日本語 IME バーの現在の状態をバックアップし、前回フォーカスを取得していた時点での IME 状態を再びその要素に適用します。
  • その要素がフォーカスを失ったときに、上記で保存していたバックアップの内容を復元します。

以下のサンプルコードは、AllowSaveImeStatus 添付プロパティの動作を確認するための例です。

XAML
コピー
<StackPanel>
    <StackPanel Orientation="Horizontal">
        <TextBox />
        <TextBlock Text="1. IME に関する設定はなにも行っていません。" />
    </StackPanel>
    <StackPanel Orientation="Horizontal">
        <TextBox im:GcImeManager.AllowSaveImeStatus="True" />
        <TextBlock Text="2. AllowSaveImeStatus を true に設定しています。" />
    </StackPanel>
    <StackPanel Orientation="Horizontal">
        <TextBox InputMethod.PreferredImeState="On" InputMethod.PreferredImeConversionMode="FullShape,Native"  />
        <TextBlock Text="3. IME の状態を「ひらがな」に設定しています。" />
    </StackPanel>
</StackPanel>

上記サンプルを実行したら、以下のそれぞれの操作を行うことで、AllowSaveImeStatus 添付プロパティの設定が IME の状態変化にどのように影響するか確認できます。

  1. はじめに、１番目の TextBox にフォーカスを移動し、IME が OFF であることを確認します。このとき IME が ON となっている場合は OFF に切り替えてください。
  2. 次に、２番目の TextBox にフォーカスを移動し、IME を ON に切り替え、再び１番目の TextBox へフォーカスを移動します。このとき、１番目の TextBox では、IME が OFF に戻っていることに注目してください。また、１番目と２番目の TextBox 間で複数回フォーカスを移動し、２番目の TextBox のみ IME が ON になることを確認してください。
  3. 前述の手順と同様に、３番目の TextBox にフォーカスを移動し、再び１番目の TextBox へフォーカスを移動します。このとき、１番目の TextBox では、３番目の TextBox で設定された IME の状態がそのまま引き継がれていることに注目してください。
  4. １番目の TextBox へフォーカスを移動し、IME を OFF にします。次に、２番目の TextBox へフォーカスを移動し、IME を ON に、入力モードを「カタカナ」に変更します。この状態で２→１→２、あるいは２→３→２とフォーカスを移動し、それぞれの TextBox 上で IME の状態がどのように変化するか確認してください。
読み取り文字列と変換結果文字列との相互変換

GetConversionList メソッドを使用して、指定された読み取り文字列に対する変換候補のリストを取得できます。また、GetReverseConversionList メソッドを使用して、指定された変換結果文字列に対する読み取り文字列のリストを取得できます。取得されるリストの内容は、IME の種類や IME の学習状態などにより異なります。

注意 メモ 注意

GetConversionList メソッドおよび GetReverseConversionList メソッドを使用する場合、アプリケーションに対して完全信頼を与える必要があります。

以下のサンプルコードは、入力された読み取り文字列に対する変換候補文字列の一覧を ListBox に表示します。

コピー
using GrapeCity.Windows.InputMan;

private void GcTextBox1_TextChanged(object sender, TextChangedEventArgs e)
{
    ListBox1.ItemsSource = GcImeManager.GetConversionList(GcTextBox1.Text);
}
トリガーの条件として IME の状態を参照する

ImeConversionMode、ImeSentenceMode、および ImeState の各プロパティを使用して、現在の IME の状態を取得することができます。これらは、InputMethod クラスの同名のプロパティと同じ値を返しますが、InputMethod と異なり、GcImeManager のそれらのプロパティは依存関係プロパティであり、Trigger や Binding をサポートします。これにより、IME 状態をトリガーの条件として使用することができます。

以下のサンプルコードは、GcTextBox コントロールがフォーカスを受け取り、かつ IME が ON の場合に、背景色を変更する XAML コードです。

XAML
コピー
<StackPanel Margin="10">
    <StackPanel.Resources>
        <Style TargetType="im:GcTextBox">
            <Style.Triggers>
                <MultiDataTrigger>
                    <MultiDataTrigger.Conditions>
                        <Condition Binding="{Binding Source={x:Static im:GcImeManager.Current}, Path=ImeState}" Value="On"/>
                        <Condition Binding="{Binding RelativeSource={RelativeSource Mode=Self}, Path=IsKeyboardFocusWithin}" Value="True"/>
                    </MultiDataTrigger.Conditions>
                    <Setter Property="Background" Value="LightGreen"/>
                </MultiDataTrigger>
            </Style.Triggers>
        </Style>
    </StackPanel.Resources>
    <TextBlock Text="フォーカスを受け取ったときに IME が OFF になるようにしています。" />
    <im:GcTextBox InputMethod.PreferredImeState="Off"/>
    <TextBlock Text="フォーカスを受け取ったときに IME が ON になるようにしています。" Margin="0, 10, 0, 0" />
    <im:GcTextBox InputMethod.PreferredImeState="On"/>
</StackPanel>
参照

その他のリソース

IME 管理コンポーネント