QueryDataList Class

QueryDataList control.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      System.Web.UI.WebControls.BaseDataList
        System.Web.UI.WebControls.DataList
          CMS.ExtendedControls.UIDataList
            CMS.Controls.BasicDataList
              CMS.Controls.QueryDataList

Namespace: CMS.Controls
Assembly: CMS.Controls (in CMS.Controls.dll) Version: 8.2.23

Syntax

public class QueryDataList : BasicDataList, 
	ICMSQueryProperties, ICMSBaseProperties

The QueryDataList type exposes the following members.

Constructors

	Name	Description
Public method	QueryDataList	Constructor.

Methods

	Name	Description
Protected method	BoundPagerToDataSource	Bound pager to the external external DataSource (Inherited from BasicDataList.)
Public method	ClearCache	Clears the cached items.
Protected method	CreateControlHierarchy	Creates a control hierarchy with or without the specified data source. (Inherited from BasicDataList.)
Protected method	CreateChildControls	Disable default create child controls. (Overrides BaseDataList.CreateChildControls().)
Public method	DataBind	Databind event. (Overrides BaseDataList.DataBind().)
Public method	GetDefaultCacheDependencies	Gets the default cache dependencies for the data source.
Public method	HasData	Indicates if data source contains data. (Inherited from BasicDataList.)
Protected method	InitControl	Ensures default data binding (Overrides BasicDataList.InitControl(Boolean).)
Protected method	LoadDynamicControls	Handles the Item Create event and creates dynamic control s if present. (Inherited from BasicDataList.)
Protected method	OnInit	Init event handler. (Inherited from BasicDataList.)
Protected method	OnLoad	OnLoad event handler (Inherited from BasicDataList.)
Protected method	PrepareControlHierarchy	Disable prepare control hierarchy. (Overrides DataList.PrepareControlHierarchy().)
Protected method	RaiseOnBeforeInit	Raises the OnBeforeInit event. (Inherited from BasicDataList.)
Public method	ReBind	Evokes control databind. (Inherited from BasicDataList.)
Public method	ReleaseContext	Releases the web part context.
Public method	ReloadData	Loads data from the according to the current values of properties. (Overrides BasicDataList.ReloadData(Boolean).)
Protected method	Render	Render event handler. (Overrides BasicDataList.Render(HtmlTextWriter).)
Public method	SetContext	Sets the web part context.

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
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	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	mControlsLoaded	Flag saying whether the dynamic controls has been loaded yet. (Inherited from BasicDataList.)
Protected field	mDataLoaded	Flag saying whether the data has been loaded yet. (Inherited from BasicDataList.)
Protected field	mDataPager	Data pager.
Protected field	mDataSource	Query data source.
Protected field	mExternalPager	External pager control?
Protected field	mFilterControl	Filter control.
Protected field	mFilterName	Filter name.
Protected field	mOnBeforeInitFired	True if the on before init was fired. (Inherited from BasicDataList.)
Protected field	mPageSizeSet	Indicates if page size property is set.
Protected field	mRelatedData	Custom data connected to the object. (Inherited from BasicDataList.)
Protected field	mRelatedDataLoaded	Related data is loaded. (Inherited from BasicDataList.)
Protected field	NoData	When DataSource is empty NoData = true
Protected field	useDataSourceControl	Indicates whether the viewer should obtain data source from the referenced control provided by the value of DataSourceControl property. (Inherited from BasicDataList.)

Properties

	Name	Description
Public property	AlternatingTransformationName	Transformation name in format application.class.transformation applied to alternating items.
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	Columns	Gets or sets the columns to be retrieved from database.
Public property	ControlContext	Control context.
Public property	DataBindByDefault	Indicates whether data binding should be performed by default. (Inherited from BasicDataList.)
Public property	DataSource	Object from which data-bound control retrieves its list of data item. (Inherited from BasicDataList.)
Public property	DataSourceControl	Control with data source. (Inherited from BasicDataList.)
Public property	DataSourceName	Data source name. (Inherited from BasicDataList.)
Protected property	DefaultDataSource	Default data source to use if no external is provided (Overrides BasicDataList.DefaultDataSource.)
Public property	EnablePaging	Enables paging and show the DataPager control.
Public property	FilterControl	Filter control.
Public property	FilterName	Gets or Set filter name.
Public property	ForceCacheMinutes	Gets or sets the value that indicates whether cache minutes must be set manually (Cache minutes value is independent on view mode and cache settings)
Public property	HideControlForZeroRows	Hides the control when no data is loaded. The default value is False. (Inherited from BasicDataList.)
Public property	IsSelected	Gets or sets the value that indicates whether current datasource contains selected item.
Public property	LoadPagesIndividually	If true, each page is loaded individually in case of paging.
Public property	OrderBy	Property to set and get the OrderBy.
Public property	PageableControl	Gets or sets the encapsulated control that implements IUniPageable interface. (Inherited from BasicDataList.)
Public property	PagerControl	Represents pager control.
Public property	PagerDataItem	Pager data item object. (Inherited from BasicDataList.)
Public property	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 BasicDataList.)
Public property	PageSize	Number of items per page.
Public property	ParentControl	Parent control.
Public property	QueryName	Query name in format application.class.query.
Public property	QueryParameters	Query parameters.
Public property	RelatedData	Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl. (Inherited from BasicDataList.)
Public property	ResolveDynamicControls	Gets or sets the value that indicates whether dynamic controls should be resolved (Inherited from BasicDataList.)
Public property	SelectedColumns	Columns to select.
Public property	SelectedDatabaseColumnName	Gets or sets columns name by which the item is selected.
Public property	SelectedItemTransformationName	Gets or sets ItemTemplate for selected item.
Public property	SelectedQueryStringKeyName	Gets or sets query string key name. Presence of the key in query string indicates, that some item should be selected. The item is determined by query string value.
Public property	SelectedValidationType	Gets or sets validation type for query string value which determines selected item. Options are int, guid and string.
Public property	SelectTopN	Top N rows to select.
Public property	ShortID	Short ID of the control. (Inherited from UIDataList.)
Public property	ShowDeleteButton	Show Delete button.
Public property	ShowEditButton	Show Edit and Delete buttons.
Public property	ShowEditDeleteButtons	Show Edit and Delete buttons.
Public property	SiteName	Gets or sets the site name, this property has no effect in this control.
Public property	StopProcessing	Stop processing.
Public property	TopN	Select top N rows.
Public property	TransformationName	Transformation name in format application.class.transformation.
Public property	UniPagerControl	Pager control. (Inherited from BasicDataList.)
Public property	WhereCondition	Property to set and get the WhereCondition.
Public property	ZeroRowsText	Text to be shown when the control is hidden by HideControlForZeroRows. (Inherited from BasicDataList.)

Events

	Name	Description
Public event	OnBeforeInit	On before init handler. (Inherited from BasicDataList.)
Public event	OnPageBinding	Occurs when the control bind data. (Inherited from BasicDataList.)
Public event	OnPageChanged	Occurs when the pager change the page and current mode is postback => reload data (Inherited from BasicDataList.)