EditField
編集フィールド UI コンポーネント
説明
編集フィールド UI コンポーネントにより、アプリ ユーザーはアプリにテキストを入力できます。EditField オブジェクトを使用して、編集フィールドの作成後に編集フィールドの外観と動作を変更します。
作成
uieditfield 関数を使用してアプリで編集フィールドを作成します。
プロパティ
テキスト
編集フィールド内のテキスト。文字ベクトルまたは string スカラーとして指定します。MATLAB® ではテキストは単一行として表示されます。複数行のテキストを許可する場合は、編集フィールドの代わりにテキスト エリア コンポーネントを使用します。
例: 'Hello world'
編集フィールドのテキストの最小文字数と最大文字数。2 要素の数値配列として指定します。最初の値は 2 番目の値以下でなければならず、値は両方とも非負でなければなりません。上限を指定しない場合は、2 番目の配列要素を Inf に設定します。
CharacterLimits を変更し、Value の文字数が新しい制限の範囲外になった場合、MATLAB は Value を '' にリセットします。たとえば、CharacterLimits が [0 5] で、Value が 'Hello' だとします。CharacterLimits を [6 Inf] に変更すると、MATLAB は Value を '' に設定します。
0 より大きい下限を指定した場合でも、次のような設定で Value が '' になる可能性があります。
編集フィールドが既定値で作成されており、アプリ ユーザーが
CharacterLimitsの範囲内の有効な値をまだ入力していない。上記のように、
CharacterLimitsを変更した後にValueプロパティがリセットされた。
例: [0 3]
例: [5 5]
例: [2 Inf]
有効なテキスト コンテンツ。次の値の 1 つとして指定します。
'text'— 任意のテキストが有効です。'letters'— テキストはすべて英字で構成されている必要があります。'digits'— テキストはすべて数字で構成されている必要があります。'alphanumerics'— テキストはすべて英数字で構成されている必要があります。
編集フィールドのプレースホルダー テキスト。文字ベクトルまたは string スカラーとして指定します。プレースホルダーは、予期される入力を説明する短いヒントを提供します。テキストは、Value プロパティが '' の場合にのみ表示されます。
例: 'Enter text'
編集フィールド内のテキストの配置。'left'、'right'、または 'center' として指定します。配置は、アプリ ユーザーが編集フィールドを編集するときの表示と、MATLAB がアプリでテキストを表示する方法に影響します。
フォントと色
フォントの色。RGB 3 成分、16 進数カラー コードまたは表にリストされたオプションのいずれかとして指定します。
RGB 3 成分および 16 進数カラー コードは、カスタム色を指定するのに役立ちます。
RGB 3 成分は、色の赤、緑、青成分の強度を指定する 3 成分の行ベクトルです。強度値は
[0,1]の範囲でなければなりません。たとえば[0.4 0.6 0.7]のようになります。16 進数カラー コードは、ハッシュ記号 (
#) で始まり、3 桁または 6 桁の0からFまでの範囲の 16 進数が続く文字ベクトルまたは string スカラーです。この値は大文字と小文字を区別しません。したがって、カラー コード"#FF8800"、"#ff8800"、"#F80"、および"#f80"は等価です。
あるいは、名前を使用して一部の一般的な色を指定できます。次の表に、名前の付いた色オプション、等価の RGB 3 成分、および 16 進数カラー コードを示します。
| 色名 | 省略名 | RGB 3 成分 | 16 進数カラー コード | 外観 |
|---|---|---|---|---|
"red" | "r" | [1 0 0] | "#FF0000" |
|
"green" | "g" | [0 1 0] | "#00FF00" |
|
"blue" | "b" | [0 0 1] | "#0000FF" |
|
"cyan" | "c" | [0 1 1] | "#00FFFF" |
|
"magenta" | "m" | [1 0 1] | "#FF00FF" |
|
"yellow" | "y" | [1 1 0] | "#FFFF00" |
|
"black" | "k" | [0 0 0] | "#000000" |
|
"white" | "w" | [1 1 1] | "#FFFFFF" |
|
次の表に、ライト テーマとダーク テーマでのプロットの既定のカラー パレットを示します。
| パレット | パレットの色 |
|---|---|
R2025a より前: ほとんどのプロットで、これらの色が既定で使用されます。 |
|
|
|
orderedcolors 関数と rgb2hex 関数を使用すると、これらのパレットの RGB 3 成分および 16 進数カラー コードを取得できます。たとえば、"gem" パレットの RGB 3 成分を取得し、16 進数カラー コードに変換します。
RGB = orderedcolors("gem");
H = rgb2hex(RGB);R2023b より前: RGB = get(groot,"FactoryAxesColorOrder") を使用して、RGB 3 成分を取得します。
R2024a より前: H = compose("#%02X%02X%02X",round(RGB*255)) を使用して、16 進数カラー コードを取得します。
背景色。RGB 3 成分、16 進数カラー コード、または表にリストされた色オプションのいずれかとして指定します。
RGB 3 成分および 16 進数カラー コードは、カスタム色を指定するのに役立ちます。
RGB 3 成分は、色の赤、緑、青成分の強度を指定する 3 成分の行ベクトルです。強度値は
[0,1]の範囲でなければなりません。たとえば[0.4 0.6 0.7]のようになります。16 進数カラー コードは、ハッシュ記号 (
#) で始まり、3 桁または 6 桁の0からFまでの範囲の 16 進数が続く文字ベクトルまたは string スカラーです。この値は大文字と小文字を区別しません。したがって、カラー コード"#FF8800"、"#ff8800"、"#F80"、および"#f80"は等価です。
あるいは、名前を使用して一部の一般的な色を指定できます。次の表に、名前の付いた色オプション、等価の RGB 3 成分、および 16 進数カラー コードを示します。
| 色名 | 省略名 | RGB 3 成分 | 16 進数カラー コード | 外観 |
|---|---|---|---|---|
"red" | "r" | [1 0 0] | "#FF0000" |
|
"green" | "g" | [0 1 0] | "#00FF00" |
|
"blue" | "b" | [0 0 1] | "#0000FF" |
|
"cyan" | "c" | [0 1 1] | "#00FFFF" |
|
"magenta" | "m" | [1 0 1] | "#FF00FF" |
|
"yellow" | "y" | [1 1 0] | "#FFFF00" |
|
"black" | "k" | [0 0 0] | "#000000" |
|
"white" | "w" | [1 1 1] | "#FFFFFF" |
|
次の表に、ライト テーマとダーク テーマでのプロットの既定のカラー パレットを示します。
| パレット | パレットの色 |
|---|---|
R2025a より前: ほとんどのプロットで、これらの色が既定で使用されます。 |
|
|
|
orderedcolors 関数と rgb2hex 関数を使用すると、これらのパレットの RGB 3 成分および 16 進数カラー コードを取得できます。たとえば、"gem" パレットの RGB 3 成分を取得し、16 進数カラー コードに変換します。
RGB = orderedcolors("gem");
H = rgb2hex(RGB);R2023b より前: RGB = get(groot,"FactoryAxesColorOrder") を使用して、RGB 3 成分を取得します。
R2024a より前: H = compose("#%02X%02X%02X",round(RGB*255)) を使用して、16 進数カラー コードを取得します。
対話機能
編集フィールドが編集可能かどうか。'on' または 'off'、もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' の値は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は、matlab.lang.OnOffSwitchState 型の on/off の logical 値として保存されます。
このプロパティを Enable プロパティ値と組み合わせて使用して、コンポーネントがアプリ ユーザーの入力に応答するかどうか、またどのように応答するかを決定します。
編集フィールドを編集可能にし、関連するコールバックをトリガー可能にするには、
EnableプロパティとEditableプロパティの両方の値を'on'に設定します。
編集フィールドを編集不可にし、テキストを読みやすくするには、
Enableプロパティの値を'on'に設定し、Editableプロパティの値を'off'に設定します。
編集フィールドを編集不可にし、テキストをグレー表示にするには、両方のプロパティを
'off'に設定します。
編集フィールドの操作可能状態。'on' または 'off'、もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' の値は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は、matlab.lang.OnOffSwitchState 型の on/off の logical 値として保存されます。
このプロパティを Editable プロパティ値と組み合わせて使用して、コンポーネントがアプリ ユーザーの入力に応答するかどうか、またどのように応答するかを決定します。
編集フィールドを編集可能にし、関連するコールバックをトリガー可能にするには、
EnableプロパティとEditableプロパティの両方の値を'on'に設定します。 編集フィールドを編集不可にし、テキストを読みやすくするには、
Enableプロパティの値を'on'に設定し、Editableプロパティの値を'off'に設定します。 編集フィールドを編集不可にし、テキストをグレー表示にするには、両方のプロパティを
'off'に設定します。
ツールヒント。文字ベクトル、文字ベクトルの cell 配列、string 配列、または 1 次元の categorical 配列として指定します。このプロパティを使用して、実行時にユーザーがポインターをコンポーネントに合わせるとメッセージが表示されるようにします。コンポーネントが無効になっている場合でも、ツールヒントは表示されます。複数行のテキストを表示するには、文字ベクトルの cell 配列または string 配列を指定します。配列の各要素は、テキストの各行になります。このプロパティを categorical 配列として指定した場合、MATLAB はカテゴリの完全なセットではなく、配列内の値を使用します。
コンテキスト メニュー。関数 uicontextmenu を使用して作成された ContextMenu オブジェクトとして指定します。このプロパティは、コンポーネントを右クリックしたときにコンテキスト メニューを表示するために使用します。
位置
レイアウト オプション。GridLayoutOptions オブジェクトとして指定します。このプロパティは、グリッド レイアウト コンテナーの子であるコンポーネントのオプションを指定します。コンポーネントがグリッド レイアウト コンテナーの子ではない場合 (たとえば、Figure またはパネルの子である場合) は、このプロパティは空で、効果はありません。しかし、コンポーネントがグリッド レイアウト コンテナーの子である場合は、GridLayoutOptions オブジェクトの Row プロパティおよび Column プロパティを設定して、グリッドの目的の行と列にコンポーネントを配置することができます。
たとえば、以下のコードは、編集フィールドをその親グリッドの 3 行目の 2 列目に配置します。
g = uigridlayout([4 3]); ef = uieditfield(g); ef.Layout.Row = 3; ef.Layout.Column = 2;
編集フィールドが複数の行または列にまたがるようにするには、Row または Column プロパティを 2 要素のベクトルとして指定します。たとえば、次の編集フィールドは 2 列目から 3 列目にまたがります。
ef.Layout.Column = [2 3];
コールバック
値が変更中のコールバック。次の値のいずれかとして指定します。
関数ハンドル。
最初の要素が関数ハンドルである cell 配列。cell 配列内のその後の要素はコールバック関数に渡される引数です。
有効な MATLAB 式を含む文字ベクトル (非推奨)。MATLAB は、この式をベース ワークスペースで評価します。
このコールバックは次のように実行されます。
ユーザーが編集フィールドに入力する間、コールバックは繰り返し実行されます。
ユーザーが Enter キーを押すと、コールバックが実行されます。
編集フィールドの値がプログラムによって変更された場合、コールバックは実行されません。
このコールバック関数は、ユーザーの編集フィールドの操作に関する特定の情報にアクセスできます。MATLAB は、この情報を ValueChangingData オブジェクトに格納して、2 番目の引数としてコールバック関数に渡します。App Designer では、引数は event と呼ばれます。ドット表記を使用して、オブジェクトのプロパティをクエリできます。たとえば、event.Value は、コールバックの実行をトリガーした編集フィールド内の値です。ValueChangingData オブジェクトは、文字ベクトルとして指定されているコールバック関数では使用できません。
ValueChangingData オブジェクトのプロパティは次のようになります。
| プロパティ | 説明 |
|---|---|
Value | コールバックの実行をトリガーした値 |
Source | コールバックを実行するコンポーネント |
EventName | 'ValueChanging' |
EditField オブジェクトの Value プロパティは、ユーザーが Enter キーを押すまで更新されません。ただし、ValueChangingData オブジェクトの Value プロパティをクエリすることで、ユーザーが Enter キーを押す前に入力しているテキストを取得できます。
メモ
EditField オブジェクトの Value プロパティをそれ自体の ValueChangingFcn コールバック内から更新しないでください。予期しない動作を引き起こす可能性があります。ユーザー入力に応じて編集フィールドの値を更新するには、代わりに ValueChangedFcn コールバックを使用します。
コールバックの記述の詳細については、App Designer のコールバックを参照してください。
コールバック実行制御
親/子
親コンテナー。Figure オブジェクトまたはその子コンテナー (Tab、Panel、ButtonGroup、GridLayout) のいずれかとして指定します。コンテナーが指定されていない場合、MATLAB は関数 uifigure を呼び出し、親コンテナーとして使用される新しい Figure オブジェクトを作成します。
識別子
この プロパティ は読み取り専用です。
グラフィックス オブジェクトのタイプ。'uieditfield' として返されます。
オブジェクト関数
focus | UI コンポーネントにフォーカスを移動 |
例
数値編集フィールドを作成し、その範囲を 0 ～ 100 に設定します。
fig = uifigure; ef = uieditfield(fig,"numeric", ... "Limits",[0 100]);
既定値を決定します。
val = ef.Value
val = 0
編集フィールドの値を 50 に設定します。
ef.Value = 50;
長さが 3 ～ 12 文字であり、文字と数字のみで構成されるテキストをアプリ ユーザーが入力できるテキスト編集フィールドを作成します。
fig = uifigure; ef = uieditfield(fig, ... "CharacterLimits",[3 12], ... "InputType","alphanumerics");
無効な値をテキスト編集フィールドに入力すると、MATLAB はその問題を示すメッセージを表示します。その後、Enter キーを押したり、コンポーネントから移動したりすることで無効な値を入力すると、MATLAB はその値を直前の有効な値に戻します。
アプリ ユーザーがテキスト編集フィールドに入力した値のログを保持し、テキスト エリアにそのログを表示するアプリを作成します。
logEntriesApp.m という名前のファイルで、アプリを実装する関数を作成します。
UI Figure およびグリッド レイアウト マネージャーを作成してアプリをレイアウトします。
グリッド レイアウト マネージャーでテキスト編集フィールドとテキスト エリアを作成します。
ユーザーが編集フィールドに新しいテキストを入力するたびに前に入力されていたテキストをテキスト エリアに追加する
editFieldValueChangedという名前のコールバック関数を作成し、その関数を編集フィールドのValueChangedFcnコールバック プロパティに割り当てます。コールバック イベント データを使用して、前に入力されていたテキストにアクセスします。コールバックの詳細については、プログラムで作成したアプリ用のコールバックの作成を参照してください。
function logEntriesApp fig = uifigure; g = uigridlayout(fig); g.RowHeight = {'fit','1x'}; g.ColumnWidth = {'1x',150,'1x'}; loglist = uitextarea(g, ... "Editable","off"); loglist.Layout.Row = 2; loglist.Layout.Column = 2; ef = uieditfield(g, ... "Value","Daniela Hendrix",... "ValueChangedFcn",@(src,event) editFieldValueChanged(src,event,loglist)); ef.Layout.Row = 1; ef.Layout.Column = 2; end % Create ValueChangedFcn callback function editFieldValueChanged(src,event,loglist) prev = event.PreviousValue; loglist.Value = [prev; loglist.Value]; end
関数 logEntriesApp を実行します。編集フィールドに名前をいくつか入力します。新しい名前を入力するたびに、アプリは前の名前を、テキスト エリアに表示されているログに追加します。
