QueryHelper Class

QueryString helper methods.

Inheritance Hierarchy

System.Object
  CMS.Helpers.QueryHelper

Namespace: CMS.Helpers
Assembly: CMS.Helpers (in CMS.Helpers.dll) Version: 13.0.131

Syntax

public class QueryHelper : IDataContainer, 
	ISimpleDataContainer

The QueryHelper type exposes the following members.

Constructors

	Name	Description
Public method	QueryHelper

Properties

	Name	Description
Public property	ColumnNames	Column names.
Public property Static member	EncodedQueryString	Returns html encoded query string.
Public property Static member	HashEnabled	If true, the hash check is enabled.
Public property Static member	Instance	Singleton Instance of the query helper.
Public property	Item	Gets or sets the value of the column.
Protected property Static member	QueryString	Query string
Protected property Static member	RouteValues	Route data

Methods

	Name	Description
Public method Static member	BuildQuery	Build the query from the given items
Public method Static member	BuildQueryWithHash	Build the query from the given items and adds the hash to the query
Public method Static member	Contains	Returns true if query parameter is present in the query string.
Public method	ContainsColumn	Returns true if the object contains specified column.
Public method Static member	GetBoolean	Returns the boolean representation of a query parameter or default value if parameter is not boolean.
Public method Static member	GetColor	Returns the color representation of a query parameter or default value if parameter is not a valid color.
Public method Static member	GetControlClientId	Returns control client ID from a query parameter or default value if parameter is not a valid control client ID.
Public method Static member	GetDecimal	Returns the decimal representation of a query parameter or default value if parameter is not a decimal number.
Public method Static member	GetDouble	Returns the double representation of a query parameter or default value if parameter is not a double number.
Public method Static member	GetGuid	Returns the GUID representation of a query parameter or default value if parameter is not GUID.
Public method Static member	GetHash(String)	Generates hash for given QueryString.
Public method Static member	GetHash(String, Boolean)	Generates hash for given QueryString.
Public method Static member	GetInteger	Returns the integer representation of a query parameter or default value if parameter is not an integer number.
Public method Static member	GetParameterString	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 method Static member	GetString	Returns query string parameter or default value if query string is not defined.
Public method Static member	GetText	Returns HTML encoded query string parameter or default value if query string is not defined.
Public method	GetValue	Gets the value from QueryString.
Public method	SetValue	Not implemented.
Public method	ToString	Returns the string representation of the query string (Overrides Object.ToString().)
Public method	TryGetValue	Returns value of column.
Public method Static member	ValidateHash(String, String, HashSettings, Boolean)	Validates given QueryString against hash.
Public method Static member	ValidateHash(String, String, String, String, Boolean)	Validates given QueryString against hash.
Public method Static member	ValidateHashString(String, String, HashSettings)	Validates given value against hash.
Public method Static member	ValidateHashString(String, String, String, String)	Validates given value against hash.

Extension Methods

	Name	Description
Public Extension Method	CheckRequiredColumns	Returns true if given list of columns do not have null values in the object (Defined by DataExtensions.)
Public Extension Method	ToJSON	Returns JSON representation of current instance of IDataContainer. (Defined by DataExtensions.)
Public Extension Method	ToXML(XmlWriter, Boolean)	Overloaded. Writes XML representation of current instance of IDataContainer to provided XmlWriter. (Defined by DataExtensions.)
Public Extension Method	ToXML(String, Boolean)	Overloaded. Returns XML representation of current instance of IDataContainer. (Defined by DataExtensions.)
Public Extension Method	ToXML(XmlWriter, List<String>, Boolean)	Overloaded. Writes XML representation of selected columns of current instance of IDataContainer to provided XmlWriter. (Defined by DataExtensions.)