Class ViewModelSummary<TEntity>

Inheritance
System.Object
ObservableClass
ViewModel
ViewModelSummary<TEntity>
Implements
INotifyPropertyChanged
IDisposable
IDataErrorInfo
INotifyDataErrorInfo
Inherited Members
Namespace: ISynergy.Framework.Mvvm.ViewModels
Assembly: ISynergy.Framework.Mvvm.dll
Syntax
public abstract class ViewModelSummary<TEntity> : ViewModel, IViewModelSummary<TEntity>, IViewModelSelectedItem<TEntity>, IViewModel, IObservableClass, IBindable, ICleanup
Type Parameters
Name Description
TEntity

Constructors

View Source

ViewModelSummary(IContext, IBaseCommonServices, ILogger, Boolean, Boolean)

Initializes a new instance of the ViewModelSummary<TEntity> class.

Declaration
protected ViewModelSummary(IContext context, IBaseCommonServices commonServices, ILogger logger, bool refreshOnInitialization = true, bool automaticValidation = false)
Parameters
Type Name Description
IContext context

The context.
IBaseCommonServices commonServices

The common services.
ILogger logger

The logger factory.
System.Boolean refreshOnInitialization

if set to true [refresh on initialization].
System.Boolean automaticValidation

Properties

View Source

AddCommand

Gets or sets the add command.

Declaration
public AsyncRelayCommand AddCommand { get; }
Property Value
Type Description
AsyncRelayCommand

The add command.
View Source

DeleteCommand

Gets or sets the delete command.

Declaration
public AsyncRelayCommand<TEntity> DeleteCommand { get; }
Property Value
Type Description
AsyncRelayCommand<TEntity>

The delete command.
View Source

EditCommand

Gets or sets the edit command.

Declaration
public AsyncRelayCommand<TEntity> EditCommand { get; }
Property Value
Type Description
AsyncRelayCommand<TEntity>

The edit command.
View Source

IsUpdate

Gets or sets the IsUpdate property value.

Declaration
public bool IsUpdate { get; set; }
Property Value
Type Description
System.Boolean

true if this instance is an update; otherwise (new), false.
View Source

Items

Gets or sets the Items property value.

Declaration
public ObservableCollection<TEntity> Items { get; set; }
Property Value
Type Description
ObservableCollection<TEntity>

The items.
View Source

RefreshCommand

Gets or sets the refresh command.

Declaration
public AsyncRelayCommand RefreshCommand { get; }
Property Value
Type Description
AsyncRelayCommand

The refresh command.
View Source

RefreshOnInitialization

Gets a value indicating whether [refresh on initialization].

Declaration
public bool RefreshOnInitialization { get; }
Property Value
Type Description
System.Boolean

true if [refresh on initialization]; otherwise, false.
View Source

SearchCommand

Gets or sets the search command.

Declaration
public AsyncRelayCommand<object> SearchCommand { get; }
Property Value
Type Description
AsyncRelayCommand<System.Object>

The search command.
View Source

SelectedItem

Gets or sets the SelectedItem property value.

Declaration
public TEntity SelectedItem { get; set; }
Property Value
Type Description
TEntity

The selected item.
View Source

SubmitCommand

Gets or sets the submit command.

Declaration
public AsyncRelayCommand<TEntity> SubmitCommand { get; }
Property Value
Type Description
AsyncRelayCommand<TEntity>

The submit command.

Methods

View Source

AddAsync()

Adds the asynchronous.

Declaration
public abstract Task AddAsync()
Returns
Type Description
Task

Task.
View Source

ApplyQueryAttributes(IDictionary<String, Object>)

Declaration
public virtual void ApplyQueryAttributes(IDictionary<string, object> query)
Parameters
Type Name Description
IDictionary<System.String, System.Object> query
View Source

Cleanup()

Declaration
public override void Cleanup()
Overrides
ViewModel.Cleanup()
View Source

DeleteAsync(TEntity)

delete as an asynchronous operation.

Declaration
public async Task DeleteAsync(TEntity e)
Parameters
Type Name Description
TEntity e

The e.
Returns
Type Description
Task
View Source

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing
Overrides
ViewModel.Dispose(Boolean)
View Source

EditAsync(TEntity)

Edits the asynchronous.

Declaration
public abstract Task EditAsync(TEntity e)
Parameters
Type Name Description
TEntity e

The e.
Returns
Type Description
Task

Task.
View Source

GetItemsAsync()

get items as an asynchronous operation.

Declaration
public async Task<bool> GetItemsAsync()
Returns
Type Description
Task<System.Boolean>

true if XXXX, false otherwise.
View Source

InitializeAsync()

initialize as an asynchronous operation.

Declaration
public override async Task InitializeAsync()
Returns
Type Description
Task

Task.
Overrides
ViewModel.InitializeAsync()
View Source

OnSubmitted(SubmitEventArgs<TEntity>)

Called when [submitted].

Declaration
protected virtual void OnSubmitted(SubmitEventArgs<TEntity> e)
Parameters
Type Name Description
SubmitEventArgs<TEntity> e

The e.
View Source

RefreshAsync()

Refreshes the asynchronous.

Declaration
public virtual Task<bool> RefreshAsync()
Returns
Type Description
Task<System.Boolean>

Task<System.Boolean>.
View Source

RemoveAsync(TEntity)

Removes the asynchronous.

Declaration
public abstract Task RemoveAsync(TEntity e)
Parameters
Type Name Description
TEntity e

The e.
Returns
Type Description
Task

Task.
View Source

RetrieveItemsAsync(CancellationToken)

Retrieves the items asynchronous.

Declaration
public abstract Task<List<TEntity>> RetrieveItemsAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken

The cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Type Description
Task<List<TEntity>>

Task<List<TEntity>>.
View Source

SearchAsync(Object)

Searches the asynchronous.

Declaration
public abstract Task SearchAsync(object e)
Parameters
Type Name Description
System.Object e

The e.
Returns
Type Description
Task

Task.
View Source

SetSelectedItemAsync(TEntity)

Sets the selected item.

Declaration
public virtual Task SetSelectedItemAsync(TEntity e)
Parameters
Type Name Description
TEntity e

The e.
Returns
Type Description
Task
View Source

SubmitAsync(TEntity, Boolean)

Submits the asynchronous.

Declaration
public virtual Task SubmitAsync(TEntity e, bool validateUnderlayingProperties = true)
Parameters
Type Name Description
TEntity e

The e.
System.Boolean validateUnderlayingProperties
Returns
Type Description
Task

Task.

Events

View Source

Submitted

Occurs when [submitted].

Declaration
public event EventHandler<SubmitEventArgs<TEntity>> Submitted
Event Type
Type Description
EventHandler<SubmitEventArgs<TEntity>>

Implements

IViewModelSummary<TEntity>
IViewModelSelectedItem<TEntity>
IViewModel
IObservableClass
IBindable
INotifyPropertyChanged
IDisposable
IDataErrorInfo
INotifyDataErrorInfo
ICleanup

Extension Methods

Matrix.Replace<T>(T, Object, Object)
Matrix.IsEqual(Object, Object, Decimal, Decimal)
EntityBaseExtensions.HasProperty(Object, String)
ArrayExtensions.Concatenate<T>(T, T[])
CollectionExtensions.FromHierarchy<TSource>(TSource, Func<TSource, TSource>, Func<TSource, Boolean>)
CollectionExtensions.FromHierarchy<TSource>(TSource, Func<TSource, TSource>)
ObjectExtensions.Clone<T>(T)
ObjectExtensions.To<T>(Object)
ObjectExtensions.To(Object, Type)
ObjectExtensions.HasMethod(Object, String)
ObjectExtensions.AddressOf<T>(T)
ReflectionExtensions.GetIdentityValue<T>(T)
ReflectionExtensions.GetIdentityValue<T, TResult>(T)
ReflectionExtensions.GetIdentityProperty<T>(T)
ReflectionExtensions.HasIdentityProperty<T>(T)
ReflectionExtensions.GetPropertyValue<T, TResult>(T, String, TResult)
ReflectionExtensions.GetPropertyInfo<T, TValue>(T, Expression<Func<T, TValue>>)
ReflectionExtensions.GetTitleValue<T>(T)
ReflectionExtensions.HasParentIdentityProperty<T>(T)
ReflectionExtensions.GetParentIdentityProperty<T>(T)
ReflectionExtensions.IsFreeApplication<T>(T)