The CMSQueryProperties type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
Name | Description | |
---|---|---|
CMSQueryProperties |
Methods
Name | Description | |
---|---|---|
AddAttributesToRender | Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers. (Inherited from WebControl.) | |
AddedControl | (Inherited from Control.) | |
AddParsedSubObject | Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. (Inherited from Control.) | |
ApplyStyle | Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. (Inherited from WebControl.) | |
ApplyStyleSheetSkin | Applies the style properties defined in the page style sheet to the control. (Inherited from Control.) | |
BuildProfileTree | Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control.) | |
ClearCache |
Clears the cached items.
(Inherited from CMSAbstractQueryProperties.) | |
ClearCachedClientID | Sets the cached ClientID value to null. (Inherited from Control.) | |
ClearEffectiveClientIDMode | Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control.) | |
ClearChildControlState | Deletes the control-state information for the server control's child controls. (Inherited from Control.) | |
ClearChildState | Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.) | |
ClearChildViewState | Deletes the view-state information for all the server control's child controls. (Inherited from Control.) | |
CopyBaseAttributes | Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. (Inherited from WebControl.) | |
CreateControlCollection | Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.) | |
CreateControlStyle | Creates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers. (Inherited from WebControl.) | |
CreateChildControls | Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering. (Inherited from Control.) | |
DataBind | Binds a data source to the invoked server control and all its child controls. (Inherited from Control.) | |
DataBind(Boolean) | Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control.) | |
DataBindChildren | Binds a data source to the server control's child controls. (Inherited from Control.) | |
Dispose | Enables a server control to perform final clean up before it is released from memory. (Inherited from Control.) | |
EnsureChildControls | Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.) | |
EnsureID | Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control.) | |
Equals | (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
FindControl(String) | Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.) | |
FindControl(String, Int32) | Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method. (Inherited from Control.) | |
Focus | Sets input focus to a control. (Inherited from Control.) | |
GetCacheDependency |
Gets the cache dependency for the control.
(Inherited from CMSAbstractBaseProperties.) | |
GetDefaultCacheDependencies |
Gets the default cache dependencies for the data source.
(Inherited from CMSAbstractQueryProperties.) | |
GetDesignModeState | Gets design-time data for a control. (Inherited from Control.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetRouteUrl(Object) | Gets the URL that corresponds to a set of route parameters. (Inherited from Control.) | |
GetRouteUrl(RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters. (Inherited from Control.) | |
GetRouteUrl(String, Object) | Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.) | |
GetRouteUrl(String, RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetUniqueIDRelativeTo | Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.) | |
HasControls | Determines if the server control contains any child controls. (Inherited from Control.) | |
HasEvents | Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.) | |
IsLiteralContent | Determines if the server control holds only literal content. (Inherited from Control.) | |
LoadControlState | Restores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.) | |
LoadData(Boolean) |
Loads data from the database according to the current values of properties.
(Inherited from CMSAbstractQueryProperties.) | |
LoadData(Boolean, Int32, Int32, Int32 ) |
Loads data from the database according to the current values of properties.
(Inherited from CMSAbstractQueryProperties.) | |
LoadViewState | Restores view-state information from a previous request that was saved with the SaveViewState method. (Inherited from WebControl.) | |
MapPathSecure | Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
MergeStyle | Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. (Inherited from WebControl.) | |
OnBubbleEvent | Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.) | |
OnDataBinding | Raises the DataBinding event. (Inherited from Control.) | |
OnInit |
Init event handler.
(Inherited from CMSWebControl.) | |
OnLoad | Raises the Load event. (Inherited from Control.) | |
OnPreRender | Raises the PreRender event. (Inherited from Control.) | |
OnUnload | Raises the Unload event. (Inherited from Control.) | |
OpenFile | Gets a Stream used to read a file. (Inherited from Control.) | |
RaiseBubbleEvent | Assigns any sources of the event and its information to the control's parent. (Inherited from Control.) | |
ReleaseContext |
Releases the control context.
(Inherited from CMSAbstractBaseProperties.) | |
RemovedControl | (Inherited from Control.) | |
Render | Renders the control to the specified HTML writer. (Inherited from WebControl.) | |
RenderBeginTag | Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) | |
RenderContents | Renders the contents of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) | |
RenderControl(HtmlTextWriter) | Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control.) | |
RenderControl(HtmlTextWriter, ControlAdapter) | Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.) | |
RenderEndTag | Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) | |
RenderChildren | Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control.) | |
ResolveAdapter | Gets the control adapter responsible for rendering the specified control. (Inherited from Control.) | |
ResolveClientUrl | Gets a URL that can be used by the browser. (Inherited from Control.) | |
ResolveUrl | Converts a URL into one that is usable on the requesting client. (Inherited from Control.) | |
SaveControlState | Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.) | |
SaveViewState | Saves any state that was modified after the TrackViewState method was invoked. (Inherited from WebControl.) | |
SetContext |
Sets the control context.
(Inherited from CMSAbstractBaseProperties.) | |
SetDesignModeState | Sets design-time data for a control. (Inherited from Control.) | |
SetRenderMethodDelegate | Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
TrackViewState | Causes the control to track changes to its view state so they can be stored in the object's ViewState property. (Inherited from WebControl.) |
Extension Methods
Name | Description | |
---|---|---|
AddCssClass |
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
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.) | |
GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
GetCssClasses |
Returns all CSS classes of control.
(Defined by ControlsExtensions.) | |
GetRenderedHTML |
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.) | |
GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
HasCssClass |
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
RemoveCssClass |
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
SetCssClasses |
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.) | |
ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
Fields
Name | Description | |
---|---|---|
mControlContext |
Control context.
(Inherited from CMSAbstractBaseProperties.) | |
mParent |
Parent control.
(Inherited from CMSAbstractBaseProperties.) | |
mStopProcessing |
Stop processing this control.
(Inherited from CMSAbstractBaseProperties.) |
Properties
Name | Description | |
---|---|---|
AccessKey | Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.) | |
Adapter | Gets the browser-specific adapter for the control. (Inherited from Control.) | |
AppRelativeTemplateSourceDirectory | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.) | |
Attributes | Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.) | |
BackColor | Gets or sets the background color of the Web server control. (Inherited from WebControl.) | |
BindingContainer | Gets the control that contains this control's data binding. (Inherited from Control.) | |
BorderColor | Gets or sets the border color of the Web control. (Inherited from WebControl.) | |
BorderStyle | Gets or sets the border style of the Web server control. (Inherited from WebControl.) | |
BorderWidth | Gets or sets the border width of the Web server control. (Inherited from WebControl.) | |
CacheDependencies |
Cache dependencies, each cache dependency on a new line.
(Inherited from CMSAbstractBaseProperties.) | |
CacheItemName |
Name of the cache item the control will use.
(Inherited from CMSAbstractBaseProperties.) | |
CacheMinutes |
Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
(Inherited from CMSAbstractQueryProperties.) | |
ClientID | Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.) | |
ClientIDMode | Gets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control.) | |
ClientIDSeparator | Gets a character value representing the separator character used in the ClientID property. (Inherited from Control.) | |
Context | Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.) | |
ControlContext |
Control context.
(Inherited from CMSAbstractBaseProperties.) | |
Controls | Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from Control.) | |
ControlStyle | Gets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.) | |
ControlStyleCreated | Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. (Inherited from WebControl.) | |
ControlTagKey |
Overrides the generation of the SPAN tag with custom tag.
(Inherited from CMSAbstractBaseProperties.) | |
CssClass | Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.) | |
DataItemContainer | Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.) | |
DataKeysContainer | Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control.) | |
DesignMode | Gets a value indicating whether a control is being used on a design surface. (Inherited from Control.) | |
Enabled | Gets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl.) | |
EnableTheming | Gets or sets a value indicating whether themes apply to this control. (Inherited from WebControl.) | |
EnableViewState | Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from Control.) | |
Events | Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.) | |
Font | Gets the font properties associated with the Web server control. (Inherited from WebControl.) | |
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)
(Inherited from CMSAbstractQueryProperties.) | |
ForeColor | Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.) | |
HasAttributes | Gets a value indicating whether the control has attributes set. (Inherited from WebControl.) | |
HasChildViewState | Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.) | |
Height | Gets or sets the height of the Web server control. (Inherited from WebControl.) | |
ChildControlsCreated | Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control.) | |
ID | Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.) | |
IdSeparator | Gets the character used to separate control identifiers. (Inherited from Control.) | |
IsEnabled | Gets a value indicating whether the control is enabled. (Inherited from WebControl.) | |
IsChildControlStateCleared | Gets a value indicating whether controls contained within this control have control state. (Inherited from Control.) | |
IsLiveSite |
Indicates if control is used on live site.
(Inherited from CMSWebControl.) | |
IsSelected |
Gets or sets the value that indicates whether current datasource contains selected item.
(Inherited from CMSAbstractQueryProperties.) | |
IsTrackingViewState | Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.) | |
IsViewStateEnabled | Gets a value indicating whether view state is enabled for this control. (Inherited from Control.) | |
LoadViewStateByID | Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.) | |
NamingContainer | Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. (Inherited from Control.) | |
OrderBy |
ORDER BY part of the SQL statement.
(Inherited from CMSAbstractBaseProperties.) | |
Page | Gets a reference to the Page instance that contains the server control. (Inherited from Control.) | |
PageSize |
Number of items per page.
(Inherited from CMSAbstractQueryProperties.) | |
Parent | Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.) | |
ParentControl |
Parent control.
(Inherited from CMSAbstractBaseProperties.) | |
QueryName |
Query name in format application.class.query.
(Inherited from CMSAbstractQueryProperties.) | |
QueryParameters |
Query parameters.
(Inherited from CMSAbstractQueryProperties.) | |
RenderingCompatibility | Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.) | |
SelectedColumns |
Gets or sets the columns to be retrieved from database.
(Inherited from CMSAbstractBaseProperties.) | |
SelectedDatabaseColumnName |
Gets or sets columns name by which the item is selected.
(Inherited from CMSAbstractQueryProperties.) | |
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.
(Inherited from CMSAbstractQueryProperties.) | |
SelectedValidationType |
Gets or sets validation type for query string value which determines selected item.
Options are int, guid and string.
(Inherited from CMSAbstractQueryProperties.) | |
SelectTopN |
Select top N rows.
(Inherited from CMSAbstractQueryProperties.) | |
ShortID |
Short ID of the control.
(Inherited from CMSWebControl.) | |
Site | Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.) | |
SiteName |
Site code name.
(Inherited from CMSAbstractBaseProperties.) | |
SkinID | Gets or sets the skin to apply to the control. (Inherited from WebControl.) | |
StopProcessing |
Indicates if processing of the control should be stopped and the control should not retrieve or display any data.
(Inherited from CMSAbstractBaseProperties.) | |
Style | Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from WebControl.) | |
SupportsDisabledAttribute | Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false. (Inherited from WebControl.) | |
TabIndex | Gets or sets the tab index of the Web server control. (Inherited from WebControl.) | |
TagKey | Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Inherited from WebControl.) | |
TagName | Gets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.) | |
TemplateControl | Gets or sets a reference to the template that contains this control. (Inherited from Control.) | |
TemplateSourceDirectory | Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.) | |
ToolTip | Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.) | |
TopN |
Select top N rows.
(Inherited from CMSAbstractBaseProperties.) | |
UIContext |
Returns control's UI context
(Inherited from CMSWebControl.) | |
UniqueID | Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.) | |
ViewState | Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from Control.) | |
ViewStateIgnoresCase | Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.) | |
ViewStateMode | Gets or sets the view-state mode of this control. (Inherited from Control.) | |
Visible | Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.) | |
WhereCondition |
WHERE part of the SQL statement.
(Inherited from CMSAbstractBaseProperties.) | |
Width | Gets or sets the width of the Web server control. (Inherited from WebControl.) |
Events
Name | Description | |
---|---|---|
DataBinding | Occurs when the server control binds to a data source. (Inherited from Control.) | |
Disposed | Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control.) | |
Init | Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.) | |
Load | Occurs when the server control is loaded into the Page object. (Inherited from Control.) | |
PreRender | Occurs after the Control object is loaded but prior to rendering. (Inherited from Control.) | |
Unload | Occurs when the server control is unloaded from memory. (Inherited from Control.) |
See Also