Parameter.Visible Property

Specifies whether a parameter‘s editor should be displayed in the Parameters UI, which is invoked for an end-user if the XtraReport.RequestParameters property is enabled.

Namespace: DevExpress.XtraReports.Parameters

Assembly: DevExpress.Printing.v20.2.Core.dll

NuGet Packages: DevExpress.Printing.Core, DevExpress.WindowsDesktop.Printing.Core

Declaration

C#

[DefaultValue(true)]
public bool Visible { get; set; }

VB.NET

<DefaultValue(True)>
Public Property Visible As Boolean

Property Value

Type	Default	Description
Boolean	**true**	true to display the parameter’s editor; otherwise, false.

Remarks

When a report’s XtraReport.RequestParameters property is enabled, the Parameters UI is invoked on report generation, which prompts an end-user to fill in values for all report parameters whose Visible property is set to true.

So, if you want to hide a particular parameter from this list and silently assign its value, set a parameter’s Visible property to false. If you want to disable all parameters simultaneously, disable the XtraReport.RequestParameters property (as described in Use the Parameters Panel to Ask for User Input).

For more information, refer to Using Report Parameters.

Example

This example demonstrates how to create a report with a parameter at runtime.

After a parameter is added to the report, its value can be used in the report’s XtraReportBase.FilterString, or displayed in a XRLabel control.

Then, when the report is being previewed, an end-user can modify the parameter’s value via the Parameters UI, which is enabled using the ReportPrintTool.AutoShowParametersPanel property.

C#

using System;
using System.Windows.Forms;
using DevExpress.XtraReports.UI;
using DevExpress.XtraReports.Parameters;
// ...

private void simpleButton1_Click(object sender, EventArgs e) {
    // Create a report instance.
    XtraReport1 report = new XtraReport1();

    // Create a parameter and specify its name.
    Parameter param1 = new Parameter();
    param1.Name = "CatID";

    // Specify other parameter properties.
    param1.Type = typeof(System.Int32);
    param1.Value = 1;
    param1.Description = "Category: ";
    param1.Visible = true;

    // Add the parameter to the report.
    report.Parameters.Add(param1);

    // Specify the report's filter string.
    report.FilterString = "[CategoryID] = [Parameters.CatID]";

    // Force the report creation without previously 
    // requesting the parameter value from end-users.
    report.RequestParameters = false;

    // Show the parameter's value on a Report Header band.
    XRLabel label = new XRLabel();
    label.DataBindings.Add(new XRBinding(param1, "Text", "Category: {0}"));
    ReportHeaderBand reportHeader = new ReportHeaderBand();
    reportHeader.Controls.Add(label);
    report.Bands.Add(reportHeader);

    // Assign the report to a ReportPrintTool,
    // to hide the Parameters panel,
    // and show the report's print preview.
    ReportPrintTool pt = new ReportPrintTool(report);
    pt.AutoShowParametersPanel = true;
    pt.ShowPreviewDialog();
}

VB.NET

Imports System
Imports System.Windows.Forms
Imports DevExpress.XtraReports.UI
Imports DevExpress.XtraReports.Parameters
' ...

Private Sub simpleButton1_Click(ByVal sender As Object, _
ByVal e As EventArgs) Handles simpleButton1.Click
    ' Create a report instance.
    Dim report As New XtraReport1()

    ' Create a parameter and specify its name.
    Dim param1 As New Parameter()
    param1.Name = "CatID"

    ' Specify other parameter properties.
    param1.Type = GetType(System.Int32)
    param1.Value = 1
    param1.Description = "Category: "
    param1.Visible = True

    ' Add the parameter to the report.
    report.Parameters.Add(param1)

    ' Specify the report's filter string.
    report.FilterString = "[CategoryID] = [Parameters.CatID]"

    ' Force the report creation without previously 
    ' requesting the parameter value from end-users.
    report.RequestParameters = False

    ' Show the parameter's value on a Report Header band.
    Dim label As New XRLabel()
    label.DataBindings.Add(New XRBinding(param1, "Text", "Category: {0}"))
    Dim reportHeader As New ReportHeaderBand()
    reportHeader.Controls.Add(label)
    report.Bands.Add(reportHeader)

    ' Assign the report to a ReportPrintTool,
    ' to hide the Parameters panel,
    ' and show the report's print preview.
    Dim pt As New ReportPrintTool(report)
    pt.AutoShowParametersPanel = True
    pt.ShowPreviewDialog()
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Visible property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

Reporting_getting-started-xtrareports-e5144/CS/SalaryReports - Step 07/MainForm.cs#L26

report.Parameters["paramEmpName"].Value = string.Empty;
report.Parameters["paramEmpName"].Visible = false;
e.Control = new DocumentViewerUserControl() { Report = report };

Reporting_how-to-implement-a-custom-report-service-providing-report-documents-layouts-e4445/CS/HostApp/ReportService.cs#L37

for (int i = 0; i < report.Parameters.Count; i++) {
    report.Parameters[i].Visible = false;
}

Reporting_documentpreviewcontrol-how-to-create-a-drill-down-report-runtime-sample-t337482/CS/dxWPFApp/MainWindow.xaml.cs#L154

Parameter categoryNameParameter = new DevExpress.XtraReports.Parameters.Parameter();
categoryNameParameter.Visible = false;
categoryNameParameter.Name = "catNameParam";

Reporting_how-to-assign-a-list-of-dynamic-values-to-a-report-parameter-e4081/CS/DynamicParameterValues/XtraReport1.cs#L18

parameter1.Name = "parameterProduct";
parameter1.Visible = true;
parameter1.Description = "Product Name: ";

Reporting_how-to-assign-a-list-of-static-values-to-a-report-parameter-e4082/CS/StaticParameterValues/XtraReport1.cs#L21

parameter1.Name = "parameterProduct";
parameter1.Visible = true;
parameter1.Description = "Product Name: ";

VB.NET

Reporting_getting-started-xtrareports-e5144/VB/SalaryReports - Step 07/MainForm.vb#L21

report.Parameters("paramEmpName").Value = String.Empty
report.Parameters("paramEmpName").Visible = False
e.Control = New DocumentViewerUserControl() With {.Report = report}

Reporting_how-to-implement-a-custom-report-service-providing-report-documents-layouts-e4445/VB/HostApp/ReportService.vb#L40

For i As Integer = 0 To report.Parameters.Count - 1
    report.Parameters(i).Visible = False
Next i

Reporting_documentpreviewcontrol-how-to-create-a-drill-down-report-runtime-sample-t337482/VB/dxWPFApp/MainWindow.xaml.vb#L158

Dim categoryNameParameter As Parameter = New DevExpress.XtraReports.Parameters.Parameter()
categoryNameParameter.Visible = False
categoryNameParameter.Name = "catNameParam"

Reporting_how-to-silently-pass-a-parameters-value-to-a-report-e548/VB/Form1.vb#L22

' Hide the Parameters UI from end-users.
report.catID.Visible = False

reporting-winforms-parameter-dynamic-list/VB/MultiValueParametersExample/Form1.vb#L32

param1.LookUpSettings = lookupSettings
param1.Visible = True
' Add the parameter to the report.