6-4-1 Functions for attribute-formulas

Show/Hide functions

Function name	Feature
VISIBLE	Switches between show/hide.

Color functions

Function name	Feature
TEXT_COLOR	Changes the font color.
MONO_COLOR	Changes the monochrome color.
STROKE_COLOR	Changes the line color (ruled lines and borders).
FILL_COLOR	Changes the surface color (fill color).

Coordinate functions

Function name	Feature
MOVE	Changes the coordinates (by moving a specified amount).
POS	Changes the coordinates (by moving to a specified position).
START_POS	Changes the coordinates of the start point.
END_POS	Changes the coordinates of the end point.
SCALE	Changes the magnification ratio (enlarges/reduces the size).
ROTATE	Changes the rotation angle.

Text functions

Restriction

The following restrictions apply if the locale of the XML form file is in English, French, Czech, or Thai:

You cannot use "FONT_ID".
For "HALF_FONT_ID", you cannot specify "0" as a half-width font number.

Function name	Feature
BOLD	Changes the bold attribute of text.
ITALIC	Changes the italic attribute of text.
FONT_ID	Changes the full-width font.
HALF_FONT_ID	Changes the half-width font.
FONT_SIZE	Changes the font size.
TEXT	Changes the content of static text.
UNDERLINE	Highlights text with underlines and other styles.
PAINT	Highlights text with background fill.
AREA	Automatically adjusts the font size so that text fits in the specified area.
FONT_STYLE	Copies string attributes.

Shape functions

Function name	Feature
STROKE_STYLE	Copies line (ruled lines and borders) attributes.
FILL_STYLE	Copies surface (fill) attributes.
ARROW_STYLE	Copies arrow attributes.

Multi-page functions

Function name	Feature
PAGE_VISIBLE	Switches between show/hide (multi-page setting).
TEXT_PAGE_COLOR	Changes the font color (multi-page setting).
MONO_PAGE_COLOR	Changes the monochrome color (multi-page setting).
STROKE_PAGE_COLOR	Changes the line color (ruled lines and borders) (multi-page setting).
FILL_PAGE_COLOR	Changes the surface color (fill color) (multi-page setting).

Coordinate reference functions

Function name	Feature
XVAL	Retrieves the X coordinate.
YVAL	Retrieves the Y coordinate.
START_XVAL	Retrieves the X coordinate of the start point.
START_YVAL	Retrieves the Y coordinate of the start point.
END_XVAL	Retrieves the X coordinate of the end point.
END_YVAL	Retrieves the Y coordinate of the end point.

Show/Hide functions

VISIBLE

Feature	Switches between show/hide.
Format	null VISIBLE(Flag_int)
Settings	Specify whether to show or hide the item in "Flag_int". 0: Hide 1: Show Caution If the VISIBLE function is used after the PAGE_VISIBLE function, only the result of the VISIBLE function is reflected in the output.

Feature

Switches between show/hide.

Format

null VISIBLE(Flag_int)

Settings

Specify whether to show or hide the item in "Flag_int".

0: Hide

1: Show

Caution

If the VISIBLE function is used after the PAGE_VISIBLE function, only the result of the VISIBLE function is reflected in the output.

Table 1. Target item

Item name	Graphic mode OFF	Graphic mode ON
Field
Static text
Barcode		-
GS1 Databar		-
2D barcode		-
Image
Straight, vertical/horizontal lines
Rectangle
Polyline/polygon	-
Regular polygon	-
Circle	-
Ellipse	-
Circular arc	-
Ellipse arc	-
Bezier curve	-
Spline curve	-
Block arrow (single-direction)	-
Bent block arrow	-
U-Turn block arrow	-
Curved block arrow	-
Rectangular callout	-
Elliptical callout	-
Cloud callout	-
Memo	-
Clock	-
Star	-
Multi-item	-
Chart (chart area)	-

Color functions

TEXT_COLOR

Feature	Changes the font color.
Format	null TEXT_COLOR(ColorNumber_int)
Settings	Specify the palette color number for the font color in "ColorNumber_int". Field, static text Basic mode: 0 to 16 (0 is the page color) Graphic mode: 0 to 256 (0 is the page color) Graphic mode items other than listed above: 1 to 256 Caution If the color mode check box is cleared in the paper properties, items are not output in the specified color. The items are output in monochrome (grayscale).

Feature

Changes the font color.

Format

null TEXT_COLOR(ColorNumber_int)

Settings

Specify the palette color number for the font color in "ColorNumber_int".

Field, static text

Basic mode: 0 to 16 (0 is the page color)

Graphic mode: 0 to 256 (0 is the page color)

Graphic mode items other than listed above: 1 to 256

Caution

If the color mode check box is cleared in the paper properties, items are not output in the specified color. The items are output in monochrome (grayscale).

Table 2. Target item

Item name	Graphic mode OFF	Graphic mode ON
Field
Static text
Rectangular callout	-
Elliptical callout	-
Cloud callout	-

MONO_COLOR

Feature	Changes the monochrome color.
Format	null MONO_COLOR(ColorNumber_int)
Settings	Specify the palette color number for the monochrome color in "ColorNumber_int". Image Basic mode: 0 to 16 (0 is the page color) Graphic mode: 0 to 256 (0 is the page color) Barcode, GS1 Databar Basic mode: 0 to 16 (0 is the page color) Caution If the color mode check box is cleared in the paper properties, items are not output in the specified color. The items are output in monochrome (grayscale). This function is not effective for images other than monochrome images.

Feature

Changes the monochrome color.

Format

null MONO_COLOR(ColorNumber_int)

Settings

Specify the palette color number for the monochrome color in "ColorNumber_int".

Image

Basic mode: 0 to 16 (0 is the page color)

Graphic mode: 0 to 256 (0 is the page color)

Barcode, GS1 Databar

Basic mode: 0 to 16 (0 is the page color)

Caution

If the color mode check box is cleared in the paper properties, items are not output in the specified color. The items are output in monochrome (grayscale).
This function is not effective for images other than monochrome images.

Table 3. Target item

Item name	Graphic mode OFF	Graphic mode ON
Image
Barcode		-
GS1 Databar		-

STROKE_COLOR

Feature	Changes the line color (ruled lines and borders).
Format	null STROKE_COLOR(ColorNumber_int)
Settings	Specify the palette color number for the line color (ruled lines and borders) in "ColorNumber_int". Straight line, rectangle, subform, record Basic mode: 0 to 16 (0 is the page color) Graphic mode: 0 to 256 (0 is the page color) Graphic mode items other than listed above: 1 to 256 Caution If the color mode check box is cleared in the paper properties, items are not output in the specified color. The items are output in monochrome (grayscale).

Feature

Changes the line color (ruled lines and borders).

Format

null STROKE_COLOR(ColorNumber_int)

Settings

Specify the palette color number for the line color (ruled lines and borders) in "ColorNumber_int".

Straight line, rectangle, subform, record

Basic mode: 0 to 16 (0 is the page color)

Graphic mode: 0 to 256 (0 is the page color)

Graphic mode items other than listed above: 1 to 256

Caution

If the color mode check box is cleared in the paper properties, items are not output in the specified color. The items are output in monochrome (grayscale).

Table 4. Target item

Item name	Graphic mode OFF	Graphic mode ON
Subform (frame)
Record (frame)
Straight, vertical/horizontal lines
Rectangle
Polyline/polygon	-
Regular polygon	-
Circle	-
Ellipse	-
Circular arc	-
Ellipse arc	-
Bezier curve	-
Spline curve	-
Block arrow (single-direction)	-
Bent block arrow	-
U-Turn block arrow	-
Curved block arrow	-
Rectangular callout	-
Elliptical callout	-
Cloud callout	-
Memo	-
Clock	-	*1
Star	-

The part to be changed is "Frame color".

FILL_COLOR

Feature	Changes the surface color (fill color).
Format	null FILL_COLOR(ColorNumber_int)
Settings	Specify the palette color number for the surface color (fill color) in "ColorNumber_int". Rectangle, record Basic mode: 0 to 16 (0 is the page color) Graphic mode: 0 to 256 (0 is the page color) Graphic mode items other than listed above: 1 to 256 Caution If the color mode check box is cleared in the paper properties, items are not output in the specified color. The items are output in monochrome (grayscale). The setting of "Fill pattern" is ignored.

Feature

Changes the surface color (fill color).

Format

null FILL_COLOR(ColorNumber_int)

Settings

Specify the palette color number for the surface color (fill color) in "ColorNumber_int".

Rectangle, record

Basic mode: 0 to 16 (0 is the page color)

Graphic mode: 0 to 256 (0 is the page color)

Graphic mode items other than listed above: 1 to 256

Caution

If the color mode check box is cleared in the paper properties, items are not output in the specified color. The items are output in monochrome (grayscale).
The setting of "Fill pattern" is ignored.

Table 5. Target item

Item name	Graphic mode OFF	Graphic mode ON
Record (frame)
Rectangle
Polyline/polygon	-
Regular polygon	-
Circle	-
Ellipse	-
Circular arc	-
Ellipse arc	-
Spline curve	-
Block arrow (single-direction)	-
Bent block arrow	-
U-Turn block arrow	-
Curved block arrow	-	*1
Rectangular callout	-
Elliptical callout	-
Cloud callout	-
Memo	-	*2
Clock	-
Star	-

The part to be changed is "Outer color".
The part to be changed is "Surface color".

Coordinate functions

MOVE

Feature	Changes the coordinates (by moving a specified amount).
Format	null MOVE(RelativeX_double,RelativeY_double)
Settings	Specify the amount of movement in the horizontal (X) direction in "RelativeX_double" (unit: dot, right direction is positive). Specify the amount of movement in the vertical (Y) direction in "RelativeY_double" (unit: dot, down direction is positive). Restriction You must specify the arguments within the range of -2147483648 to 2147483647. Movement cannot be carried out if the circumscribed range after the movement would not fall within the range of -10000 (dot) to 100000 (dot).

Table 6. Target item

Item name	Graphic mode OFF	Graphic mode ON
Field
Static text
Barcode		-
GS1 Databar		-
2D barcode		-
Image
Straight, vertical/horizontal lines
Rectangle
Polyline/polygon	-
Regular polygon	-
Circle	-
Ellipse	-
Circular arc	-
Ellipse arc	-
Bezier curve	-
Spline curve	-
Block arrow (single-direction)	-
Bent block arrow	-
U-Turn block arrow	-
Curved block arrow	-
Rectangular callout	-
Elliptical callout	-
Cloud callout	-
Memo	-
Clock	-
Star	-
Multi-item	-
Chart (chart area)	-

POS

Feature	Changes the coordinates (by moving to a specified position).
Format	null POS(X_double,Y_double)
Settings	Specify the horizontal (X) position in "X_double" (unit: dot). Specify the vertical (Y) position in "Y_double" (unit: dot). Restriction You must specify the arguments within the range of -2147483648 to 2147483647. You cannot move the position if the circumscribed range after the movement would not fall within the range of -10000 (dot) to 100000 (dot).

Table 7. Target item

Item name	Graphic mode OFF	Graphic mode ON
Field
Static text
Image
Barcode		-
GS1 Databar		-
2D barcode		-
Straight, vertical/horizontal lines
Rectangle
Polyline/polygon	-
Regular polygon	-
Circle	-
Ellipse	-
Circular arc	-
Ellipse arc	-
Bezier curve	-
Spline curve	-
Block arrow (single-direction)	-
Bent block arrow	-
U-Turn block arrow	-
Curved block arrow	-
Rectangular callout	-
Elliptical callout	-
Cloud callout	-
Memo	-
Clock	-
Star	-
Chart (chart area)	-

Reference

For details on the coordinate position you should specify for each target item, see "Position specified in POS".

START_POS

Feature	Changes the coordinates of the start point.
Format	null START_POS(X_double,Y_double)
Settings	Specify the horizontal (X) position of the start point in "X_double" (unit: dot). Specify the vertical (Y) position of the start point in "Y_double" (unit: dot). Caution It is disabled if the length or area becomes 0 after transformation. For images, it is necessary that the condition "start point X < end point X, and start point Y < end point Y" will be satisfied after the change, with the rotation angle returned to 0. For memo and callout items, it is necessary that the condition "start point X < end point X, and start point Y < end point Y" will be satisfied after the change. Restriction You must specify the arguments within the range of -2147483648 to 2147483647. Movement cannot be carried out if the circumscribed range after the change would not fall within the range of -10000 (dot) to 100000 (dot). For images, it can be specified only when the Print size property is set to Variable.

Table 8. Target item

Item name	Graphic mode OFF	Graphic mode ON
Image
Straight, vertical/horizontal lines
Rectangle
Bezier curve	-
Block arrow (single-direction)	-
Bent block arrow	-
U-Turn block arrow	-
Curved block arrow	-
Rectangular callout	-
Elliptical callout	-
Cloud callout	-
Memo	-

Reference

For details on the coordinate position you should specify for each target item, see "Position specified in START_POS".

END_POS

Feature	Changes the coordinates of the end point.
Format	null END_POS(X_double,Y_double)
Settings	Specify the horizontal (X) position of the end point in "X_double" (unit: dot). Specify the vertical (Y) position of the end point in "Y_double" (unit: dot). Caution It is disabled if the length or area becomes 0 after transformation. For images, it is necessary that the condition "start point X < end point X, and start point Y < end point Y" will be satisfied after the change, with the rotation angle returned to 0. For memo and callout items, it is necessary that the condition "start point X < end point X, and start point Y < end point Y" will be satisfied after the change. Restriction You must specify the arguments within the range of -2147483648 to 2147483647. Movement cannot be carried out if the circumscribed range after the change would not fall within the range of -10000 (dot) to 100000 (dot). For images, it can be specified only when the Print size property is set to Variable.

Table 9. Target item

Item name	Graphic mode OFF	Graphic mode ON
Image
Straight, vertical/horizontal lines
Rectangle
Bezier curve	-
Block arrow (single-direction)	-
Bent block arrow	-
U-Turn block arrow	-
Curved block arrow	-
Rectangular callout	-
Elliptical callout	-
Cloud callout	-
Memo	-

Reference

For details on the coordinate position you should specify for each target item, see "Position specified in END_POS".

SCALE

Feature	Changes the magnification ratio (enlarges/reduces the size).
Format	null SCALE(HorizontalMag_double,VerticalMag_double)
Settings	Specify the horizontal (X) enlargement/reduction ratio in "HorizontalMag_double". Specify the vertical (Y) enlargement/reduction ratio in "VerticalMag_double". Field, static text Basic mode: 0.5, 1, 2, 3, 4, 6, 8 Graphic mode: 0.5 to 10 Callouts: 0.01 to 100 (0.5 to 10 when including characters inside) Straight line, rectangle, image: 0.01 to 100 Graphic mode items other than listed above: 0.01 to 100 Caution For text inside callout items, unlike fields or static text, the font size (unit: point) is changed. For such cases, the second argument (VerticalMag_double) is used. For callout items that contain text, you need to specify the magnification ratio within the range of 0.5 to 10. If the specified ratio is not within the range, the item cannot be printed. Regular polygons, circles, circular arcs, clocks, and stars are enlarged/reduced based on the smaller ratio among the horizontal and vertical magnification ratios. Restriction Shape items cannot be enlarged/reduced if the circumscribed range after the change would not fall within the range of -10000 (dot) to 100000 (dot.) For images, it can be specified only when the Print size property is set to Variable.

Table 10. Target item

Item name	Graphic mode OFF	Graphic mode ON
Field
Static text
Image
Straight, vertical/horizontal lines
Rectangle
Regular polygon	-
Circle	-
Ellipse	-
Circular arc	-
Ellipse arc	-
Bezier curve	-
Block arrow (single-direction)	-
Rectangular callout	-
Elliptical callout	-
Cloud callout	-
Memo	-
Clock	-
Star	-

Reference

For details on how each target item is enlarged/reduced, see "SCALE operation".

ROTATE

Feature	Changes the rotation angle.
Format	null ROTATE(Angle_double)
Settings	Specify the rotation angle in "Angle_double". (The positive direction is counter-clockwise (left).) Field, static text, rectangle Basic mode: 0, 90, 180, 270 Graphic mode: -3600 to 3600 (processed with 360 remainder) Image Graphic mode: -3600 to 3600 (processed with 360 remainder) Regular polygon, ellipse, ellipse arc, star -3600 to 3600 (processed with 360 remainder) Caution For fields and static text, the behavior of rotation differs depending on the mode setting (basic mode/graphic mode), text direction (horizontal/vertical), and the field type (full-width/half-width). Tile images are not rotated. Restriction Shapes or images cannot be rotated if the circumscribed range after the rotation would not fall within the range of -10000 (dot) to 100000 (dot.)

Feature

Changes the rotation angle.

Format

null ROTATE(Angle_double)

Settings

Specify the rotation angle in "Angle_double". (The positive direction is counter-clockwise (left).)

Field, static text, rectangle

Basic mode: 0, 90, 180, 270

Graphic mode: -3600 to 3600 (processed with 360 remainder)

Image

Graphic mode: -3600 to 3600 (processed with 360 remainder)

Regular polygon, ellipse, ellipse arc, star

-3600 to 3600 (processed with 360 remainder)

Caution

For fields and static text, the behavior of rotation differs depending on the mode setting (basic mode/graphic mode), text direction (horizontal/vertical), and the field type (full-width/half-width).
Tile images are not rotated.

Restriction

Shapes or images cannot be rotated if the circumscribed range after the rotation would not fall within the range of -10000 (dot) to 100000 (dot.)

Table 11. Target item

Item name	Graphic mode OFF	Graphic mode ON
Field
Static text
Image	-
Rectangle
Regular polygon	-
Ellipse	-
Ellipse arc	-
Star	-

Reference

For details on how each target item is rotated, see "ROTATE operation".

Text functions

BOLD

Feature	Changes the bold attribute of text.
Format	null BOLD(Flag_int)
Settings	In "Flag_int", specify ON/OFF for the bold attribute. 1: ON 0: OFF

Feature

Changes the bold attribute of text.

Format

null BOLD(Flag_int)

Settings

In "Flag_int", specify ON/OFF for the bold attribute.

1: ON

0: OFF

Table 12. Target item

Item name	Graphic mode OFF	Graphic mode ON
Field
Static text
Rectangular callout	-
Elliptical callout	-
Cloud callout	-

ITALIC

Feature	Changes the italic attribute of text.
Format	null ITALIC(Flag_int)
Settings	In "Flag_int", specify ON/OFF for the italic attribute. 1: ON 0: OFF

Feature

Changes the italic attribute of text.

Format

null ITALIC(Flag_int)

Settings

In "Flag_int", specify ON/OFF for the italic attribute.

1: ON

0: OFF

Table 13. Target item

Item name	Graphic mode OFF	Graphic mode ON
Field
Static text
Rectangular callout	-
Elliptical callout	-
Cloud callout	-

FONT_ID

Feature	Changes the full-width font.
Format	null FONT_ID(FullWidthFont_int)
Settings	Specify the full-width font number in "FullWidthFont_int". When using the basic mode, specify any of the following values: 0: MS Mincho 1: MS Gothic In graphic mode, specify a full-width font number set in the XML form file within the following range. 0 to [the number of full-width fonts configured in the form - 1] Restriction You cannot use this feature if the locale of the XML form file is in English, French, Czech, or Thai. Caution If there are any improper configurations in the settings for each output printer model, or the Font.Alternative (alternative font) setting in the main properties (vfreport.properties.*), the form itself may not be printed.

Feature

Changes the full-width font.

Format

null FONT_ID(FullWidthFont_int)

Settings

Specify the full-width font number in "FullWidthFont_int".

When using the basic mode, specify any of the following values:

0: MS Mincho

1: MS Gothic

In graphic mode, specify a full-width font number set in the XML form file within the following range.

0 to [the number of full-width fonts configured in the form - 1]

Restriction

You cannot use this feature if the locale of the XML form file is in English, French, Czech, or Thai.

Caution

If there are any improper configurations in the settings for each output printer model, or the Font.Alternative (alternative font) setting in the main properties (vfreport.properties.*), the form itself may not be printed.

Table 14. Target item

Item name	Graphic mode OFF	Graphic mode ON
Field
Static text
Rectangular callout	-
Elliptical callout	-
Cloud callout	-

HALF_FONT_ID

Feature	Changes the half-width font.
Format	null HALF_FONT_ID(HalfWidthFont_int)
Settings	Specify the half-width font number in "HalfWidthFont_int". When using the basic mode, specify any of the following values: 0: None (use the full-width font) 1: Courier 2: OCRB In graphic mode, specify a half-width font number set in the XML form file within the following range. 0 to [the number of half-width fonts configured in the form] Restriction You cannot specify "0" as the half-width font number if the locale of the XML form file is in English, French, Czech, or Thai. Caution If there are any improper configurations in the settings for each output printer model, or the Font.Alternative (alternative font) setting in the main properties (vfreport.properties.*), the form itself may not be printed.

Feature

Changes the half-width font.

Format

null HALF_FONT_ID(HalfWidthFont_int)

Settings

Specify the half-width font number in "HalfWidthFont_int".

When using the basic mode, specify any of the following values:

0: None (use the full-width font)

1: Courier

2: OCRB

In graphic mode, specify a half-width font number set in the XML form file within the following range.

0 to [the number of half-width fonts configured in the form]

Restriction

You cannot specify "0" as the half-width font number if the locale of the XML form file is in English, French, Czech, or Thai.

Caution

Table 15. Target item

Item name	Graphic mode OFF	Graphic mode ON
Field
Static text
Rectangular callout	-
Elliptical callout	-
Cloud callout	-

FONT_SIZE

Feature	Changes the font size.
Format	null FONT_SIZE(Point_double)
Settings	Specify the font size in units of points in "Point_double" (1 to 96).

Table 16. Target item

Item name	Graphic mode OFF	Graphic mode ON
Field
Static text
Rectangular callout	-
Elliptical callout	-
Cloud callout	-

TEXT

Feature	Changes the content of static text.
Format	null TEXT(String_string)
Settings	Specify the string contents in "String_string".

Table 17. Target item

Item name	Graphic mode OFF	Graphic mode ON
Static text
Rectangular callout	-
Elliptical callout	-
Cloud callout	-

UNDERLINE

Feature

Highlights text with underlines and other styles.

Format

null UNDERLINE(LineType_int,Width_int,Kind_int<,ColorNumber_int<,Range_int<,Range_string<,NumberedRange_string>>>>)

Settings

Specify any of the following line types in "LineType_int":
0
Solid line
1
Dashed line 1
2
Dashed line 2
3
Dashed line 3
4
Dash-dot line
5
Dash-dot-dot line
Specify the line width (thickness) in units of dots in "Width_int" (1 to 16).
Specify any of the following types in "Kind_int":
1
Underline
2
Overline
3
Double underline
4
Double overline
5
Double strikethrough line
6
Strikethrough line
Specify the palette color number for the line color in "ColorNumber_int". You can omit this step.
Basic mode: [0] to 16 (the value in [ ] is the initial value)
　0: Page color
Specify any of the following values in "Range". You can omit this step.
[0]: Highlights field area (the value in [ ] is the initial value)
　1: Highlights only data area
　2: Highlights the specified range (for each character)
　3: Highlights the specified range (by specifying strings)

Specify characters or strings that you want to highlight in "Range_string". You can omit this step.

Specify this argument only when the value of "Range_int" is "2" or "3".

If the value in "Range_int" is "2", specify the value for the width of the line you want to apply for each character in the output data in units of dots.

Reference

"One character" for each character has the following meanings:

For horizontal writing fields (text direction: horizontal)

One half-width character is counted as "1 character", and one full-width character is counted as "2 characters".

For vertical writing fields (text direction: vertical)

One character is counted as "one character".

The descriptions for each available value are as follows:

Available line width values	Description
0	Does not draw any line.
1 to 9	Draws a line with the specified line width. (Example: if "1" is specified, the line width is 1.)
A (a)	Draws a line with the line width of 10.
B (b)	Draws a line with the line width of 11.
C (c)	Draws a line with the line width of 12.
D (d)	Draws a line with the line width of 13.
E (e)	Draws a line with the line width of 14.
F (f)	Draws a line with the line width of 15.
G (g)	Draws a line with the line width of 16.

Reference

For values enclosed with ( ), you can also specify a lower case character.

If you specify "3" in "Range_int", specify the string that you want to highlight.
Note that you must specify a value for the seventh argument, "NumberedRange_string".

Specify the ID of the string to highlight in "NumberedRange_string".
Specify this argument only when the value of "Range_int" is "3".
Use a half-width numeric value to specify which string you want to highlight. (The value in [ ] is the initial value.)
［0］
Searches data for the string specified in "Range_string", and highlights all occurrences of the string that were found.
Positive value
Searches for the string specified in "Range_string" from the beginning of the data, and highlights the string corresponding to the specified number.
Example: "2" is specified
Highlights the second string detected from the beginning of the data.
Negative value
Searches for the string specified in "Range_string" from the end of the data, and highlights the string corresponding to the specified number.
Example: "-2" is specified
Highlights the second string detected from the end of the data.

Reference

If you specify "3" in "Range_int", and omit "NumberedRange_string", the initial value is used.
You can use ", (half-width comma)" and ": (half-width colon)" as follows to specify multiple numbers:
- , (Half-width comma)
  Separate numbers.
  - Example 1: 1,3
    Highlights the first and third strings counted from the beginning of the data.
  - Example 2: -1:-3
    Highlights the first and third strings counted from the end of the data.
- : (Single byte colon)
  Specify a range of numbers.
  Specify in the format of "<smaller_value>:<larger_value>".
  - Example 1: 1,3
    Highlights the first to third strings counted from the beginning of the data.
  - Example 2: -3:-1
    Highlights the first to third strings counted from the end of the data.

Caution

When "Range_int" is set to "2"
- The value you specified in "Width_int" is ignored and the line width you specified in "Range_string" is enabled.
  However, you cannot omit the value of "Width_int". You must specify a value (1 to 16).
- Any part you specified that exceeds the print data length is ignored.
When "Range_int" is set to "3"
About "NumberedRange_string"
- You cannot specify both positive and negative numbers at the same time.
- When you specify two or more numbers using half-width commas and "0" is included in "NumberedRange_string", all of the other numbers are ignored, and all occurrences of the string are highlighted.

Restriction

When "Range_int" is set to "2"
It cannot be used if an auto-link field is set for the field.
When "Range_int" is set to "3"
For an auto link-field, if the string specified in "Range_string" is present at the word wrap position, it will not be found in the search.
If the value of the property Pitch(dot) is greater than "0", or if Edit style is set to Justification, the position of the underline drawn for the string may differ between the edges and the center of the string.
The positions of highlight lines and characters may be misaligned depending on the settings for the font size, paper resolution, and edit style.
Thai is not supported.

Usage examples

Usage examples of "Type" (third argument) *1
- Example 1: Underline
  UNDERLINE(0, 1, 1, 0, 1)
- Example 2: Double underline
  UNDERLINE(0, 1, 3, 0, 1)
- Example 3: Single strikethrough line
  UNDERLINE(0, 1, 6, 0, 1)
Usage examples of "Range_int" (fifth argument) and "NumberedRange_string" (seventh argument)
- When the value of "Range_int" is "2" *2
  - Example 4.1
    To output the data "July 23, 2011" in a horizontal writing field to underline "July" (the first to fourth characters from the beginning) with line width "2", "23" (the sixth and seventh characters) with line width "9", and "2011" (the tenth to thirteenth characters) with line width "2".
    UNDERLINE(0, 1, 1, 0, 2, "00002200990022")
  - Example 4.2
    To output the data "2011年07月23日" in a vertical writing field to underline "年" (the fifth character from the beginning) with line width "2", "月" (the eighth character) with line width "9", and "日" (the eleventh character) with line width "2".
    UNDERLINE(0, 1, 1, 0, 2, "00002009002")
- When the value for "Range_int" is "3" and "NumberedRange_string" (seventh argument) is specified *3
  - Example 5.1
    To search data for the string "Important" and underline all occurrences of the string
    UNDERLINE(0, 1, 1, 0, 3, "Important", "0")
  - Example 5.2
    To search data for the string "Important" and underline the second string counted from the beginning when multiple occurrences were found
    UNDERLINE(0, 1, 1, 0, 3, "Important", "2")
  - Example 5.3
    To search data for the string "Important" and underline the second string counted from the end when multiple occurrences were found
    UNDERLINE(0, 1, 1, 0, 3, "Important", "-2")
  - When using a field reference
    Example 5.4
    To search for strings in the field "F1" (where the Data type property is Text), and draw a strikethrough line for all occurrences of the string
    UNDERLINE(0, 1, 6, 0, 3, F1)
  - When using an edit function
    Example 5.5
    To search for strings in the field "F1" (where the Data type property is Numeric value), and draw a single strikethrough line for all occurrences of the string
    UNDERLINE(0, 1, 6, 0, 3, STR(F1))

Reference

For details on print results, see ""Kind_int" (third argument)".
For details on print results, see ""Range_int" (fifth argument)".
For details on print results, see ""NumberedRange_string" (seventh argument)".

Reference

To include ' (single quotation) or " (double quotation) when defining "Range_string" and "NumberedRange_string" directly in an attribute-formula, enclose the quotations with double quotations.

(Example): To specify "'Important'" in "Range_string" (single quotations are shown in bold red)

UNDERLINE(0, 1, 1, 0, 3, "'" + "Important" + "''")

Table 18. Target item

Item name	Graphic mode OFF	Graphic mode ON
Field		-

PAINT

Feature	Highlights text with background fill.
Format	null PAINT(FillColorNumber_int,Brightness_int<,LineSearchType_int<,Range_int>>)
Settings	Specify the palette color number for the fill color in "FillColorNumber_int". Basic mode: 0 to 16 (0 is the page color) Specify the fill brightness in "Brightness_int" (0=Dark to 100=Bright). Specify any of the following values in "LineSearchType_int". The value in [ ] is the default value. [1] : Do not search for surrounding lines (the area to fill follows "Range_int") 　2: Search surrounding lines and fill the area surrounded by the lines Specify any of the following values in "Range_int". The value in [ ] is the default value. [0]: Highlights field area 　1: Highlights only data area Reference You can omit "LineSearchType_int" and "Range_int". When specifying "Range_int" (fourth argument), you need to specify "LineSearchType_int" (third argument) as well. Fill by the PAINT function is drawn on the same layer as the item for which the attribute-formula is set. Caution If the color mode check box is cleared in the paper properties, items are not output in the specified fill color. The items are output in monochrome (grayscale). Restriction Thai is not supported.
Usage examples	Example 1: Filling a data area PAINT(3, 50, 1, 1) Example 2: Filling a field area PAINT(3, 50) Example 3: Filling an area enclosed by ruled lines PAINT(3, 50, 2)

Table 19. Target item

Item name	Graphic mode OFF	Graphic mode ON
Field		-

Reference

For details on "LineSearchType_int" (third argument) and "Range_int" (fourth argument), see "PAINT settings".

AREA

Feature	Automatically adjusts the font size so that text fits in the specified area.
Format	null AREA(Width_double,Height_double,FixedAspectRatio_int<,Alignment_int>)
Settings	Specify the horizontal (X) size of the area in "Width_double" (unit: dot, Base point: upper left of field, between 3 and 100000). Specify the vertical (Y) size of the area in "Height_double" (unit: dot, Base point: upper left of field, between 3 and 100000). Specify any of the following values in "FixedAspectRatio_int": 0: Do not fix the aspect ratio 1: Fix the aspect ratio Specify any of the following values in "Alignment_int". The value in [ ] is the default value. When the text direction is horizontal, 4 = top, 5 = center, 6 = bottom Reference You can omit "<Alignment_int>". Caution This function is enabled only when the rotation angle is divisible by 90. This function is disabled when a proportional font is used. This function is disabled when the Text direction property is set to Vertical. Restriction You can specify only "1" in "FixedAspectRatio_int" in the basic mode. Thai is not supported.

Table 20. Target item

Item name	Graphic mode OFF	Graphic mode ON
Field

Reference

For details on "FixedAspectRatio_int" (third argument) and "Alignment_int" (fourth argument), see "AREA settings".

FONT_STYLE

Feature	Copies string attributes.
Format	null FONT_STYLE(CopySourceItemName_item)
Settings	In "CopySourceItemName_item", specify the name of the item that you want to refer to for string attributes. Caution The item type and mode (basic/graphic) must match between the item for which you want to change the attributes and the item that you want to refer to for the attributes. (For callout items, you can also specify static text items that are set in the graphic mode.) The item to be referred to must be located on the same or a higher level in the hierarchy.

Table 21. Target item

Item name	Graphic mode OFF	Graphic mode ON
Field
Static text
Rectangular callout	-
Elliptical callout	-
Cloud callout	-

Reference

For details on the attributes of each target item that are copied, see "Attributes copied by FONT_STYLE".

Shape functions

STROKE_STYLE

Feature	Copies line (ruled lines and borders) attributes.
Format	null STROKE_STYLE(CopySourceItemName_item)
Settings	In "CopySourceItemName_item", specify the name of the item that you want to refer to line (ruled lines and borders) attributes. Caution The item type and mode (basic/graphic) must match between the item for which you want to change the attributes and the item that you want to refer to for the attributes. (Specify a rectangle when changing the attributes of a subform or record.) The item that you want to refer to for the attributes must be located on the same or a higher level in the hierarchy.

Table 22. Target item

Item name	Graphic mode OFF	Graphic mode ON
Subform (frame)
Record (frame)
Straight, vertical/horizontal lines
Rectangle
Polyline/polygon	-
Regular polygon	-
Circle	-
Ellipse	-
Circular arc	-
Ellipse arc	-
Bezier curve	-
Spline curve	-
Block arrow (single-direction)	-
Bent block arrow	-
U-Turn block arrow	-
Curved block arrow	-
Rectangular callout	-
Elliptical callout	-
Cloud callout	-
Memo	-
Clock	-
Star	-

Reference

For details on the attributes of each target item that are copied, see "Attributes copied by STROKE_STYLE".

FILL_STYLE

Feature	Copies surface (fill) attributes.
Format	null FILL_STYLE(CopySourceItemName_item)
Settings	In "CopySourceItemName_item", specify the name of the item that you want to refer to for surface (fill) attributes. Caution The item type and mode (basic/graphic) must match between the item for which you want to change the attributes and the item that you want to refer to for the attributes. (Specify a rectangle when changing the attributes of a record.) The item to be referred to must be located on the same or a higher level in the hierarchy. For records, the change will be overwritten by the change from an attribute-formula function if there is a conflict with hatching.

Table 23. Target item

Item name	Graphic mode OFF	Graphic mode ON
Record (frame)
Rectangle
Polyline/polygon	-
Regular polygon	-
Circle	-
Ellipse	-
Circular arc	-
Ellipse arc	-
Spline curve	-
Block arrow (single-direction)	-
Bent block arrow	-
U-Turn block arrow	-
Curved block arrow	-
Memo	-
Clock	-
Star	-

Reference

For details on the attributes of each target item that are copied, see "Attributes copied by FILL_STYLE".

ARROW_STYLE

Feature	Copies arrow attributes.
Format	null ARROW_STYLE(CopySourceItemName_item)
Settings	In "CopySourceItemName_item", specify the name of the item that you want to refer to for arrow attributes. Caution The item type must match between the item for which you want to change the attributes and the item that you want to refer to for the attributes. The item to be referred to must be located on the same or a higher level in the hierarchy. For polyline/polygon items with the Polygon properties check box selected, this function is disabled.

Table 24. Target item

Item name	Graphic mode OFF	Graphic mode ON
Straight, vertical/horizontal lines	-
Polyline/polygon	-
Circular arc	-
Ellipse arc	-
Bezier curve	-
Spline curve	-
Block arrow (single-direction)	-
Bent block arrow	-
U-Turn block arrow	-
Curved block arrow	-

Reference

For details on the attributes of each target item that are copied, see "Attributes copied by ARROW_STYLE".

Multi-page functions

PAGE_VISIBLE

Feature	Switches between show/hide (multi-page setting).
Format	null PAGE_VISIBLE(Flag_int,MultiPageNumber_int)
Settings	Specify whether to show or hide the item in "Flag_int". 0: Hide 1: Show Specify the multi-page ID for which you want to change the show/hide status in "MultiPageNumber_int" (from 1 to the last available multi-page ID). Caution If the VISIBLE function is used after the PAGE_VISIBLE function, only the result of the VISIBLE function is reflected in the output.

Table 25. Target item

Item name	Graphic mode OFF	Graphic mode ON
Field
Static text
Barcode		-
GS1 Databar		-
2D barcode		-
Image
Straight, vertical/horizontal lines
Rectangle
Polyline/polygon	-
Regular polygon	-
Circle	-
Ellipse	-
Circular arc	-
Ellipse arc	-
Bezier curve	-
Spline curve	-
Block arrow (single-direction)	-
Bent block arrow	-
U-Turn block arrow	-
Curved block arrow	-
Rectangular callout	-
Elliptical callout	-
Cloud callout	-
Memo	-
Clock	-
Star	-
Multi-item	-
Chart (chart area)	-

TEXT_PAGE_COLOR

Feature	Changes the font color (multi-page setting).
Format	null TEXT_PAGE_COLOR(ColorNumber_int,MultiPageNumber_int)
Settings	Specify the palette color number for the font color in "ColorNumber_int". Field, static text Basic mode: 0 to 16 (0 is the page color) Graphic mode: 0 to 256 (0 is the page color) Specify the multi-page ID for which you want to change the color in "MultiPageNumber_int" (from 1 to the last available multi-page ID). Caution If the color mode check box is cleared in the paper properties, items are not output in the specified color. The items are output in monochrome (grayscale). If the Gradation check box is selected, only some parts may be affected.

Table 26. Target item

Item name	Graphic mode OFF	Graphic mode ON
Field
Static text

MONO_PAGE_COLOR

Feature	Changes the monochrome color (multi-page setting).
Format	null MONO_PAGE_COLOR(ColorNumber_int,MultiPageNumber_int)
Settings	Specify the palette color number for the monochrome color in "ColorNumber_int". Image Basic mode: 0 to 16 (0 is the page color) Graphic mode: 0 to 256 (0 is the page color) Barcode, GS1 Databar Basic mode: 0 to 16 (0 is the page color) Specify the multi-page ID for which you want to change the color in "MultiPageNumber" (from 1 to the last available multi-page ID). Caution If the color mode check box is cleared in the paper properties, items are not output in the specified color. The items are output in monochrome (grayscale). This function is not effective for images other than monochrome images.

Table 27. Target item

Item name	Graphic mode OFF	Graphic mode ON
Image
Barcode		-
GS1 Databar		-

STROKE_PAGE_COLOR

Feature	Changes the line color (ruled lines and borders) (multi-page setting).
Format	null STROKE_PAGE_COLOR(ColorNumber_int,MultiPageNumber_int)
Settings	Specify the palette color number for the line color (ruled lines and borders) in "ColorNumber_int". Straight line, rectangle, subform, record Basic mode: 0 to 16 (0 is the page color) Graphic mode: 0 to 256 (0 is the page color) Specify the multi-page ID for which you want to change the color in "MultiPageNumber_int" (from 1 to the last available multi-page ID). Caution If the color mode check box is cleared in the paper properties, items are not output in the specified color. The items are output in monochrome (grayscale). If Line color pattern is not Fill color, only some parts may be affected.

Table 28. Target item

Item name	Graphic mode OFF	Graphic mode ON
Subform (frame)
Record (frame)
Straight, vertical/horizontal lines
Rectangle

FILL_PAGE_COLOR

Feature	Changes the surface color (fill color) (multi-page setting).
Format	null FILL_PAGE_COLOR(ColorNumber_int,MultiPageNumber_int)
Settings	Specify the palette color number for the surface color (fill color) in "ColorNumber_int". Rectangle, record Basic mode: 0 to 16 (0 is the page color) Graphic mode: 0 to 256 (0 is the page color) Specify the multi-page ID for which you want to change the color in "MultiPageNumber_int" (from 1 to the last available multi-page ID). Caution If the color mode check box is cleared in the paper properties, items are not output in the specified color. The items are output in monochrome (grayscale). If Fill pattern is not Fill color, only some parts may be affected. For records, the change will be overwritten by the change from an attribute-formula function if there is a conflict with hatching.

Table 29. Target item

Item name	Graphic mode OFF	Graphic mode ON
Record (frame)
Rectangle

Coordinate reference functions

XVAL

Feature	Retrieves the X coordinate.
Format	double XVAL(<ItemName_item>)
Settings	Specify the item name from which you want to retrieve the X coordinate in "ItemName_item". Reference You can omit "<ItemName_item>". If you omit it, the function returns the X coordinate of the item itself. Caution The item to be referred to must be located on the same or a higher level in the hierarchy. The retrieval accuracy may be in integer units if the graphic mode of the item is off.

Table 30. Target item

Item name	Graphic mode OFF	Graphic mode ON
Field
Static text
Barcode		-
GS1 Databar		-
2D barcode		-
Image
Straight, vertical/horizontal lines
Rectangle
Polyline/polygon	-
Regular polygon	-
Circle	-
Ellipse	-
Circular arc	-
Ellipse arc	-
Bezier curve	-
Spline curve	-
Block arrow (single-direction)	-
Bent block arrow	-
U-Turn block arrow	-
Curved block arrow	-
Rectangular callout	-
Elliptical callout	-
Cloud callout	-
Memo	-
Clock	-
Star	-
Chart (chart area)	-
TextFrame (frame)	-

Reference

For details on the coordinate position retrieved from each target item, see "Position retrieved by XVAL and YVAL".

YVAL

Feature	Retrieves the Y coordinate.
Format	double YVAL(<ItemName_item>)
Settings	Specify the item name from which you want to retrieve the Y coordinate in "ItemName_item". Reference You can omit "<ItemName_item>". If you omit it, the function returns the Y coordinate of the item itself. Caution The item that you want to refer to for the attributes must be located on the same or a higher level in the hierarchy. The retrieval accuracy may be in integer units if the graphic mode of the item is off.

Table 31. Target item

Item name	Graphic mode OFF	Graphic mode ON
Field
Static text
Barcode		-
GS1 Databar		-
2D barcode		-
Image
Straight, vertical/horizontal lines
Rectangle
Polyline/polygon	-
Regular polygon	-
Circle	-
Ellipse	-
Circular arc	-
Ellipse arc	-
Bezier curve	-
Spline curve	-
Block arrow (single-direction)	-
Bent block arrow	-
U-Turn block arrow	-
Curved block arrow	-
Rectangular callout	-
Elliptical callout	-
Cloud callout	-
Memo	-
Clock	-
Star	-
Chart (chart area)	-
TextFrame (frame)	-

Reference

For details on the coordinate position retrieved from each target item, see "Position retrieved by XVAL and YVAL".

START_XVAL

Feature	Retrieves the X coordinate of the start point.
Format	double START_XVAL(<ItemName_item>)
Settings	Specify the item name from which you want to retrieve the X coordinate of the start point in "ItemName_item". Reference You can omit "<ItemName_item>". If you omit it, the function returns the X coordinate of the start point of the item itself. Caution The item to be referred to must be located on the same or a higher level in the hierarchy. The retrieval accuracy may be in integer units if the graphic mode of the item is off.

Table 32. Target item

Item name	Graphic mode OFF	Graphic mode ON
Subform (frame)
Record (frame)
Image
Straight, vertical/horizontal lines
Rectangle
Bezier curve	-
Block arrow (single-direction)	-
Bent block arrow	-
U-Turn block arrow	-
Curved block arrow	-
Rectangular callout	-
Elliptical callout	-
Cloud callout	-
Memo	-
Chart (chart area)	-
TextFrame (frame)	-
Formcopy (frame)		-

Reference

For details on the coordinate position retrieved from each target item, see "Position retrieved by START_XVAL and START_YVAL".

START_YVAL

Feature	Retrieves the Y coordinate of the start point.
Format	double START_YVAL(<ItemName_item>)
Settings	Specify the item name from which you want to retrieve the Y coordinate of the start point in "ItemName_item". Reference You can omit "<ItemName_item>". If you omit it, the function returns the Y coordinate of the start point of the item itself. Caution The item to be referred to must be located on the same or a higher level in the hierarchy. The retrieval accuracy may be in integer units if the graphic mode of the item is off.

Table 33. Target item

Item name	Graphic mode OFF	Graphic mode ON
Subform (frame)
Record (frame)
Image
Straight, vertical/horizontal lines
Rectangle
Bezier curve	-
Block arrow (single-direction)	-
Bent block arrow	-
U-Turn block arrow	-
Curved block arrow	-
Rectangular callout	-
Elliptical callout	-
Cloud callout	-
Memo	-
Chart (chart area)	-
TextFrame (frame)	-
Formcopy (frame)		-

Reference

For details on the coordinate position retrieved from each target item, see "Position retrieved by START_XVAL and START_YVAL".

END_XVAL

Feature	Retrieves the X coordinate of the end point.
Format	double END_XVAL(<ItemName_item>)
Settings	Specify the item name from which you want to retrieve the X coordinate of the end point in "ItemName_item". Reference You can omit "<ItemName_item>". If you omit it, the function returns the X coordinate of the end point of the item itself. Caution The item to be referred to must be located on the same or a higher level in the hierarchy. The retrieval accuracy may be in integer units if the graphic mode of the item is off.

Table 34. Target item

Item name	Graphic mode OFF	Graphic mode ON
Subform (frame)
Record (frame)
Image
Straight, vertical/horizontal lines
Rectangle
Bezier curve	-
Block arrow (single-direction)	-
Bent block arrow	-
U-Turn block arrow	-
Curved block arrow	-
Rectangular callout	-
Elliptical callout	-
Cloud callout	-
Memo	-
Chart (chart area)	-
TextFrame (frame)	-
Formcopy (frame)		-

Reference

For details on the coordinate position retrieved from each target item, see "Position retrieved by END_XVAL and END_YVAL".

END_YVAL

Feature	Retrieves the Y coordinate of the end point.
Format	double END_YVAL(<ItemName_item>)
Settings	Specify the item name from which you want to retrieve the Y coordinate of the end point in "ItemName_item". Reference You can omit "<ItemName_item>". If you omit it, the function returns the Y coordinate of the end point of the item itself. Caution The item to be referred to must be located on the same or a higher level in the hierarchy. The retrieval accuracy may be in integer units if the graphic mode of the item is off.

Table 35. Target item

Item name	Graphic mode OFF	Graphic mode ON
Subform (frame)
Record (frame)
Image
Straight, vertical/horizontal lines
Rectangle
Bezier curve	-
Block arrow (single-direction)	-
Bent block arrow	-
U-Turn block arrow	-
Curved block arrow	-
Rectangular callout	-
Elliptical callout	-
Cloud callout	-
Memo	-
Chart (chart area)	-
TextFrame (frame)	-
Formcopy (frame)		-

Reference

For details on the coordinate position retrieved from each target item, see "Position retrieved by END_XVAL and END_YVAL".

In this section: