MasterListToSubsetBinder(TSubsetModel, TMasterModel, TListModel, TIdentifier) Class

MasterListToSubsetBinderTSubsetModel, TMasterModel, TListModel, TIdentifier Class

A binder that binds between a master list and a subset of the master list's rows. Rows are distinguished by an identifier.

Inheritance Hierarchy

SystemObject
  VirtualRadar.WinForms.PortableBindingControlBinder
    VirtualRadar.WinForms.PortableBindingMasterListToListBinderTMasterModel, TListModel
      VirtualRadar.WinForms.PortableBindingMasterListToSubsetBinderTSubsetModel, TMasterModel, TListModel, TIdentifier

Namespace: VirtualRadar.WinForms.PortableBinding
Assembly: VirtualRadar.WinForms (in VirtualRadar.WinForms.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy

public class MasterListToSubsetBinder<TSubsetModel, TMasterModel, TListModel, TIdentifier> : MasterListToListBinder<TMasterModel, TListModel>
where TListModel : class

Public Class MasterListToSubsetBinder(Of TSubsetModel, TMasterModel, TListModel As Class, TIdentifier)
	Inherits MasterListToListBinder(Of TMasterModel, TListModel)

generic<typename TSubsetModel, typename TMasterModel, typename TListModel, typename TIdentifier>
where TListModel : ref class
public ref class MasterListToSubsetBinder : public MasterListToListBinder<TMasterModel, TListModel>

type MasterListToSubsetBinder<'TSubsetModel, 'TMasterModel, 'TListModel, 'TIdentifier when 'TListModel : not struct> =  
    class
        inherit MasterListToListBinder<'TMasterModel, 'TListModel>
    end

Type Parameters

TSubsetModel: The type of object that holds the subset list, the list of identifiers.
TMasterModel: The type of object that holds the master list.
TListModel: The type of object in the master list.
TIdentifier: The type of identifier.

The MasterListToSubsetBinderTSubsetModel, TMasterModel, TListModel, TIdentifier type exposes the following members.

Constructors

	Name	Description
	MasterListToSubsetBinderTSubsetModel, TMasterModel, TListModel, TIdentifier	Creates a new object.

Top

Properties

	Name	Description
	AddHandler	Gets or sets the method that handles the adding of new items. Can only be set before initialisation. (Inherited from MasterListToListBinderTModel, TListModel.)
	AutoAddEnabled	Gets or sets a value indicating that if AddHandler is null then an automatic add handler should be used. (Inherited from MasterListToListBinderTModel, TListModel.)
	AutoDeleteEnabled	Gets or sets a value indicating that if DeleteHandler is null then an automatic delete handler should be used. (Inherited from MasterListToListBinderTModel, TListModel.)
	CheckedChangedHandler	See base docs. Throws exception if you try to set it. (Overrides MasterListToListBinderTModel, TListModelCheckedChangedHandler.)
	Control	Gets the control that is showing the list. (Inherited from MasterListToListBinderTModel, TListModel.)
	ControlObject	Gets the control that has been bound to the model. (Inherited from ControlBinder.)
	ControlValueObject	See base docs. (Inherited from MasterListToListBinderTModel, TListModel.)
	DeleteHandler	Gets or sets the method that handles the removal of existing items. Can only be set before initialisation. (Inherited from MasterListToListBinderTModel, TListModel.)
	EditHandler	Gets or sets the method that handles the editing of an existing item. Can only be set before initialisation. (Inherited from MasterListToListBinderTModel, TListModel.)
	EnableSorting	Gets or sets a value indicating that the rows are to be sorted on display. Can only be set before initialisation. (Inherited from MasterListToListBinderTModel, TListModel.)
	FetchColumns	Gets or sets the method that handles the fetching of columns. Can only be set before initialisation. (Inherited from MasterListToListBinderTModel, TListModel.)
	GetListIdentifierAction	Gets or sets the action that retrieves the identifier from a row list item.
	GetSortValue	Gets or sets a delegate that returns a comparable value from the list model for a single column. (Inherited from MasterListToListBinderTModel, TListModel.)
	GetSubsetAction	Gets or sets the action that retrieves the subset list from the subset model.
	Initialised	Gets a value indicating that the object has been initialised. (Inherited from ControlBinder.)
	Model	Gets the model that owns the list. (Inherited from MasterListToListBinderTModel, TListModel.)
	ModelList	Gets the list held by the model. (Inherited from MasterListToListBinderTModel, TListModel.)
	ModelListBindingList	Gets the ModelList as an IBindingList. (Inherited from MasterListToListBinderTModel, TListModel.)
	ModelObject	Gets the model that has been bound to the control. (Inherited from ControlBinder.)
	ModelSubsetBindingList	Gets the list of subset identitifers as an IBindingList.
	ModelSubsetList	Gets the list of subset identifiers.
	ModelValueObject	See base docs. (Inherited from MasterListToListBinderTModel, TListModel.)
	SubsetModel	Gets or sets the object that holds the subset list of identifiers.
	UpdateMode	Gets or sets an indication of when values are copied from the control to the model. Cannot be modified once the binder has been initialised. (Inherited from ControlBinder.)

Top

Methods

	Name	Description
	AddListModel	Calls the add handler, returns the list model that it creates. (Inherited from MasterListToListBinderTModel, TListModel.)
	ChangeModelObject	Changes the model object. (Inherited from ControlBinder.)
	CopyControlToModel	Refreshes the model's content with the content of the control. (Inherited from ControlBinder.)
	CopyModelSubsetToControl	Sets the checkmarks on the control to mirror the checkmarks on the model list.
	CopyModelToControl	Refreshes the control's content with the content of the model. (Inherited from ControlBinder.)
	DeleteListModel	Calls the delete handler with the list model passed across. (Inherited from MasterListToListBinderTModel, TListModel.)
	Dispose	See interface docs. (Inherited from ControlBinder.)
	Dispose(Boolean)	See base class docs. (Overrides MasterListToListBinderTModel, TListModelDispose(Boolean).)
	DoCopyControlToModel	See base docs. (Inherited from MasterListToListBinderTModel, TListModel.)
	DoCopyModelToControl	See base docs. (Overrides MasterListToListBinderTModel, TListModelDoCopyModelToControl.)
	DoHookControl	Performs the actual work of hooking the control. Can be overridden. (Inherited from ControlBinder.)
	DoHookControlPropertyChanged	See base docs. (Inherited from MasterListToListBinderTModel, TListModel.)
	DoHookModel	Performs the actual work of hooking the model. Can be overridden. (Inherited from ControlBinder.)
	DoInitialiseControl	Does the work of initialising the control. By default this just calls CopyModelToControl. (Inherited from ControlBinder.)
	DoInitialising	See base docs. (Overrides MasterListToListBinderTModel, TListModelDoInitialising.)
	DoUnhookControl	Performs the actual work of unhooking the control. Can be overridden. (Inherited from ControlBinder.)
	DoUnhookControlPropertyChanged	See base docs. (Inherited from MasterListToListBinderTModel, TListModel.)
	DoUnhookModel	Performs the actual work of unhooking the model. Can be overridden. (Inherited from ControlBinder.)
	EditListModel	Calls the edit handler with the list model passed across. (Inherited from MasterListToListBinderTModel, TListModel.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Finalises the object. (Inherited from ControlBinder.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HookControl	Hooks the events on the control. (Inherited from ControlBinder.)
	HookModel	Hooks the events on the model. (Inherited from ControlBinder.)
	Initialise	Initialises the binder. Must be called before the binder will start working. (Inherited from ControlBinder.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UnhookControl	Unhooks the events on the control. (Inherited from ControlBinder.)
	UnhookModel	Unhooks the events on the model. (Inherited from ControlBinder.)

Top

Fields

	Name	Description
	_BaseFetchColumns	The base method to fetch columns. We chain onto this.
	_CheckedChangedHandler	Protected method that is handles changing the checked state for an item. (Inherited from MasterListToListBinderTModel, TListModel.)
	_FetchColumns	Protected method that fetches the content of the list, split into columns. (Inherited from MasterListToListBinderTModel, TListModel.)
	_UpdatesLocked	True if changes are not to be copied between the control and the model. (Inherited from ControlBinder.)

Top

Reference

VirtualRadar.WinForms.PortableBinding Namespace