Click or drag to resize
CMSDocumentComparison Class
Document Comparison control.
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UI.WebControlsWebControl
      CMS.Base.Web.UICMSWebControl
        CMS.DocumentEngine.Web.UICMSAbstractBaseProperties
          CMS.DocumentEngine.Web.UICMSAbstractControlProperties
            CMS.DocumentEngine.Web.UICMSDocumentComparison

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 13.0.131
Syntax
C#
[SerializableAttribute]
public class CMSDocumentComparison : CMSAbstractControlProperties, 
	INamingContainer

The CMSDocumentComparison type exposes the following members.

Constructors
  NameDescription
Public methodCMSDocumentComparison
Constructor.
Top
Fields
  NameDescription
Protected fieldbasicURLParams
Basic URL params.
Protected fieldmBtnAdd
Add button.
Protected fieldmControlContext
Control context.
(Inherited from CMSAbstractBaseProperties.)
Protected fieldmDataSource
Data source variable.
(Inherited from CMSAbstractControlProperties.)
Protected fieldmDrpDocumentList
CMSDropDownList variable.
Protected fieldmMultiColumnTable
Multi column table variable.
Protected fieldmParent
Parent control.
(Inherited from CMSAbstractBaseProperties.)
Protected fieldmStopProcessing
Stop processing this control.
(Inherited from CMSAbstractBaseProperties.)
Protected fieldmTableParams
Table params.
Protected fieldmTreeProvider
Tree provider variable.
(Inherited from CMSAbstractControlProperties.)
Protected fieldnewDisplayNodeIDs
New display node Id.
Protected fieldNoData
When DataSource is empty NoData = true.
Top
Properties
  NameDescription
Public propertyAddButton
Add document button.
Public propertyBasicMultiColumnTable
Table displaying the documents.
Public propertyCacheDependencies
Cache dependencies, each cache dependency on a new line.
(Inherited from CMSAbstractBaseProperties.)
Public propertyCacheItemName
Name of the cache item the control will use.
(Inherited from CMSAbstractBaseProperties.)
Public propertyCacheMinutes
Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
(Inherited from CMSAbstractBaseProperties.)
Public propertyCheckPermissions
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 propertyClassNames
Property to set and get the class names list (separated by the semicolon).
(Inherited from CMSAbstractControlProperties.)
Public propertyCombineWithDefaultCulture
Property to set and get the CombineWithDefaultCulture flag.
(Inherited from CMSAbstractControlProperties.)
Public propertyControlContext
Control context.
(Inherited from CMSAbstractBaseProperties.)
Public propertyControlTagKey
Overrides the generation of the SPAN tag with custom tag.
(Inherited from CMSAbstractBaseProperties.)
Public propertyCultureCode
Property to set and get the CultureCode.
(Inherited from CMSAbstractControlProperties.)
Public propertyDataSource
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 propertyDocumentList
Drop-down list with all comparable documents.
Public propertyDropDownListColumn
Column to be displayed in the drop-down list.
Public propertyFilterOutDuplicates
Indicates if the duplicated (linked) items should be filtered out from the data.
(Inherited from CMSAbstractControlProperties.)
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from CMSWebControl.)
Public propertyMaxRelativeLevel
Property to set and get the MaxRelativeLevel.
(Inherited from CMSAbstractControlProperties.)
Public propertyOrderBy
ORDER BY part of the SQL statement.
(Inherited from CMSAbstractBaseProperties.)
Public propertyParentControl
Parent control.
(Inherited from CMSAbstractBaseProperties.)
Public propertyPath
Property to set and get the Path.
(Inherited from CMSAbstractControlProperties.)
Public propertyRemoveAllText
Text of the link for removing all compared documents.
Public propertyRemoveText
Text of the link for removing selected document.
Public propertySelectedColumns
Gets or sets the columns to be retrieved from database.
(Inherited from CMSAbstractBaseProperties.)
Public propertySelectOnlyPublished
Property to set and get the SelectOnlyPublished flag.
(Inherited from CMSAbstractControlProperties.)
Public propertyShortID
Short ID of the control.
(Inherited from CMSWebControl.)
Public propertySiteName
Site code name.
(Inherited from CMSAbstractBaseProperties.)
Public propertyStopProcessing
Indicates if processing of the control should be stopped and the control should not retrieve or display any data.
(Inherited from CMSAbstractBaseProperties.)
Public propertyTableParams
Params of the table to be displayed. A string array of size (x, 4).
Protected propertyTagKey
Overrides the generation of the SPAN tag with custom tag.
(Overrides WebControlTagKey.)
Public propertyTopN
Select top N rows.
(Inherited from CMSAbstractBaseProperties.)
Public propertyTreeProvider
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
(Inherited from CMSAbstractControlProperties.)
Public propertyWhereCondition
WHERE part of the SQL statement.
(Inherited from CMSAbstractBaseProperties.)
Public propertyZeroRowsText
Text to be shown when control havent any data.
Top
Methods
  NameDescription
Protected methodAddSelectedItem
Adds item to the table.
Protected methodControlPrerender
Prerender event - set table parameters.
Protected methodCreateChildControls
Renders the control at run-time.
(Overrides ControlCreateChildControls.)
Public methodGetCacheDependency
Gets the cache dependency for the control.
(Inherited from CMSAbstractBaseProperties.)
Public methodGetDefaultCacheDependencies
Gets the default cache dependencies for the data source.
(Inherited from CMSAbstractControlProperties.)
Protected methodHandleCulture
Appends culture parameter to query. Handles "##ALL##" macro
(Inherited from CMSAbstractControlProperties.)
Protected methodOnInit
Init event handler.
(Inherited from CMSWebControl.)
Public methodReleaseContext
Releases the control context.
(Inherited from CMSAbstractBaseProperties.)
Public methodReloadData
Reload control data.
(Inherited from CMSAbstractControlProperties.)
Protected methodRender
Renders the control at design-time.
(Overrides WebControlRender(HtmlTextWriter).)
Public methodSetContext
Sets the control context.
(Inherited from CMSAbstractBaseProperties.)
Top
Extension Methods
  NameDescription
Public Extension MethodAddCssClass
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodCallHandled
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 MethodGetCssClasses
Returns all CSS classes of control.
(Defined by ControlsExtensions.)
Public Extension MethodGetRenderedHTML
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Public Extension MethodHasCssClass
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodRemoveCssClass
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodSetCssClasses
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.)
Top
See Also