FOM Reference > Content > Pages > fLineNumbering interface
  
fLineNumbering interface
This object specifies properties for line numbering on a frame.
HorizontalLocations enumeration
Where to draw the line numbers in relation to the line.
The HorizontalLocations enumeration has the following constants of type int.
LOCATION_LINE = 0
Draw the numbers outside of the line edge.
LOCATION_FRAME = 1
Draw the numbers outside of the frame edge.
LOCATION_COLUMN = 2
Draw the numbers outside of the text column edge.
LOCATION_PAGE = 3
Draw the numbers inside the page edge.
Sides enumeration
Which side of the location to draw the number.
The Sides enumeration has the following constants of type int.
SIDE_LEFT = 0
Draw the numbers on the left of the location.
SIDE_RIGHT = 1
Draw the numbers on the right of the location.
color attribute
The color to use when drawing the line numbering.
color
Access
read-write
Returns
fColor
countParagraphs attribute
If true, the start of each paragraph will be counted instead of each line.
countParagraphs
Access
read-write
Returns
boolean
countTableColumn attribute
Only count lines in this table column. If set to -1, lines in all columns will be counted.
countTableColumn
Access
read-write
Returns
int
enabled attribute
If true, line numbers will be drawn when this frame is formatted.
enabled
Access
read-write
Returns
boolean
font attribute
The name of the font to use when drawing the line numbering.
font
Access
read-write
Returns
String
formatSeparator attribute
The separator to use when generating the line number.
formatSeparator
Access
read-write
Returns
String
formatSeparatorWidth attribute
The number of characters between each separator when generating the line number.
formatSeparatorWidth
Access
read-write
Returns
int
height attribute
The font height for the line numbering.
height
Access
read-write
Returns
fLength
ignoreEmptyLines attribute
If true, lines with no text will be ignored.
ignoreEmptyLines
Access
read-write
Returns
boolean
location attribute
Where to draw the line numbers. Values are one of fLineNumbering-HorizontalLocations.
location
Access
read-write
Returns
int
multiple attribute
How often to output the line numbering.
multiple
Access
read-write
Returns
int
numberFormat attribute
The format sequence to use when generating the line number. Valid values are in fNumberFormat-NumberFormats.
numberFormat
Access
read-write
Returns
String
offset attribute
The offset from the location to draw the numbering.
offset
Access
read-write
Returns
fLength
prefix attribute
The string to prefix the line number with.
prefix
Access
read-write
Returns
String
restart attribute
If true, the line numbering will restart from 1, otherwise it will continue from the highest value of the last frame formatted.
restart
Access
read-write
Returns
boolean
side attribute
Which side of the location to draw the number. Values are one of fLineNumbering-Sides.
side
Access
read-write
Returns
int