Class QueryHelper

Namespace

CMS.Helpers

Assembly

CMS.Helpers.dll

QueryString helper methods.

public class QueryHelper : IDataContainer, ISimpleDataContainer

Inheritance

object

QueryHelper

Implements

IDataContainer

ISimpleDataContainer

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Properties

ColumnNames

Column names.

public List<string> ColumnNames { get; }

Property Value

List<string>

Instance

Singleton Instance of the query helper.

public static QueryHelper Instance { get; }

Property Value

QueryHelper

this[string]

Gets or sets the value of the column.

public object this[string columnName] { get; set; }

Parameters

columnName string

Column name

Property Value

object

Methods

ContainsColumn(string)

Returns true if the object contains specified column.

public bool ContainsColumn(string columnName)

Parameters

columnName string

Column name

Returns

bool

GetBoolean(string, bool)

Returns the boolean representation of a query parameter or default value if parameter is not boolean.

public static bool GetBoolean(string name, bool defaultValue)

Parameters

name string

Query parameter

defaultValue bool

Default value

Returns

bool

GetGuid(string, Guid)

Returns the GUID representation of a query parameter or default value if parameter is not GUID.

public static Guid GetGuid(string name, Guid defaultValue)

Parameters

name string

Query parameter

defaultValue Guid

Default value

Returns

Guid

GetInteger(string, int)

Returns the integer representation of a query parameter or default value if parameter is not an integer number.

public static int GetInteger(string name, int defaultValue)

Parameters

name string

Query parameter

defaultValue int

Default value

Returns

int

GetParameterString()

Returns string containing all parameters and their values from CMS.Helpers.QueryHelper.RouteValues and CMS.Helpers.QueryHelper.QueryString. Parameters are sorted by their names and merged together with CMS.Helpers.QueryHelper.QueryString having precedence over CMS.Helpers.QueryHelper.RouteValues.

public static string GetParameterString()

Returns

string

GetString(string, string)

Returns query string parameter or default value if query string is not defined.

public static string GetString(string name, string defaultValue)

Parameters

name string

Query parameter

defaultValue string

Default value

Returns

string

GetValue(string)

Gets the value from QueryString.

public object GetValue(string key)

Parameters

key string

QueryString key

Returns

object

SetValue(string, object)

Not implemented.

public bool SetValue(string key, object value)

Parameters

key string

QueryString key

value object

New value

Returns

bool

ToString()

Returns the string representation of the query string

public override string ToString()

Returns

string

TryGetValue(string, out object)

Returns value of column.

public bool TryGetValue(string columnName, out object value)

Parameters

columnName string

Column name

value object

Returns the value

Returns

bool

Returns true if the operation was successful (the value was present)