DataRepeater

Wisej.Web.DataRepeater

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

• Control

  • ScrollableControl

    • ContainerControl

      • DataRepeater

Displays data in a customizable list format.

C#

public class DataRepeater : ContainerControl, ISupportInitialize

VB.NET

Public Class DataRepeater
    Inherits ContainerControl
    Implements ISupportInitialize

Constructors

DataRepeater()

Initializes a new instance of the DataRepeater class.

Properties

AllowUserToAddItems

Boolean: Returns or sets whether users can add a new row to the DataRepeater at run time. (Default: True)

AllowUserToDeleteItems

Boolean: Returns or sets whether users can delete a row from the DataRepeater at run time. (Default: True)

BorderStyle

BorderStyle: Returns or sets the border style for the DataRepeater control. (Default: Solid)

ClientArea

Rectangle: Returns the client rectangle to use in the designer.

CurrentItem

DataRepeaterItem: Returns the current DataRepeaterItem in the DataRepeater control. (Default: null)

CurrentItemIndex

Int32: Returns or sets the index of the current DataRepeaterItem in a DataRepeater control. (Default: -1)

DataMember

String: Return or sets the name of the list or table in the data source for which the DataRepeater is displaying data. (Default: "")

DataSource

Object: Returns or sets the data source for which the DataRepeater is displaying data. (Default: null)

DisplayedItems

DataRepeaterItem[]: Returns the list of DataRepeaterItem items currently displayed on the client.

FirstDisplayedItemIndex

Int32: Return the index of the first currently displayed DataRepeaterItem in a DataRepeater control. (Default: 0)

IsCurrentItemModified

Boolean: Return whether the data for a DataRepeaterItem in the DataRepeater control has been changed by a user. (Default: False)

ItemBorderStyle

BorderStyle: Returns or sets the border style for the items in a DataRepeater control.

Default value is BorderStyle.Solid

ItemCount

Int32: Returns or sets the number of DataRepeaterItem items that are in the DataRepeater control. (Default: 0)

ItemHeaderSize

Int32: Return sets the size of the item header in a DataRepeater control.

ItemHeaderVisible

Boolean: Returns or sets whether item headers are displayed in a DataRepeater control.

The default value is true.

ItemSelectedBackColor

Color: Returns or sets the background color for the DataRepeaterItem panel when it's the CurrentItem.

ItemSize

Size: Returns or sets the size of the DataRepeaterItem child panels.

ItemTemplate

DataRepeaterItem: Returns the template that represents the DataRepeaterItem for the DataRepeater control.

The default value is a Wisej.Web.DataRepeaterItem with BorderStyle: None

LayoutStyle

DataRepeaterLayoutStyles: Return or sets whether the DataRepeater control will be displayed with a vertical or horizontal orientation. (Default: Vertical)

PrefetchItems

Int32: Returns or sets the number of items to prefetch outside of the visible area. The default is 0 (disabled). (Default: 0)

RightToLeftLayout

Boolean: Enables or disables right-to-left layout when the value of RightToLeft is Yes (Default: False)

ScrollBarVisible

Boolean: Returns or sets whether the scrollbar is visible. When the scrollbar is hidden, the user can still scroll using touch events, the keyboard, or the wheel. (Default: True)

VirtualMode

Boolean: Returns or sets a value that indicates whether you have provided your own data-management operations for the DataRepeater control. (Default: False)

Methods

AddNew()

Adds a new DataRepeaterItem to the DataRepeater control.

CancelEdit()

Allows users to cancel an edit to the current child control in the current DataRepeaterItem.

FocusActiveControl()

Selects the active control. If the active control is not focusable, it selects the next focusable control.

OnAllowUserToAddItemsChanged(e)

Fires the AllowUserToAddItemsChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnAllowUserToDeleteItemsChanged(e)

Fires the AllowUserToDeleteItemsChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnBindingContextChanged(e)

Fires the BindingContextChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnCreateControl()

OnCurrentItemIndexChanged(e)

Fires the CurrentItemIndexChanged event.

Parameter	Type	Description
e	EventArgs	An EventArgs object that contains the event data.

OnDataError(e)

Fires the DataError event.

Parameter	Type	Description
e	DataRepeaterDataErrorEventArgs	An instance of DataRepeaterDataErrorEventArgs that contains the event data.

OnDataMemberChanged(e)

Fires the DataMemberChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnDataSourceChanged(e)

Fires the DataSourceChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnItemCloned(e)

Fires the ItemCloned event.

Parameter	Type	Description
e	DataRepeaterItemEventArgs	An DataRepeaterItemEventArgs object that contains the event data.

OnItemCloning(e)

Fires the ItemCloning event.

Parameter	Type	Description
e	DataRepeaterItemCloneEventArgs	An DataRepeaterItemCloneEventArgs object that contains the event data.

OnItemsAdded(e)

Fires the ItemsAdded event.

Parameter	Type	Description
e	DataRepeaterAddRemoveItemsEventArgs	An DataRepeaterAddRemoveItemsEventArgs object that contains the event data.

OnItemSelected(e)

Fires the ItemSelected event.

Parameter	Type	Description
e	DataRepeaterItemEventArgs	An DataRepeaterItemEventArgs object that contains the event data.

OnItemsRemoved(e)

Fires the ItemsRemoved event.

Parameter	Type	Description
e	DataRepeaterAddRemoveItemsEventArgs	An DataRepeaterAddRemoveItemsEventArgs object that contains the event data.

OnItemUpdate(e)

Fires the ItemUpdate event.

Parameter	Type	Description
e	DataRepeaterItemEventArgs	An DataRepeaterItemEventArgs object that contains the event data.

OnItemValueNeeded(e)

Fires the ItemValueNeeded event.

Parameter	Type	Description
e	DataRepeaterItemValueEventArgs	An DataRepeaterItemValueEventArgs object that contains the event data.

OnItemValuePushed(e)

Fires the ItemValueNeeded event.

Parameter	Type	Description
e	DataRepeaterItemValueEventArgs	An DataRepeaterItemValueEventArgs object that contains the event data.

OnLayoutStyleChanged(e)

Fires the LayoutStyleChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnNewItemNeeded(e)

Fires the NewItemNeeded event.

Parameter	Type	Description
e	EventArgs	An EventArgs object that contains the event data.

OnUserAddedItems(e)

Fires the UserAddedItems event.

Parameter	Type	Description
e	DataRepeaterAddRemoveItemsEventArgs	An DataRepeaterAddRemoveItemsEventArgs object that contains the event data.

OnUserDeletedItems(e)

Fires the UserDeletedItems event.

Parameter	Type	Description
e	DataRepeaterAddRemoveItemsEventArgs	An DataRepeaterAddRemoveItemsEventArgs object that contains the event data.

OnUserDeletingItems(e)

Fires the UserDeletingItems event.

Parameter	Type	Description
e	DataRepeaterAddRemoveItemsCancelEventArgs	An DataRepeaterAddRemoveItemsCancelEventArgs object that contains the event data.

OnValidating(e)

Fires the Validating event.

Parameter	Type	Description
e	CancelEventArgs	A CancelEventArgs that contains the event data.

OnVirtualModeChanged(e)

Fires the VirtualModeChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnWebEvent(e)

Processes the event from the client.

Parameter	Type	Description
e	WisejEventArgs	Event arguments.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

OnWebUpdate(state)

Updates the client component using the state information.

Parameter	Type	Description
state	Object	Dynamic state object.

Refresh()

Forces a full reload of the data displayed by this DataRepeater.

Refresh(refreshChildren)

Forces a full reload of the data displayed by this DataRepeater.

Parameter	Type	Description
refreshChildren	Boolean	True to also refresh all the children of this control.

RemoveAt(index)

Removes a DataRepeaterItem at the specified position from a DataRepeater control.

Parameter	Type	Description
index	Int32	The index of the DataRepeaterItem.

Throws:

• ArgumentOutOfRangeException The value specified for index is less than 0 or greater than ItemCount - 1.

RenderScrollableProperties(config)

Parameter	Type	Description
config	Object

ResetItemBorderStyle()

Resets the value of ItemBorderStyle to the original value.

ResetItemHeaderSize()

Resets the value of ItemHeaderSize to the original value.

ResetItemHeaderVisible()

Resets the value of ItemHeaderVisible to the original value.

ScrollItemIntoView(index)

Scrolls the specified DataRepeaterItem into view.

Parameter	Type	Description
index	Int32	The index of the DataRepeaterItem.

Throws:

• ArgumentOutOfRangeException The value specified for index is less than 0 or greater than ItemCount - 1.

ScrollItemIntoView(index, alignWithTop)

Scrolls a specified DataRepeaterItem into view, optionally aligning it with the top of the control.

Parameter	Type	Description
index	Int32	The index of the DataRepeaterItem.
alignWithTop	Boolean	true to align the top of the DataRepeaterItem with the top of the control; otherwise, false.

Throws:

• ArgumentOutOfRangeException The value specified for index is less than 0 or greater than ItemCount - 1.

SetBoundsCore(x, y, width, height, specified)

Parameter	Type	Description
x	Int32
y	Int32
width	Int32
height	Int32
specified	BoundsSpecified

Events

AllowUserToAddItemsChanged

EventHandler Fired when the AllowUserToAddItems property changes.

AllowUserToDeleteItemsChanged

EventHandler Fired when the AllowUserToDeleteItems property changes.

CurrentItemIndexChanged

EventHandler Fired when the property CurrentItemIndex changes.

DataError

DataRepeaterDataErrorEventHandler Fired when an external data-parsing or validation operation throws an exception, or when an attempt to commit data to a data source fails.

DataMemberChanged

EventHandler Fired when the DataMember property changes.

DataSourceChanged

EventHandler Fired when the DataSource property changes.

ItemCloned

DataRepeaterItemEventHandler Fired after the DataRepeaterItem and its controls are cloned from the ItemTemplate.

ItemCloning

DataRepeaterItemCloneEventHandler Fired before the DataRepeaterItem and its controls are cloned from the ItemTemplate.

ItemsAdded

DataRepeaterAddRemoveItemsEventHandler Fired when a new DataRepeaterItem is added to the DataRepeater control.

ItemSelected

DataRepeaterItemEventHandler Fired after the DataRepeaterItem becomes the current item.

ItemsRemoved

DataRepeaterAddRemoveItemsEventHandler Fired when a DataRepeaterItem is deleted from the DataRepeater control.

ItemUpdate

DataRepeaterItemEventHandler Fired when an instance of DataRepeaterItem is updated.

ItemValueNeeded

DataRepeaterItemValueEventHandler Fired when the VirtualMode property is set to true and a new value for a child control of a DataRepeaterItem is needed.

ItemValuePushed

DataRepeaterItemValueEventHandler Fired when the VirtualMode property is set to true and the value of a child control in the DataRepeaterItem changes.

LayoutStyleChanged

EventHandler Fired when the LayoutStyle property changes.

NewItemNeeded

EventHandler Fired when the VirtualMode property is set to true and the user creates a new DataRepeaterItem.

UserAddedItems

DataRepeaterAddRemoveItemsEventHandler Fired when the user adds a new DataRepeaterItem.

UserDeletedItems

DataRepeaterAddRemoveItemsEventHandler Fired after the user deletes a DataRepeaterItem.

UserDeletingItems

DataRepeaterAddRemoveItemsCancelEventHandler Fired when the user deletes a DataRepeaterItem.

VirtualModeChanged

EventHandler Fired when the VirtualMode property changes.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IBindableComponent	Bindable components implement this interface.
IContainerControl	Provides the functionality for a control to act as a parent for other controls.
IDropTarget	Controls that support drag & drop operations implement this interface.
IWisejComponent	All wisej components implement this interface.
IWisejControl	All wisej controls derived from the Control class must implement this interface.
IWisejSerializable	Allows an object to serialize itself.