CMSAbstractBaseFilterControl Class

Abstract class for filter controls.

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
            More...

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

Syntax

public abstract class CMSAbstractBaseFilterControl : AbstractUserControl, 
	ICMSBaseProperties, IFilterControl

The CMSAbstractBaseFilterControl type exposes the following members.

Constructors

	Name	Description
Protected method	CMSAbstractBaseFilterControl

Properties

	Name	Description
Protected property	BaseProperties	Data properties
Public property	CacheDependencies	Cache dependencies, each cache dependency on a new line.
Public property	CacheItemName	Name of the cache item the control will use.
Public property	CacheMinutes	Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
Public property	ComponentName	Component name (Inherited from AbstractUserControl.)
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	DisableFilterCaching	Enables or disables filter caching.
Public property	DocumentManager	Document manager control (Inherited from AbstractUserControl.)
Public property	FilterChanged	Property to set and get the Filter changed.
Public property	FilterControl	Data filter control.
Public property	FilterControlPath	Gets or sets the path of the filter control.
Public property	FilteredControl	Filtered control.
Public property	FilterIsSet	Property to get if the filter is set.
Public property	FilterMode	Allow to set filter mode (useful if same filter is used to filter different items)
Public property	FilterName	Property to set and get the Filter name.
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	MessagesPlaceHolder	Placeholder for messages (Inherited from AbstractUserControl.)
Public property	OrderBy	Property to set and get the OrderBy.
Public property	Parameters	Hashtable with additional parameters.
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.
Public property	SelectedValue	This value is used to initialize filter control according to currently selected value.
Public property	ShortID	Short ID of the control. (Inherited from AbstractUserControl.)
Public property	SiteID	Property to set and get the filter SiteID.
Public property	SiteName	Property to set and get the SiteName.
Public property	SourceFilterControl	Gets the source filter control.
Public property	SourceFilterName	Gets or sets the source filter name.
Public property	StopProcessing	Stop processing. (Overrides AbstractUserControl.StopProcessing.)
Public property	ToggleAdvancedModeButton	Gets button used to toggle filter's advanced mode.
Public property	TopN	Property to set and get the Top N property.
Public property	UsesLocalMessagesPlaceHolder	Indicates if control uses local messages placeholder (Inherited from AbstractUserControl.)
Public property	Value	Filter value.
Public property	WhereCondition	Property to set and get the WhereCondition.

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	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.
Public method	GetDefaultCacheDependencies	Gets the default cache dependencies for the data source.
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.)
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	Initialize data properties from property object.
Public method	InvalidateLoadedData	Invalidate loaded data.
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. (Overrides AbstractUserControl.OnInit(EventArgs).)
Protected method	OnLoad	Load event handler. (Overrides AbstractUserControl.OnLoad(EventArgs).)
Protected method	OnPreRender	PreRender event handler. (Inherited from AbstractUserControl.)
Protected method	PropagateProperties	Propagates given settings
Public method	RaiseOnFilterChanged	Run OnDataFilterChanged handler.
Protected method	RegisterOnFilterChangedHandler	Register OnFilterChanged handler
Protected method	Render	Render event handler. (Inherited from AbstractUserControl.)
Public method	ResetFilter	Resets filter to default state.
Protected method	ResetPager	Resets pager data
Public method	ResolveUrl	Resolves the given URL (Inherited from AbstractUserControl.)
Public method	RestoreFilterState	Restores filter state from the specified object.
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.
Public method	StoreFilterState	Stores filter state to the specified object.
Protected method	ToggleAdvancedModeButton_Click	Toggle advanced mode button click event

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.