Region Properties

Note

 

Each region has its own field and row properties. In addition, some properties apply only to line-oriented regions. These properties are marked with an asterisk.

Property
Description
Editable
Affects XML
Navigational
Type
The type of the region that currently has focus.
Yes. You can change the region type from this field.
No
No
Name
The name you want to assign to this region in the XML output. Optional.
Yes
Yes
No
Row Element Name
The name you want to assign to all rows in the region. The default value is row.
Yes
Yes
No
Element Name Source
Whether the source for the element name is user-specified, taken from the value of the first row in the region, or whether the row is named according to the WS-EDI standard.
Yes
Yes
No
Match Pattern
A regular expression you can use to filter rows in a region. Only rows that match the pattern you specify are output to XML.
Yes
Yes
No
Cursor Position
The offset from the start of the region to the current cursor location.
This value also appears in the status bar.
Yes. Moves the cursor to the location you specify.
No
Yes
Size
The region's size in characters.
No
No
No
Portion of File
The starting and ending offsets of the current region.
No
No
No
Row Count
The number of rows in the current region.
No
No
No
Row Number
The number of the current row.
This value also appears in the status bar.
Yes. Moves the cursor to the row you specify.
No
Yes
Cursor Position in Row
The offset from the start of the row.
Yes. Moves the cursor to the location in the row you specify.
No
Yes
Row Length
The number of characters in the current row.
No
No
No
Longest Row Length*
The number of characters in the longest row in the current region.
No
No
No
Line Terminator*
The type of line terminator character detected by Stylus Studio.
Yes
No
No
Field Separator*
The type of field separator character detected by Stylus Studio.
Yes
No
No
Delimiter Pairs*
Sets of delimiting characters detected by Stylus Studio.
Yes
No
No
Comment String*
String used by the Convert to XML adapter - if the beginning of a row matches the string in this field, the adapter interprets the row as a comment and does not output it in the XML.
Yes
Yes
No
Escape Characters*
Allows you to distinguish escape characters from separators - if a character in the input file is preceded by an Escape Character, that character is not treated as delimiting character, separator, or subsequent escape character.
Yes
Yes
No
Toss Characters*
Characters outside delimiting characters that should be ignored.
Yes
Yes
No
Field Component Separator*
The type of character used to separate sub-fields detected by Stylus Studio. If this character appears in a string, the string is split into sub-fields when the input file is converted to XML.
Yes
Yes
No
Collapse Consecutive Field Separators*
Whether or not multiple consecutive field separators should be treated as one. For example, if this property is set to Yes, X,,Y,,Z is treated as X,Y,Z. This property is most useful when spaces are used as delimiting characters.
Yes
Yes
No
Double Delimiter to Escape
Whether or not to treat a pair of delimiting characters within a delimited string as escaped characters. For example, if this property is set to Yes, "abc""xyz" is treated as abc"xyz.
Yes
Yes
No
Table 18. Region Properties

* This property is for line-oriented regions only.

 
Free Stylus Studio XML Training: