Click or drag to resize
BasicUniView Class
Extended UniView control that automates data binding.
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
                CMS.DocumentEngine.Web.UIQueryUniView

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 13.0.131
Syntax
C#
public class BasicUniView : UniView, 
	IUniPageableContainer, IRelatedData

The BasicUniView type exposes the following members.

Constructors
  NameDescription
Public methodBasicUniView
Constructor.
Top
Fields
  NameDescription
Protected fieldmDataLoaded
Indicates whether data were loaded.
Protected fieldmOnBeforeInitFired
True if the on before init was fired.
Protected fieldmRelatedData
Custom data connected to the object.
Protected fieldmRelatedDataLoaded
Related data is loaded.
Protected fielduseDataSourceControl
Indicates whether the viewer should obtain data source from the referenced control provided by the value of DataSourceControl property.
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 propertyDataBindByDefault
Indicates whether data binding should be performed by default.
Public propertyDataSource
Object from which data-bound control retrieves its list of data item.
(Overrides UniViewDataSource.)
Public propertyDataSourceControl
Control with data source.
Public propertyDataSourceName
Gets or sets name of source.
Protected propertyDefaultDataSource
Default data source to use if no external is provided.
Public propertyFirstItemTemplate
First item template.
(Inherited from UniView.)
Public propertyFooterTemplate
Footer item template.
(Inherited from UniView.)
Public propertyHeaderTemplate
Header item template.
(Inherited from UniView.)
Public propertyHideControlForZeroRows
Hides the control when no data is loaded. Default value is False.
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 propertyItemTemplate
Default item template.
(Inherited from UniView.)
Public propertyLastItemTemplate
Last item template.
(Inherited from UniView.)
Public propertyOuterData
Data generated in header and footer.
(Inherited from UniView.)
Public propertyPageableControl
Gets or sets the encapsulated control that implements IUniPageable interface.
Public propertyPagerDataItem
Gets or sets the IUniPageable.PagerDataItem value.
(Inherited from UniView.)
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 propertyRelatedData
Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl.
Public propertyRelationColumnID
Column from which specifies value of current level (for example parent document id).
(Inherited from UniView.)
Public propertyResolveDynamicControls
Gets or sets the value that indicates whether dynamic controls should be resolved
Public propertySelectedItemColumnName
Gets or sets the column name which should be used for selected item comparison.
(Inherited from UniView.)
Public propertySelectedItemValue
Gets or sets the value which indicates selected item.
(Inherited from UniView.)
Public propertySeparatorTemplate
Separator item template.
(Inherited from UniView.)
Public propertySingleItemTemplate
Single item template.
(Inherited from UniView.)
Public propertyTransformations
Gets or sets the transformation collection.
(Inherited from UniView.)
Public propertyUniPagerControl
Pager control.
(Inherited from UniView.)
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 propertyZeroRowsText
Text to be shown when the control is hidden by HideControlForZeroRows.
Top
Methods
  NameDescription
Protected methodBoundPagerToDataSource
Bound pager to the external external DataSource
Protected methodCreateChildControls
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.)
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.
Protected methodInitControl
Ensures default data binding
Protected methodObjectToDataRowView
Converts object (DataSet, DataTable, DataRow) to DataRowView.
(Inherited from UniView.)
Protected methodOnInit
Init event handler.
(Overrides BaseDataBoundControlOnInit(EventArgs).)
Protected methodOnLoad
OnLoad event handler
(Overrides DataBoundControlOnLoad(EventArgs).)
Protected methodProcessItem
Add UniView item to the controls collection and bind it.
(Inherited from UniView.)
Protected methodRaiseOnBeforeInit
Raises the OnBeforeInit event.
Public methodReBind
Evokes control databind.
(Inherited from UniView.)
Public methodReloadData
Reloads the control data, skips the loading if the data is already loaded.
Protected methodRender
Render event handler, to maintain the proper control rendering.
(Overrides UniViewRender(HtmlTextWriter).)
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.
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
Remarks
Temporary class, will be finished in future versions
See Also