PPGLayout.AddItem

PPGLayout.AddItem operator

導入

v4.0

詳細

コントロールをPPGレイアウトに追加します。通常、この新しい項目はインスペクト対象オブジェクトのパラメータを表します。ユーザは値を表示および変更することができます。たとえば、このメソッドを使用して、CustomProperty の数値パラメータの値を表示するスライダコントロールを追加できます。

このメソッドを使用して、あらゆる種類のコントロールを追加できます。ただし、特に一般的な一部のコントロール用には、PPGLayout.AddColor のような便利なメソッドが追加されています。

多くの場合は、このメソッドに対する呼び出しの後に PPGItem.SetAttribute の呼び出しが 1回または複数回行われ、項目の外観に関する追加情報が提供されます。

C#構文

PPGItem PPGLayout.AddItem( String in_ParamName, String in_opt_Label, String in_opt_UIType );

スクリプト構文

oReturn = PPGLayout.AddItem( ParamName, [Label], [UIType] );

戻り値

PPGItem

パラメータ

パラメータ タイプ 説明
ParamName String Parameter のスクリプト名。この名前のパラメータが存在しない場合でも呼び出しはエラーになりません。ただし、この場合は、コントロールはレイアウトの一部として表示されません(PPGItem.Name を参照)。
Label String ほとんどのコントロールはラベルを持ちます。たとえば、数値スライダの左側に表示されるテキストがラベルにあたります。ここで指定しなかった場合は、代わりにパラメータの名前(SIObject.Name を参照)または Parameter.ScriptName が表示されます(PPGItem.Labelを参照)。
UIType siPPGControlType 描画するコントロールを指定します。たとえば、この引数を使用して、パラメータがコンボボックスとして表示されるように指定できます(PPGItem.Type を参照)。

指定しなかった場合は、単純なヒューリスティックによって、使用するコントロールが Parameter.ValueType に基づいて自動的に決定されます。たとえば、文字列に指定する編集コントロールには、floatintegerのようなスライダを使用する数値型、あるいはチェックボックスを使用するbooleanパラメータなどがあります。

関連項目

Parameter.ScriptName PPGLayout.AddString PPGLayout.AddEnumControl PPGLayout.AddColor PPGLayout.AddButton PPGLayout.AddGroup PPGLayout.AddTab