Back to Devexpress

ReportDesignerBuilder.ParameterEditingSettings(Action<ReportDesignerParameterEditingSettings>) Method

xtrareports-devexpress-dot-aspnetcore-dot-reporting-dot-reportdesigner-dot-reportdesignerbuilder-dot-parametereditingsettings-x28-action-reportdesignerparametereditingsettings-x29.md

latest6.1 KB
Original Source

ReportDesignerBuilder.ParameterEditingSettings(Action<ReportDesignerParameterEditingSettings>) Method

Contains settings that configure user interface elements related to the editing of parameters, parameter groups, and parameter separators in the Web Report Designer.

Namespace : DevExpress.AspNetCore.Reporting.ReportDesigner

Assembly : DevExpress.AspNetCore.Reporting.v25.2.dll

NuGet Package : DevExpress.AspNetCore.Reporting

Declaration

csharp
public ReportDesignerBuilder ParameterEditingSettings(
    Action<ReportDesignerParameterEditingSettings> configure
)
vb
Public Function ParameterEditingSettings(
    configure As Action(Of ReportDesignerParameterEditingSettings)
) As ReportDesignerBuilder

Parameters

NameTypeDescription
configureAction<ReportDesignerParameterEditingSettings>

A Action delegate method that allows you to specify editing settings parameters, parameter groups, and parameter separators.

|

Returns

TypeDescription
ReportDesignerBuilder

A ReportDesignerBuilder that can be used to further configure the Report Designer.

|

Remarks

Use the following properties to change the editing settings of parameters, parameter groups, and parameter separators in the Web Report Designer:

AllowEditParameterCollectionHides the UI elements that allow users to add and delete parameters.AllowEditParameterGroupsHides the UI elements that allow users to add and delete parameter groups.AllowEditParameterSeparatorsHides the UI elements that allow users to add and delete parameter separators.AllowEditPropertiesAllows you to disable all property editors for parameters and parameter groups.AllowReorderParametersHides UI elements that allow users to reorder parameters, parameter groups, and parameter separators.

The following code snippet makes parameters, parameter groups, and separators read-only for users (users cannot add or delete parameters/groups/separators, edit their properties, and reorder them). Note that the techniques vary depending on whether you bind the Web Report Designer to a report object (or by a report name) or to a ReportDesignerModel object.

cshtml
@{
    var designerRender = Html.DevExpress().ReportDesigner("reportDesigner")
        .Height("100%")
        .ParameterEditingSettings(configure => {
            configure.AllowEditParameterCollection = false;
            configure.AllowEditParameterSeparators = false;
            configure.AllowEditParameterGroups = false;
            configure.AllowEditProperties = false;
            configure.AllowReorderParameters = false;})
        .Height("100%")
        .Bind("TestReport");
    @designerRender.RenderHtml()
}
cs
public IActionResult ReportDesigner(
    [FromServices] IReportDesignerModelBuilder reportDesignerModelBuilder, 
    [FromQuery] string reportName) {
    // ...
    var designerModel = reportDesignerModelBuilder
        .Report(reportName)
        .BuildModel();
    designerModel.ParameterEditingSettings.AllowEditParameterCollection = false;
    designerModel.ParameterEditingSettings.AllowEditParameterGroups = false;
    designerModel.ParameterEditingSettings.AllowEditParameterSeparators = false;
    designerModel.ParameterEditingSettings.AllowEditProperties = false;
    designerModel.ParameterEditingSettings.AllowReorderParameters = false;
    return View(designerModel);
}

You can handle the CustomizeParameterProperties event to implement a more tailored solution (for example, disable only specific property editors).

See Also

Specify Parameter Editing Settings in ASP.NET Core Applications

ReportDesignerBuilder Class

ReportDesignerBuilder Members

DevExpress.AspNetCore.Reporting.ReportDesigner Namespace