Click or drag to resize
CMSUniView Class
UniView control that can be bounded to the CMS content.
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UI.WebControlsWebControl
      System.Web.UI.WebControlsBaseDataBoundControl
        System.Web.UI.WebControlsDataBoundControl
          System.Web.UI.WebControlsCompositeDataBoundControl
            CMS.DocumentEngine.Web.UIUniView
              CMS.DocumentEngine.Web.UIBasicUniView
                CMS.DocumentEngine.Web.UICMSUniView

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 13.0.131
Syntax
C#
public class CMSUniView : BasicUniView, ICMSDataProperties, 
	ICMSControlProperties, ICMSBaseProperties

The CMSUniView type exposes the following members.

Constructors
Fields
  NameDescription
Protected fieldmDataLoaded
Indicates whether data were loaded.
(Inherited from BasicUniView.)
Protected fieldmDataSource
Document data source.
Protected fieldmFilterControl
Filter control.
Protected fieldmFilterName
Filter name.
Protected fieldmFooterItem
Footer item code.
Protected fieldmHeaderItem
Header item code.
Protected fieldmItemSeparator
Item separator code.
Protected fieldmOnBeforeInitFired
True if the on before init was fired.
(Inherited from BasicUniView.)
Protected fieldmRelatedData
Custom data connected to the object.
(Inherited from BasicUniView.)
Protected fieldmRelatedDataLoaded
Related data is loaded.
(Inherited from BasicUniView.)
Protected fieldmUniPager
Current uni pager.
Protected fielduseDataSourceControl
Indicates whether the viewer should obtain data source from the referenced control provided by the value of DataSourceControl property.
(Inherited from BasicUniView.)
Top
Properties
  NameDescription
Public propertyAlternatingItemTemplate
Alternating item template.
(Inherited from UniView.)
Public propertyAlternatingRange
Item / AlternatingItem template changing interval
(Inherited from UniView.)
Public propertyAlternatingStartPosition
Alternating start position.
(Inherited from UniView.)
Public propertyAlternatingTransformationName
Transformation name in format application.class.transformation applied to alternating items.
Public propertyCacheDependencies
Cache dependencies, each cache dependency on a new line.
Public propertyCacheItemName
Name of the cache item the control will use.
Public propertyCacheMinutes
Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
Public propertyCategoryName
Property to set and get the category name for filtering documents.
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.
Public propertyClassNames
Property to set and get the classnames list (separated by the semicolon).
Public propertyColumns
Gets or sets the columns to be retrieved from database.
Public propertyCombineWithDefaultCulture
Property to set and get the CombineWithDefaultCulture flag.
Public propertyControlContext
Control context.
Public propertyCultureCode
Property to set and get the CultureCode.
Public propertyDataBindByDefault
Indicates whether data binding should be performed by default.
Public propertyDataSource
Object from which data-bound control retrieves its list of data item.
(Inherited from BasicUniView.)
Public propertyDataSourceControl
Control with data source.
(Inherited from BasicUniView.)
Public propertyDataSourceName
Gets or sets name of source.
(Inherited from BasicUniView.)
Protected propertyDefaultDataSource
Default data source to use if no external is provided
(Overrides BasicUniViewDefaultDataSource.)
Public propertyDelayedLoading
Indicates whether the data should be loaded to the load event instead of default init event.
Public propertyEnablePaging
Gets or sets the value that indicates whether paging is enabled.
Public propertyFilterControl
Filter control.
Public propertyFilterName
Gets or Set filter name.
Public propertyFilterOutDuplicates
Indicates if the duplicated (linked) items should be filtered out from the data.
Public propertyFirstItemTemplate
First item template.
(Inherited from UniView.)
Public propertyFirstTransformationName
Transformation name in format application.class.transformation applied to footer item.
Public propertyFooterTemplate
Footer item template.
(Inherited from UniView.)
Public propertyFooterTransformationName
Transformation name in format application.class.transformation applied to footer item.
Public propertyHeaderTemplate
Header item template.
(Inherited from UniView.)
Public propertyHeaderTransformationName
Transformation name in format application.class.transformation applied to header item.
Public propertyHideControlForZeroRows
Hides the control when no data is loaded. Default value is False.
(Inherited from BasicUniView.)
Public propertyHideHeaderAndFooterForSingleItem
Hide Outer data (header, footer) for single item.
(Inherited from UniView.)
Public propertyHierarchicalDisplayMode
Gets or sets the display mode for hierarchical datasource.
(Inherited from UniView.)
Public propertyHierarchicalTransformationName
Transformation name for hierarchical transformation collection in format application.class.transformation.
Public propertyIsSelected
Gets a value indicating whether the current item is a selected item.
Public propertyItemSeparatorValue
Item separator between displayed records.
Public propertyItemTemplate
Default item template.
(Inherited from UniView.)
Public propertyLastItemTemplate
Last item template.
(Inherited from UniView.)
Public propertyLastTransformationName
Transformation name in format application.class.transformation applied to last item.
Public propertyLoadHierarchicalData
Gets or sets the value that indicates whether data should be binded in default format or changed to hierarchical grouped dataset
Public propertyLoadPagesIndividually
If true, each page is loaded individually in case of paging.
Public propertyMaxRelativeLevel
Property to set and get the MaxRelativeLevel.
Public propertyNestedControlsID
Nested controls ID, use ';' like separator.
Public propertyOrderBy
Property to set and get the OrderBy.
Public propertyOuterData
Data generated in header and footer.
(Inherited from UniView.)
Public propertyPageableControl
Gets or sets the encapsulated control that implements IUniPageable interface.
(Inherited from BasicUniView.)
Public propertyPagerControl
Gets the current unipager instance.
Public propertyPagerCurrentPageTemplate
Current page template.
Public propertyPagerDataItem
Gets or sets the IUniPageable.PagerDataItem value.
(Inherited from UniView.)
Public propertyPagerDirectPageTemplate
Direct page control template.
Public propertyPagerFirstPageTemplate
First page template.
Public propertyPagerForceNumberOfResults
Gets or sets the number of result. Enables proceed "fake" datasets, where number of results in the dataset is not correspondent to the real number of results This property must be equal -1 if should be disabled
(Inherited from UniView.)
Public propertyPagerLastPageTemplate
Last page template.
Public propertyPagerLayoutTemplate
Layout template.
Public propertyPagerNextGroupTemplate
Next group template.
Public propertyPagerNextPageTemplate
Next page template.
Public propertyPagerPageNumbersSeparatorTemplate
Page numbers separator template.
Public propertyPagerPageNumbersTemplate
Page numbers template.
Public propertyPagerPosition
Pager position.
Public propertyPagerPreviousGroupTemplate
Previous group template.
Public propertyPagerPreviousPageTemplate
Previous page template.
Public propertyPageSize
Number of items per page.
Public propertyParentControl
Parent control.
Public propertyPath
Property to set and get the Path.
Public propertyRelatedData
Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl.
(Inherited from BasicUniView.)
Public propertyRelatedNodeIsOnTheLeftSide
If true, the returned nodes are on the right side of the relationship.
Public propertyRelationColumnID
Column from which specifies value of current level (for example parent document id).
(Inherited from UniView.)
Public propertyRelationshipName
Name of the relationship.
Public propertyRelationshipWithNodeGuid
Select nodes with given relationship with given node.
Public propertyResetScrollPositionOnPostBack
Gets or sets the value that indicates whether scroll position should be cleared after post back paging
Public propertyResolveDynamicControls
Gets or sets the value that indicates whether dynamic controls should be resolved
(Inherited from BasicUniView.)
Public propertySelectedColumns
Gets or sets the columns to be retrieved from database.
Public propertySelectedFootertemTransformationName
Transformation name for selected footeritem in format application.class.transformation.
Public propertySelectedHeaderItemTransformationName
Transformation name for selected header item in format application.class.transformation.
Public propertySelectedItemColumnName
Gets or sets the column name which should be used for selected item comparison.
(Inherited from UniView.)
Public propertySelectedItemTransformationName
Transformation name for selected item in format application.class.transformation.
Public propertySelectedItemValue
Gets or sets the value which indicates selected item.
(Inherited from UniView.)
Public propertySelectOnlyPublished
Property to set and get the SelectOnlyPublished flag.
Public propertySelectTopN
Top N rows to select.
Public propertySeparatorTemplate
Separator item template.
(Inherited from UniView.)
Public propertySeparatorTransformationName
Transformation name in format application.class.transformation applied to footer item.
Public propertyShowDeleteButton
Show Delete button.
Public propertyShowEditButton
Show Edit and Delete buttons.
Public propertyShowEditDeleteButtons
Show Edit and Delete buttons.
Public propertySingleItemTemplate
Single item template.
(Inherited from UniView.)
Public propertySingleTransformationName
Transformation name in format application.class.transformation applied to single item.
Public propertySiteName
Property to set and get the SiteName.
Public propertyStopProcessing
Stop processing
Public propertyTopN
Select top N rows.
Public propertyTransformationName
Transformation name in format application.class.transformation.
Public propertyTransformations
Gets or sets the transformation collection.
(Inherited from UniView.)
Public propertyTreeProvider
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
Public propertyUniPagerControl
Pager control.
(Inherited from UniView.)
Public propertyUseHierarchicalOrder
Gets or sets the value that indicates whether default hierarchical order value should be used. The order is used only if LoadHierarchicalData is set to true. Default order value is "NodeLevel, NodeOrder". Value of OrderBy property is joined at the end of the order by expression
Public propertyUseNearestItemForHeaderAndFooter
Gets or sets the value that indicates whether data from nearest data item should be used for header or footer item. This value is ignored if OuterData property is set.
(Inherited from UniView.)
Public propertyWhereCondition
Property to set and get the WhereCondition.
Public propertyZeroRowsText
Text to be shown when the control is hidden by HideControlForZeroRows.
(Inherited from BasicUniView.)
Top
Methods
  NameDescription
Protected methodBoundPagerToDataSource
Bound pager to the external external DataSource
(Inherited from BasicUniView.)
Public methodClearCache
Clears the cached items.
Protected methodCreateChildControls
Creates the control hierarchy that is used to render a composite data-bound control based on the values that are stored in view state.
(Overrides CompositeDataBoundControlCreateChildControls.)
Protected methodCreateChildControls(IEnumerable, Boolean)
Creates child controls.
(Inherited from UniView.)
Protected methodCreateHierarchicalItem
Creates new UniView item and initialize object with selected template.
(Inherited from UniView.)
Protected methodCreateItem
Creates new UniView item and initialize object with selected template.
(Inherited from UniView.)
Public methodDataBind
Binds a data source to the invoked server control and all its child controls.
(Overrides BaseDataBoundControlDataBind.)
Protected methodGenerateContent
Default method to the content generating.
(Inherited from UniView.)
Protected methodGenerateInnerHierarchicalContent
Inner hierarchical content generating.
(Inherited from UniView.)
Protected methodGenerateSeparateHierarchicalContent
Separate hierarchical content generating.
(Inherited from UniView.)
Protected methodGetDataItemValue
Returns value from specified data item object.
(Inherited from UniView.)
Protected methodGetItemsCount
Try to get items count from IEnumerable object.
(Inherited from UniView.)
Protected methodGetItemType
Returns item type based on current index and item count.
(Inherited from UniView.)
Protected methodGetTemplate
Returns default item template if selected template is empty.
(Inherited from UniView.)
Public methodHasData
Indicates if data source contains data.
(Inherited from BasicUniView.)
Protected methodInitControl
Ensures default data binding
(Overrides BasicUniViewInitControl(Boolean).)
Protected methodObjectToDataRowView
Converts object (DataSet, DataTable, DataRow) to DataRowView.
(Inherited from UniView.)
Protected methodOnInit
Init event handler.
(Inherited from BasicUniView.)
Protected methodOnLoad
OnLoad event handler
(Inherited from BasicUniView.)
Protected methodPager_OnPageChange
Event raised when page changed
Protected methodProcessItem
Add UniView item to the controls collection and bind it.
(Inherited from UniView.)
Protected methodRaiseOnBeforeInit
Raises the OnBeforeInit event.
(Inherited from BasicUniView.)
Public methodReBind
Evokes control databind.
(Inherited from UniView.)
Public methodReleaseContext
Releases the web part context.
Public methodReloadData
Loads data from the according to the current values of properties.
(Overrides BasicUniViewReloadData(Boolean).)
Protected methodRender
Render event handler.
(Overrides BasicUniViewRender(HtmlTextWriter).)
Public methodSetContext
Sets the web part context.
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
Events
  NameDescription
Public eventOnBeforeInit
On before init handler.
(Inherited from BasicUniView.)
Public eventOnItemCreated
Occurs when an item is created in the UniView control.
(Inherited from UniView.)
Public eventOnItemDataBound
Occurs when the control bind UniView item.
(Inherited from UniView.)
Public eventOnPageBinding
Occurs when the control bind data.
(Inherited from UniView.)
Public eventOnPageChanged
Occurs when the pager change the page and current mode is postback => reload data
(Inherited from UniView.)
Top
See Also