Click or drag to resize
CMSViewer Class
Control for displaying CMS content transformed using XSLT.
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.UICMSAbstractDataProperties
              CMS.DocumentEngine.Web.UICMSViewer

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 13.0.131
Syntax
C#
public class CMSViewer : CMSAbstractDataProperties, INamingContainer

The CMSViewer type exposes the following members.

Constructors
  NameDescription
Public methodCMSViewer
Top
Fields
  NameDescription
Protected fieldCURRENT_DOCUMENT_GUID
Guid constant specifying current document.
(Inherited from CMSAbstractDataProperties.)
Protected fieldmCategory
Filtered category code name.
(Inherited from CMSAbstractDataProperties.)
Protected fieldmControlContext
Control context.
(Inherited from CMSAbstractBaseProperties.)
Protected fieldmDataLoaded
Flag saying whether the data has been already loaded.
(Inherited from CMSAbstractDataProperties.)
Protected fieldmDataSource
Data source variable.
(Inherited from CMSAbstractControlProperties.)
Protected fieldmNoData
When DataSource is empty NoData = true.
Protected fieldmParent
Parent control.
(Inherited from CMSAbstractBaseProperties.)
Protected fieldmStopProcessing
Stop processing this control.
(Inherited from CMSAbstractBaseProperties.)
Protected fieldmTreeProvider
Tree provider variable.
(Inherited from CMSAbstractControlProperties.)
Top
Properties
  NameDescription
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 propertyCategoryName
Property to set and get the category name for filtering documents.
(Inherited from CMSAbstractDataProperties.)
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 propertyColumns
Gets or sets the columns to be retrieved from database.
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.)
Protected propertyDefaultColumns
Gets the default column names which should be used always for CMS-related data.
(Inherited from CMSAbstractDataProperties.)
Public propertyFilterOutDuplicates
Indicates if the duplicated (linked) items should be filtered out from the data.
(Inherited from CMSAbstractControlProperties.)
Public propertyHideControlForZeroRows
Hides the control when no data is loaded. The default value is False.
Public propertyIsAutomatic
Returns true if path was automatically set.
(Inherited from CMSAbstractDataProperties.)
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from CMSWebControl.)
Public propertyIsSelected
Indicates whether selected transformation should be used
(Inherited from CMSAbstractDataProperties.)
Public propertyMaxRelativeLevel
Property to set and get the MaxRelativeLevel.
(Inherited from CMSAbstractControlProperties.)
Public propertyNoData
Gets the value that indicates whether the control contains any data.
Public propertyOrderBy
ORDER BY part of the SQL statement.
(Inherited from CMSAbstractBaseProperties.)
Public propertyPageSize
Number of items per page.
(Inherited from CMSAbstractDataProperties.)
Public propertyParentControl
Parent control.
(Inherited from CMSAbstractBaseProperties.)
Public propertyPath
Property to set and get the Path.
(Inherited from CMSAbstractDataProperties.)
Public propertyRelatedNodeIsOnTheLeftSide
If true, the returned nodes are on the right side of the relationship.
(Inherited from CMSAbstractDataProperties.)
Public propertyRelationshipName
Name of the relationship.
(Inherited from CMSAbstractDataProperties.)
Public propertyRelationshipWithNodeGuid
Select nodes with given relationship with given node.
(Inherited from CMSAbstractDataProperties.)
Public propertyResolveDynamicControls
Gets or sets the value that indicates whether dynamic controls should be resolved
Public propertySelectedColumns
Gets or sets the columns to be retrieved from database.
(Inherited from CMSAbstractBaseProperties.)
Public propertySelectedItemTransformationName
Transformation name for selected item in format application.class.transformation.
(Inherited from CMSAbstractDataProperties.)
Public propertySelectOnlyPublished
Property to set and get the SelectOnlyPublished flag.
(Inherited from CMSAbstractControlProperties.)
Public propertySelectTopN
Top N rows to select.
(Inherited from CMSAbstractDataProperties.)
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.)
Protected propertyTagKey
Overrides the generation of the SPAN tag with custom tag.
(Overrides WebControlTagKey.)
Public propertyTopN
Select top N rows.
(Inherited from CMSAbstractBaseProperties.)
Public propertyTransformationName
Transformation name in format application.class.transformation.
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 the control doesn't display any data.
Top
Methods
  NameDescription
Public methodBuildFormat
Build format.
Public methodClearCache
Clears the cached items.
(Inherited from CMSAbstractDataProperties.)
Protected methodCreateChildControls
CreateChildControls() override.
(Overrides ControlCreateChildControls.)
Public methodGetCacheDependency
Gets the cache dependency for the control.
(Inherited from CMSAbstractBaseProperties.)
Public methodGetDataSet(String)
Retrieves DataSet with node according to the provided parameters.
(Inherited from CMSAbstractDataProperties.)
Public methodGetDataSet(String, Boolean, Int32, Int32, Int32)
Retrieves DataSet with node according to the provided parameters.
(Inherited from CMSAbstractDataProperties.)
Public methodGetDefaultCacheDependencies
Gets the default cache dependencies for the data source.
(Inherited from CMSAbstractControlProperties.)
Public methodGetDocument
Returns document of specified path. It optionally uses cache.
(Inherited from CMSAbstractDataProperties.)
Protected methodGetQueryInternal
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 methodHandleCulture
Appends culture parameter to query. Handles "##ALL##" macro
(Inherited from CMSAbstractControlProperties.)
Public methodLoadData(Object, Boolean)
Loads the data to the data source.
(Inherited from CMSAbstractDataProperties.)
Public methodLoadData(Object, Boolean, Int32, Int32, Int32)
Loads the data to the data source.
(Inherited from CMSAbstractDataProperties.)
Protected methodOnInit
Init event handler.
(Inherited from CMSWebControl.)
Protected methodOnLoad
OnLoad override, ensure child controls if it wasn't ensured regularly.
(Overrides ControlOnLoad(EventArgs).)
Public methodReleaseContext
Releases the control context.
(Inherited from CMSAbstractBaseProperties.)
Public methodReloadData
Reload control data.
(Overrides CMSAbstractControlPropertiesReloadData(Boolean).)
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