New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

FilterFieldBuilder<T>

Class

Defines the fluent API for configuring the FilterField settings.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

Syntax:

public class FilterFieldBuilder<T>

Inheritance: objectFilterFieldBuilder<T>

Inherited Members object.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

FilterFieldBuilder(FilterField<T>)

Initialize the FilterFieldBuilder

public FilterFieldBuilder(FilterField<T> settings)

Parameters:settingsFilterField<T>

The FilterField

Methods

DefaultValue(object)

A value which will be initially set as a filter value when an expression item for the specific field is created.

public FilterFieldBuilder<T> DefaultValue(object value)

Parameters:valueobject

The value for DefaultValue

Returns:

FilterFieldBuilder<T>

Example:

@(Html.Kendo().Filter&lt;ProductViewModel&gt;()
.Name("filter")
.Fields(fields =&gt;
{
fields.Add(field =&gt; field.ProductName)
.DefaultValue("Chai");
})
)

EditorTemplate(string)

The template which the widget will use to create the field editor.

public FilterFieldBuilder<T> EditorTemplate(string value)

Parameters:valuestring

The value that configures the editortemplate.

Returns:

FilterFieldBuilder<T>

EditorTemplateHandler(Func<object, object>)

The template which the widget will use to create the field editor.

public FilterFieldBuilder<T> EditorTemplateHandler(Func<object, object> value)

Parameters:valueFunc<object, object>

The value for EditorTemplate

Returns:

FilterFieldBuilder<T>

Example:

@(Html.Kendo().Filter&lt;ProductViewModel&gt;()
.Name("filter")
.Fields(fields =&gt;
{
fields.Add(product =&gt; product.ProductName)
.EditorTemplateHandler(@&lt;text&gt;
function editorTemplateHandler(e){
editor template handling code
}
&lt;/text&gt;);
})
)

EditorTemplateHandler(string)

The template which the widget will use to create the field editor.

public FilterFieldBuilder<T> EditorTemplateHandler(string value)

Parameters:valuestring

The value for EditorTemplate

Returns:

FilterFieldBuilder<T>

Example:

@(Html.Kendo().Filter&lt;ProductViewModel&gt;()
.Name("filter")
.Fields(fields =&gt;
{
fields.Add(field =&gt; field.ProductName)
.EditorTemplateHandler("editorTemplateHandler");
})
)

EditorTemplateId(string)

The template which the widget will use to create the field editor.

public FilterFieldBuilder<T> EditorTemplateId(string value)

Parameters:valuestring

The value that configures the editortemplate.

Returns:

FilterFieldBuilder<T>

EditorTemplateView(MvcHtmlString)

The template which the widget will use to create the field editor.

public FilterFieldBuilder<T> EditorTemplateView(MvcHtmlString value)

Parameters:valueMvcHtmlString

The value that configures the editortemplate.

Returns:

FilterFieldBuilder<T>

Label(string)

Defines a value which will be visualized instead of the data feild name.

public FilterFieldBuilder<T> Label(string value)

Parameters:valuestring

The value that configures the label.

Returns:

FilterFieldBuilder<T>

Operators(Action<FilterOperatorsSettingsBuilder>)

The text of the filter operators displayed in the filter.

public FilterFieldBuilder<T> Operators(Action<FilterOperatorsSettingsBuilder> configurator)

Parameters:configuratorAction<FilterOperatorsSettingsBuilder>

The configurator for the operators setting.

Returns:

FilterFieldBuilder<T>

Example:

@(Html.Kendo().Filter&lt;ProductViewModel&gt;()
.Name("filter")
.Fields(fields =&gt;
{
fields.Add(product =&gt; product.ProductName)
.Label("ProductName")
.Operators(operators =&gt;
{
operators.String(s =&gt;
{
s.Contains("Contains")
.Startswith("Starts with")
.Endswith("Ends with")
.Eq("Equals")
.Neq("Does not equal")
.Isnull("Is null")
.Isnotnull("Is not null")
.Isnotempty("Is not empty")
.Isnullorempty("Is null or empty")
.Isnotnullorempty("Is not null or empty")
.Contains("Contains")
.Doesnotcontain("Does not contain");
});
});
})
)

PreviewFormat(string)

Sets the format of the value in the preview.

public FilterFieldBuilder<T> PreviewFormat(string value)

Parameters:valuestring

The format.

Returns:

FilterFieldBuilder<T>

Example:

@(Html.Kendo().Filter&lt;ProductViewModel&gt;()
.Name("filter")
.Fields(fields =&gt;
{
fields.Add(field =&gt; field.UnitPrice)
.PreviewFormat("n2");
})
)