Click or drag to resize
CMSQueryProperties Class
Properties container for the Query based controls.
Inheritance Hierarchy

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 11.0.0
Syntax
C#
public sealed class CMSQueryProperties : CMSAbstractQueryProperties, 
	ICMSQueryProperties, ICMSBaseProperties

The CMSQueryProperties type exposes the following members.

Constructors
  NameDescription
Public methodCMSQueryProperties
Top
Fields
  NameDescription
Protected fieldmControlContext
Control context.
(Inherited from CMSAbstractBaseProperties.)
Protected fieldmParent
Parent control.
(Inherited from CMSAbstractBaseProperties.)
Protected fieldmStopProcessing
Stop processing this control.
(Inherited from CMSAbstractBaseProperties.)
Top
Properties
  NameDescription
Public propertyCacheDependencies
Cache dependencies, each cache dependency on a new line.
(Inherited from CMSAbstractBaseProperties.)
Public propertyCacheItemName
Name of the cache item the control will use.
(Inherited from CMSAbstractBaseProperties.)
Public propertyCacheMinutes
Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
(Inherited from CMSAbstractQueryProperties.)
Public propertyControlContext
Control context.
(Inherited from CMSAbstractBaseProperties.)
Public propertyControlTagKey
Overrides the generation of the SPAN tag with custom tag.
(Inherited from CMSAbstractBaseProperties.)
Public propertyForceCacheMinutes
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)
(Inherited from CMSAbstractQueryProperties.)
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from CMSWebControl.)
Public propertyIsSelected
Gets or sets the value that indicates whether current datasource contains selected item.
(Inherited from CMSAbstractQueryProperties.)
Public propertyOrderBy
ORDER BY part of the SQL statement.
(Inherited from CMSAbstractBaseProperties.)
Public propertyPageSize
Number of items per page.
(Inherited from CMSAbstractQueryProperties.)
Public propertyParentControl
Parent control.
(Inherited from CMSAbstractBaseProperties.)
Public propertyQueryName
Query name in format application.class.query.
(Inherited from CMSAbstractQueryProperties.)
Public propertyQueryParameters
Query parameters.
(Inherited from CMSAbstractQueryProperties.)
Public propertySelectedColumns
Gets or sets the columns to be retrieved from database.
(Inherited from CMSAbstractBaseProperties.)
Public propertySelectedDatabaseColumnName
Gets or sets columns name by which the item is selected.
(Inherited from CMSAbstractQueryProperties.)
Public propertySelectedQueryStringKeyName
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.
(Inherited from CMSAbstractQueryProperties.)
Public propertySelectedValidationType
Gets or sets validation type for query string value which determines selected item. Options are int, guid and string.
(Inherited from CMSAbstractQueryProperties.)
Public propertySelectTopN
Select top N rows.
(Inherited from CMSAbstractQueryProperties.)
Public propertyShortID
Short ID of the control.
(Inherited from CMSWebControl.)
Public propertySiteName
Site code name.
(Inherited from CMSAbstractBaseProperties.)
Public propertyStopProcessing
Indicates if processing of the control should be stopped and the control should not retrieve or display any data.
(Inherited from CMSAbstractBaseProperties.)
Public propertyTopN
Select top N rows.
(Inherited from CMSAbstractBaseProperties.)
Public propertyWhereCondition
WHERE part of the SQL statement.
(Inherited from CMSAbstractBaseProperties.)
Top
Methods
  NameDescription
Public methodClearCache
Clears the cached items.
(Inherited from CMSAbstractQueryProperties.)
Public methodGetCacheDependency
Gets the cache dependency for the control.
(Inherited from CMSAbstractBaseProperties.)
Public methodGetDefaultCacheDependencies
Gets the default cache dependencies for the data source.
(Inherited from CMSAbstractQueryProperties.)
Public methodLoadData(Boolean)
Loads data from the database according to the current values of properties.
(Inherited from CMSAbstractQueryProperties.)
Public methodLoadData(Boolean, Int32, Int32, Int32)
Loads data from the database according to the current values of properties.
(Inherited from CMSAbstractQueryProperties.)
Protected methodOnInit
Init event handler.
(Inherited from CMSWebControl.)
Public methodReleaseContext
Releases the control context.
(Inherited from CMSAbstractBaseProperties.)
Public methodSetContext
Sets the control context.
(Inherited from CMSAbstractBaseProperties.)
Top
Extension Methods
  NameDescription
Public Extension MethodAddCssClass
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodCallHandled
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 MethodGetCssClasses
Returns all CSS classes of control.
(Defined by ControlsExtensions.)
Public Extension MethodGetRenderedHTML
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Public Extension MethodHasCssClass
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodRemoveCssClass
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodSetCssClasses
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.)
Top
See Also