mxsdoc

依存

• std

struct MwmBindingStruct

データバインディングの仕組みを提供する。

補足

作成パラメータ

MwmBindingStruct mode sourceName target targetPropertyName [targetEventName]

通知

通知名	通知データ	タイミング
#Converter	新たなconverter値	converterを設定した後
#Mode	新たなmode値	modeを設定した後
#Source	新たなsource値	sourceを設定した後
#SourceName	新たなsourceName値	sourceNameを設定した後
#SourceValueChanged	undefined	ソースの値を設定した後
#Target	新たなtarget値	targetを設定した後
#TargetEnabledChanged	ターゲットオブジェクトのEnabledプロパティの値	ターゲットオブジェクトが使用可能かどうかを設定した後
#TargetEventName	新たなtargetEventName値	targetEventNameを設定した後
#TargetPropertyName	新たなtargetPropertyName値	targetPropertyNameを設定した後
#TargetPropertyValueChanged	設定後のプロパティ値	ターゲットオブジェクトのプロパティ値を設定した後

オブザーバ

購読先	メソッド
MwmCommandStruct.CanExecuteChanged	SourceChanged
MwmCommandStruct.StateChanged	SourceChanged
MwmPropertyStruct.EnabledChanged	SourceChanged
MwmPropertyStruct.StateChanged	SourceChanged
MwmViewModelStruct.targetChanged	TargetChanged

public _CP1_

プロパティ

<Name>

作成パラメータ1。バインディングにおけるデータフローの方向。既定値は1。

public _CP2_

プロパティ

<Name>

作成パラメータ2。ソース名。プロパティオブジェクトまたはコマンドオブジェクトの名前。既定値はundefined。

public _CP3_

プロパティ

<RolloutClass|RolloutControl|RCMenu|MenuItem>

作成パラメータ3。ターゲットオブジェクト。既定値はundefined。

public _CP4_

プロパティ

<Name|UndefinedClass>

作成パラメータ4。ターゲットオブジェクトのプロパティ名。既定値はundefined。

public _CP5_

プロパティ

<Name|UndefinedClass>

作成パラメータ5。ターゲットオブジェクトのイベント名。既定値はundefined。

private converter

プロパティ

<Struct:MwmConverterStruct>

ソース-ターゲット間の値のコンバータ。既定値はundefined。

private mode

プロパティ

<Integer>

バインディングにおけるデータフローの方向。既定値は1。

private source

プロパティ

<Struct:MwmCommandStruct|Struct:MwmPropertyStruct>

ソースオブジェクト。既定値はundefined。

private sourceName

プロパティ

<Name>

ソース名。プロパティオブジェクトまたはコマンドオブジェクトの名前。既定値はundefined。

private target

プロパティ

<RolloutClass|RolloutControl|RCMenu|MenuItem>

ターゲットオブジェクト。既定値はundefined。

private targetEventName

プロパティ

<Name|UndefinedClass>

ターゲットオブジェクトのイベント名。既定値はundefined。

private targetPropertyName

プロパティ

<Name|UndefinedClass>

ターゲットオブジェクトのプロパティ名。既定値はundefined。

public fn GetConverter

ソース-ターゲット間の値のコンバータを取得する。

戻り値

<Struct:MwmConverterStruct|UndefinedClass>

public fn GetMode

バインディングにおけるデータフローの方向を取得する。

戻り値

<Integer>

public fn GetSource

ソースオブジェクトを取得する。

戻り値

<Struct:MwmCommandStruct|Struct:MwmPropertyStruct|UndefinedClass>

public fn GetSourceName

ソース名を取得する。

戻り値

<Name|UndefinedClass>

public fn GetSourceValue

ソースがプロパティオブジェクトの場合に値を取得する。

戻り値

<Any>

補足

コンバータが設定されている場合はターゲット用に変換した値を返す。
ソースがプロパティオブジェクト以外の場合はundefinedを返す。

public fn GetTarget

ターゲットオブジェクトを取得する。

戻り値

<RolloutClass|RolloutControl|RCMenu|MenuItem|UndefinedClass>

public fn GetTargetEnabled

ターゲットオブジェクトが使用可能かどうかを取得する。

戻り値

<BooleanClass>

補足

ターゲットオブジェクトがロールアウトコントロール以外の場合はfalseを返す。

public fn GetTargetEventName

ターゲットオブジェクトのイベント名を取得する。

戻り値

<Name|UndefinedClass>

public fn GetTargetName

ターゲットオブジェクトの名前を取得する。

戻り値

<Name|UndefinedClass>

public fn GetTargetPropertyName

ターゲットオブジェクトのプロパティ名を取得する。

戻り値

<Name|UndefinedClass>

public fn GetTargetPropertyValue

ターゲットオブジェクトのプロパティ値を取得する。

戻り値

<Any>

補足

コンバータが設定されている場合はソース用に変換した値を返す。
ソースがプロパティオブジェクト以外の場合、および該当のプロパティが存在しない場合はundefinedを返す。

public fn Refresh

ソースオブジェクトの状態をターゲットオブジェクトに反映する。

戻り値

<OkClass>

public fn SetConverter

ソース-ターゲット間の値のコンバータを設定する。

パラメータ

obj

<Struct:MwmConverterStruct|UndefinedClass>

戻り値

<Struct:MwmConverterStruct|UndefinedClass>

補足

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

public fn SetMode

バインディングにおけるデータフローの方向を設定する。

パラメータ

input

<Integer>

有効な値は次の通り。

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

戻り値

<Integer>

補足

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

public fn SetSource

ソースオブジェクトを設定する。

パラメータ

obj

<Struct:MwmCommandStruct|Struct:MwmPropertyStruct>

戻り値

<Struct:MwmCommandStruct|Struct:MwmPropertyStruct|UndefinedClass>

補足

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

public fn SetSourceName

ソース名を設定する。

パラメータ

input

<Name>

プロパティオブジェクトまたはコマンドオブジェクトの名前。

戻り値

<Name>

補足

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

public fn SetSourceValue

ソースがプロパティオブジェクトの場合に値を設定する。

パラメータ

input

<Any>

戻り値

<Any>

補足

ソースがプロパティオブジェクト以外の場合は何もしない。

public fn SetTarget

ターゲットオブジェクトを設定する。

パラメータ

obj

<RolloutClass|RolloutControl|RCMenu|MenuItem>

戻り値

<RolloutClass|RolloutControl|RCMenu|MenuItem>

補足

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

public fn SetTargetEnabled

ターゲットオブジェクトが使用可能かどうかを設定する。

パラメータ

input

<BooleanClass>

戻り値

<BooleanClass>

補足

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

public fn SetTargetEventName

ターゲットオブジェクトのイベント名を設定する。

パラメータ

input

<Name|UndefinedClass>

戻り値

<Name|UndefinedClass>

補足

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

public fn SetTargetPropertyName

ターゲットオブジェクトのプロパティ名を設定する。

パラメータ

input

<Name|UndefinedClass>

戻り値

<Name|UndefinedClass>

補足

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

public fn SetTargetPropertyValue

ターゲットオブジェクトのプロパティ値を設定する。

パラメータ

input

<Any>

戻り値

<Any>

補足

ソースがプロパティオブジェクト以外の場合、および入力値とプロパティ値の型が異なる場合は何もしない。
ただしIntegerとFloatについてはNumberとして扱うので異なっていても可とする。

public fn SourceChanged

ソース更新の通知を受け取る。

パラメータ

type

<Name>

パラメータ

param

<Any>

戻り値

<OkClass>

public fn TargetChanged

ターゲット更新の通知を受け取る。

パラメータ

type

<Name>

パラメータ

param

<Any>

戻り値

<OkClass>

補足

通常param引数にはイベントデータが渡される。

private fn isTypeEqual

パラメータ

actual

<Any>

パラメータ

expected

<Any>

戻り値

<BooleanClass>

private fn isValidCommand

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidConverter

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidEvent

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidMenuItem

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidProperty

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidRCMenu

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidRollout

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidRolloutControl

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidTarget

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn subscribeSource

ソースオブジェクトを購読する。

戻り値

<OkClass>

private fn unsubscribeSource

ソースオブジェクトの購読を解除する。

戻り値

<OkClass>

private fn updateTargetEnabled

ターゲットオブジェクトが使用可能かどうかの状態を更新する。

戻り値

<OkClass>

private fn updateTargetPropertyValue

ターゲットオブジェクトのプロパティ値の状態を更新する。

戻り値

<OkClass>

public fn StructName

戻り値

<Name>

public fn Dump

パラメータ

indent:

<String>

パラメータ

out:

<FileStream|StringStream|WindowStream>

出力先。既定値はlistener。

戻り値

<OkClass>

public fn Equals

パラメータ

obj

<Any>

戻り値

<BooleanClass>

補足

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

public StateChanged

プロパティ

<Struct:ObservableStruct>