Interface IParameterEditorsBuilder

Represents a builder that provides a fluent API for configuring parameter editors of the MVC Report Viewer. Used to customize the default parameter input controls by specifying JavaScript functions that create alternative UI components for different parameter types.

Namespace: Telerik.ReportViewer.Mvc

Assembly: Telerik.ReportViewer.Mvc.dll

Syntax

public interface IParameterEditorsBuilder

Remarks

All editor functions are executed in the client-side JavaScript context of the MVC Report Viewer.

Methods

BooleanEditor(String)

Attaches a parameter editor that will handle Boolean parameters.

Declaration

IParameterEditorsBuilder BooleanEditor(string createEditorFunction)

Parameters

System.String createEditorFunction The name of the JavaScript function (without parentheses) that creates the Boolean editor UI component.

Returns

IParameterEditorsBuilder The current IParameterEditorsBuilder instance for method chaining.

Remarks

Used for Boolean parameters, typically creating checkboxes, toggle switches, or radio button pairs for true/false values.

CustomEditors(CustomParameterEditor[])

Attaches parameter editors that can handle custom scenarios using both match and create functions for complex parameter matching logic.

Declaration

IParameterEditorsBuilder CustomEditors(params CustomParameterEditor[] customParameterEditors)

Parameters

CustomParameterEditor[] customParameterEditors Array of CustomParameterEditor objects with both match and create functions for custom parameter scenarios.

Returns

IParameterEditorsBuilder The current IParameterEditorsBuilder instance for method chaining.

Remarks

Custom editors are evaluated before all other editors in the specified order, enabling complex matching scenarios like MultiValue DateTime parameters.

DateTimeEditor(String)

Attaches a parameter editor that will handle DateTime parameters.

Declaration

IParameterEditorsBuilder DateTimeEditor(string createEditorFunction)

Parameters

System.String createEditorFunction The name of the JavaScript function (without parentheses) that creates the DateTime editor UI component.

Returns

IParameterEditorsBuilder The current IParameterEditorsBuilder instance for method chaining.

Remarks

Used for DateTime parameters, typically creating date pickers, time pickers, or combined date-time input controls.

DefaultEditor(String)

Attaches a parameter editor that will handle non-defined parameters that don't match any specific type editor.

Declaration

IParameterEditorsBuilder DefaultEditor(string createEditorFunction)

Parameters

System.String createEditorFunction The name of the JavaScript function (without parentheses) that creates the default editor UI component.

Returns

IParameterEditorsBuilder The current IParameterEditorsBuilder instance for method chaining.

Remarks

Serves as a fallback editor for parameters that don't match any specific type or configuration pattern.

MultiSelectEditor(String)

Attaches a parameter editor that will handle parameters that have provided AvailableValues and MultiValue set to true.

Declaration

IParameterEditorsBuilder MultiSelectEditor(string createEditorFunction)

Parameters

System.String createEditorFunction The name of the JavaScript function (without parentheses) that creates the multi-select editor UI component.

Returns

IParameterEditorsBuilder The current IParameterEditorsBuilder instance for method chaining.

Remarks

Used for parameters with predefined value lists that allow multiple selections, such as multi-select dropdowns or checkbox lists.

MultiValueEditor(String)

Attaches a parameter editor that will handle parameters that have MultiValue set to true but have not provided AvailableValues.

Declaration

IParameterEditorsBuilder MultiValueEditor(string createEditorFunction)

Parameters

System.String createEditorFunction The name of the JavaScript function (without parentheses) that creates the multi-value editor UI component.

Returns

IParameterEditorsBuilder The current IParameterEditorsBuilder instance for method chaining.

Remarks

Used for parameters that accept multiple values without predefined lists, such as multi-line text areas or tag input controls.

NumberEditor(String)

Attaches a parameter editor that will handle Numeric parameters.

Declaration

IParameterEditorsBuilder NumberEditor(string createEditorFunction)

Parameters

System.String createEditorFunction The name of the JavaScript function (without parentheses) that creates the Numeric editor UI component.

Returns

IParameterEditorsBuilder The current IParameterEditorsBuilder instance for method chaining.

Remarks

Used for Numeric parameters, typically creating number input controls, sliders, or specialized numeric input widgets.

SingleSelectEditor(String)

Attaches a parameter editor that will handle parameters that have provided AvailableValues and MultiValue set to false.

Declaration

IParameterEditorsBuilder SingleSelectEditor(string createEditorFunction)

Parameters

System.String createEditorFunction The name of the JavaScript function (without parentheses) that creates the single-select editor UI component.

Returns

IParameterEditorsBuilder The current IParameterEditorsBuilder instance for method chaining.

Remarks

Used for parameters with predefined value lists that allow only single selection, such as dropdown lists or radio button groups.

StringEditor(String)

Attaches a parameter editor that will handle String parameters.

Declaration

IParameterEditorsBuilder StringEditor(string createEditorFunction)

Parameters

System.String createEditorFunction The name of the JavaScript function (without parentheses) that creates the String editor UI component.

Returns

IParameterEditorsBuilder The current IParameterEditorsBuilder instance for method chaining.

Remarks

Used for String parameters, typically creating text input controls, text areas, or specialized string input widgets.