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

Declaration

[DefaultValue(true)]
public bool Visible { get; set; }
<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.

Examples

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.

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();
}
See Also