ListBindingHelper

Wisej.Web.ListBindingHelper

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides functionality to discover a bindable list and the properties of the items contained in the list when they differ from the public properties of the object to which they bind.

C#

public class ListBindingHelper

VB.NET

Public Class ListBindingHelper

Methods

GetList(list)

Returns a list associated with the specified data source.

Parameter	Type	Description
list	Object	The data source to examine for its underlying list.

Returns: Object. An Object representing the underlying list if it exists; otherwise, the original data source specified by list .

GetList(dataSource, dataMember)

Returns an object, typically a list, from the evaluation of a specified data source and optional data member.

Parameter	Type	Description
dataSource	Object	The data source from which to find the list.
dataMember	String	The name of the data source property that contains the list. This can be null.

Returns: Object. An Object representing the underlying list if it was found; otherwise, dataSource .

Throws:

• ArgumentException The specified data member name did not match any of the properties found for the data source.

GetListItemProperties(list)

Returns the PropertyDescriptorCollection that describes the properties of an item type contained in a specified data source, or properties of the specified data source.

Parameter	Type	Description
list	Object	The data source to examine for property information.

Returns: PropertyDescriptorCollection. The PropertyDescriptorCollection containing the properties of the items contained in list , or properties of list..

GetListItemProperties(list, listAccessors)

Returns the PropertyDescriptorCollection that describes the properties of an item type contained in a collection property of a data source. Uses the specified PropertyDescriptor array to indicate which properties to examine.

Parameter	Type	Description
list	Object	The data source to be examined for property information.
listAccessors	PropertyDescriptor[]	The PropertyDescriptor array describing which properties of the data source to examine. This can be null.

Returns: PropertyDescriptorCollection. The PropertyDescriptorCollection describing the properties of the item type contained in a collection property of the data source.

GetListItemProperties(dataSource, dataMember, listAccessors)

Returns the PropertyDescriptorCollection that describes the properties of an item type contained in the specified data member of a data source. Uses the specified PropertyDescriptor array to indicate which properties to examine.

Parameter	Type	Description
dataSource	Object	The data source to be examined for property information.
dataMember	String	The optional data member to be examined for property information. This can be null.
listAccessors	PropertyDescriptor[]	The PropertyDescriptor array describing which properties of the data member to examine. This can be null.

Returns: PropertyDescriptorCollection. The PropertyDescriptorCollection describing the properties of an item type contained in a collection property of the specified data source.

Throws:

• ArgumentException The specified data member could not be found in the specified data source.

GetListItemType(list)

Returns the data type of the items in the specified list.

Parameter	Type	Description
list	Object	The list to be examined for type information.

Returns: Type. The Type of the items contained in the list.

GetListItemType(dataSource, dataMember)

Returns the data type of the items in the specified data source.

Parameter	Type	Description
dataSource	Object	The data source to examine for items.
dataMember	String	The optional name of the property on the data source that is to be used as the data member. This can be null.

Returns: Type. For complex data binding, the Type of the items represented by the dataMember in the data source; otherwise, the Type of the item in the list itself.

GetListName(list, listAccessors)

Returns the name of an underlying list, given a data source and optional PropertyDescriptor array.

Parameter	Type	Description
list	Object	The data source to examine for the list name.
listAccessors	PropertyDescriptor[]	An array of PropertyDescriptor objects to find in the data source. This can be null.

Returns: String. The name of the list in the data source, as described by listAccessors , or the name of the data source type.