Element Filters

How to Access

As with the Document Options tabs, you can access the Element filter details from two different places; the start point affects the persistence of the filter definition:

• If you define the filters on the Element Filters tab of the Generate RTF Documentation dialog, you can create filter settings for the current report to be run; selections are non-persistent, and are reset when you close the dialog or select a different template

• If you access the filter definitions by clicking on the File | Document Options menu option on the RTF Style Template Editor dialog, the settings are saved with the template as the default settings for any run of this report

You add filters by clicking on the Add Filters button; to edit the filters, either double-click on the panel contents or click on the Edit Filter button, to display the Edit Filters dialog

The format is the element field name, the conditions placed on the field value, any actual value or delimiting value to search on, and whether the filter item is required (mandatory), as described below

Generate RTF Documentation

File and Print Options

RTF Style Template Editor

Add Filters

Search In

Select the type and name of each element field to search on

Condition

Select the condition of the search parameter

The available options are Contains, Equal To, Not Equals and One Of

Fields and Conditions

Look For

Specify the search term to perform the conditional search on

This value can pertain to the selected element field; for example, the value could be a date for DateCreated or a text value for other fields

The search term can contain multiple values, separated by commas

Required

Indicate that the search results must include elements with your search term in that field; you select these checkboxes on the Add Filters dialog

The fields listed as filters have an OR relationship when no Required checkboxes are selected; that is, if the search term is found in any one of those fields, then the element is displayed

Any field having the Required checkbox ticked overrides fields where the Required checkbox is not ticked

Adding Filters

Element Features

- Optional

- Required

Specify whether element features are optional or required; these appear as a new branch underneath the root element term in the Search In column

If you scroll down the Search In column, you see sub-branches such as Attribute, Change and Custom Property; these are the element features

You can add these features by clicking on the Add Filter button; the Add Filters dialog displays, with a list of all the filters you can choose for an element or element feature

Click on the Search On drop-down arrow to see a list of the element features you can search on; each feature has its own set of filters such as Name, Notes and Alias, which you can add to your search

To search on an element attribute name, you would add the Attribute feature with a Name filter to your search

The Optional radio button enables you to generate a list of elements that meet one of the element features (Element Type = Object), or one of the feature filters (Attribute Name = Class1); for example, if your search is:

   Element Name = Class11, Attribute Name = m_Att1 or Scope = Public

the search results list all the elements that have the name of Class11 and all the elements that have an Attribute Name of m_Att1 or a Scope of Public

The Required radio button enables you to generate a list of elements that must have the element features you have added; for example, if your search is:

   Element Name = Class, Attribute Name = m_Att1 or Scope = Public

you would get elements that must have the name of Class AND an Attribute with a name of m_att1 or a Scope of Public

Add Filter

Add a new set of parameters to filter the search on

Adding Filters

Edit Filter

Open the Edit Filters dialog, which enables you to change the search parameters

Remove Filter

Remove the selected filter from the search