BasicUniView Class

Extended UniView control that automates data binding.

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
                CMS.DocumentEngine.Web.UI.CMSUniView
                CMS.DocumentEngine.Web.UI.QueryUniView

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

Syntax

public class BasicUniView : UniView, 
	IUniPageableContainer, IRelatedData

The BasicUniView type exposes the following members.

Constructors

	Name	Description
Public method	BasicUniView	Constructor.

Fields

	Name	Description
Protected field	mDataLoaded	Indicates whether data were loaded.
Protected field	mOnBeforeInitFired	True if the on before init was fired.
Protected field	mRelatedData	Custom data connected to the object.
Protected field	mRelatedDataLoaded	Related data is loaded.
Protected field	useDataSourceControl	Indicates whether the viewer should obtain data source from the referenced control provided by the value of DataSourceControl property.

Properties

	Name	Description
Public property	AlternatingItemTemplate	Alternating item template. (Inherited from UniView.)
Public property	AlternatingRange	Item / AlternatingItem template changing interval (Inherited from UniView.)
Public property	AlternatingStartPosition	Alternating start position. (Inherited from UniView.)
Public property	DataBindByDefault	Indicates whether data binding should be performed by default.
Public property	DataSource	Object from which data-bound control retrieves its list of data item. (Overrides UniView.DataSource.)
Public property	DataSourceControl	Control with data source.
Public property	DataSourceName	Gets or sets name of source.
Protected property	DefaultDataSource	Default data source to use if no external is provided.
Public property	FirstItemTemplate	First item template. (Inherited from UniView.)
Public property	FooterTemplate	Footer item template. (Inherited from UniView.)
Public property	HeaderTemplate	Header item template. (Inherited from UniView.)
Public property	HideControlForZeroRows	Hides the control when no data is loaded. Default value is False.
Public property	HideHeaderAndFooterForSingleItem	Hide Outer data (header, footer) for single item. (Inherited from UniView.)
Public property	HierarchicalDisplayMode	Gets or sets the display mode for hierarchical datasource. (Inherited from UniView.)
Public property	ItemTemplate	Default item template. (Inherited from UniView.)
Public property	LastItemTemplate	Last item template. (Inherited from UniView.)
Public property	OuterData	Data generated in header and footer. (Inherited from UniView.)
Public property	PageableControl	Gets or sets the encapsulated control that implements IUniPageable interface.
Public property	PagerDataItem	Gets or sets the IUniPageable.PagerDataItem value. (Inherited from UniView.)
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 (Inherited from UniView.)
Public property	RelatedData	Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl.
Public property	RelationColumnID	Column from which specifies value of current level (for example parent document id). (Inherited from UniView.)
Public property	ResolveDynamicControls	Gets or sets the value that indicates whether dynamic controls should be resolved
Public property	SelectedItemColumnName	Gets or sets the column name which should be used for selected item comparison. (Inherited from UniView.)
Public property	SelectedItemValue	Gets or sets the value which indicates selected item. (Inherited from UniView.)
Public property	SeparatorTemplate	Separator item template. (Inherited from UniView.)
Public property	SingleItemTemplate	Single item template. (Inherited from UniView.)
Public property	Transformations	Gets or sets the transformation collection. (Inherited from UniView.)
Public property	UniPagerControl	Pager control. (Inherited from UniView.)
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. (Inherited from UniView.)
Public property	ZeroRowsText	Text to be shown when the control is hidden by HideControlForZeroRows.

Methods

	Name	Description
Protected method	BoundPagerToDataSource	Bound pager to the external external DataSource
Protected method	CreateChildControls	Creates child controls. (Inherited from UniView.)
Protected method	CreateHierarchicalItem	Creates new UniView item and initialize object with selected template. (Inherited from UniView.)
Protected method	CreateItem	Creates new UniView item and initialize object with selected template. (Inherited from UniView.)
Protected method	GenerateContent	Default method to the content generating. (Inherited from UniView.)
Protected method	GenerateInnerHierarchicalContent	Inner hierarchical content generating. (Inherited from UniView.)
Protected method	GenerateSeparateHierarchicalContent	Separate hierarchical content generating. (Inherited from UniView.)
Protected method	GetDataItemValue	Returns value from specified data item object. (Inherited from UniView.)
Protected method	GetItemsCount	Try to get items count from IEnumerable object. (Inherited from UniView.)
Protected method	GetItemType	Returns item type based on current index and item count. (Inherited from UniView.)
Protected method	GetTemplate	Returns default item template if selected template is empty. (Inherited from UniView.)
Public method	HasData	Indicates if data source contains data.
Protected method	InitControl	Ensures default data binding
Protected method	ObjectToDataRowView	Converts object (DataSet, DataTable, DataRow) to DataRowView. (Inherited from UniView.)
Protected method	OnInit	Init event handler. (Overrides BaseDataBoundControl.OnInit(EventArgs).)
Protected method	OnLoad	OnLoad event handler (Overrides DataBoundControl.OnLoad(EventArgs).)
Protected method	ProcessItem	Add UniView item to the controls collection and bind it. (Inherited from UniView.)
Protected method	RaiseOnBeforeInit	Raises the OnBeforeInit event.
Public method	ReBind	Evokes control databind. (Inherited from UniView.)
Public method	ReloadData	Reloads the control data, skips the loading if the data is already loaded.
Protected method	Render	Render event handler, to maintain the proper control rendering. (Overrides UniView.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	OnBeforeInit	On before init handler.
Public event	OnItemCreated	Occurs when an item is created in the UniView control. (Inherited from UniView.)
Public event	OnItemDataBound	Occurs when the control bind UniView item. (Inherited from UniView.)
Public event	OnPageBinding	Occurs when the control bind data. (Inherited from UniView.)
Public event	OnPageChanged	Occurs when the pager change the page and current mode is postback => reload data (Inherited from UniView.)

Remarks

Temporary class, will be finished in future versions