Class BaseViewModelMixin<TViewModel>

Namespace

Bannerlord.UIExtenderEx.ViewModels

Assembly

Bannerlord.UIExtenderEx.dll

Basic implementation for IViewModelMixin.
Generic parameter TViewModel will be used to determine which ViewModel to extend.
You can use the field ViewModel to access the original ViewModel.
Be aware that it might be null if GC has disposed the original ViewModel. The mixin holds a weak reference to it.

public abstract class BaseViewModelMixin<TViewModel> : IViewModelMixin where TViewModel : ViewModel

Type Parameters

TViewModel

ViewModel this mixin is extending.

Inheritance

object

BaseViewModelMixin<TViewModel>

Implements

IViewModelMixin

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

BaseViewModelMixin(TViewModel)

protected BaseViewModelMixin(TViewModel vm)

Parameters

vm TViewModel

Properties

ViewModel

The original ViewModel.
Be aware that it might be null if GC has disposed the original ViewModel. The mixin holds a weak reference to it.

protected TViewModel? ViewModel { get; }

Property Value

TViewModel

Methods

GetPrivate<TValue>(string)

Helper method to get non public value from attached view model instance.

protected TValue? GetPrivate<TValue>(string name)

Parameters

name string

name of the field

Returns

TValue

Type Parameters

TValue

type

OnFinalize()

Called when the original's OnFinalize() is called.
Defaults to an empty method.

public virtual void OnFinalize()

OnPropertyChanged(string?)

protected void OnPropertyChanged(string? propertyName = null)

Parameters

propertyName string

OnPropertyChangedWithValue(object, string?)

protected void OnPropertyChangedWithValue(object value, string? propertyName = null)

Parameters

value object

propertyName string

OnRefresh()

Called when the original ViewModel is refreshed. The method name is dynamic, you need to set RefreshMethodName for the method to be called.
Defaults to an empty method.

public virtual void OnRefresh()

SetField<T>(ref T, T, string)

protected bool SetField<T>(ref T field, T value, string propertyName)

Parameters

field T

value T

propertyName string

Returns

bool

Type Parameters

T

SetPrivate<TValue>(string, TValue?)

Helper method to set non public value of attached view model instance.

protected void SetPrivate<TValue>(string name, TValue? value)

Parameters

name string

name of the member to set

value TValue

new value

Type Parameters

TValue

member type