Skip to content

Commit 033d6b4

Browse files
Merge pull request #15362 from lishibo/patch-2
Add documents on hidden parameter behavior
2 parents e0f781a + c8e6af7 commit 033d6b4

5 files changed

Lines changed: 77 additions & 51 deletions

docs/reporting-services/report-design/customize-the-parameters-pane-in-a-report-report-builder.md

Lines changed: 77 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -11,54 +11,80 @@ author: maggiesMSFT
1111
ms.author: maggies
1212
---
1313
# Customize the Parameters Pane in a Report (Report Builder)
14-
When creating paginated reports with parameters in Report Builder, you can customize the Parameters pane. In report design view, you can drag a parameter to a specific column and row in the Parameters pane. You can add and remove columns to change the layout of the pane.
15-
16-
When you drag a parameter to a new column and row in the pane, the parameter order changes in the **Report Data** pane. When you change the order of the parameter in the **Report Data** pane, the location of the parameter in the pane is changed. For more information about why parameter order is important, see [Change the Order of a Report Parameter (Report Builder and SSRS)](../../reporting-services/report-design/change-the-order-of-a-report-parameter-report-builder-and-ssrs.md).
17-
18-
## To customize the parameters pane
19-
20-
1. On the **View** tab, select the **Parameters** checkbox to display the parameters pane.
21-
22-
![Access parameters pane from View tab](../../reporting-services/report-design/media/ssrs-customparameter-accessparameterpanedesignmode.png "Access parameters pane from View tab")
23-
24-
The pane appears at the top of the design surface.
25-
26-
2. To add a parameter to the pane, do one of the following.
27-
28-
- Right click an empty cell in the parameters pane, and then click **Add Parameter**.
29-
30-
![Add new parameter from parameters pane](../../reporting-services/report-design/media/ssrs-customizeparameter-addnewparameter.png "Add new parameter from parameters pane")
31-
32-
- Right click **Parameters** in the **Report Data** pane, and then click **Add Parameter**.
33-
34-
3. To move a parameter to a new location in the parameters pane, drag the parameter to a different cell in the pane.
35-
36-
When you change the location of the parameter in the pane, the order of the parameter in the **Parameters** list in the **Report Data** pane is automatically changed. For more information about the impact of the parameter order, see [Change the Order of a Report Parameter (Report Builder and SSRS)](../../reporting-services/report-design/change-the-order-of-a-report-parameter-report-builder-and-ssrs.md)
37-
38-
4. To access the properties for a parameter, do one of the following.
39-
40-
- Right click the parameter in the parameters pane, and then click **Parameter Properties**.
41-
42-
![Access parameter properties from the parameters pane](../../reporting-services/report-design/media/ssrs-customizeparameter-accessparameterproperties-composite.png "Access parameter properties from the parameters pane")
43-
44-
- Right click the parameter in the **Report Data** pane, and then click **Parameter Properties**.
45-
46-
5. To add new columns and rows to the pane, or delete existing rows and columns, right click anywhere in the parameters pane and then click a command on the menu that displays.
47-
48-
![Add columns and rows to the parameters pane](../../reporting-services/report-design/media/ssrs-customparameter-addcolumnsrows.png "Add columns and rows to the parameters pane")
49-
50-
> [!IMPORTANT]
51-
> When you delete a column or row that contains parameters, the parameters are deleted from the report.
52-
53-
6. To delete a parameter from the pane and from the report, do one of the following.
54-
55-
- Right click the parameter in the parameters pane, and then click **Delete**.
56-
57-
![Delete parameters from the parameters pane](../../reporting-services/report-design/media/ssrs-customparameter-deleteparameter.png "Delete parameters from the parameters pane")
58-
59-
- Right click parameter in the **Report Data** pane, and then click **Delete**.
60-
61-
## See Also
62-
[Report Parameters (Report Builder and Report Designer)](../../reporting-services/report-design/report-parameters-report-builder-and-report-designer.md)
63-
64-
14+
When creating paginated reports with parameters in Report Builder, you can customize the Parameters pane. In report design view, you can drag a parameter to a specific column and row in the Parameters pane. You can add and remove columns to change the layout of the pane.
15+
16+
When you drag a parameter to a new column and row in the pane, the parameter order changes in the **Report Data** pane. When you change the order of the parameter in the **Report Data** pane, the location of the parameter in the pane is changed. For more information about why parameter order is important, see [Change the Order of a Report Parameter (Report Builder and SSRS)](../../reporting-services/report-design/change-the-order-of-a-report-parameter-report-builder-and-ssrs.md).
17+
18+
## To customize the parameters pane
19+
20+
1. On the **View** tab, select the **Parameters** checkbox to display the parameters pane.
21+
22+
![Access parameters pane from View tab](../../reporting-services/report-design/media/ssrs-customparameter-accessparameterpanedesignmode.png "Access parameters pane from View tab")
23+
24+
The pane appears at the top of the design surface.
25+
26+
2. To add a parameter to the pane, do one of the following.
27+
28+
- Right click an empty cell in the parameters pane, and then click **Add Parameter**.
29+
30+
![Add new parameter from parameters pane](../../reporting-services/report-design/media/ssrs-customizeparameter-addnewparameter.png "Add new parameter from parameters pane")
31+
32+
- Right click **Parameters** in the **Report Data** pane, and then click **Add Parameter**.
33+
34+
3. To move a parameter to a new location in the parameters pane, drag the parameter to a different cell in the pane.
35+
36+
When you change the location of the parameter in the pane, the order of the parameter in the **Parameters** list in the **Report Data** pane is automatically changed. For more information about the impact of the parameter order, see [Change the Order of a Report Parameter (Report Builder and SSRS)](../../reporting-services/report-design/change-the-order-of-a-report-parameter-report-builder-and-ssrs.md)
37+
38+
4. To access the properties for a parameter, do one of the following.
39+
40+
- Right click the parameter in the parameters pane, and then click **Parameter Properties**.
41+
42+
![Access parameter properties from the parameters pane](../../reporting-services/report-design/media/ssrs-customizeparameter-accessparameterproperties-composite.png "Access parameter properties from the parameters pane")
43+
44+
- Right click the parameter in the **Report Data** pane, and then click **Parameter Properties**.
45+
46+
5. To add new columns and rows to the pane, or delete existing rows and columns, right click anywhere in the parameters pane and then click a command on the menu that displays.
47+
48+
![Add columns and rows to the parameters pane](../../reporting-services/report-design/media/ssrs-customparameter-addcolumnsrows.png "Add columns and rows to the parameters pane")
49+
50+
> [!IMPORTANT]
51+
> When you delete a column or row that contains parameters, the parameters are deleted from the report.
52+
53+
6. To delete a parameter from the pane and from the report, do one of the following.
54+
55+
- Right click the parameter in the parameters pane, and then click **Delete**.
56+
57+
![Delete parameters from the parameters pane](../../reporting-services/report-design/media/ssrs-customparameter-deleteparameter.png "Delete parameters from the parameters pane")
58+
59+
- Right click parameter in the **Report Data** pane, and then click **Delete**.
60+
61+
## Hidden/Internal parameters in runtime
62+
If you have hidden/internal parameters, the logic on whether it'll be rendered as empty space in runtime is as follows:
63+
64+
- If any row or column is full of hidden/internal parameters or empty cell, then it won't be rendered in runtime;
65+
- Otherwise, both hidden/internal parameters and empty cell will be rendered as empty space;
66+
67+
For example, `ReportParameter1` is hidden while rests are visible:
68+
69+
![Hidden Parameter Example 1](../../reporting-services/report-design/media/ssrs-hidden-parameter-rb-1.png "One hidden parameter in layout grid")
70+
71+
This will result in an empty space in runtime because there are visible parameters in first column or first row:
72+
73+
![Hidden Parameter Example 1 - runtime](../../reporting-services/report-design/media/ssrs-hidden-parameter-server-1.png "One hidden parameter in layout grid result in empty space in runtime")
74+
75+
Now if we change `ReportParameter3` to hidden as well:
76+
77+
![Hidden Parameter Example 2](../../reporting-services/report-design/media/ssrs-hidden-parameter-rb-2.png "Two hidden parameter in same column")
78+
79+
Then the first column is omitted because the whole column is empty:
80+
81+
![Hidden Parameter Example 2 - runtime](../../reporting-services/report-design/media/ssrs-hidden-parameter-server-2.png "Two hidden parameter in same column in runtime")
82+
83+
## Default layout
84+
For those reports that were authored before SSRS 2016 version, a default layout grid of 2 columns and N rows will be used in runtime. To change the layout, simply open the report in latest Report Builder and save back, then a customized layout info will be saved to .rdl file as well.
85+
86+
87+
## See also
88+
[Report Parameters (Report Builder and Report Designer)](../../reporting-services/report-design/report-parameters-report-builder-and-report-designer.md)
89+
90+
2.91 KB
Loading
3.12 KB
Loading
2.33 KB
Loading
2.07 KB
Loading

0 commit comments

Comments
 (0)