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