CMSViewer Class

Control for displaying CMS content transformed using XSLT.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.Base.Web.UI.CMSWebControl
        CMS.DocumentEngine.Web.UI.CMSAbstractBaseProperties
          CMS.DocumentEngine.Web.UI.CMSAbstractControlProperties
            CMS.DocumentEngine.Web.UI.CMSAbstractDataProperties
              CMS.DocumentEngine.Web.UI.CMSViewer

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

Syntax

public class CMSViewer : CMSAbstractDataProperties, INamingContainer

The CMSViewer type exposes the following members.

Constructors

	Name	Description
Public method	CMSViewer

Fields

	Name	Description
Protected field	CURRENT_DOCUMENT_GUID	Guid constant specifying current document. (Inherited from CMSAbstractDataProperties.)
Protected field	mCategory	Filtered category code name. (Inherited from CMSAbstractDataProperties.)
Protected field	mControlContext	Control context. (Inherited from CMSAbstractBaseProperties.)
Protected field	mDataLoaded	Flag saying whether the data has been already loaded. (Inherited from CMSAbstractDataProperties.)
Protected field	mDataSource	Data source variable. (Inherited from CMSAbstractControlProperties.)
Protected field	mNoData	When DataSource is empty NoData = true.
Protected field	mParent	Parent control. (Inherited from CMSAbstractBaseProperties.)
Protected field	mStopProcessing	Stop processing this control. (Inherited from CMSAbstractBaseProperties.)
Protected field	mTreeProvider	Tree provider variable. (Inherited from CMSAbstractControlProperties.)

Properties

	Name	Description
Public property	CacheDependencies	Cache dependencies, each cache dependency on a new line. (Inherited from CMSAbstractBaseProperties.)
Public property	CacheItemName	Name of the cache item the control will use. (Inherited from CMSAbstractBaseProperties.)
Public property	CacheMinutes	Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached. (Inherited from CMSAbstractBaseProperties.)
Public property	CategoryName	Property to set and get the category name for filtering documents. (Inherited from CMSAbstractDataProperties.)
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 CMSAbstractControlProperties.)
Public property	ClassNames	Property to set and get the class names list (separated by the semicolon). (Inherited from CMSAbstractControlProperties.)
Public property	Columns	Gets or sets the columns to be retrieved from database.
Public property	CombineWithDefaultCulture	Property to set and get the CombineWithDefaultCulture flag. (Inherited from CMSAbstractControlProperties.)
Public property	ControlContext	Control context. (Inherited from CMSAbstractBaseProperties.)
Public property	ControlTagKey	Overrides the generation of the SPAN tag with custom tag. (Inherited from CMSAbstractBaseProperties.)
Public property	CultureCode	Property to set and get the CultureCode. (Inherited from CMSAbstractControlProperties.)
Public property	DataSource	Gets or sets a DataSet containing values used to populate the items within the control. This value needn't be set. (Inherited from CMSAbstractControlProperties.)
Protected property	DefaultColumns	Gets the default column names which should be used always for CMS-related data. (Inherited from CMSAbstractDataProperties.)
Public property	FilterOutDuplicates	Indicates if the duplicated (linked) items should be filtered out from the data. (Inherited from CMSAbstractControlProperties.)
Public property	HideControlForZeroRows	Hides the control when no data is loaded. The default value is False.
Public property	IsAutomatic	Returns true if path was automatically set. (Inherited from CMSAbstractDataProperties.)
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSWebControl.)
Public property	IsSelected	Indicates whether selected transformation should be used (Inherited from CMSAbstractDataProperties.)
Public property	MaxRelativeLevel	Property to set and get the MaxRelativeLevel. (Inherited from CMSAbstractControlProperties.)
Public property	NoData	Gets the value that indicates whether the control contains any data.
Public property	OrderBy	ORDER BY part of the SQL statement. (Inherited from CMSAbstractBaseProperties.)
Public property	PageSize	Number of items per page. (Inherited from CMSAbstractDataProperties.)
Public property	ParentControl	Parent control. (Inherited from CMSAbstractBaseProperties.)
Public property	Path	Property to set and get the Path. (Inherited from CMSAbstractDataProperties.)
Public property	RelatedNodeIsOnTheLeftSide	If true, the returned nodes are on the right side of the relationship. (Inherited from CMSAbstractDataProperties.)
Public property	RelationshipName	Name of the relationship. (Inherited from CMSAbstractDataProperties.)
Public property	RelationshipWithNodeGuid	Select nodes with given relationship with given node. (Inherited from CMSAbstractDataProperties.)
Public property	ResolveDynamicControls	Gets or sets the value that indicates whether dynamic controls should be resolved
Public property	SelectedColumns	Gets or sets the columns to be retrieved from database. (Inherited from CMSAbstractBaseProperties.)
Public property	SelectedItemTransformationName	Transformation name for selected item in format application.class.transformation. (Inherited from CMSAbstractDataProperties.)
Public property	SelectOnlyPublished	Property to set and get the SelectOnlyPublished flag. (Inherited from CMSAbstractControlProperties.)
Public property	SelectTopN	Top N rows to select. (Inherited from CMSAbstractDataProperties.)
Public property	ShortID	Short ID of the control. (Inherited from CMSWebControl.)
Public property	SiteName	Site code name. (Inherited from CMSAbstractBaseProperties.)
Public property	StopProcessing	Indicates if processing of the control should be stopped and the control should not retrieve or display any data. (Inherited from CMSAbstractBaseProperties.)
Protected property	TagKey	Overrides the generation of the SPAN tag with custom tag. (Overrides WebControl.TagKey.)
Public property	TopN	Select top N rows. (Inherited from CMSAbstractBaseProperties.)
Public property	TransformationName	Transformation name in format application.class.transformation.
Public property	TreeProvider	Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created. (Inherited from CMSAbstractControlProperties.)
Public property	WhereCondition	WHERE part of the SQL statement. (Inherited from CMSAbstractBaseProperties.)
Public property	ZeroRowsText	Text to be shown when the control doesn't display any data.

Methods

	Name	Description
Public method	BuildFormat	Build format.
Public method	ClearCache	Clears the cached items. (Inherited from CMSAbstractDataProperties.)
Protected method	CreateChildControls	CreateChildControls() override. (Overrides Control.CreateChildControls().)
Public method	GetCacheDependency	Gets the cache dependency for the control. (Inherited from CMSAbstractBaseProperties.)
Public method	GetDataSet(String)	Retrieves DataSet with node according to the provided parameters. (Inherited from CMSAbstractDataProperties.)
Public method	GetDataSet(String, Boolean, Int32, Int32, Int32)	Retrieves DataSet with node according to the provided parameters. (Inherited from CMSAbstractDataProperties.)
Public method	GetDefaultCacheDependencies	Gets the default cache dependencies for the data source. (Inherited from CMSAbstractControlProperties.)
Public method	GetDocument	Returns document of specified path. It optionally uses cache. (Inherited from CMSAbstractDataProperties.)
Protected method	GetQueryInternal	Returns a multi-document query which represents the data specified by the given parameters and other object properties (path, WhereCondition etc.) (Inherited from CMSAbstractDataProperties.)
Protected method	HandleCulture	Appends culture parameter to query. Handles "##ALL##" macro (Inherited from CMSAbstractControlProperties.)
Public method	LoadData(Object, Boolean)	Loads the data to the data source. (Inherited from CMSAbstractDataProperties.)
Public method	LoadData(Object, Boolean, Int32, Int32, Int32)	Loads the data to the data source. (Inherited from CMSAbstractDataProperties.)
Protected method	OnInit	Init event handler. (Inherited from CMSWebControl.)
Protected method	OnLoad	OnLoad override, ensure child controls if it wasn't ensured regularly. (Overrides Control.OnLoad(EventArgs).)
Public method	ReleaseContext	Releases the control context. (Inherited from CMSAbstractBaseProperties.)
Public method	ReloadData	Reload control data. (Overrides CMSAbstractControlProperties.ReloadData(Boolean).)
Protected method	Render	Renders the control at design-time. (Overrides WebControl.Render(HtmlTextWriter).)
Public method	SetContext	Sets the control context. (Inherited from CMSAbstractBaseProperties.)

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