DataRepeater

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.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)

CurrentItem

DataRepeaterItem: Returns the current DataRepeaterItem in the DataRepeater control.

CurrentItemIndex

Int32: Returns or sets the index of the current DataRepeaterItem in a DataRepeater control.

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.

IsCurrentItemModified

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

ItemBorderStyle

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

ItemCount

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

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.

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.

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.

Throws:

• ReadOnlyException The AllowUserToAddItems property is set to False.

CancelEdit()

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

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.

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.

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
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.