CMSDocumentComparison Class

Document Comparison control.

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

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

Syntax

[SerializableAttribute]
public class CMSDocumentComparison : CMSAbstractControlProperties, 
	INamingContainer

The CMSDocumentComparison type exposes the following members.

Constructors

	Name	Description
Public method	CMSDocumentComparison	Constructor.

Fields

	Name	Description
Protected field	basicURLParams	Basic URL params.
Protected field	mBtnAdd	Add button.
Protected field	mControlContext	Control context. (Inherited from CMSAbstractBaseProperties.)
Protected field	mDataSource	Data source variable. (Inherited from CMSAbstractControlProperties.)
Protected field	mDrpDocumentList	CMSDropDownList variable.
Protected field	mMultiColumnTable	Multi column table variable.
Protected field	mParent	Parent control. (Inherited from CMSAbstractBaseProperties.)
Protected field	mStopProcessing	Stop processing this control. (Inherited from CMSAbstractBaseProperties.)
Protected field	mTableParams	Table params.
Protected field	mTreeProvider	Tree provider variable. (Inherited from CMSAbstractControlProperties.)
Protected field	newDisplayNodeIDs	New display node Id.
Protected field	NoData	When DataSource is empty NoData = true.

Properties

	Name	Description
Public property	AddButton	Add document button.
Public property	BasicMultiColumnTable	Table displaying the documents.
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	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	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.)
Public property	DocumentList	Drop-down list with all comparable documents.
Public property	DropDownListColumn	Column to be displayed in the drop-down list.
Public property	FilterOutDuplicates	Indicates if the duplicated (linked) items should be filtered out from the data. (Inherited from CMSAbstractControlProperties.)
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSWebControl.)
Public property	MaxRelativeLevel	Property to set and get the MaxRelativeLevel. (Inherited from CMSAbstractControlProperties.)
Public property	OrderBy	ORDER BY part of the SQL statement. (Inherited from CMSAbstractBaseProperties.)
Public property	ParentControl	Parent control. (Inherited from CMSAbstractBaseProperties.)
Public property	Path	Property to set and get the Path. (Inherited from CMSAbstractControlProperties.)
Public property	RemoveAllText	Text of the link for removing all compared documents.
Public property	RemoveText	Text of the link for removing selected document.
Public property	SelectedColumns	Gets or sets the columns to be retrieved from database. (Inherited from CMSAbstractBaseProperties.)
Public property	SelectOnlyPublished	Property to set and get the SelectOnlyPublished flag. (Inherited from CMSAbstractControlProperties.)
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.)
Public property	TableParams	Params of the table to be displayed. A string array of size (x, 4).
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	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 control havent any data.

Methods

	Name	Description
Protected method	AddSelectedItem	Adds item to the table.
Protected method	ControlPrerender	Prerender event - set table parameters.
Protected method	CreateChildControls	Renders the control at run-time. (Overrides Control.CreateChildControls().)
Public method	GetCacheDependency	Gets the cache dependency for the control. (Inherited from CMSAbstractBaseProperties.)
Public method	GetDefaultCacheDependencies	Gets the default cache dependencies for the data source. (Inherited from CMSAbstractControlProperties.)
Protected method	HandleCulture	Appends culture parameter to query. Handles "##ALL##" macro (Inherited from CMSAbstractControlProperties.)
Protected method	OnInit	Init event handler. (Inherited from CMSWebControl.)
Public method	ReleaseContext	Releases the control context. (Inherited from CMSAbstractBaseProperties.)
Public method	ReloadData	Reload control data. (Inherited from CMSAbstractControlProperties.)
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.)