UniView Class

UniView control is basic control to display data based on selected templates.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      System.Web.UI.WebControls.BaseDataBoundControl
        System.Web.UI.WebControls.DataBoundControl
          System.Web.UI.WebControls.CompositeDataBoundControl
            CMS.DocumentEngine.Web.UI.UniView
              CMS.DocumentEngine.Web.UI.BasicUniView

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 12.0.0

Syntax

public class UniView : CompositeDataBoundControl, IUniPageable

The UniView type exposes the following members.

Constructors

	Name	Description
Public method	UniView

Properties

	Name	Description
Public property	AlternatingItemTemplate	Alternating item template.
Public property	AlternatingRange	Item / AlternatingItem template changing interval
Public property	AlternatingStartPosition	Alternating start position.
Public property	DataSource	Gets or sets the object from which data-bound control retrieves its list of data item. (Overrides BaseDataBoundControl.DataSource.)
Public property	FirstItemTemplate	First item template.
Public property	FooterTemplate	Footer item template.
Public property	HeaderTemplate	Header item template.
Public property	HideHeaderAndFooterForSingleItem	Hide Outer data (header, footer) for single item.
Public property	HierarchicalDisplayMode	Gets or sets the display mode for hierarchical datasource.
Public property	ItemTemplate	Default item template.
Public property	LastItemTemplate	Last item template.
Public property	OuterData	Data generated in header and footer.
Public property	PagerDataItem	Gets or sets the IUniPageable.PagerDataItem value.
Public property	PagerForceNumberOfResults	Gets or sets the number of result. Enables proceed "fake" datasets, where number of results in the dataset is not correspondent to the real number of results This property must be equal -1 if should be disabled
Public property	RelationColumnID	Column from which specifies value of current level (for example parent document id).
Public property	SelectedItemColumnName	Gets or sets the column name which should be used for selected item comparison.
Public property	SelectedItemValue	Gets or sets the value which indicates selected item.
Public property	SeparatorTemplate	Separator item template.
Public property	SingleItemTemplate	Single item template.
Public property	Transformations	Gets or sets the transformation collection.
Public property	UniPagerControl	Pager control.
Public property	UseNearestItemForHeaderAndFooter	Gets or sets the value that indicates whether data from nearest data item should be used for header or footer item. This value is ignored if OuterData property is set.

Methods

	Name	Description
Protected method	CreateChildControls	Creates child controls. (Overrides CompositeDataBoundControl.CreateChildControls(IEnumerable, Boolean).)
Protected method	CreateHierarchicalItem	Creates new UniView item and initialize object with selected template.
Protected method	CreateItem	Creates new UniView item and initialize object with selected template.
Protected method	GenerateContent	Default method to the content generating.
Protected method	GenerateInnerHierarchicalContent	Inner hierarchical content generating.
Protected method	GenerateSeparateHierarchicalContent	Separate hierarchical content generating.
Protected method	GetDataItemValue	Returns value from specified data item object.
Protected method	GetItemsCount	Try to get items count from IEnumerable object.
Protected method	GetItemType	Returns item type based on current index and item count.
Protected method	GetTemplate	Returns default item template if selected template is empty.
Protected method	ObjectToDataRowView	Converts object (DataSet, DataTable, DataRow) to DataRowView.
Protected method	ProcessItem	Add UniView item to the controls collection and bind it.
Public method	ReBind	Evokes control databind.
Protected method	Render	Removes default webcontrol span tag. (Overrides WebControl.Render(HtmlTextWriter).)

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	CallHandled	Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false. (Defined by ControlsExtensions.)
Public Extension Method	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)

Events

	Name	Description
Public event	OnItemCreated	Occurs when an item is created in the UniView control.
Public event	OnItemDataBound	Occurs when the control bind UniView item.
Public event	OnPageBinding	Occurs when the control bind data.
Public event	OnPageChanged	Occurs when the pager change the page and current mode is postback => reload data