CMSAbstractControlFilterControl Class |
Namespace: CMS.DocumentEngine.Web.UI
public abstract class CMSAbstractControlFilterControl : CMSAbstractBaseFilterControl, ICMSControlProperties, ICMSBaseProperties
The CMSAbstractControlFilterControl type exposes the following members.
Name | Description | |
---|---|---|
![]() | CMSAbstractControlFilterControl |
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 |
Classname 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.) |
![]() | 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.) |
![]() | DisableFilterCaching |
Enables or disables filter caching.
(Inherited from CMSAbstractBaseFilterControl.) |
![]() | DocumentManager |
Document manager control
(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.) |
![]() | 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.) |
![]() | MaxRelativeLevel |
Relative level of child documents that should be selected. -1 selects all child documents.
|
![]() | MessagesPlaceHolder |
Placeholder for messages
(Inherited from AbstractUserControl.) |
![]() | OrderBy |
Property to set and get the OrderBy.
(Inherited from CMSAbstractBaseFilterControl.) |
![]() | Parameters |
Hashtable with additional parameters.
(Inherited from CMSAbstractBaseFilterControl.) |
![]() | Path |
Path of the documents to be displayed. /% selects all documents.
|
![]() ![]() | 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.
|
![]() | 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.) |
![]() | TreeProvider |
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
|
![]() | 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.) |
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.) |
![]() | 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.) |
![]() | EvalDouble |
Evaluates the item data and converts it to the integer.
(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.) |
![]() | GetDefaultCacheDependencies |
Gets the default cache dependencies for the data source.
(Inherited from CMSAbstractBaseFilterControl.) |
![]() | 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.) |
![]() | 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 |
Initialize data properties from property object.
(Overrides CMSAbstractBaseFilterControlInitDataProperties(ICMSBaseProperties).) |
![]() | InvalidateLoadedData |
Invalidate loaded data.
(Inherited from CMSAbstractBaseFilterControl.) |
![]() | 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 |
Propagates given settings
(Inherited from CMSAbstractBaseFilterControl.) |
![]() | RaiseOnFilterChanged |
Run OnDataFilterChanged handler.
(Inherited from CMSAbstractBaseFilterControl.) |
![]() | RegisterOnFilterChangedHandler |
Register OnFilterChanged handler
(Inherited from CMSAbstractBaseFilterControl.) |
![]() | ReloadData |
Reload control data.
|
![]() | Render |
Render event handler.
(Inherited from AbstractUserControl.) |
![]() | ResetFilter |
Resets filter to default state.
(Inherited from CMSAbstractBaseFilterControl.) |
![]() | ResetPager |
Resets pager data
(Inherited from CMSAbstractBaseFilterControl.) |
![]() | ResolveUrl |
Resolves the given URL
(Inherited from AbstractUserControl.) |
![]() | RestoreFilterState |
Restores filter state from the specified object.
(Inherited from CMSAbstractBaseFilterControl.) |
![]() | ShowConfirmation |
Shows the general confirmation message.
(Inherited from AbstractUserControl.) |
![]() | ShowError |
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) |
![]() | ShowChangesSaved |
Shows the general changes saved message.
(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.) |
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.) |
Name | Description | |
---|---|---|
![]() | OnFilterChanged |
Filter change handler.
(Inherited from CMSAbstractBaseFilterControl.) |