InScope Function (Report Builder and SSRS)

Article
06/13/2017

Indicates whether the current instance of an item is in the specified scope.

Note

You can create and modify report definitions (.rdl) in Report Builder and in Report Designer in SQL Server Data Tools. Each authoring environment provides different ways to create, open, and save reports and related items. For more information, see Designing Reports in Report Designer and Report Builder (SSRS) on the Web at microsoft.com.

Syntax

InScope(scope)

Parameters

scope
(String) The name of a dataset, data region, or group that specifies a scope.

Return Type

Returns a Boolean.

Remarks

The InScope function tests the scope of the current instance of a report item for membership in the scope specified by the scopeparameter.

Scope cannot be an expression.

A typical use for the InScope function is in data regions that have dynamic scoping. For example, InScope can be used in a drillthrough link in a data region cells to provide a different report name and different sets of parameters depending on which cell is clicked. An example of this is as follows:

The following expression, used as the report name in a drillthrough link, opens the ProductDetail report if the clicked cell is in the Month group, and the ProductSummary report if it is not.
```
=Iif(InScope("Month"), "ProductDetail", "ProductSummary")  
```
The following expression, used in the Omit property of a drillthrough report parameter, will pass the parameter to the target report only if the clicked cell is in the Product group.
```
=Not(InScope("Product"))  
```

For more information, see Aggregate Functions Reference (Report Builder and SSRS) and Expression Scope for Totals, Aggregates, and Built-in Collections (Report Builder and SSRS).

Example

The following code example indicates whether the current instance of the item is in the Product dataset, data region, or group scope.

=InScope("Product")

Share via