ReportDesignerParameterEditingSettings Class

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.XtraReports.Web.ReportDesigner.DataContracts

Assembly: DevExpress.Data.v24.1.dll

NuGet Package: DevExpress.Data

Declaration

C#

[DataContract]
public class ReportDesignerParameterEditingSettings :
    SerializableSettingsBase

VB.NET

<DataContract>
Public Class ReportDesignerParameterEditingSettings
    Inherits SerializableSettingsBase

Related API Members

The following members return ReportDesignerParameterEditingSettings objects:

• ReportDesignerSettingsBase.ParameterEditingSettings

Remarks

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

AllowEditParameterCollection

Hides the UI elements that allow users to add and delete parameters.

AllowEditParameterGroups

Hides the UI elements that allow users to add and delete parameter groups.

AllowEditParameterSeparators

Hides the UI elements that allow users to add and delete parameter separators.

AllowEditProperties

Allows you to disable all property editors for parameters and parameter groups.

AllowEditParameterCollection

Hides the UI elements that allow users to add and delete parameters.

AllowReorderParameters

Hides 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.

Bind To Report

@{
    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()
}

Bind To Model

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);
}

Inheritance

Object

DevExpress.Utils.SerializableSettingsBase

ReportDesignerParameterEditingSettings