mxsdoc

依存

• std

struct MwmCommandStruct

ビューモデルにコマンドを定義するための構造体。

補足

作成パラメータ

MwmCommandStruct commandName executeFunction [modelAttribute] [executeCondition] [canExecuteCondition]

通知

通知名	通知データ	タイミング
#CanExecuteChanged	CanExecuteメソッドの戻り値	RaiseCanExecuteChangedメソッドが呼ばれた直後
#CanExecuteCondition	新たなcanExecuteCondition値	canExecuteConditionを設定した後
#CommandName	新たなcommandName値	commandNameを設定した後
#ExecuteCondition	新たなexecuteCondition値	executeConditionを設定した後
#ExecuteFunction	新たなexecuteFunction値	executeFunctionを設定した後
#Model	新たなmodel値	modelを設定した後
#ModelAttribute	新たなmodelAttribute値	modelAttributeを設定した後

オブザーバ

購読先	メソッド
canExecuteConditionに設定した条件オブジェクト	RaiseCanExecuteChanged

public _CP1_

プロパティ

<Name>

作成パラメータ1。コマンド名。既定値はundefined。

public _CP2_

プロパティ

<MAXScriptFunction|UndefinedClass>

作成パラメータ2。コマンドの内容を定義した関数。既定値はundefined。

public _CP3_

プロパティ

<Struct:MwmModelAttributeStruct|UndefinedClass>

作成パラメータ3。モデル属性。既定値はundefined。

public _CP4_

プロパティ

<Struct:MwmConditionStruct|UndefinedClass>

作成パラメータ4。コマンドで使用するプロパティを格納した条件オブジェクト。既定値はundefined。

public _CP5_

プロパティ

<Struct:MwmConditionStruct|UndefinedClass>

作成パラメータ5。コマンドが実行可能かどうかを判定する条件オブジェクト。既定値はundefined。

private canExecuteCondition

プロパティ

<Struct:MwmConditionStruct|UndefinedClass>

コマンドが実行可能かどうかを判定する条件オブジェクト。既定値はundefined。

private commandName

プロパティ

<Name>

コマンド名。バインディングのソース名。既定値はundefined。

private executeCondition

プロパティ

<Struct:MwmConditionStruct|UndefinedClass>

コマンドで使用するプロパティを格納した条件オブジェクト。既定値はundefined。

private executeFunction

プロパティ

<MAXScriptFunction|UndefinedClass>

コマンドの内容を定義した関数。既定値はundefined。

private model

プロパティ

<Struct|UndefinedClass>

モデルオブジェクト。既定値はundefined。

private modelAttribute

プロパティ

<Struct:MwmModelAttributeStruct|UndefinedClass>

モデル属性。既定値はundefined。

public fn CanExecute

コマンドが実行可能かどうかを判定する。

戻り値

<BooleanClass>

補足

条件式が真偽値以外を返した場合はtrueを返す。

public fn Execute

コマンドを実行する。

パラメータ

event

<Struct:MwmEventStruct|UndefinedClass>

イベント情報。

戻り値

<OkClass>

public fn GetCanExecuteCondition

コマンドが実行可能かどうかを判定する条件オブジェクトを取得する。

戻り値

<Struct:MwmConditionStruct|UndefinedClass>

public fn GetCommandName

コマンド名を取得する。

戻り値

<Name>

public fn GetExecuteCondition

コマンドで使用するプロパティを格納した条件オブジェクトを取得する。

戻り値

<Struct:MwmConditionStruct|UndefinedClass>

public fn GetExecuteFunction

コマンドの内容を定義した関数を取得する。

戻り値

<MAXScriptFunction|UndefinedClass>

public fn GetModel

モデルオブジェクトを取得する。

戻り値

<Struct|UndefinedClass>

public fn GetModelAttribute

モデル属性を取得する。

戻り値

<Struct:MwmModelAttributeStruct|UndefinedClass>

public fn RaiseCanExecuteChanged

コマンドが実行可能かどうかの変更通知を発行する。

パラメータ

type

<Name>

パラメータ

param

<Any>

戻り値

<OkClass>

public fn SetCanExecuteCondition

コマンドが実行可能かどうかを判定する条件オブジェクトを設定する。

パラメータ

condition

<Struct:MwmConditionStruct>

戻り値

<Struct:MwmConditionStruct|UndefinedClass>

補足

無効な値の場合は何もしない。

public fn SetCommandName

コマンド名を設定する。

パラメータ

input

<Name>

戻り値

<Name>

補足

無効な値の場合は何もしない。

public fn SetExecuteCondition

コマンドで使用するプロパティを格納した条件オブジェクトを設定する。

パラメータ

condition

<Struct:MwmConditionStruct>

戻り値

<Struct:MwmConditionStruct|UndefinedClass>

補足

無効な値の場合は何もしない。

public fn SetExecuteFunction

コマンドの内容を定義した関数を設定する。

パラメータ

input

<MAXScriptFunction>

戻り値

<MAXScriptFunction|UndefinedClass>

補足

無効な値の場合は何もしない。
指定する関数は次のように実装する。

fn exampleExecuteFunction model params event = (
  model.Foo params[1].Value params[2].Value
  ok
)

• 第一引数にコマンドに関連付けられたモデルオブジェクト、第二引数にプロパティ名とプロパティ値のペアの配列を取る。

  引数	型
  model	<Struct>
  params	<Array[<DataPair Name:<Name> Value:<Any>>]>
  event	<Struct:MwmEventStruct|UndefinedClass>

• 任意の値を返す。

public fn SetModel

モデルオブジェクトを設定する。

パラメータ

obj

<Struct|UndefinedClass>

戻り値

<Struct|UndefinedClass>

補足

無効な値の場合は何もしない。

public fn SetModelAttribute

モデル属性を設定する。

パラメータ

obj

<Struct:MwmModelAttributeStruct|UndefinedClass>

戻り値

<Struct:MwmModelAttributeStruct|UndefinedClass>

補足

無効な値の場合は何もしない。

private fn isValidCondition

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidFunction

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidModel

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidModelAttribute

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidObservable

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidProperty

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn subscribeCanExecuteCondition

コマンドが実行可能かどうかを判定する条件オブジェクトを購読する。

戻り値

<OkClass>

private fn unsubscribeCanExecuteCondition

コマンドが実行可能かどうかを判定する条件オブジェクトの購読を解除する。

戻り値

<OkClass>

public fn StructName

戻り値

<Name>

public fn Dump

パラメータ

indent:

<String>

パラメータ

out:

<FileStream|StringStream|WindowStream>

出力先。既定値はlistener。

戻り値

<OkClass>

public fn Equals

パラメータ

obj

<Any>

戻り値

<BooleanClass>

補足

大文字と小文字を区別する。

public CanExecuteChanged

プロパティ

<Struct:ObservableStruct>

public StateChanged

プロパティ

<Struct:ObservableStruct>