ICMSDataProperties Interface

Data controls interface definition.

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

Syntax

public interface ICMSDataProperties : ICMSControlProperties, 
	ICMSBaseProperties

The ICMSDataProperties type exposes the following members.

Properties

	Name	Description
Public property	CacheDependencies	Cache dependencies, each cache dependency on a new line. (Inherited from ICMSBaseProperties.)
Public property	CacheItemName	Name of the cache item the control will use. (Inherited from ICMSBaseProperties.)
Public property	CacheMinutes	Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached. (Inherited from ICMSBaseProperties.)
Public property	CategoryName	Property to set and get the category name for filtering documents.
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. (Inherited from ICMSControlProperties.)
Public property	ClassNames	Class name value or several values separated by semicolon. (Inherited from ICMSControlProperties.)
Public property	CombineWithDefaultCulture	Indicates if the documents from the default culture version should be alternatively used. (Inherited from ICMSControlProperties.)
Public property	CultureCode	Culture code, such as en-us. (Inherited from ICMSControlProperties.)
Public property	FilterOutDuplicates	Indicates if the duplicated (linked) items should be filtered out from the data.
Public property	MaxRelativeLevel	Relative level of child documents that should be selected. -1 selects all child documents. (Inherited from ICMSControlProperties.)
Public property	OrderBy	Property to set and get the OrderBy. (Inherited from ICMSBaseProperties.)
Public property	PageSize	Number of items per page.
Public property	Path	Path of the documents to be displayed. /% selects all documents. (Inherited from ICMSControlProperties.)
Public property	RelatedNodeIsOnTheLeftSide	If true, the returned nodes are on the right side of the relationship.
Public property	RelationshipName	Name of the relationship.
Public property	RelationshipWithNodeGuid	Select nodes with given relationship with given node.
Public property	SelectedColumns	Columns to select, null or empty returns all columns. (Inherited from ICMSBaseProperties.)
Public property	SelectedItemTransformationName	Transformation name for selected item in format application.class.transformation.
Public property	SelectOnlyPublished	Indicates if only published documents should be displayed. (Inherited from ICMSControlProperties.)
Public property	SelectTopN	Select top N rows.
Public property	SiteName	Property to set and get the SiteName. (Inherited from ICMSBaseProperties.)
Public property	StopProcessing	Stop processing. (Inherited from ICMSBaseProperties.)
Public property	TopN	Select top N rows. (Inherited from ICMSBaseProperties.)
Public property	TreeProvider	Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created. (Inherited from ICMSControlProperties.)
Public property	WhereCondition	Property to set and get the WhereCondition. (Inherited from ICMSBaseProperties.)

Methods

	Name	Description
Public method	ReloadData	Reload control data. (Inherited from ICMSControlProperties.)