Click or drag to resize
CMSDocumentsDataSource Class
Documents data source control.
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UITemplateControl
      System.Web.UIUserControl
        CMS.Base.Web.UIAbstractUserControl
          CMS.DocumentEngine.Web.UICMSAbstractBaseFilterControl
            CMS.DocumentEngine.Web.UICMSBaseDataSource
              CMS.DocumentEngine.Web.UICMSControlDataSource
                CMS.DocumentEngine.Web.UICMSDocumentsDataSource

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 CMSDocumentsDataSource : CMSControlDataSource, 
	ICMSDataProperties, ICMSControlProperties, ICMSBaseProperties

The CMSDocumentsDataSource type exposes the following members.

Constructors
  NameDescription
Public methodCMSDocumentsDataSource
Default constructor
Top
Fields
  NameDescription
Protected fieldmDataSource
Data source.
(Inherited from CMSBaseDataSource.)
Top
Properties
  NameDescription
Protected propertyBaseProperties
Data properties
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyCacheDependencies
Cache dependencies, each cache dependency on a new line.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyCacheItemName
Name of the cache item the control will use.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyCacheMinutes
Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyCategoryName
Category code name for filtering documents.
(Inherited from CMSControlDataSource.)
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 CMSControlDataSource.)
Public propertyClassNames
Class name value or several values separated by semicolon.
(Inherited from CMSControlDataSource.)
Public propertyCombineWithDefaultCulture
Indicates if the documents from the default culture version should be alternatively used.
(Inherited from CMSControlDataSource.)
Public propertyComponentName
Component name
(Inherited from AbstractUserControl.)
Public propertyControlContext
Control context.
(Inherited from CMSBaseDataSource.)
Protected propertyControlProperties
Data properties
(Inherited from CMSControlDataSource.)
Public propertyCultureCode
Culture code, such as en-us.
(Inherited from CMSControlDataSource.)
Public propertyCurrentSite
Current site
(Inherited from AbstractUserControl.)
Public propertyCurrentUser
Current user
(Inherited from AbstractUserControl.)
Public propertyDataSource
Gets or sets source with data.
(Inherited from CMSBaseDataSource.)
Public propertyDisableFilterCaching
Enables or disables filter caching.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyFilterChanged
Property to set and get the Filter changed.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyFilterControl
Data filter control.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyFilterControlPath
Gets or sets the path of the filter control.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyFilteredControl
Filtered control.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyFilterIsSet
Property to get if the filter is set.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyFilterMode
Allow to set filter mode (useful if same filter is used to filter different items)
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyFilterName
Property to set and get the Filter name.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyFilterOutDuplicates
Indicates if the duplicated (linked) items should be filtered out from the data.
(Inherited from CMSControlDataSource.)
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from AbstractUserControl.)
Public propertyIsSelected
Gets the value that indicates whether current data source contains selected item.
(Overrides CMSBaseDataSourceIsSelected.)
Public propertyLoadCurrentPageOnly
Gets or sets the value that indicates that if a page is selected, the datasource will provide data for the selected page only.
Public propertyLoadPagesIndividually
If true, each page is loaded individually in case of paging.
(Inherited from CMSBaseDataSource.)
Protected propertyMaxRecords
Maximum number of records to get from the database.
(Inherited from CMSBaseDataSource.)
Public propertyMaxRelativeLevel
Relative level of child documents that should be selected. -1 selects all child documents.
(Inherited from CMSControlDataSource.)
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Protected propertyOffset
Offset where the data retrieved from database should start.
(Inherited from CMSBaseDataSource.)
Public propertyOrderBy
Property to set and get the OrderBy.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyPagerDataItem
Pager data item object.
(Inherited from CMSBaseDataSource.)
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 CMSBaseDataSource.)
Public propertyPageSize
Number of items per page.
Public propertyParameters
Hashtable with additional parameters.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyParentControl
Parent control.
Public propertyPath
Path of the documents to be displayed. /% selects all documents.
(Inherited from CMSControlDataSource.)
Public propertyRelatedData
Related data.
(Inherited from CMSBaseDataSource.)
Public propertyRelatedNodeIsOnTheLeftSide
If true, the returned nodes are on the right side of the relationship.
Public propertyRelationshipName
Name of the relationship.
Public propertyRelationshipWithNodeGuid
Select nodes with given relationship with given node.
Public propertyCode exampleResourcePrefix
Prefix for the resource strings which are used for the localization by the control and its child controls.
(Inherited from AbstractUserControl.)
Public propertyResourcePrefixes
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.)
Public propertySelectedColumns
Columns which should be selected.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertySelectedItemTransformationName
Transformation name for selected item in format application.class.transformation.
Public propertySelectedValue
This value is used to initialize filter control according to currently selected value.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertySelectOnlyPublished
Indicates if only published documents should be displayed.
(Inherited from CMSControlDataSource.)
Public propertySelectTopN
Top N rows to select.
(Inherited from CMSControlDataSource.)
Public propertyShortID
Short ID of the control.
(Inherited from AbstractUserControl.)
Public propertySiteID
Property to set and get the filter SiteID.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertySiteName
Property to set and get the SiteName.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertySourceFilterControl
Gets the source filter control.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertySourceFilterName
Gets or sets the source filter name.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyStopProcessing
Stop processing.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyToggleAdvancedModeButton
Gets button used to toggle filter's advanced mode.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyTopN
Property to set and get the Top N property.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyTotalRecords
Total number of records.
(Inherited from CMSBaseDataSource.)
Public propertyTreeProvider
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
(Inherited from CMSControlDataSource.)
Public propertyUniPagerControl
Pager control.
(Inherited from CMSBaseDataSource.)
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.)
Public propertyValue
Filter value.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyWhereCondition
Property to set and get the WhereCondition.
(Inherited from CMSAbstractBaseFilterControl.)
Top
Methods
  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddError
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddHeaderAction
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.)
Public methodAddInformation
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddMessage
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodClearCache
Clears the cached items.
(Inherited from CMSBaseDataSource.)
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.)
Public methodEval(String)
Evaluates the given value
(Inherited from AbstractUserControl.)
Public methodEval(String, Boolean)
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.)
Public methodEvalBool
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.)
Public methodEvalDateTime
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.)
Public methodEvalDecimal
Evaluates the item data and converts it to the decimal.
(Inherited from AbstractUserControl.)
Public methodEvalDouble
Evaluates the item data and converts it to the double.
(Inherited from AbstractUserControl.)
Public methodEvalGuid
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.)
Public methodEvalHTML
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.)
Public methodEvalHtmlAttribute
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.)
Public methodEvalInteger
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalJSString
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.)
Public methodEvalText(String)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Public methodEvalText(String, Boolean)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Public methodGetCacheDependency
Gets the cache dependency for the control.
(Inherited from CMSAbstractBaseFilterControl.)
Protected methodGetDataSource
Gets data source according to caching properties.
(Inherited from CMSBaseDataSource.)
Protected methodGetDataSource(Int32, Int32)
Gets data source according to caching properties.
(Overrides CMSBaseDataSourceGetDataSource(Int32, Int32).)
Protected methodGetDataSourceFromDB
Gets data source from DB.
(Inherited from CMSBaseDataSource.)
Protected methodGetDataSourceFromDB(Int32, Int32, Int32)
Gets data source from DB.
(Inherited from CMSBaseDataSource.)
Public methodGetDefaultCacheDependencies
Gets the default cache dependencies for the data source.
(Inherited from CMSControlDataSource.)
Protected methodGetDefaultCacheKey
Gets the default cache key.
(Inherited from CMSBaseDataSource.)
Public methodGetFlagIconUrl
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.)
Public methodGetImagePath
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetImageUrl
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Protected methodGetRelatedData
Gets related data.
(Inherited from CMSBaseDataSource.)
Public methodGetString
Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined.
(Inherited from AbstractUserControl.)
Public methodInitDataProperties(ICMSBaseProperties)
Initialize data properties from property object.
(Inherited from CMSAbstractBaseFilterControl.)
Public methodInitDataProperties(ICMSControlProperties)
Initialize data properties from property object.
(Inherited from CMSControlDataSource.)
Public methodInitDataProperties(ICMSDataProperties)
Initialize data properties from property object.
Public methodInvalidateLoadedData
Invalidate loaded data.
(Inherited from CMSBaseDataSource.)
Public methodLoadData
Loads data from the database according to the current values of properties.
(Inherited from CMSBaseDataSource.)
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
Public methodLogAndShowError
Logs the exception and
(Inherited from AbstractUserControl.)
Protected methodOnInit
Init event handler.
(Inherited from CMSAbstractBaseFilterControl.)
Protected methodOnLoad
Load event handler.
(Inherited from CMSAbstractBaseFilterControl.)
Protected methodOnPreRender
PreRender event handler.
(Inherited from AbstractUserControl.)
Protected methodPropagateProperties(ICMSBaseProperties)
Propagates given settings
(Inherited from CMSAbstractBaseFilterControl.)
Protected methodPropagateProperties(ICMSControlProperties)
Propagates given settings
(Inherited from CMSControlDataSource.)
Protected methodPropagateProperties(ICMSDataProperties)
Propagates given settings
Public methodRaiseOnFilterChanged
Run OnDataFilterChanged handler.
(Inherited from CMSAbstractBaseFilterControl.)
Protected methodRaiseOnPageBinding
Raises the page binding event.
(Inherited from CMSBaseDataSource.)
Public methodReBind
Evokes control databind.
(Inherited from CMSBaseDataSource.)
Protected methodRegisterOnFilterChangedHandler
Register OnFilterChanged handler
(Inherited from CMSAbstractBaseFilterControl.)
Public methodReleaseContext
Releases the web part context.
Public methodReloadData
Reload control data.
(Inherited from CMSControlDataSource.)
Protected methodRender
Render event handler.
(Inherited from AbstractUserControl.)
Public methodResetFilter
Resets filter to default state.
(Inherited from CMSAbstractBaseFilterControl.)
Protected methodResetPager
Resets pager data if pager is bound
(Inherited from CMSBaseDataSource.)
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Public methodRestoreFilterState
Restores filter state from the specified object.
(Inherited from CMSAbstractBaseFilterControl.)
Public methodSetContext
Sets the web part context.
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractUserControl.)
Public methodShowConfirmation
Shows the general confirmation message.
(Inherited from AbstractUserControl.)
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowMessage(MessageTypeEnum, String, String, String, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodSourceFilterControl_OnFilterChanged
Handles the OnFilterChanged event of the SourceFilter control.
(Inherited from CMSAbstractBaseFilterControl.)
Public methodStoreFilterState
Stores filter state to the specified object.
(Inherited from CMSAbstractBaseFilterControl.)
Protected methodToggleAdvancedModeButton_Click
Toggle advanced mode button click event
(Inherited from CMSAbstractBaseFilterControl.)
Top
Extension Methods
  NameDescription
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 MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Top
Events
  NameDescription
Public eventOnFilterChanged
Filter change handler.
(Inherited from CMSAbstractBaseFilterControl.)
Public eventOnPageBinding
Occurs when the control bind data.
(Inherited from CMSBaseDataSource.)
Public eventOnPageChanged
Occurs when the pager change the page and current mode is postback => reload data
(Inherited from CMSBaseDataSource.)
Top
See Also