CMSDocumentsDataSource Class

Documents data source control.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.UserControl
        CMS.Base.Web.UI.AbstractUserControl
          CMS.DocumentEngine.Web.UI.CMSAbstractBaseFilterControl
            CMS.DocumentEngine.Web.UI.CMSBaseDataSource
              CMS.DocumentEngine.Web.UI.CMSControlDataSource
                CMS.DocumentEngine.Web.UI.CMSDocumentsDataSource

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 12.0.0

Syntax

[SerializableAttribute]
public class CMSDocumentsDataSource : CMSControlDataSource, 
	ICMSDataProperties, ICMSControlProperties, ICMSBaseProperties

The CMSDocumentsDataSource type exposes the following members.

Constructors

	Name	Description
Public method	CMSDocumentsDataSource	Default constructor

Fields

	Name	Description
Protected field	mDataSource	Data source. (Inherited from CMSBaseDataSource.)

Properties

	Name	Description
Protected property	BaseProperties	Data properties (Inherited from CMSAbstractBaseFilterControl.)
Public property	CacheDependencies	Cache dependencies, each cache dependency on a new line. (Inherited from CMSAbstractBaseFilterControl.)
Public property	CacheItemName	Name of the cache item the control will use. (Inherited from CMSAbstractBaseFilterControl.)
Public property	CacheMinutes	Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached. (Inherited from CMSAbstractBaseFilterControl.)
Public property	CategoryName	Category code name for filtering documents. (Inherited from CMSControlDataSource.)
Public property	CheckPermissions	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 property	ClassNames	Class name value or several values separated by semicolon. (Inherited from CMSControlDataSource.)
Public property	CombineWithDefaultCulture	Indicates if the documents from the default culture version should be alternatively used. (Inherited from CMSControlDataSource.)
Public property	ComponentName	Component name (Inherited from AbstractUserControl.)
Public property	ControlContext	Control context. (Inherited from CMSBaseDataSource.)
Protected property	ControlProperties	Data properties (Inherited from CMSControlDataSource.)
Public property	CultureCode	Culture code, such as en-us. (Inherited from CMSControlDataSource.)
Public property	CurrentDocument	Current document (Inherited from AbstractUserControl.)
Public property	CurrentPageInfo	Current page info (Inherited from AbstractUserControl.)
Public property	CurrentSite	Current site (Inherited from AbstractUserControl.)
Public property	CurrentUser	Current user (Inherited from AbstractUserControl.)
Public property	DataSource	Gets or sets source with data. (Inherited from CMSBaseDataSource.)
Public property	DisableFilterCaching	Enables or disables filter caching. (Inherited from CMSAbstractBaseFilterControl.)
Public property	DocumentManager	Document manager control (Inherited from AbstractUserControl.)
Public property	FilterChanged	Property to set and get the Filter changed. (Inherited from CMSAbstractBaseFilterControl.)
Public property	FilterControl	Data filter control. (Inherited from CMSAbstractBaseFilterControl.)
Public property	FilterControlPath	Gets or sets the path of the filter control. (Inherited from CMSAbstractBaseFilterControl.)
Public property	FilteredControl	Filtered control. (Inherited from CMSAbstractBaseFilterControl.)
Public property	FilterIsSet	Property to get if the filter is set. (Inherited from CMSAbstractBaseFilterControl.)
Public property	FilterMode	Allow to set filter mode (useful if same filter is used to filter different items) (Inherited from CMSAbstractBaseFilterControl.)
Public property	FilterName	Property to set and get the Filter name. (Inherited from CMSAbstractBaseFilterControl.)
Public property	FilterOutDuplicates	Indicates if the duplicated (linked) items should be filtered out from the data. (Inherited from CMSControlDataSource.)
Public property	HeaderActions	Header actions control (Inherited from AbstractUserControl.)
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from AbstractUserControl.)
Public property	IsSelected	Gets the value that indicates whether current data source contains selected item. (Overrides CMSBaseDataSource.IsSelected.)
Public property	LoadCurrentPageOnly	Gets or sets the value that indicates that if a page is selected, the datasource will provide data for the selected page only.
Public property	LoadPagesIndividually	If true, each page is loaded individually in case of paging. (Inherited from CMSBaseDataSource.)
Protected property	MaxRecords	Maximum number of records to get from the database. (Inherited from CMSBaseDataSource.)
Public property	MaxRelativeLevel	Relative level of child documents that should be selected. -1 selects all child documents. (Inherited from CMSControlDataSource.)
Public property	MessagesPlaceHolder	Placeholder for messages (Inherited from AbstractUserControl.)
Protected property	Offset	Offset where the data retrieved from database should start. (Inherited from CMSBaseDataSource.)
Public property	OrderBy	Property to set and get the OrderBy. (Inherited from CMSAbstractBaseFilterControl.)
Public property	PagerDataItem	Pager data item object. (Inherited from CMSBaseDataSource.)
Public property	PagerForceNumberOfResults	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 property	PageSize	Number of items per page.
Public property	Parameters	Hashtable with additional parameters. (Inherited from CMSAbstractBaseFilterControl.)
Public property	ParentControl	Parent control.
Public property	Path	Path of the documents to be displayed. /% selects all documents. (Inherited from CMSControlDataSource.)
Public property	RelatedData	Related data. (Inherited from CMSBaseDataSource.)
Public property	RelatedNodeIsOnTheLeftSide	If true, the returned nodes are on the right side of the relationship.
Public property	RelationshipName	Name of the relationship.
Public property	RelationshipWithNodeGuid	Select nodes with given relationship with given node.
Public property Code example	ResourcePrefix	Prefix for the resource strings which are used for the localization by the control and its child controls. (Inherited from AbstractUserControl.)
Public property	ResourcePrefixes	List of cached resource prefixes for the parent hierarchy (Inherited from AbstractUserControl.)
Public property	SelectedColumns	Columns which should be selected. (Inherited from CMSAbstractBaseFilterControl.)
Public property	SelectedItemTransformationName	Transformation name for selected item in format application.class.transformation.
Public property	SelectedValue	This value is used to initialize filter control according to currently selected value. (Inherited from CMSAbstractBaseFilterControl.)
Public property	SelectOnlyPublished	Indicates if only published documents should be displayed. (Inherited from CMSControlDataSource.)
Public property	SelectTopN	Top N rows to select. (Inherited from CMSControlDataSource.)
Public property	ShortID	Short ID of the control. (Inherited from AbstractUserControl.)
Public property	SiteID	Property to set and get the filter SiteID. (Inherited from CMSAbstractBaseFilterControl.)
Public property	SiteName	Property to set and get the SiteName. (Inherited from CMSAbstractBaseFilterControl.)
Public property	SourceFilterControl	Gets the source filter control. (Inherited from CMSAbstractBaseFilterControl.)
Public property	SourceFilterName	Gets or sets the source filter name. (Inherited from CMSAbstractBaseFilterControl.)
Public property	StopProcessing	Stop processing. (Inherited from CMSAbstractBaseFilterControl.)
Public property	ToggleAdvancedModeButton	Gets button used to toggle filter's advanced mode. (Inherited from CMSAbstractBaseFilterControl.)
Public property	TopN	Property to set and get the Top N property. (Inherited from CMSAbstractBaseFilterControl.)
Public property	TotalRecords	Total number of records. (Inherited from CMSBaseDataSource.)
Public property	TreeProvider	Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created. (Inherited from CMSControlDataSource.)
Public property	UniPagerControl	Pager control. (Inherited from CMSBaseDataSource.)
Public property	UsesLocalMessagesPlaceHolder	Indicates if control uses local messages placeholder (Inherited from AbstractUserControl.)
Public property	Value	Filter value. (Inherited from CMSAbstractBaseFilterControl.)
Public property	WhereCondition	Property to set and get the WhereCondition. (Inherited from CMSAbstractBaseFilterControl.)

Methods

	Name	Description
Public method	AddConfirmation	Adds confirmation text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddError	Adds error text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddHeaderAction	Adds specified action to the page header actions. (Inherited from AbstractUserControl.)
Public method	AddInformation	Adds information text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddMessage	Adds message text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddWarning	Adds warning text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	ClearCache	Clears the cached items. (Inherited from CMSBaseDataSource.)
Public method	EnsureControls	Interface for control that is able to explicitly ensure its child controls (Inherited from AbstractUserControl.)
Public method	Eval(String)	Evaluates the given value (Inherited from AbstractUserControl.)
Public method	Eval(String, Boolean)	Evaluates the item data (safe version), with html encoding. (Inherited from AbstractUserControl.)
Public method	EvalBool	Evaluates the item data and converts it to the bool. (Inherited from AbstractUserControl.)
Public method	EvalDateTime	Evaluates the item data and converts it to the date time. (Inherited from AbstractUserControl.)
Public method	EvalDecimal	Evaluates the item data and converts it to the decimal. (Inherited from AbstractUserControl.)
Public method	EvalDouble	Evaluates the item data and converts it to the double. (Inherited from AbstractUserControl.)
Public method	EvalGuid	Evaluates the item data and converts it to the guid. (Inherited from AbstractUserControl.)
Public method	EvalHTML	Evaluates the item data and doesn't encode it. Method should be used for columns with html content. (Inherited from AbstractUserControl.)
Public method	EvalHtmlAttribute	Evaluates the item data, encodes it to be used in HTML attribute. (Inherited from AbstractUserControl.)
Public method	EvalInteger	Evaluates the item data and converts it to the integer. (Inherited from AbstractUserControl.)
Public method	EvalJSString	Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'". (Inherited from AbstractUserControl.)
Public method	EvalText(String)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Public method	EvalText(String, Boolean)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Public method	GetCacheDependency	Gets the cache dependency for the control. (Inherited from CMSAbstractBaseFilterControl.)
Protected method	GetDataSource()	Gets data source according to caching properties. (Inherited from CMSBaseDataSource.)
Protected method	GetDataSource(Int32, Int32)	Gets data source according to caching properties. (Overrides CMSBaseDataSource.GetDataSource(Int32, Int32).)
Protected method	GetDataSourceFromDB()	Gets data source from DB. (Inherited from CMSBaseDataSource.)
Protected method	GetDataSourceFromDB(Int32, Int32, Int32)	Gets data source from DB. (Inherited from CMSBaseDataSource.)
Public method	GetDefaultCacheDependencies	Gets the default cache dependencies for the data source. (Inherited from CMSControlDataSource.)
Protected method	GetDefaultCacheKey	Gets the default cache key. (Inherited from CMSBaseDataSource.)
Public method	GetFlagIconUrl	Returns resolved path to the flag image for the specified culture. (Inherited from AbstractUserControl.)
Public method	GetImagePath	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetImageUrl	Gets UI image relative path. (Inherited from AbstractUserControl.)
Protected method	GetRelatedData	Gets related data. (Inherited from CMSBaseDataSource.)
Public method	GetString	Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined. (Inherited from AbstractUserControl.)
Public method	InitDataProperties(ICMSBaseProperties)	Initialize data properties from property object. (Inherited from CMSAbstractBaseFilterControl.)
Public method	InitDataProperties(ICMSControlProperties)	Initialize data properties from property object. (Inherited from CMSControlDataSource.)
Public method	InitDataProperties(ICMSDataProperties)	Initialize data properties from property object.
Public method	InvalidateLoadedData	Invalidate loaded data. (Inherited from CMSBaseDataSource.)
Public method	LoadData	Loads data from the database according to the current values of properties. (Inherited from CMSBaseDataSource.)
Public method	LoadUserControl	Loads the user control based on the given path (Inherited from AbstractUserControl.)
Public method	LogAndShowError	Logs the exception and (Inherited from AbstractUserControl.)
Protected method	OnInit	Init event handler. (Inherited from CMSAbstractBaseFilterControl.)
Protected method	OnLoad	Load event handler. (Inherited from CMSAbstractBaseFilterControl.)
Protected method	OnPreRender	PreRender event handler. (Inherited from AbstractUserControl.)
Protected method	PropagateProperties(ICMSBaseProperties)	Propagates given settings (Inherited from CMSAbstractBaseFilterControl.)
Protected method	PropagateProperties(ICMSControlProperties)	Propagates given settings (Inherited from CMSControlDataSource.)
Protected method	PropagateProperties(ICMSDataProperties)	Propagates given settings
Public method	RaiseOnFilterChanged	Run OnDataFilterChanged handler. (Inherited from CMSAbstractBaseFilterControl.)
Protected method	RaiseOnPageBinding	Raises the page binding event. (Inherited from CMSBaseDataSource.)
Public method	ReBind	Evokes control databind. (Inherited from CMSBaseDataSource.)
Protected method	RegisterOnFilterChangedHandler	Register OnFilterChanged handler (Inherited from CMSAbstractBaseFilterControl.)
Public method	ReleaseContext	Releases the web part context.
Public method	ReloadData	Reload control data. (Inherited from CMSControlDataSource.)
Protected method	Render	Render event handler. (Inherited from AbstractUserControl.)
Public method	ResetFilter	Resets filter to default state. (Inherited from CMSAbstractBaseFilterControl.)
Protected method	ResetPager	Resets pager data if pager is bound (Inherited from CMSBaseDataSource.)
Public method	ResolveUrl	Resolves the given URL (Inherited from AbstractUserControl.)
Public method	RestoreFilterState	Restores filter state from the specified object. (Inherited from CMSAbstractBaseFilterControl.)
Public method	SetContext	Sets the web part context.
Public method	ShowChangesSaved	Shows the general changes saved message. (Inherited from AbstractUserControl.)
Public method	ShowConfirmation	Shows the general confirmation message. (Inherited from AbstractUserControl.)
Public method	ShowError	Shows the specified error message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowInformation	Shows the given information on the page, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowMessage(MessageTypeEnum, String, String, String, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Protected method	ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowWarning	Shows the specified warning message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Protected method	SourceFilterControl_OnFilterChanged	Handles the OnFilterChanged event of the SourceFilter control. (Inherited from CMSAbstractBaseFilterControl.)
Public method	StoreFilterState	Stores filter state to the specified object. (Inherited from CMSAbstractBaseFilterControl.)
Protected method	ToggleAdvancedModeButton_Click	Toggle advanced mode button click event (Inherited from CMSAbstractBaseFilterControl.)

Extension Methods

	Name	Description
Public Extension Method	CallHandled	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 Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)

Events

	Name	Description
Public event	OnFilterChanged	Filter change handler. (Inherited from CMSAbstractBaseFilterControl.)
Public event	OnPageBinding	Occurs when the control bind data. (Inherited from CMSBaseDataSource.)
Public event	OnPageChanged	Occurs when the pager change the page and current mode is postback => reload data (Inherited from CMSBaseDataSource.)