ValueFromListBinder(TModel, TControl, TValue, TListModel) Class

ValueFromListBinderTModel, TControl, TValue, TListModel Class

The base class for binders that let the user choose a single value from a list of values. If the list implements IBindingList then changes to the list are copied into the control.

Inheritance Hierarchy

SystemObject
  VirtualRadar.WinForms.PortableBindingControlBinder
    VirtualRadar.WinForms.PortableBindingValueBinderTModel, TControl, TValue
      VirtualRadar.WinForms.PortableBindingValueFromListBinderTModel, TControl, TValue, TListModel
        VirtualRadar.WinForms.PortableBindingComboBoxBinderTModel, TListModel, TValue

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

Syntax

C++

Copy

public abstract class ValueFromListBinder<TModel, TControl, TValue, TListModel> : ValueBinder<TModel, TControl, TValue>
where TModel : class, INotifyPropertyChanged
where TControl : Control

Public MustInherit Class ValueFromListBinder(Of TModel As {Class, INotifyPropertyChanged}, TControl As Control, TValue, TListModel)
	Inherits ValueBinder(Of TModel, TControl, TValue)

generic<typename TModel, typename TControl, typename TValue, typename TListModel>
where TModel : ref class, INotifyPropertyChanged
where TControl : Control
public ref class ValueFromListBinder abstract : public ValueBinder<TModel, TControl, TValue>

[<AbstractClassAttribute>]
type ValueFromListBinder<'TModel, 'TControl, 'TValue, 'TListModel when 'TModel : not struct and INotifyPropertyChanged when 'TControl : Control> =  
    class
        inherit ValueBinder<'TModel, 'TControl, 'TValue>
    end

Type Parameters

TModel: The type of object that holds the value bound to a property on one object in the list of TListModel objects.
TControl: The type of control that renders the list and lets the user choose a single item.
TValue: The type of value to copy from the selected item to the control.
TListModel: The type of value held in the binding list.

The ValueFromListBinderTModel, TControl, TValue, TListModel type exposes the following members.

Constructors

	Name	Description
	ValueFromListBinderTModel, TControl, TValue, TListModel(TModel, TControl, IListTListModel, ExpressionFuncTModel, TValue, ActionTModel, TValue)	Creates a new object.
	ValueFromListBinderTModel, TControl, TValue, TListModel(TModel, TControl, IListTListModel, ExpressionFuncTModel, TValue, ActionTModel, TValue, FuncTControl, TValue, ActionTControl, TValue)	Creates a new object.

Top

Properties

	Name	Description
	Control	Gets the control. (Inherited from ValueBinderTModel, TControl, TValue.)
	ControlObject	Gets the control that has been bound to the model. (Inherited from ControlBinder.)
	ControlValue	Gets the control's value. (Inherited from ValueBinderTModel, TControl, TValue.)
	ControlValueObject	See base docs. (Inherited from ValueBinderTModel, TControl, TValue.)
	GetListItemDescription	Gets or sets a method that returns a list item's description. Cannot be set after initialisation.
	GetListItemValue	Gets or sets a method that returns the list item's value. Cannot be set after initialisation.
	Initialised	Gets a value indicating that the object has been initialised. (Inherited from ControlBinder.)
	ItemDescriptions	The list of descriptions that we're going to use for the list.
	List	Gets the list.
	Model	Gets the model. (Inherited from ValueBinderTModel, TControl, TValue.)
	ModelObject	Gets the model that has been bound to the control. (Inherited from ControlBinder.)
	ModelPropertyName	Gets or sets the name of the model's property to bind to. Only required if the ctor getModelValue parameter does more than just return a property. Cannot be set once the binder has been initialised. (Inherited from ValueBinderTModel, TControl, TValue.)
	ModelValue	Gets the model's value. (Inherited from ValueBinderTModel, TControl, TValue.)
	ModelValueObject	See base docs. (Inherited from ValueBinderTModel, TControl, TValue.)
	SortList	Gets or sets a value indicating that the list should be sorted.
	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
	ChangeModelObject	Changes the model object. (Inherited from ControlBinder.)
	CopyControlToModel	Refreshes the model's content with the content of the control. (Inherited from ControlBinder.)
	CopyListToControl	Copies the list to the control.
	CopyModelToControl	Refreshes the control's content with the content of the model. (Inherited from ControlBinder.)
	Dispose	See interface docs. (Inherited from ControlBinder.)
	Dispose(Boolean)	See base docs. (Overrides ControlBinderDispose(Boolean).)
	DoCopyControlToModel	See base docs. (Overrides ControlBinderDoCopyControlToModel.)
	DoCopyListToControl	Copies the item descriptions to the control.
	DoCopyModelToControl	See base docs. (Overrides ControlBinderDoCopyModelToControl.)
	DoGetSelectedListValue	Does the work of getting the selected item from the list.
	DoHookControl	Performs the actual work of hooking the control. Can be overridden. (Inherited from ControlBinder.)
	DoHookControlPropertyChanged	Overridden to hook the control event that is raised as soon as the user changes the control's value. (Inherited from ControlBinder.)
	DoHookModel	See base docs. (Inherited from ValueBinderTModel, TControl, TValue.)
	DoInitialiseControl	Does the work of initialising the control. By default this just calls CopyModelToControl. (Inherited from ControlBinder.)
	DoInitialising	See base docs. (Overrides ValueBinderTModel, TControl, TValueDoInitialising.)
	DoSetSelectedListValue	Does the work of setting the value for the selected item in the list.
	DoUnhookControl	Performs the actual work of unhooking the control. Can be overridden. (Inherited from ControlBinder.)
	DoUnhookControlPropertyChanged	Overridden to unhook the control event that is raised as soon as the user changes the control's value. (Inherited from ControlBinder.)
	DoUnhookModel	See base docs. (Inherited from ValueBinderTModel, TControl, TValue.)
	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.)
	GetSelectedListValue	Gets the value for the selected item from the list.
	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.)
	SetSelectedListValue	Sets the value for the selected item in the list.
	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
	_GetControlValue	Protected method that reads a control's current value. (Inherited from ValueBinderTModel, TControl, TValue.)
	_ListUpdatesLocked	True if copies between lists are locked.
	_SetControlValue	Protected method that writes a control's current value. (Inherited from ValueBinderTModel, TControl, TValue.)
	_UpdatesLocked	True if changes are not to be copied between the control and the model. (Inherited from ControlBinder.)

Top

Remarks

Changes in the bound property on the model change which item is shown as selected in the list. Changes to the list of models are reflected on the display. The value copied from the row to the model is assumed to be a value that uniquely identifies the row in the list.

Reference

VirtualRadar.WinForms.PortableBinding Namespace