XSIUIToolkit.MsgBox

XSIUIToolkit.MsgBox

導入

v4.0

詳細

このメソッドは vBScript の MsgBox関数と同じで、Softimage でシンプルなモーダルメッセージウィンドウをポップアップ表示させることができます。アプリケーションがフリーズされるため、ユーザはボタンをクリックしてウィンドウを閉じる必要があります。

デフォルトではOK ボタンのみが表示されますが、siMsgAbortRetryIgnore や siMsgYesNo のようなフラグを使用してこの動作を変更できます。

デフォルトではアイコンは表示されませんが、siMsgQuestion のようなフラグを使用して、メッセージの性質や重要性を表示することもできます。

このメソッドではバッチモードでのスクリプトの実行も可能なため、VBScript のネイティブの MsgBox関数よりも便利です。Softimage をバッチモードで実行した場合は、ルーチンによって即座に戻り値としてデフォルトのボタンが戻されます。デフォルトでは最初のボタンがデフォルトのボタンとみなされますが、siMsgDefaultButton2やsiMsgDefaultButton3のようなフラグを指定することで変更できます。

詳細については、VBScript のマニュアルで MsgBox を参照するか、Win32 のマニュアルで MessageBox を参照してください。

C#構文

Int32 XSIUIToolkit.MsgBox( String in_Msg, Int32 in_flags, String in_Caption );

スクリプト構文

oReturn = XSIUIToolkit.MsgBox( Message, [Flags], [Caption] );

戻り値

siMsgButtonPressed

パラメータ

パラメータ タイプ 説明
Message String 画面に表示されるメッセージ
Flags siMsgBoxFlags ダイアログの表示を制御するフラグ
Caption String メッセージボックスのタイトルに表示するテキスト。通常はこのパラメータを使用してメッセージボックスのソースが分かるようなタイトル(プラグインの名前やスクリプトファイル名など)を指定します。デフォルトでは Softimage の標準のタイトルが使用されます。

JScript の例

// In batch mode buttonPressed is always "siMsgYes"

var buttonPressed = XSIUIToolkit.Msgbox( "Is this example exciting?", 

			siMsgYesNo | siMsgQuestion, "SDK Example" ) ;

if ( buttonPressed == siMsgNo )

{

	LogMessage( "I am sorry, I will try harder next time." ) ;

}

else

{

	LogMessage( "Thanks, if software had emotions I'd be feeling good" ) ;

}

// Try to encourage the user to select the second button

// In batch mode buttonPressed is always siMsgCancel

buttonPressed = XSIUIToolkit.Msgbox( "Please click cancel", siMsgOKCancel | siMsgDefaultButton2 );

if ( buttonPressed == siMsgCancel )

{

	LogMessage( "Thank you" ) ;

}