mxsdoc

依存

• mwm
• mwmDefinitionPool
• MwmStruct
• startupLoader
• std

global mwm

変数

<Struct:MwmStruct>

struct MwmStruct

MVVMフレームワーク。

private converterTable

プロパティ

<Dictionary <Name> <Struct:MwmConverterStruct>>

汎用的なコンバータに名前を付けて格納。既定値はundefined。

private applicationDef

プロパティ

<StructDef:MwmApplicationStruct>

private bindingDef

プロパティ

<StructDef:MwmBindingStruct>

private commandDef

プロパティ

<StructDef:MwmCommandStruct>

private conditionDef

プロパティ

<StructDef:MwmConditionStruct>

private converterDef

プロパティ

<StructDef:MwmConverterStruct>

private eventDef

プロパティ

<StructDef:MwmEventStruct>

private modelAttributeDef

プロパティ

<StructDef:MwmModelAttributeStruct>

private propertyDef

プロパティ

<StructDef:MwmPropertyStruct>

private viewModelDef

プロパティ

<StructDef:MwmViewModelStruct>

public fn AddConverter

汎用的なコンバータを追加する。

パラメータ

converterName

<Name>

コンバータ名。

パラメータ

converter

<Struct:MwmConverterStruct>

コンバータオブジェクト。

戻り値

<Struct:MwmConverterStruct|UndefinedClass>

補足

無効な値の場合はundefinedを返す。
既に登録済みのコンバータ名を指定した場合は内容が上書きされる。

public fn CreateApplication

アプリケーションを作成する。

パラメータ

applicationName

<Name>

アプリケーション名。

パラメータ

startupViewName

<Name>

起動時に表示されるビューの名前。

パラメータ

applicationFile:

<String>

アプリケーションファイルのパス。既定値はundefined。

戻り値

<Struct:MwmApplicationStruct|UndefinedClass>

補足

無効な値の場合はundefinedを返す。

public fn CreateCommand

コマンドを作成する。

パラメータ

commandName

<Name>

コマンド名。

パラメータ

executeFunction:

<MAXScriptFunction|UndefinedClass>

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

パラメータ

modelAttribute:

<Struct:MwmModelAttributeStruct|UndefinedClass>

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

パラメータ

executeCondition:

<Struct:MwmConditionStruct|UndefinedClass>

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

パラメータ

canExecuteCondition:

<Struct:MwmConditionStruct|UndefinedClass>

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

戻り値

<Struct:MwmCommandStruct|UndefinedClass>

補足

無効な値の場合はundefinedを返す。

public fn CreateCommandBinding

ターゲットオブジェクトとコマンドとのバインディングを作成する。

パラメータ

commandName

<Name>

コマンド名。

パラメータ

target

<RolloutClass|RolloutControl|RCMenu|MenuItem>

ターゲットオブジェクト。

パラメータ

targetEventName

<Name>

ターゲットオブジェクトのイベント名。

戻り値

<Struct:MwmBindingStruct|UndefinedClass>

補足

無効な値の場合はundefinedを返す。

public fn CreateCondition

条件オブジェクトを作成する。

パラメータ

evaluator:

<MAXScriptFunction|UndefinedClass>

条件式を定義した関数。既定値はundefined。

戻り値

<Struct:MwmConditionStruct|UndefinedClass>

public fn CreateConverter

コンバータを作成する。

パラメータ

toTargetFunction

<MAXScriptFunction>

値をターゲット用に変換する関数。

パラメータ

toSourceFunction

<MAXScriptFunction>

値をソース用に変換する関数。

戻り値

<Struct:MwmConverterStruct|UndefinedClass>

補足

無効な値の場合はundefinedを返す。

public fn CreateEvent

イベントを作成する。

パラメータ

control

<RolloutClass|RolloutControl|RCMenu|MenuItem>

イベント発生元のロールアウトコントロール。

パラメータ

eventName

<Name>

イベント名。

パラメータ

params

<Array[<Any>]|Any>

イベントデータ。

戻り値

<Struct:MwmEventStruct|UndefinedClass>

補足

無効な値の場合はundefinedを返す。

public fn CreateModelAttribute

モデル属性を作成する。

パラメータ

modelName

<Name>

モデル名。

パラメータ

propertyName:

<Name|UndefinedClass>

モデルのプロパティ名。既定値はundefined。

パラメータ

getterName:

<Name|UndefinedClass>

モデルのプロパティ値取得メソッド名。既定値はundefined。

パラメータ

setterName:

<Name|UndefinedClass>

モデルのプロパティ値設定メソッド名。既定値はundefined。

戻り値

<Struct:MwmModelAttributeStruct|UndefinedClass>

補足

無効な値の場合はundefinedを返す。

public fn CreateProperty

プロパティを作成する。

パラメータ

propertyName

<Name>

プロパティ名。

パラメータ

propertyValue

<Any>

プロパティ値。

パラメータ

modelAttribute:

<Struct:MwmModelAttributeStruct|UndefinedClass>

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

パラメータ

enabledCondition:

<Struct:MwmConditionStruct|UndefinedClass>

プロパティが使用可能かどうかを判定する条件オブジェクト。既定値はundefined。

戻り値

<Struct:MwmPropertyStruct|UndefinedClass>

補足

無効な値の場合はundefinedを返す。

public fn CreatePropertyBinding

ターゲットオブジェクトとプロパティとのバインディングを作成する。

パラメータ

mode

<Integer>

バインディングにおけるデータフローの方向。
有効な値は次の通り。

値	名前	動作
1	TwoWay	ソースまたはターゲットのいずれかが変更されるともう一方も更新される。
2	OneWay	ソースが変更されるとターゲットも更新される。
3	OneWayToSource	ターゲットが変更されるとソースも更新される。

パラメータ

propertyName

<Name>

プロパティ名。

パラメータ

target

<RolloutClass|RolloutControl>

ターゲットオブジェクト。

パラメータ

targetPropertyName

<Name|UndefinedClass>

ターゲットオブジェクトのプロパティ名。

パラメータ

targetEventName

<Name|UndefinedClass>

ターゲットオブジェクトのイベント名。

戻り値

<Struct:MwmBindingStruct|UndefinedClass>

補足

無効な値の場合はundefinedを返す。

public fn CreateViewModel

ビューモデルを作成する。

パラメータ

viewModelName

<Name>

ビューモデル名。

戻り値

<Struct:MwmViewModelStruct|UndefinedClass>

補足

無効な値の場合はundefinedを返す。

public fn GetConverter

汎用コンバータを取得する。

パラメータ

converterName

<Name>

戻り値

<Struct:MwmConverterStruct|UndefinedClass>

補足

無効な値の場合はundefinedを返す。

public fn GetConverterNames

全ての汎用コンバータの名前を取得する。

戻り値

<Array[<Name>]>

public fn Install

インストールする。

戻り値

<OkClass>

補足

静的メソッド。

public fn IsValidViewModel

指定されたオブジェクトがビューモデルかどうかを判定する。

パラメータ

obj

<Any>

戻り値

<BooleanClass>

public fn Uninstall

アンインストールする。

戻り値

<OkClass>

補足

静的メソッド。

private fn isValidControl

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidConverter

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidMenuItem

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidModelAttribute

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidRCMenu

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidRollout

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidRolloutControl

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private version

プロパティ

<Array[<Integer>]>

バージョン番号。メジャー、マイナー、パッチの順。

public fn StructName

戻り値

<Name>

public fn Dump

パラメータ

indent:

<String>

パラメータ

out:

<FileStream|StringStream|WindowStream>

出力先。既定値はlistener。

戻り値

<OkClass>

public fn Equals

パラメータ

obj

<Any>

戻り値

<BooleanClass>

補足

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

public fn GetVersion

戻り値

<Array[<Integer>]>