Apex リファレンスガイド
jLabel クラス
名前空間
使用方法
カスタム表示ラベルを使用することで、開発者は、情報 (ヘルプテキストやエラーメッセージなど) を自動的にユーザーの母国語に表示する多言語アプリケーションを作成できます。カスタム表示ラベルは、文字数が 1000 文字という制限があり、Apex クラス、Visualforce ページ、Lightning ページ、または Lightning コンポーネントからアクセスできます。カスタム表示ラベルについての詳細は、Salesforce ヘルプの「カスタム表示ラベル」を参照してください。表示ラベルの値は、Salesforce でサポートされる言語に翻訳できます。サポートされる言語については、Salesforce ヘルプの「サポートされる言語」を参照してください。
- カスタム表示ラベルを定義するには、[設定] から、[クイック検索] ボックスに「カスタム表示ラベル」と入力し、[カスタム表示ラベル] を選択します。
- 翻訳された値を割り当てるには、トランスレーションワークベンチをオンにして、翻訳の対応付けを追加します。
- デフォルトの言語設定の表示ラベル、または言語と名前空間の表示ラベルを取得するには、System.Label.get(namespace, label, language) を使用します。
- 名前空間に表示ラベルと言語の翻訳が存在するかどうかを確認するには、Label.translationExists(namespace, label, language) を使用します。
Apex コードで表示ラベルを参照、またはインスタンス化するには、次のようにします。
1System.Label.myLabelName表示ラベルを Aura コンポーネントに渡す方法については、『Lightning Aura コンポーネント開発者ガイド』の「Apex での表示ラベルの取得」を参照してください。
例
次の例では、MyLabel という英語の表示ラベルが MyNamespace 名前空間にある場合に True が返されます。
1boolean exists = Label.translationExists('MyNamespace', 'MyLabel', 'en')次の例では、MyLabel のカスタム表示ラベルのフランス語の翻訳テキストが取得されます。
1String value = Label.get('MyNamespace', 'MyLabel', 'fr')Label のメソッド
Label のメソッドは次のとおりです。
get(namespace, label, language)
署名
public static String get(String namespace, String label, String language)
パラメーター
- namespace
- 型: String
- 名前空間名が null の場合は、パッケージの名前空間にデフォルト設定されます。名前空間名が空の文字列の場合は、組織の名前空間を意味します。
- label
- 型: String
- 表示ラベル名を null や空の文字列にすることはできません。
- language
- 型: String
- このパラメーターは、有効な言語 ISO コードである必要があります。Salesforce ヘルプの「サポートされる言語」の「プラットフォーム専用言語」セクションを参照してください。
戻り値
型: String
translationExists(namespace, label, language)
署名
public static Boolean translationExists(string namespace, string label, string language)
パラメーター
- namespace
- 型: String
- 名前空間名が null の場合は、パッケージの名前空間にデフォルト設定されます。名前空間名が空の文字列の場合は、組織の名前空間を意味します。
- label
- 型: String
- 表示ラベル名を null や空の文字列にすることはできません。
- language
- 型: String
- このパラメーターは、有効な言語 ISO コードである必要があります。Salesforce ヘルプの「サポートされる言語」の「プラットフォーム専用言語」セクションを参照してください。
戻り値
型: Boolean