Eclipse BIRT Report Object Model (ROM)

HideRule Structure

# Structure Overview

Defines a visibility rule for a report item in a kind of output format.

### Details

Display Name: | Hide
Since: | 1.0

### Property Summary

format
  Identifies the format in which the element should be hidden.
valueExpr
  A boolean expression that determines whether to hide the element or not.

### Description

The visibility rule says when a report item should be hidden. It can be hidden based on the output type, an expression, or both. For example, the browser control is normally hidden in all output formats except HTML. A past-due item might be hidden if the account is not past due.

An item can be completely hidden (hidden in all formats), or hidden only in selected formats. An item hidden in all formats is never actually created in the Factory. An item hidden in selected formats is created, but will be omitted when rendered to the format for which it is hidden.

# Property Detail

## format Property

Identifies the format in which the element should be hidden.

### Details

Type: | string
Since: | 1.0
Required: | No
Display Name: | Format
JavaScript Type: |
Default Value: | all
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
all | All | all |
viewer | Viewer | viewer |
pdf | Pdf | pdf |
reportlet | Reportlet | reportlet |

### Description

This property identifies the output format in which to hide the element. The element can be hidden in all output formats (using the "All" choice), or in a specific format. If the element is hidden in all formats, then it is not created in the Factory. Otherwise, is created, but is removed before rendering in the Presentation engine when converted to the target output format.

## valueExpr Property

A boolean expression that determines whether to hide the element or not.

### Details

Type: | expression
Context: |
Expression Type: | boolean
Since: | 1.0
Required: | No
Display Name: | Expression
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### Description

The boolean expression to evaluate. If the expression evaluates to `true`, then the element is hidden; Otherwise, the element is not hidden. Default to `true` if no expression is given.