<%@ page language="C#" masterpagefile="~/templates/Documentation.master" inherits="Page" pagetitle="Defining and Joining Regions" keywords="Defining and Joining Regions"%>

Defining and Joining Regions

An input file can contain any number of regions; fixed-width and line-oriented regions can exist in the same file. The Custom XML Conversion Editor provides tools that allow you to define new regions and join existing ones.

This section covers the following topics:

Defining a Region

Joining Regions

Defining a Region

When you define a region in an input file, Stylus Studio splits the region at the current cursor location. The new region starts with the character on which the cursor resided when the region was defined, but it can be of either type - fixed-width or line-oriented - regardless of the type of the original region.

Consider the following input file:

# Bike Inventory Overview 2004-10-01 09:00:07EDT Make,Model,Year,Mileage BMW,R1150RS,2004,14274 Kawasaki,GPz1100,1996,60234 Ducati,ST2,1997,24000 Moto Guzzi,LeMans,2001,12393 BMW,R1150R,2002,17439 Ducati,Monster,2000,15682 Aprilia,Futura,2001,17320

# Bike Inventory Overview 2004-10-01 09:00:07EDT 
Make,Model,Year,Mileage 
BMW,R1150RS,2004,14274 
Kawasaki,GPz1100,1996,60234 
Ducati,ST2,1997,24000 
Moto Guzzi,LeMans,2001,12393 
BMW,R1150R,2002,17439 
Ducati,Monster,2000,15682 
Aprilia,Futura,2001,17320

By default, Stylus Studio reads this as a file with a single region. You might decide you want your XML to distinguish headers from actual records and treat the two accordingly (not generating headers as XML, for example).

When you define a new region, the Custom XML Conversion Editor renumbers all the rows, using a region:row number format. In addition, each region is displayed with its own field name row, which is displayed in light green with the default field element name, field, as shown in Figure 170.

Figure 170. Regions Are Numbered and Colored Differently

Field and row values are independent across regions. For example, the <row> element might be <reg1>, <reg2>, and so on for each of the regions in an input file.

To define a region:

1. Place the cursor in the document pane on the character with which you want to start the new region.

2. Click the Start New Region Here (

) button, or select CustomXMLConversion > Start New Region Here from the Stylus Studio menu.

Stylus Studio displays the Start New Region dialog box.

Figure 171. Start New Region Dialog Box

3. Choose the type of region you want to create (line-oriented, fixed-width, or no-output).

4. Choose where you want the new region to start (at the current row, or at a specific number of bytes from the start of the file).


Tip		If the .conv file you are creating will be used with different input files, it is possible that the line lengths could vary from file to file, changing the byte offset. Consider using the row setting (the default) for the Begin New Region property in this case.

5. Click OK.

Joining Regions

You can join regions that you define as well as regions that Stylus Studio interpreted when it first read the input file. You can join the current region to either adjacent region - the previous region, or the next region.

The region type after the join operation depends on whether you are joining with the previous region or the next region.The region you are joining assumes the type of the region to which it is being joined.

Table 22. Region Type After Joining Regions
Region Joined With	Resulting Region Type
Next	The region you are using to perform the join
Previous	The region to which you are joining

To join a region:

1. Place the cursor anywhere in the region you want to join with another region.

2. Click the Join with Previous Region (

) or Join with Next Region (

) button. These actions are also accessible from the CustomXMLConversion menu and the shortcut menu in the Custom XML Conversion Editor.

Stylus Studio joins the region you specified in step 1with the adjacent region.

< Previous| Next >