Class Kanji

Namespace: KanjiVariants

Assembly: KanjiVariants.dll

一文字の漢字の代替候補と文字集合への所属を調べます。

public static class Kanji

Inheritance: object

Kanji

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

GetAlternatives(KanjiCharacter, CharacterSet, KanjiFallbackOptions)

MJ縮退マップにある候補と、明示的に許可された基底文字から使用可能な文字を重複なく取得します。

public static IReadOnlyList<KanjiCharacter> GetAlternatives(KanjiCharacter character, CharacterSet characterSet, KanjiFallbackOptions options = KanjiFallbackOptions.None)

Parameters

character KanjiCharacter: 候補を調べる漢字。登録済みの IVS/SVS も指定できます。
characterSet CharacterSet: 候補の所属を確認する文字集合。
options KanjiFallbackOptions: 登録済み IVS/SVS の基底文字へフォールバックするかどうか。

Returns

IReadOnlyList<KanjiCharacter>: 使用可能な候補の一覧。候補がない場合は空の一覧です。

Exceptions

ArgumentOutOfRangeException: characterSet が未定義の値の場合。
ArgumentOutOfRangeException: options に未定義の値が含まれる場合。

GetAlternatives(string, CharacterSet, KanjiFallbackOptions)

文字列で指定した漢字の代替候補を取得します。

public static IReadOnlyList<KanjiCharacter> GetAlternatives(string character, CharacterSet characterSet, KanjiFallbackOptions options = KanjiFallbackOptions.None)

Parameters

character string: 認識可能な漢字一文字または登録済み IVS/SVS。
characterSet CharacterSet: 候補の所属を確認する文字集合。
options KanjiFallbackOptions: 登録済み IVS/SVS の基底文字へフォールバックするかどうか。

Returns

IReadOnlyList<KanjiCharacter>: 使用可能な候補の一覧。候補がない場合は空の一覧です。

Exceptions

ArgumentNullException: character が null の場合。
FormatException: character が漢字一文字または登録済み IVS/SVS でない場合。
ArgumentOutOfRangeException: characterSet が未定義の値の場合。
ArgumentOutOfRangeException: options に未定義の値が含まれる場合。

IsSupported(KanjiCharacter, CharacterSet)

漢字表現そのものが指定文字集合に含まれるかを判定します。

public static bool IsSupported(KanjiCharacter character, CharacterSet characterSet)

Parameters

character KanjiCharacter: 所属を調べる漢字。Variation Selector 付きの表現は各文字集合で false です。
characterSet CharacterSet: 所属を確認する文字集合。

Returns

bool: 漢字表現が文字集合に含まれる場合は true。

Exceptions

ArgumentOutOfRangeException: characterSet が未定義の値の場合。

IsSupported(string, CharacterSet)

文字列で指定した漢字の所属を判定します。

public static bool IsSupported(string character, CharacterSet characterSet)

Parameters

character string: 認識可能な漢字一文字または登録済み IVS/SVS。
characterSet CharacterSet: 所属を確認する文字集合。

Returns

bool: 漢字表現が文字集合に含まれる場合は true。

Exceptions

ArgumentNullException: character が null の場合。
FormatException: character が漢字一文字または登録済み IVS/SVS でない場合。
ArgumentOutOfRangeException: characterSet が未定義の値の場合。

TryGetAlternative(KanjiCharacter, CharacterSet, out KanjiCharacter, KanjiFallbackOptions)

MJ縮退マップの一意な変換先を優先し、明示的に許可された場合は登録済み IVS/SVS の基底文字へフォールバックします。

public static bool TryGetAlternative(KanjiCharacter character, CharacterSet characterSet, out KanjiCharacter alternative, KanjiFallbackOptions options = KanjiFallbackOptions.None)

Parameters

character KanjiCharacter: 変換先を調べる漢字。登録済みの IVS/SVS も指定できます。
characterSet CharacterSet: 変換先の所属を確認する文字集合。
alternative KanjiCharacter: 成功時は変換先。それ以外は既定値です。
options KanjiFallbackOptions: 登録済み IVS/SVS の基底文字へフォールバックするかどうか。

Returns

bool: 文字集合内の変換先が得られた場合は true。

Exceptions

ArgumentOutOfRangeException: characterSet が未定義の値の場合。
ArgumentOutOfRangeException: options に未定義の値が含まれる場合。

TryGetAlternative(string, CharacterSet, out KanjiCharacter, KanjiFallbackOptions)

文字列で指定した漢字について、公式の一意な変換先または許可された基底文字を取得します。

public static bool TryGetAlternative(string character, CharacterSet characterSet, out KanjiCharacter alternative, KanjiFallbackOptions options = KanjiFallbackOptions.None)

Parameters

character string: 認識可能な漢字一文字または登録済み IVS/SVS。
characterSet CharacterSet: 変換先の所属を確認する文字集合。
alternative KanjiCharacter: 成功時は変換先。それ以外は既定値です。
options KanjiFallbackOptions: 登録済み IVS/SVS の基底文字へフォールバックするかどうか。

Returns

bool: 文字集合内の変換先が得られた場合は true。

Exceptions

ArgumentNullException: character が null の場合。
FormatException: character が漢字一文字または登録済み IVS/SVS でない場合。
ArgumentOutOfRangeException: characterSet が未定義の値の場合。
ArgumentOutOfRangeException: options に未定義の値が含まれる場合。