CMSAbstractDataProperties Class |
Namespace: CMS.DocumentEngine.Web.UI
public abstract class CMSAbstractDataProperties : CMSAbstractControlProperties, ICMSDataProperties, ICMSControlProperties, ICMSBaseProperties
The CMSAbstractDataProperties type exposes the following members.
Name | Description | |
---|---|---|
CMSAbstractDataProperties |
Name | Description | |
---|---|---|
CURRENT_DOCUMENT_GUID |
Guid constant specifying current document.
| |
mCategory |
Filtered category code name.
| |
mControlContext |
Control context.
(Inherited from CMSAbstractBaseProperties.) | |
mDataLoaded |
Flag saying whether the data has been already loaded.
| |
mDataSource |
Data source variable.
(Inherited from CMSAbstractControlProperties.) | |
mParent |
Parent control.
(Inherited from CMSAbstractBaseProperties.) | |
mStopProcessing |
Stop processing this control.
(Inherited from CMSAbstractBaseProperties.) | |
mTreeProvider |
Tree provider variable.
(Inherited from CMSAbstractControlProperties.) |
Name | Description | |
---|---|---|
CacheDependencies |
Cache dependencies, each cache dependency on a new line.
(Inherited from CMSAbstractBaseProperties.) | |
CacheItemName |
Name of the cache item the control will use.
(Inherited from CMSAbstractBaseProperties.) | |
CacheMinutes |
Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
(Inherited from CMSAbstractBaseProperties.) | |
CategoryName |
Property to set and get the category name for filtering documents.
| |
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 CMSAbstractControlProperties.) | |
ClassNames |
Property to set and get the class names list (separated by the semicolon).
(Inherited from CMSAbstractControlProperties.) | |
CombineWithDefaultCulture |
Property to set and get the CombineWithDefaultCulture flag.
(Inherited from CMSAbstractControlProperties.) | |
ControlContext |
Control context.
(Inherited from CMSAbstractBaseProperties.) | |
ControlTagKey |
Overrides the generation of the SPAN tag with custom tag.
(Inherited from CMSAbstractBaseProperties.) | |
CultureCode |
Property to set and get the CultureCode.
(Inherited from CMSAbstractControlProperties.) | |
DataSource |
Gets or sets a DataSet containing values used to populate the items within the control. This value needn't be set.
(Inherited from CMSAbstractControlProperties.) | |
DefaultColumns |
Gets the default column names which should be used always for CMS-related data.
| |
FilterOutDuplicates |
Indicates if the duplicated (linked) items should be filtered out from the data.
(Inherited from CMSAbstractControlProperties.) | |
IsAutomatic |
Returns true if path was automatically set.
| |
IsLiveSite |
Indicates if control is used on live site.
(Inherited from CMSWebControl.) | |
IsSelected |
Indicates whether selected transformation should be used
| |
MaxRelativeLevel |
Property to set and get the MaxRelativeLevel.
(Inherited from CMSAbstractControlProperties.) | |
OrderBy |
ORDER BY part of the SQL statement.
(Inherited from CMSAbstractBaseProperties.) | |
PageSize |
Number of items per page.
| |
ParentControl |
Parent control.
(Inherited from CMSAbstractBaseProperties.) | |
Path |
Property to set and get the Path.
(Overrides CMSAbstractControlProperties.Path.) | |
RelatedNodeIsOnTheLeftSide |
If true, the returned nodes are on the right side of the relationship.
| |
RelationshipName |
Name of the relationship.
| |
RelationshipWithNodeGuid |
Select nodes with given relationship with given node.
| |
SelectedColumns |
Gets or sets the columns to be retrieved from database.
(Inherited from CMSAbstractBaseProperties.) | |
SelectedItemTransformationName |
Transformation name for selected item in format application.class.transformation.
| |
SelectOnlyPublished |
Property to set and get the SelectOnlyPublished flag.
(Inherited from CMSAbstractControlProperties.) | |
SelectTopN |
Top N rows to select.
| |
ShortID |
Short ID of the control.
(Inherited from CMSWebControl.) | |
SiteName |
Site code name.
(Inherited from CMSAbstractBaseProperties.) | |
StopProcessing |
Indicates if processing of the control should be stopped and the control should not retrieve or display any data.
(Inherited from CMSAbstractBaseProperties.) | |
TopN |
Select top N rows.
(Inherited from CMSAbstractBaseProperties.) | |
TreeProvider |
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
(Inherited from CMSAbstractControlProperties.) | |
WhereCondition |
WHERE part of the SQL statement.
(Inherited from CMSAbstractBaseProperties.) |
Name | Description | |
---|---|---|
ClearCache |
Clears the cached items.
| |
GetCacheDependency |
Gets the cache dependency for the control.
(Inherited from CMSAbstractBaseProperties.) | |
GetDataSet(String) |
Retrieves DataSet with node according to the provided parameters.
| |
GetDataSet(String, Boolean, Int32, Int32, Int32) |
Retrieves DataSet with node according to the provided parameters.
| |
GetDefaultCacheDependencies |
Gets the default cache dependencies for the data source.
(Inherited from CMSAbstractControlProperties.) | |
GetDocument |
Returns document of specified path. It optionally uses cache.
| |
GetQueryInternal |
Returns a multi-document query which represents the data specified by the given parameters and other object properties (path, WhereCondition etc.)
| |
HandleCulture |
Appends culture parameter to query. Handles "##ALL##" macro
(Inherited from CMSAbstractControlProperties.) | |
LoadData(Object, Boolean) |
Loads the data to the data source.
| |
LoadData(Object, Boolean, Int32, Int32, Int32) |
Loads the data to the data source.
| |
OnInit |
Init event handler.
(Inherited from CMSWebControl.) | |
ReleaseContext |
Releases the control context.
(Inherited from CMSAbstractBaseProperties.) | |
ReloadData |
Reload control data.
(Inherited from CMSAbstractControlProperties.) | |
SetContext |
Sets the control context.
(Inherited from CMSAbstractBaseProperties.) |
Name | Description | |
---|---|---|
AddCssClass |
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
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.) | |
GetCssClasses |
Returns all CSS classes of control.
(Defined by ControlsExtensions.) | |
GetRenderedHTML |
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.) | |
GetString |
Gets the string by the specified resource key
(Defined by ControlsExtensions.) | |
HasCssClass |
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
RemoveCssClass |
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
SetCssClasses |
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.) |