SearchViewModelBase Class


SearchViewModelBase Class

The documentation is integral part of the weroSoft product documentation. This part is intended to be used by developers only.

Represents the base class of a view model that supports searching.

Inheritance Hierarchy

Namespace: WeroSoft.Triton.Desktop
Assembly: WeroSoft.Triton.Desktop.Library (in WeroSoft.Triton.Desktop.Library.dll) Version: 3.0 Pre-Release

Syntax

Copy

public abstract class SearchViewModelBase : CultureSupportingViewModel, 
	ISearchViewModelBase, IProgressSignalization

Remarks

When a search is started it verifies that the amount of data to load does not exceeds the defined limit. In this case the used is asked to confirm start searching. The class supports two types of client: IReconnectingClient and IQueryableClient, therefore the methods which have the client as arguments are defined virtually twice. The developer shall implement the methods corresponding to the required client.

The SearchViewModelBase type exposes the following members.

Constructors

	Name	Description
	SearchViewModelBase	Initializes an instance of the type SearchViewModelBase.

Top

Properties

	Name	Description
	IsModified	Gets or sets the flag indicating whether the object has been modified or not. (Inherited from ViewModelBase.)
	IsReadOnly	Gets or sets the flag indicating whether the object is read-only. (Inherited from ViewModelBase.)
	IsSearching	Gets whether the search is running or not.
	ItemsAmount	Gets the total number of items to be loaded.
	ModelCascadingCollectionChangedEventObjects	Gets a list of cascaded events for collection changed. (Inherited from ViewModelBase.)
	ModelCascadingEventObjects	Gets a list of cascaded event objects. (Inherited from ViewModelBase.)
	ProgressText	Gets or sets the progress information of the searching.
	SearchProvider	Gets or sets the search provider.
	SearchStatus	Gets the status of the search.
	UseDialogMessageArea	Gets or sets whether messages shall be shown in the message area of the dialog or of the workspace

Top

Methods

	Name	Description
	ApplySearchTimeDefinitionToQuery	Create a query for the named property corresponding to the search criterion.
	Cancel	Cancel the search.
	Clear	Clears the results of the search.
	Continue	Not supported.
	ConvertToQuery	Convert the search definition into a query.
	CultureChanged	Called if the culture has been changed. (Inherited from CultureSupportingViewModel.)
	Dispose	Disposes the object. (Inherited from CultureSupportingViewModel.)
	Dispose(Boolean)	Called during disposing the generator. (Overrides CultureSupportingViewModelDispose(Boolean).)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	FetchPage(ISearchDefinition, IReconnectingClient)	Fetch asynchronously one page of data using the query defined in the client context.
	FetchPage(ISearchDefinition, IQueryableClient)	Fetch asynchronously one page of data using the query defined in the client context.
	Finalize	Destructor of the class. (Overrides ObjectFinalize.)
	GetClient	Gets the client of the search.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetIQueryableClient	Gets the client of the search.
	GetItemsAmount(ISearchDefinition, IReconnectingClient)	Gets the number of items that will be returned by the search with the given definition.
	GetItemsAmount(ISearchDefinition, IQueryableClient)	Gets the number of items that will be returned by the search with the given definition.
	GetNumberOfLoadedItems	Gets the total number of items delivered by the search.
	GetPropertyValueT	Gets the value of a particular property. (Inherited from ViewModelBase.)
	GetResourceValueT	Gets the value of a particular property. (Inherited from CultureSupportingViewModel.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InitializeSearch	Initialize the search provider.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NotifyAllRegisteredProperties	Notify all registered properties in the property collection. (Inherited from CultureSupportingViewModel.)
	OnPropertyChanged	Raises the event PropertyChanged. (Inherited from NotifyPropertyChanged.)
	Pause	Not supported.
	SetPropertyValue	Sets the value of a particular property. (Inherited from ViewModelBase.)
	StartSearch	Starts a new search.
	StopSearch	Stops the current search.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	PropertyChanged	Raised on changing a property. (Inherited from NotifyPropertyChanged.)

Top

Fields

	Name	Description
	HasNoModifyingAttribute	Gets a collection for handling modification flags. (Inherited from ViewModelBase.)
	SearchName	The name of the search, shown left of th progress.
	ShowProgress	Defines whether the progress shall be shown or not.

Top

Extension Methods

	Name	Description
	Clone(CloneWorkingMode, IEnumerableType)	Overloaded. Clones an object by serialization. (Defined by RuntimeExtensions.)
	CloneT(CloneWorkingMode, IEnumerableType)	Overloaded. Clones an object by serialization. (Defined by RuntimeExtensions.)
	Convert	(Defined by DataConverterExtensions.)
	CreateTraceDataEntry(StringBuilder, SourceLevels, TraceableKind, String)	Overloaded. Creates a data entry into a string builder according to the giving parameters. (Defined by TraceExtensions.)
	CreateTraceDataEntry(SourceLevels, TraceableKind, String, String, Int32)	Overloaded. Creates a trace entry for a data element. (Defined by TraceExtensions.)
	CreateTraceDataEntry(StringBuilder, SourceLevels, TraceableKind, String, String, Int32)	Overloaded. Creates a trace entry into a string builder. (Defined by TraceExtensions.)
	DynamicCast	Dynamically casts a reference to another type. (Defined by TypeManagerHelper.)
	ExtractSystemParametersFromTrigger	Extracts the system parameters from a collection of trigger parameter and transform them to a dictionary using string keys and string values. (Defined by TriggerExtensions.)
	GetFieldValue(String)	Overloaded. Gets the data object held by a defined field of a particular type. (Defined by UnitTest.)
	GetFieldValueT(String)	Overloaded. Gets the data object held by a defined field of a particular type. (Defined by UnitTest.)
	GetPropertyValue(String)	Overloaded. Gets the data object held by a defined property of a particular type. (Defined by UnitTest.)
	GetPropertyValueT(String)	Overloaded. Gets the data object held by a defined property of a particular type. (Defined by UnitTest.)
	Inject(Type, Object)	Overloaded. Injects all fields or properties which are marked with the defined attribute type name. (Defined by DataInjection.)
	Inject(Type, Object, Boolean)	Overloaded. Injects all fields or properties which are marked with the defined attribute type name. (Defined by DataInjection.)
	InjectField	Injects a value to a property within a data object. (Defined by DataInjection.)
	InjectProperty(String, Object)	Overloaded. Injects a value to a property within a data object. (Defined by DataInjection.)
	InjectProperty(String, Type, Object)	Overloaded. Injects a value to a property within a data object. (Defined by DataInjection.)
	Invoke(String, Object)	Overloaded. Invokes a method on an object by reflection. (Defined by UnitTest.)
	InvokeTResult(String, Object)	Overloaded. Invokes a method on an object by reflection. (Defined by UnitTest.)
	SetFieldValue	Sets the data object on a defined field of a particular type. (Defined by UnitTest.)
	SetPropertyValue	Sets the data object on a defined property of a particular type. (Defined by UnitTest.)
	SetReadOnlyFieldValue	Sets the data object on a defined field of a particular type. (Defined by UnitTest.)
	TryInjectProperty	Tries to Inject a value to a property within a data object. (Defined by DataInjection.)

Top

Reference

WeroSoft.Triton.Desktop Namespace

Inheritance Hierarchy