CMSUniView Class

UniView control that can be bounded to the CMS content.

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.Controls.UniView
              CMS.Controls.BasicUniView
                CMS.Controls.CMSUniView

Namespace: CMS.Controls
Assembly: CMS.Controls (in CMS.Controls.dll) Version: 9.0.0

Syntax

public class CMSUniView : BasicUniView, ICMSDataProperties, 
	ICMSControlProperties, ICMSBaseProperties

The CMSUniView type exposes the following members.

Constructors

	Name	Description
Public method	CMSUniView()	Constructor.
Public method	CMSUniView(TreeProvider)	Constructor.

Fields

	Name	Description
Protected field	mDataLoaded	Indicates whether data were loaded. (Inherited from BasicUniView.)
Protected field	mDataSource	Document data source.
Protected field	mFilterControl	Filter control.
Protected field	mFilterName	Filter name.
Protected field	mFooterItem	Footer item code.
Protected field	mHeaderItem	Header item code.
Protected field	mItemSeparator	Item separator code.
Protected field	mOnBeforeInitFired	True if the on before init was fired. (Inherited from BasicUniView.)
Protected field	mRelatedData	Custom data connected to the object. (Inherited from BasicUniView.)
Protected field	mRelatedDataLoaded	Related data is loaded. (Inherited from BasicUniView.)
Protected field	mUniPager	Current uni pager.
Protected field	useDataSourceControl	Indicates whether the viewer should obtain data source from the referenced control provided by the value of DataSourceControl property. (Inherited from BasicUniView.)

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	AlternatingTransformationName	Transformation name in format application.class.transformation applied to alternating items.
Public property	CacheDependencies	Cache dependencies, each cache dependency on a new line.
Public property	CacheItemName	Name of the cache item the control will use.
Public property	CacheMinutes	Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
Public property	CategoryName	Property to set and get the category name for filtering documents.
Public property	ClassNames	Property to set and get the classnames list (separated by the semicolon).
Public property	Columns	Gets or sets the columns to be retrieved from database.
Public property	CombineWithDefaultCulture	Property to set and get the CombineWithDefaultCulture flag.
Public property	ControlContext	Control context.
Public property	CultureCode	Property to set and get the CultureCode.
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. (Inherited from BasicUniView.)
Public property	DataSourceControl	Control with data source. (Inherited from BasicUniView.)
Public property	DataSourceName	Gets or sets name of source. (Inherited from BasicUniView.)
Protected property	DefaultDataSource	Default data source to use if no external is provided (Overrides BasicUniView.DefaultDataSource.)
Public property	DelayedLoading	Indicates whether the data should be loaded to the load event instead of default init event.
Public property	EnablePaging	Gets or sets the value that indicates whether paging is enabled.
Public property	FilterControl	Filter control.
Public property	FilterName	Gets or Set filter name.
Public property	FilterOutDuplicates	Indicates if the duplicated (linked) items should be filtered out from the data.
Public property	FirstItemTemplate	First item template. (Inherited from UniView.)
Public property	FirstTransformationName	Transformation name in format application.class.transformation applied to footer item.
Public property	FooterTemplate	Footer item template. (Inherited from UniView.)
Public property	FooterTransformationName	Transformation name in format application.class.transformation applied to footer item.
Public property	HeaderTemplate	Header item template. (Inherited from UniView.)
Public property	HeaderTransformationName	Transformation name in format application.class.transformation applied to header item.
Public property	HideControlForZeroRows	Hides the control when no data is loaded. Default value is False. (Inherited from BasicUniView.)
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	HierarchicalTransformationName	Transformation name for hierarchical transformation collection in format application.class.transformation.
Public property	CheckPermissions	Allows you to specify whether to check permissions of the current user. If the value is 'false' (default value) no permissions are checked. Otherwise, only nodes for which the user has read permission are displayed.
Public property	IsSelected	Gets a value indicating whether the current item is a selected item.
Public property	ItemSeparatorValue	Item separator between displayed records.
Public property	ItemTemplate	Default item template. (Inherited from UniView.)
Public property	LastItemTemplate	Last item template. (Inherited from UniView.)
Public property	LastTransformationName	Transformation name in format application.class.transformation applied to last item.
Public property	LoadHierarchicalData	Gets or sets the value that indicates whether data should be binded in default format or changed to hierarchical grouped dataset
Public property	LoadPagesIndividually	If true, each page is loaded individually in case of paging.
Public property	MaxRelativeLevel	Property to set and get the MaxRelativeLevel.
Public property	NestedControlsID	Nested controls ID, use ';' like separator.
Public property	OrderBy	Property to set and get the OrderBy.
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. (Inherited from BasicUniView.)
Public property	PagerControl	Gets the current unipager instance.
Public property	PagerCurrentPageTemplate	Current page template.
Public property	PagerDataItem	Gets or sets the IUniPageable.PagerDataItem value. (Inherited from UniView.)
Public property	PagerDirectPageTemplate	Direct page control template.
Public property	PagerFirstPageTemplate	First page template.
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	PagerLastPageTemplate	Last page template.
Public property	PagerLayoutTemplate	Layout template.
Public property	PagerNextGroupTemplate	Next group template.
Public property	PagerNextPageTemplate	Next page template.
Public property	PagerPageNumbersSeparatorTemplate	Page numbers separator template.
Public property	PagerPageNumbersTemplate	Page numbers template.
Public property	PagerPosition	Pager position.
Public property	PagerPreviousGroupTemplate	Previous group template.
Public property	PagerPreviousPageTemplate	Previous page template.
Public property	PageSize	Number of items per page.
Public property	ParentControl	Parent control.
Public property	Path	Property to set and get the Path.
Public property	RelatedData	Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl. (Inherited from BasicUniView.)
Public property	RelatedNodeIsOnTheLeftSide	If true, the returned nodes are on the right side of the relationship.
Public property	RelationColumnID	Column from which specifies value of current level (for example parent document id). (Inherited from UniView.)
Public property	RelationshipName	Name of the relationship.
Public property	RelationshipWithNodeGuid	Select nodes with given relationship with given node.
Public property	ResetScrollPositionOnPostBack	Gets or sets the value that indicates whether scroll position should be cleared after post back paging
Public property	ResolveDynamicControls	Gets or sets the value that indicates whether dynamic controls should be resolved (Inherited from BasicUniView.)
Public property	SelectedColumns	Gets or sets the columns to be retrieved from database.
Public property	SelectedFootertemTransformationName	Transformation name for selected footeritem in format application.class.transformation.
Public property	SelectedHeaderItemTransformationName	Transformation name for selected header item in format application.class.transformation.
Public property	SelectedItemColumnName	Gets or sets the column name which should be used for selected item comparison. (Inherited from UniView.)
Public property	SelectedItemTransformationName	Transformation name for selected item in format application.class.transformation.
Public property	SelectedItemValue	Gets or sets the value which indicates selected item. (Inherited from UniView.)
Public property	SelectOnlyPublished	Property to set and get the SelectOnlyPublished flag.
Public property	SelectTopN	Top N rows to select.
Public property	SeparatorTemplate	Separator item template. (Inherited from UniView.)
Public property	SeparatorTransformationName	Transformation name in format application.class.transformation applied to footer item.
Public property	ShowDeleteButton	Show Delete button.
Public property	ShowEditButton	Show Edit and Delete buttons.
Public property	ShowEditDeleteButtons	Show Edit and Delete buttons.
Public property	SingleItemTemplate	Single item template. (Inherited from UniView.)
Public property	SingleTransformationName	Transformation name in format application.class.transformation applied to single item.
Public property	SiteName	Property to set and get the SiteName.
Public property	StopProcessing	Stop processing
Public property	TopN	Select top N rows.
Public property	TransformationName	Transformation name in format application.class.transformation.
Public property	Transformations	Gets or sets the transformation collection. (Inherited from UniView.)
Public property	TreeProvider	Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
Public property	UniPagerControl	Pager control. (Inherited from UniView.)
Public property	UseHierarchicalOrder	Gets or sets the value that indicates whether default hierarchical order value should be used. The order is used only if LoadHierarchicalData is set to true. Default order value is "NodeLevel, NodeOrder". Value of OrderBy property is joined at the end of the order by expression
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	WhereCondition	Property to set and get the WhereCondition.
Public property	ZeroRowsText	Text to be shown when the control is hidden by HideControlForZeroRows. (Inherited from BasicUniView.)

Methods

	Name	Description
Protected method	BoundPagerToDataSource	Bound pager to the external external DataSource (Inherited from BasicUniView.)
Public method	ClearCache	Clears the cached items.
Protected method	CreateHierarchicalItem	Creates new UniView item and initialize object with selected template. (Inherited from UniView.)
Protected method	CreateChildControls	Creates child controls. (Inherited from UniView.)
Protected method	CreateItem	Creates new UniView item and initialize object with selected template. (Inherited from UniView.)
Public method	DataBind	Binds a data source to the invoked server control and all its child controls. (Overrides BaseDataBoundControl.DataBind().)
Protected method	EnsurePager	Creates instance of unipager and bind this pager to the current control.
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. (Inherited from BasicUniView.)
Protected method	InitControl	Ensures default data binding (Overrides BasicUniView.InitControl(Boolean).)
Protected method	ObjectToDataRowView	Converts object (DataSet, DataTable, DataRow) to DataRowView. (Inherited from UniView.)
Protected method	OnInit	Init event handler. (Inherited from BasicUniView.)
Protected method	OnLoad	OnLoad event handler (Inherited from BasicUniView.)
Protected method	Pager_OnPageChange	Event raised when page changed
Protected method	ProcessItem	Add UniView item to the controls collection and bind it. (Inherited from UniView.)
Protected method	RaiseOnBeforeInit	Raises the OnBeforeInit event. (Inherited from BasicUniView.)
Public method	ReBind	Evokes control databind. (Inherited from UniView.)
Public method	ReleaseContext	Releases the web part context.
Public method	ReloadData	Loads data from the according to the current values of properties. (Overrides BasicUniView.ReloadData(Boolean).)
Protected method	RemovedControl	Called after a child control is removed from controls collections. Ensures unipager for current control (Overrides Control.RemovedControl(Control).)
Protected method	Render	Render event handler. (Overrides BasicUniView.Render(HtmlTextWriter).)
Public method	SetContext	Sets the web part context.

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. (Inherited from BasicUniView.)
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.)