Click or drag to resize
QueryHelper Class
QueryString helper methods.
Inheritance Hierarchy
SystemObject
  CMS.HelpersQueryHelper

Namespace: CMS.Helpers
Assembly: CMS.Helpers (in CMS.Helpers.dll) Version: 13.0.131
Syntax
C#
public class QueryHelper : IDataContainer, 
	ISimpleDataContainer

The QueryHelper type exposes the following members.

Constructors
  NameDescription
Public methodQueryHelper
Top
Properties
  NameDescription
Public propertyColumnNames
Column names.
Public propertyStatic memberEncodedQueryString
Returns html encoded query string.
Public propertyStatic memberHashEnabled
If true, the hash check is enabled.
Public propertyStatic memberInstance
Singleton Instance of the query helper.
Public propertyItem
Gets or sets the value of the column.
Protected propertyStatic memberQueryString
Query string
Protected propertyStatic memberRouteValues
Route data
Top
Methods
  NameDescription
Public methodStatic memberBuildQuery
Build the query from the given items
Public methodStatic memberBuildQueryWithHash
Build the query from the given items and adds the hash to the query
Public methodStatic memberContains
Returns true if query parameter is present in the query string.
Public methodContainsColumn
Returns true if the object contains specified column.
Public methodStatic memberGetBoolean
Returns the boolean representation of a query parameter or default value if parameter is not boolean.
Public methodStatic memberGetColor
Returns the color representation of a query parameter or default value if parameter is not a valid color.
Public methodStatic memberGetControlClientId
Returns control client ID from a query parameter or default value if parameter is not a valid control client ID.
Public methodStatic memberGetDecimal
Returns the decimal representation of a query parameter or default value if parameter is not a decimal number.
Public methodStatic memberGetDouble
Returns the double representation of a query parameter or default value if parameter is not a double number.
Public methodStatic memberGetGuid
Returns the GUID representation of a query parameter or default value if parameter is not GUID.
Public methodStatic memberGetHash(String)
Generates hash for given QueryString.
Public methodStatic memberGetHash(String, Boolean)
Generates hash for given QueryString.
Public methodStatic memberGetInteger
Returns the integer representation of a query parameter or default value if parameter is not an integer number.
Public methodStatic memberGetParameterString
Returns string containing all parameters and their values from RouteValues and QueryString. Parameters are sorted by their names and merged together with QueryString having precedence over RouteValues.
Public methodStatic memberGetString
Returns query string parameter or default value if query string is not defined.
Public methodStatic memberGetText
Returns HTML encoded query string parameter or default value if query string is not defined.
Public methodGetValue
Gets the value from QueryString.
Public methodSetValue
Not implemented.
Public methodToString
Returns the string representation of the query string
(Overrides ObjectToString.)
Public methodTryGetValue
Returns value of column.
Public methodStatic memberValidateHash(String, String, HashSettings, Boolean)
Validates given QueryString against hash.
Public methodStatic memberValidateHash(String, String, String, String, Boolean)
Validates given QueryString against hash.
Public methodStatic memberValidateHashString(String, String, HashSettings)
Validates given value against hash.
Public methodStatic memberValidateHashString(String, String, String, String)
Validates given value against hash.
Top
Extension Methods
  NameDescription
Public Extension MethodCheckRequiredColumns
Returns true if given list of columns do not have null values in the object
(Defined by DataExtensions.)
Public Extension MethodToJSON
Returns JSON representation of current instance of IDataContainer.
(Defined by DataExtensions.)
Public Extension MethodToXML(XmlWriter, Boolean)Overloaded.
Writes XML representation of current instance of IDataContainer to provided XmlWriter.
(Defined by DataExtensions.)
Public Extension MethodToXML(String, Boolean)Overloaded.
Returns XML representation of current instance of IDataContainer.
(Defined by DataExtensions.)
Public Extension MethodToXML(XmlWriter, ListString, Boolean)Overloaded.
Writes XML representation of selected columns of current instance of IDataContainer to provided XmlWriter.
(Defined by DataExtensions.)
Top
See Also