Replaces occurrences of a specific text in a block.

The Replace text extraction rule replaces texts matching the Searched text property in blocks defined by presentation attributes or block position.

Property Type Category Description
Comment String configuration Describes the object comment to include in the documentation report.
This property generally contains an explanation about the object.
Is active boolean configuration Defines whether the extraction rule is active.
Is final boolean configuration Defines if the extraction is final, i.e. whether pending extraction rules should try to match on the current extraction rule matching blocks.

If set to true, once the rule applies on a matching block, Convertigo doesn’t apply the following rules on this block. This can be used to prevent a block from being modified by other rules.
Regular expression boolean configuration Defines whether the searched text is a regular expression or not.
If set to true, the searched text parameter is a regular expression. This allows more flexibility for text replacements. For example, with 5250 platforms, it is frequent to remove trailing dots at the end of field descriptions. To do this, set this parameter to true and set the searched for text parameter to: .(s.)+
If set to false, the searched text parameter is a simple text string that will be replaced when present.
Replacement text String configuration Defines the text that will be used to replace the searched text.
Searched text String configuration Defines the text to be replaced or the regular expression defining text to be replaced.
Depending on Regular expression property, this property contains a text or a regular expression to define the searched text.
It is possible to code non ASCII characters using the following syntax: &#<decimal ASCII code>;. For example, if the searched text is “ “ and the replaced text is  , the rule will replace all regular spaces in a block with the character of ASCII code 160 representing unbreakable spaces in HTML.
Notes:

• For more information about regular expression patterns, see the following page: http://www.regular-expressions.info/reference.html.
• To test regular expressions, you can use the regular expression tester at the following URL: http://www.regular-expressions.info/javascriptexample.html.
Attributes int selection Defines the presentation attributes on which the rule applies, i.e. the rule applies on blocks matching these presentation attributes.
This property allows to configure the rule so that it applies only to parts of screens having specific attributes, for example green text on black background.
Presentation attributes to configure are :

• Color: Foreground color, Background color, to choose in a list of predefined colors or “not to take into account”.
• Decoration: bold, reverse, underlined, blink, for each decoration choose between “with the decoration”, “normal” (i.e. without the decoration), or “not to take into account”.
Screen zone XMLRectangle selection Defines the screen zone on which the rule applies, i.e. the rule applies on blocks completely contained in this screen area.
This property allows to configure the rule so that it applies only to areas of screens. All blocks found within the specified perimeter are matching this screen zone and can be processed by the rule.
The screen area is defined through four coordinates:

• x (area left corner),
• y (area upper corner),
• w (area width),
• h (area height).

All values are given in characters, with the upper left corner being (x=0, y=0).
-1 represents an undefined value: (x=-1, y=-1, w=-1, h=-1) is an undefined area representing the whole screen, i.e. all blocks, whatever their coordinates, are matching this screen zone and can be processed by the rule.
Type String selection Defines, using a regular expression, to which block types the rule applies.
For example, if set to:

• static, the rule applies to blocks of static type only.
• static | field, the rule applies to blocks of static or field type only.
• [^field], the rule applies to all but field type blocks.

Notes:

• For more information about regular expression patterns, see the following page: http://www.regular-expressions.info/reference.html.
• To test regular expressions, you can use the regular expression tester at the following URL: http://www.regular-expressions.info/javascriptexample.html.