Element Parameter Case

Use this reference to review the specifications for the Element Parameter Case check.

The element parameter case check verifies the case of selected element parameters.

Overview

Description: Checks the case of selected element parameters.
Evaluation Criteria: Checks if element parameters are upper case, lower case, or title case.
Limitations: None
Document Types: All
Filters: Elements
Highlighting: No
Info Tab: Displays failed elements. Select element to zoom to it.
Correction: Updates the parameter with the correct case.

Examples where this template might be used

  • Find all room names not in title case.
  • Find door number suffixes not in upper case.

Details

Options:

Option Usage
Element Type(s) Element type to check.
Built In Use built in parameters.
Other Use other parameters.
Pick Element Allows the user to select an element and parameter to test.
Data Type Data type of the parameter.
Location Parameter instance or type.
UPPER CASE Test parameter for upper case.
lower case Test parameter for lower case.
Title Case Test parameter for title case.

Pass/Fail Report Options:

Value(s):

Available by right clicking in the Pass/Fail Messages Editor, then choosing Insert>>Value.

Reportable Variable Description
CheckName Name of the check.
CheckResult Result of the check. Passed/Failed.
FilterSize Size of the selection filter.
NumBadElements Number of failed elements.

Table(s):

Available by right clicking in the Pass/Fail Messages Editor, then choosing Insert>>Table.

Reportable Variable Description
ElementTable Table displaying all failed elements.

Results

After the check is run and if the criteria failed, a fail message is displayed. If the criteria passed then a pass message is displayed.