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