PPGLayout.AddString operator

導入

v4.0

詳細

文字列をPPGレイアウトに追加します。

このメソッドは PPGLayout.AddItem と非常に似ていますが、このメソッドでは複数行の文字列コントロールを容易に指定できます。

C#構文

PPGItem PPGLayout.AddString( String in_ParamName, String in_opt_Label, Boolean in_opt_Multiline, Int32 in_opt_Height );

スクリプト構文

oReturn = PPGLayout.AddString( ParamName, [Label], [MultiLine], [Height] );

戻り値

PPGItem

パラメータ

パラメータ タイプ 説明
ParamName String Parameter のスクリプト名。この名前のパラメータが存在しない場合でも呼び出しはエラーになりません。ただし、この場合は、コントロールはレイアウトの一部として表示されません
Label String ほとんどのコントロールはラベルを持ちます。たとえば、数値スライダの左側に表示されるテキストがラベルにあたります。ここで指定しなかった場合は、パラメータの名前(SIObject.Name を参照)または Parameter.ScriptName が表示されます。
MultiLine Boolean True の場合は、文字列パラメータの値は複数行の編集コントロールで表されます。ユーザは、このコントロールを使用して、スクリプトコードや自由な形式のテキストを記述できます。また、コントロールが読み取り専用の場合は、詳しい説明を表示できます。テキストがコントロールの幅や高さよりも大きい場合には、スクロールバーを使用できます。

複数行の編集の PPGItem.Type としては siControlEdit があり、属性 siUICX、siUIStyle、および siUIClass が使用されます(「PPGItem.GetAttribute」を参照)。
Height Long このパラメータは、MultiLine 属性が true の場合にのみ適用されます。複数行のコントロールの高さをピクセル単位で指定します。注:コントロールはプロパティページのサイズに応じて自動的にリサイズされるため、幅は設定する必要はありません。

デフォルト値:120

VBScript の例

set oCustomProperty = ActiveSceneRoot.AddProperty( "CustomProperty", false, "DescriptionPSet" )

oCustomProperty.AddParameter3 "Description", siString 

oCustomProperty.PPGLayout.AddString "Description",,true, 200 

oCustomProperty.Description = "Here is some " & vbcrlf & "multi-line text"

InspectObj oCustomProperty

関連項目

PPGLayout.AddItem