Class WhereParameters

Namespace

CMS.ContentEngine

Assembly

CMS.ContentEngine.dll

Parameterizes a WHERE condition applied to a content item query via ContentQueryParameters.

public sealed class WhereParameters

Inheritance

object

WhereParameters

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Methods

And()

Sets the where operator, used to combine multiple Where conditions, to AND. This operator is implicit, so it doesn't need to be specified.

public WhereParameters And()

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

Or()

Sets the where operator, used to combine multiple Where conditions, to OR.

public WhereParameters Or()

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

Where(Action<WhereParameters>)

Adds the given where condition tree to the query and puts them into parentheses.

public WhereParameters Where(Action<WhereParameters> whereCondition)

Parameters

whereCondition Action<WhereParameters>

Action configuring the where condition tree using the WhereParameters.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereContains(string, string)

Configures query with condition for a string column to contain some substring.

public WhereParameters WhereContains(string columnName, string value)

Parameters

columnName string

Column name.

value string

Substring to check.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereContainsTags(string, TagCollection)

Configures query with condition for a taxonomy column to contain specified tag collection.

public WhereParameters WhereContainsTags(string taxonomyColumnName, TagCollection tagCollection)

Parameters

taxonomyColumnName string

Taxonomy column name.

tagCollection TagCollection

Tag collection of tags and their children.

Returns

WhereParameters

Remarks

Use Create(IEnumerable<Guid>) or Create(IEnumerable<string>) to include children tags automatically.

WhereContainsTags(string, IEnumerable<Guid>)

Configures query with condition for a taxonomy column to contain specified tags.

public WhereParameters WhereContainsTags(string taxonomyColumnName, IEnumerable<Guid> tagIdentifiers)

Parameters

taxonomyColumnName string

Taxonomy column name.

tagIdentifiers IEnumerable<Guid>

Enumerable of tag identifiers.

Returns

WhereParameters

WhereEmpty(string)

Configures query with condition for a null or empty column value.

public WhereParameters WhereEmpty(string columnName)

Parameters

columnName string

Column name.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereEquals(string, object)

Matches the column to a given value.

public WhereParameters WhereEquals(string columnName, object value)

Parameters

columnName string

Column name.

value object

Value to match with.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereExists(IDataQuery)

Specifies a nested query to test for the existence of rows. Equal to "EXISTS (rows selected by nested query)".

public WhereParameters WhereExists(IDataQuery nestedQuery)

Parameters

nestedQuery IDataQuery

Nested query.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereFalse(string)

Configures query with condition for a false column value (boolean column equals false).

public WhereParameters WhereFalse(string columnName)

Parameters

columnName string

Column name.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereGreater(string, object)

Matches all records that are greater than the provided value.

public WhereParameters WhereGreater(string columnName, object value)

Parameters

columnName string

Column name.

value object

Value to be compared with.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereGreaterOrEquals(string, object)

Matches all records that are greater than or equal to the provided value.

public WhereParameters WhereGreaterOrEquals(string columnName, object value)

Parameters

columnName string

Column name.

value object

Value to be compared with.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereIn(string, IDataQuery)

Compares the column against the results of a nested query. Equal to "columnName IN (values selected by nested query)".

public WhereParameters WhereIn(string columnName, IDataQuery nestedQuery)

Parameters

columnName string

Column name.

nestedQuery IDataQuery

Nested query.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereIn(string, ICollection<Guid>)

Compares the column against a collection of values. Equal to "columnName IN (value1, value2, ...)".

public WhereParameters WhereIn(string columnName, ICollection<Guid> values)

Parameters

columnName string

Column name.

values ICollection<Guid>

Collection of values for the query.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereIn(string, ICollection<int>)

Compares the column against a collection of values. Equal to "columnName IN (value1, value2, ...)".

public WhereParameters WhereIn(string columnName, ICollection<int> values)

Parameters

columnName string

Column name.

values ICollection<int>

Collection of values for the query.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereIn(string, ICollection<string>)

Compares the column against a collection of values. Equal to "columnName IN (value1, value2, ...)".

public WhereParameters WhereIn(string columnName, ICollection<string> values)

Parameters

columnName string

Column name.

values ICollection<string>

Collection of values for the query.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereIn(string, IEnumerable<Guid>)

Compares the column against a collection of values. Equal to "columnName IN (value1, value2, ...)".

public WhereParameters WhereIn(string columnName, IEnumerable<Guid> values)

Parameters

columnName string

Column name.

values IEnumerable<Guid>

Collection of values for the query.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereIn(string, IEnumerable<int>)

Compares the column against a collection of values. Equal to "columnName IN (value1, value2, ...)".

public WhereParameters WhereIn(string columnName, IEnumerable<int> values)

Parameters

columnName string

Column name.

values IEnumerable<int>

Collection of values for the query.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereIn(string, IEnumerable<string>)

Compares the column against a collection of values. Equal to "columnName IN (value1, value2, ...)".

public WhereParameters WhereIn(string columnName, IEnumerable<string> values)

Parameters

columnName string

Column name.

values IEnumerable<string>

Collection of values for the query.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereLess(string, object)

Matches all records that are less than the provided value.

public WhereParameters WhereLess(string columnName, object value)

Parameters

columnName string

Column name.

value object

Value to be compared with.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereLessOrEquals(string, object)

Matches all records that are less than or equal to the provided value.

public WhereParameters WhereLessOrEquals(string columnName, object value)

Parameters

columnName string

Column name.

value object

Value to be compared with.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereLike(string, string)

Matches the column to a given value using LIKE operator.

public WhereParameters WhereLike(string columnName, string value)

Parameters

columnName string

Column name.

value string

Value to match with.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereNotContains(string, string)

Configures query with condition for a string column not to contain some substring.

public WhereParameters WhereNotContains(string columnName, string value)

Parameters

columnName string

Column name.

value string

Substring to check.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereNotEmpty(string)

Configures query with condition for a non empty column value.

public WhereParameters WhereNotEmpty(string columnName)

Parameters

columnName string

Column name.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereNotEquals(string, object)

Matches the column which is not equal to a given value.

public WhereParameters WhereNotEquals(string columnName, object value)

Parameters

columnName string

Column name.

value object

Value to match with.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereNotExists(IDataQuery)

Specifies a nested query to test for the existence of rows. Equal to "NOT EXISTS (rows selected by nested query)".

public WhereParameters WhereNotExists(IDataQuery nestedQuery)

Parameters

nestedQuery IDataQuery

Nested query.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereNotIn(string, IDataQuery)

Compares the column against the results of a nested query. Equal to "columnName NOT IN (values selected by nested query)".

public WhereParameters WhereNotIn(string columnName, IDataQuery nestedQuery)

Parameters

columnName string

Column name.

nestedQuery IDataQuery

Nested query.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereNotIn(string, ICollection<Guid>)

Compares the column against a collection of values. Equal to "columnName NOT IN (value1, value2, ...)".

public WhereParameters WhereNotIn(string columnName, ICollection<Guid> values)

Parameters

columnName string

Column name.

values ICollection<Guid>

Collection of values for the query.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereNotIn(string, ICollection<int>)

Compares the column against a collection of values. Equal to "columnName NOT IN (value1, value2, ...)".

public WhereParameters WhereNotIn(string columnName, ICollection<int> values)

Parameters

columnName string

Column name.

values ICollection<int>

Collection of values for the query.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereNotIn(string, ICollection<string>)

Compares the column against a collection of values. Equal to "columnName NOT IN (value1, value2, ...)".

public WhereParameters WhereNotIn(string columnName, ICollection<string> values)

Parameters

columnName string

Column name.

values ICollection<string>

Collection of values for the query.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereNotIn(string, IEnumerable<Guid>)

Compares the column against a collection of values. Equal to "columnName NOT IN (value1, value2, ...)".

public WhereParameters WhereNotIn(string columnName, IEnumerable<Guid> values)

Parameters

columnName string

Column name.

values IEnumerable<Guid>

Collection of values for the query.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereNotIn(string, IEnumerable<int>)

Compares the column against a collection of values. Equal to "columnName NOT IN (value1, value2, ...)".

public WhereParameters WhereNotIn(string columnName, IEnumerable<int> values)

Parameters

columnName string

Column name.

values IEnumerable<int>

Collection of values for the query.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereNotIn(string, IEnumerable<string>)

Compares the column against a collection of values. Equal to "columnName NOT IN (value1, value2, ...)".

public WhereParameters WhereNotIn(string columnName, IEnumerable<string> values)

Parameters

columnName string

Column name.

values IEnumerable<string>

Collection of values for the query.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereNotLike(string, string)

Matches the column to a given value using NOT LIKE operator.

public WhereParameters WhereNotLike(string columnName, string value)

Parameters

columnName string

Column name.

value string

Value to match with.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereNotNull(string)

Configures query with condition for a not null column value.

public WhereParameters WhereNotNull(string columnName)

Parameters

columnName string

Column name.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereNotStartsWith(string, string)

Selects records that do not begin with the specified characters.

public WhereParameters WhereNotStartsWith(string columnName, string value)

Parameters

columnName string

Column name.

value string

Characters to match with.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereNull(string)

Configures query with condition for a null column value.

public WhereParameters WhereNull(string columnName)

Parameters

columnName string

Column name.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereStartsWith(string, string)

Selects records that begin with the specified characters.

public WhereParameters WhereStartsWith(string columnName, string value)

Parameters

columnName string

Column name.

value string

Characters to match with.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.

WhereTrue(string)

Configures query with condition for a true column value (boolean column equals true).

public WhereParameters WhereTrue(string columnName)

Parameters

columnName string

Column name.

Returns

WhereParameters

Returns this WhereParameters instance to chain further configuration of WHERE parameters.