fdTextProperties interface

FOM Reference > Display > Page Content > fdTextProperties interface

This object provides a read-only view of all fStyle and fParagraph properties that are currently set.

autoLeading attribute

PI: tal

Activates/deactivates auto leading of text.

autoLeading
Access	read-only
Returns	boolean

autoLeadingAboveIncrement attribute

PI: talainc

Specifies the amount to increase the leading incrementally, above the baseline. The property autoLeadingAboveMaximum determines whether leading is needed.

autoLeadingAboveIncrement
Access	read-only
Returns	fLength

autoLeadingAboveMaximum attribute

PI: talamax

Specifies the value at which leading will be automatically increased.

autoLeadingAboveMaximum
Access	read-only
Returns	fLength

autoLeadingAboveMaximumTopDrop attribute

PI: talamaxdt

Specifies the value at which leading will be automatically increased when topDrop was used to control the leading.

autoLeadingAboveMaximumTopDrop
Access	read-only
Returns	fLength

autoLeadingAboveMaximumTopDropCell attribute

PI: talamaxdtc

Specifies the value at which leading will be automatically increased when topDropCell was used to control the leading.

autoLeadingAboveMaximumTopDropCell
Access	read-only
Returns	fLength

autoLeadingBbx attribute

PI: talbbx

Activates/deactivates auto leading of text in a similar way to autoLeading, but instead of assuming a 3/4-1/4 ratio from the text height it measures the bounding box of each character used.

autoLeadingBbx
Access	read-only
Returns	boolean

autoLeadingBelowIncrement attribute

PI: talbinc

Specifies the amount to increase the leading incrementally, below the baseline. The property autoLeadingBelowMaximum determines whether leading is needed.

autoLeadingBelowIncrement
Access	read-only
Returns	fLength

autoLeadingBelowMaximum attribute

PI: talbmax

Specifies the value below the baseline at which leading will be automatically increased.

autoLeadingBelowMaximum
Access	read-only
Returns	fLength

autoLeadingGap attribute

PI: talgap

Specifies the size of the gap that auto-leading should use if the gap is less than autoLeadingGapLimit.

autoLeadingGap
Access	read-only
Returns	fLength

autoLeadingGapLimit attribute

PI: talglim

Specifies the gap limit between the lowest point of a descender below the baseline and the highest point of an ascender above the baseline. If this limit is exceeded, auto leading will be applied.

autoLeadingGapLimit
Access	read-only
Returns	fLength

autoLeadingTooTall attribute

PI: taltootall

If set to true, an item that is to tall to fit and cannot be split, is allowed to overhang the bottom of the frame. This property is used in conjunction with the autoLeading property.

autoLeadingTooTall
Access	read-only
Returns	boolean

avoid attribute

PI: tpavtxt

Specifies that the style should be avoided by other text styles, therefore ensuring that text does not overlap it. The tpavtxt macro turns avoid this text mode for paragraphs on and off.

When false, text from other styles will be able to overwrite this style. When true, Arbortext LD will prevent text from other styles overwriting this style.

avoid
Access	read-only
Returns	boolean

backgroundColor attribute

PI: tpbgc

Sets the paragraph background colour.

backgroundColor
Access	read-only
Returns	fColor

backgroundHashMode attribute

PI: tpbghash

This property positions hash rule background colour precisely around text, (hash rules are not governed by the margins of a paragraph style). The background colour can be set precisely around text, instead of filling the entire frame within paragraph margins.

When false, the default paragraph rule background colour settings are on. Therefore the background colour will be positioned as normal. When true, hash rule background colour is applied to the paragraph, according to the hash rule settings specified in the Paragraph Rules dialogue box or in the ruleHashWidth property.

backgroundHashMode
Access	read-only
Returns	boolean

backgroundRule attribute

PI: ttbgc

The fTextRule object to control the style of the background rule.

backgroundRule
Access	read-only
Returns	fTextRule

balanceBaselines attribute

PI: tpbalbase

Instructs LD that when balancing text in columns that it uses the baselines, overriding the current setting of fParagraph-fitDescenders.

This is useful when using professional leading mode in combination with autoleading. It means the balance isn't affected by whether the lines at the bottom of columns have descenders or not. As a result the 1st column might be shorter if it doesn't have descenders, but there's a greater chance that the columns will contain similar numbers of line.

N.B. this mode is meant to help with text descenders - it can be cancelled for paragraphs with a minimum height, for displaymaths, or for lines containing inline maths which the auto-leading determines is the deepest thing in the line.

balanceBaselines
Access	read-only
Returns	boolean

balanceBefore attribute

PI: tpbalbef

Balances columns of text above a paragraph for which this attribute is turned on. This is the equivalent of selecting Balance cols Before para in the Paragraph Breaks dialogue box.

balanceBefore
Access	read-only
Returns	boolean

balanceColumns attribute

PI: tpbal

Switches 'column balance' on or off for the current paragraph. When a page which contains two or more columns of text is formatted (with trf or tformat), and the last paragraph on the page has this attribute, additional space will be added to the bottom margin so that the text in each column balances. This is the equivalent of selecting Balance cols After para in the Paragraph Breaks dialogue box.

balanceColumns
Access	read-only
Returns	boolean

balanceFrom attribute

PI: tpbalfrom

Specifies the position to balance columns from; either from the first column, the earliest possible position or the latest possible position.

Balance from first column.

Balance from earliest possible position.

Balance from latest possible position.

To get results, you need to have balance enabled: paragraph.balanceBefore = true. You also need to specify how many columns should be balanced: paragraph.spanColumnsNum = 2.

balanceFrom
Access	read-only
Returns	int

balanceMultiples attribute

PI: tpbalmult

Specifies if columns should be spanned in multiples of the value specified using the column span property, spanColumnsNum.

To get results, you need to have balance enabled: paragraph.balanceBefore = true. You also need to specify how many columns should be balanced: paragraph.spanColumnsNum = 2.

balanceMultiples
Access	read-only
Returns	int

balanceSpan attribute

PI: tpbalspan

Specifies the number of columns to span across. You can either span all columns or span the same number of columns as specified using the column span macro, spanColumnsNum.

When false , all columns are spanned. When true, the same number of columns as specified using the column span macro, spanColumnsNum.

To get results, you need to have balance enabled: paragraph.balanceBefore = true. You also need to specify how many columns should be balanced: paragraph.spanColumnsNum = 2.

balanceSpan
Access	read-only
Returns	boolean

baselineShift attribute

PI: tvs

Moves text vertically off its baseline by a specified amount. Can also be a negative value. Can be used or thought of as a sort of superscript (<?sup>) or subscript (<?sup>) that does not change the character size.

baselineShift
Access	read-only
Returns	fLength

capsHeight attribute

PI: tscaph

Sets the height of small capitals in percent.

capsHeight
Access	read-only
Returns	float

capsMode attribute

PI: tcaps

Forces text to appear as typed, capitalised or in lower case. The conversion only takes place for display and print purposes, leaving the actual contents of the text stream unchanged. See StyleCapsMode.

capsMode
Access	read-only
Returns	int

capsWidth attribute

PI: tscapw

Sets the width of small capitals in percent.

capsWidth
Access	read-only
Returns	float

characterVerticalFormat attribute

PI: tchrvf

Sets the vertical format for characters, generally used in conjunction with rotate. When a character is rotated, uses the character's outline, whether it is above or below the baseline and aligns itself. See CharacterVerticalFormat.

characterVerticalFormat
Access	read-only
Returns	int

characterVerticalMode attribute

PI: tchrvmode

Lets you explicitly set character vertical mode. This is particularly useful in respect to Chinese, Japanese and Korean text. When in this mode characters will sit one on top of the next.

characterVerticalMode
Access	read-only
Returns	int

characterVerticalOffset attribute

PI: tchrvfoff

Allows Japanese and Latin characters to be offset vertically in relation to English characters. This is done by adjusting the alignment point when centering, flushing top or flushing bottom.

characterVerticalOffset
Access	read-only
Returns	fLength

characterWidth attribute

PI: tchrw

Sets the fixed width for a character to use in conjunction with tchrfixedw. Once you have set the fixed width with characterWidth, you then apply it with fixedWidth.

characterWidth
Access	read-only
Returns	fLength

color attribute

PI: tic

Sets the normal colour of text. Setting the colour to none makes the body of each character transparent. You can set an outline colour using outlineColor.

color
Access	read-only
Returns	fColor

decimalChars attribute

PI: ttdch

Specifies the character on which decimal tabs align. By default this is a ' . ' (full stop), but can be changed to any other character, for instance a ' , ' (comma). The decimal tab character set specifies the set of characters that LD uses to perform decimal alignment. By default this set contains a ' . ' (full stop). It is possible to specify additional characters to this set (maximum of four) so that LD uses any of the characters to perform decimal alignment.

decimalChars
Access	read-only
Returns	String

defaultFont attribute

PI: tfdef

Defines a default font for a paragraph to use if a character is not present within the selected font. If the character is also not present in the default font, a missing glyph will be output.

defaultFont
Access	read-only
Returns	fFont

direction attribute

PI: tpdir

Changes the direction of text drawing and column flowing. Useful only in Arabic systems or any other language which reads from right to left.

0	Text flow is from left to right (latin).
1	Text flow is from right to left (arabic).

direction
Access	read-only
Returns	int

displayHeight attribute

PI: tdh

Sets the text height without changing any other attribute that depends on the height such as text width and leading.

displayHeight
Access	read-only
Returns	fLength

displayWidth attribute

PI: tdw

Sets the text width without changing any other attribute that depends on the width (e.g. inter-word spacing). This essentially gives 'condensed' or 'expanded' type.

displayWidth
Access	read-only
Returns	fLength

doubleUnderline attribute

PI: tuld

Switches double underlining on or off. Text will be double underlined using the current lineColor,underlinePosition and lineThickness. The position of the second underline will be twice the normal underlinePosition.

doubleUnderline
Access	read-only
Returns	boolean

endSpace attribute

PI: tespace

Instructs Arbortext LD to ignore or include additional spaces that occur at the end of a text stream when formatting it.

endSpace
Access	read-only
Returns	boolean

extendedBreaks attribute

PI: tpxbrk

The tpxbrk turns Extended breaks mode on and off. When Extended breaks mode is on, Arbortext LD will apply Breaks settings to text in partial columns (columns that have been interrupted or split by other frames). See fFrame::extendedBreaks.

extendedBreaks
Access	read-only
Returns	boolean

extendedOrphans attribute

PI: tpxorph

When a paragraph is broken by a frame, the extended break keeps hold of the orphans after this frame. See fFrame::extendedOrphans.

extendedOrphans
Access	read-only
Returns	boolean

fillIgnore attribute

PI: tpigfill

This property will override a frame filler stream ( fFrame::fillStream) for a frame, if the paragraph that it is applied to is the last in a column. If ignoreFill has been turned on, Arbortext LD will not fill any space left after the paragraph in the column with text from a filler stream.

When true, even if a frame filler stream has been specified for the frame, Arbortext LD will not use it to fill gaps in the column.

fillIgnore
Access	read-only
Returns	boolean

fillNoScan attribute

PI: tpnoscan

Prevents Arbortext LD using the forward scan limit for fill mode when re-formatting a document.

fillNoScan
Access	read-only
Returns	boolean

fitDescenders attribute

PI: tpfitb

Instructs LD to include text descenders, ie. anything that appears below the text baseline, when measuring text size for column fit. This affects the way text is vertically centerd in a column, flushed to the bottom, or vertically justified.

When Arbortext LD works out whether a line of text fits into a column, it usually allows descenders, i.e. anything below the baseline, to overhang the bottom of the column. You can tell Arbortext LD to measure from the bottom of the text line instead, in which case the descenders must fit in as well or the line is taken over to the next column. This affects the way text is vertically centered in a column, flushed to the bottom, or vertically justified; but in this case measuring from the bottom means that paragraph rules are taken into account too.

fitDescenders
Access	read-only
Returns	boolean

fitRules attribute

PI: tpfitbr

Instructs LD to measure text from the bottom of the text line instead of from the baseline when fitting a line of text into a column: with this option set there must be sufficent space left in the column to fit descenders, otherwise the line will be taken over to the next column. This affects the way text is vertically centered in a column, flushed to the bottom, or vertically justified; it also means that paragraph rules are taken into account during the fit calculation

This property is identical to fitDescenders but has been adapted for paragraphs with rules.

fitRules
Access	read-only
Returns	boolean

fixedWidth attribute

PI: tchrfixedw

Determines whether to use the individual width of a character or the same width for all characters. If a fixed width is used then the value of characterWidth will be applied which defaults to width.

fixedWidth
Access	read-only
Returns	boolean

flip attribute

PI: tchrflip

Flip character vertically within the outline of the character.

flip
Access	read-only
Returns	boolean

font attribute

PI: tffamily

Specifies the font family or typeface to use for text.

font
Access	read-only
Returns	fFont

fontNonLatin attribute

PI: tfnl

The default font to use for non-latin characters.

fontNonLatin
Access	read-only
Returns	fFont

height attribute

PI: th

Sets the text height of a font. Any other attributes that depend on the text height will also change.

height
Access	read-only
Returns	fLength

hyphenationAtColumnBreak attribute

PI: thyllcdis

This property controls the hyphenation of the last word before a column break. If true(the default), the last word will be hyphenated. If false, the last word will not be hyphenated.

hyphenationAtColumnBreak
Access	read-only
Returns	boolean

hyphenationAtPageBreak attribute

PI: thyllpdis

This property controls the hyphenation of the last word before a page break. If true(the default), the last word will be hyphenated. If false, the last word will not be hyphenated.

hyphenationAtPageBreak
Access	read-only
Returns	boolean

hyphenationBreakCharacters attribute

PI: twbch

Allows you to specify additional hyphenation characters at which to break a line.

hyphenationBreakCharacters
Access	read-only
Returns	String

hyphenationCharacter attribute

PI: thych

Specifies the character that will be used to show a word has been hyphenated (Only the first character of the string is used). If the string is empty, no hyphenation character will be displayed.

hyphenationCharacter
Access	read-only
Returns	String

hyphenationCharsAfter attribute

PI: thyaft

Prevent words from hyphenating too near to the end of a word.

The minimum number of characters from a word that must be left after the hyphen when a word is hyphenated. If this were, for instance, 3, the word 'hyphenated' could not be broken as 'hyphenat-ed'.

hyphenationCharsAfter
Access	read-only
Returns	int

hyphenationCharsBefore attribute

PI: thybef

Prevents words from hyphenating too near to the start of a word.

The minimum number of characters from a word that must be left in front of a hyphen. If this were, for instance, 3, the word 'hyphenated' could notbe broken as 'hy-phenated'.

hyphenationCharsBefore
Access	read-only
Returns	int

hyphenationCharsMin attribute

PI: thymin

Sets the minimum word size that may be hyphenated.

hyphenationCharsMin
Access	read-only
Returns	int

hyphenationExceptionDictionary attribute

PI: thye

Defines a primary hyphenation exception dictionary to use. This should be the tag containing the dictionary.

hyphenationExceptionDictionary
Access	read-only
Returns	fStream

hyphenationExceptionDictionary2 attribute

PI: thye2

Defines a secondary hyphenation exception dictionary to use. This should be the tag containing the dictionary.

hyphenationExceptionDictionary2
Access	read-only
Returns	fStream

hyphenationLanguage attribute

PI: tl

Sets the current language for hyphenation.

hyphenationLanguage
Access	read-only
Returns	String

hyphenationLevel attribute

PI: thyc

Sets a basic hyphenation level. This enables you to specify how strict hyphenation should be.

Value	Description
0	Least strict. Simply fits as many characters as is possible on to the line. Hyphenation will occur whenever text reaches the end of a line, regardless of whether it looks correct or not.
1..4	Increasingly strict. Implements increasingly strict hyphenation levels.
5	Normal.
6..8	Increasingly strict. Implements increasingly strict hyphenation levels.
9	Most strict. Only the most rigorous decisions will be taken for placing hyphens. This does not necessarily mean best visually. Most strict forces Arbortext LD to miss out hyphenating opportunities which would probably result in a more evenly space line.
10	Off. No attempt at hyphenation will be made. This also disables any discretionary hyphens that you may have placed in the text.
11	Simple hyphenation. This ignores Arbortext LD's normal method of comparing each previous line to the current line to see if the lines are not too far apart in terms of loose or tight fit. Using this method Arbortext LD will scan back as far as the beginning of the last paragraph and readjust the letter, word fit and hyphenation to achieve a more aesthetic appearance. With simple hyphenation (11) each line is considered individually and no scanning of previous lines will occur. Simple hyphenation works by looking at all valid hyphenation points and choosing the last one possible, so that as much of the word as possible will still fit on the line.
12	Single word only. Only hyphenates when a single word will not fit on a line. If you set hyphenation level to 12, 'Single word only' in the Hyphenation Level dialogue box, Arbortext LD will only hyphenate a word if it is wider than the measure of the text frame or line.

hyphenationLevel
Access	read-only
Returns	int

hyphenationMaxNum attribute

PI: thyn

Sets the maximum number of hyphens that may appear consecutively down the right hand edge of a column.

hyphenationMaxNum
Access	read-only
Returns	int

hyphenationOnLastWord attribute

PI: thylwdis

This property controls the hyphenation of the last word in a paragraph. If true(the default), the last word will be hyphenated. If false, the last word will not be hyphenated.

hyphenationOnLastWord
Access	read-only
Returns	boolean

hyphenationType attribute

PI: thytype

This macro enables you to specify an alternative hyphenation type for use with Arbortext LD. If you have installed Dieckmann hyphenation algorithms you need to tell Arbortext LD that you would like to use these, instead of the default hyphenation algorithms.

hyphenationType
Access	read-only
Returns	int

hyphenationUppercaseDisable attribute

PI: thyucdis

Disables hyphenation of words which include an upper-case letter, for example, names.

hyphenationUppercaseDisable
Access	read-only
Returns	boolean

ignoreCharacters attribute

PI: tignchar

If true, all output chacaters will be ignored. Entities and Tags will still be processed.

ignoreCharacters
Access	read-only
Returns	int

ignoreParagraph attribute

PI: tpignme

Ignore this paragraph for most formatting purposes.

ignoreParagraph
Access	read-only
Returns	boolean

ignoreRuleWidths attribute

PI: tpignrw

Ignore the rule widths for this paragraph, so that they don't take up any space and are centred on the paragraph boundaries.

ignoreRuleWidths
Access	read-only
Returns	boolean

indentLeft attribute

An Array that contains the left indents for this paragraph.

indentLeft
Access	read-only
Returns	fArray

indentRight attribute

An Array that contains the right indents for this paragraph.

indentRight
Access	read-only
Returns	fArray

inlineRules attribute

Sets inline rules.

inlineRules
Access	read-only
Returns	fRules

inlineRulesUnderprint attribute

If true, the inline rules will be drawn under the text.

inlineRulesUnderprint
Access	read-only
Returns	boolean

inverse attribute

PI: tinv

Gives white text on a black background. Arbortext LD automatically changes the text colour, underline colour, underline thickness and underline position to achieve this effect. For example, if you need white text on a red background, or want to change the size of the background, the best thing is to use the macros for these attributes directly. You can also use fParagraph::backgroundColor as a text attribute which will affect the lines in a paragraph below it.

inverse
Access	read-only
Returns	boolean

italic attribute

PI: tfitalic

Toggle italics of the text font.

italic
Access	read-only
Returns	boolean

justificationLimit attribute

PI: tjl

Sets the justification limit of the current paragraph. If, when the paragraph is formatted, there is less than justify limit amount of space on the last line of the paragraph, then that last line will be force justified to fit the measure.

justificationLimit
Access	read-only
Returns	fLength

keepEndWithNext attribute

PI: tpkend

When applied to a paragraph, the tpkend macro forces its last line to stay in the same column as the next paragraph. Therefore, if the next paragraph starts in another frame or column, the last line of the paragraph would be moved to stay with it. See KeepMode.

keepEndWithNext
Access	read-only
Returns	int

keepWithNext attribute

PI: tpkeep

Switches 'keep with next' on or off for the current paragraph. 'Keep with next' ties a paragraph to the start of the next paragraph such that they always appear in the same column together. If the next paragraph moves to the top of the next column or page then the current paragraph will move also. See KeepMode.

keepWithNext
Access	read-only
Returns	int

keepWithPrev attribute

PI: tpprev

When applied to a paragraph, keepWithPrev forces its first line to stay in the same column as the previous paragraph. Therefore, if the previous paragraph starts in another frame or column, the first line of the paragraph would be moved to stay with it. See KeepMode.

keepWithPrev
Access	read-only
Returns	int

kerningBeforeLigature attribute

PI: tkfirst

If true, non-shaping kerning will be applied before ligatures, otherwise it will be applied after ligatures.

kerningBeforeLigature
Access	read-only
Returns	boolean

kerningDisable attribute

PI: tkdis

If true, non-shaping kerning will not be applied. This property is ignored if fStyle.useOpenType is true.

kerningDisable
Access	read-only
Returns	boolean

kerningTable attribute

PI: tk

Specifies which of the current document’s kerning tables will be used to control the automatic kerning of text.

kerningTable
Access	read-only
Returns	fStream

leading attribute

PI: tlb

Sets the line spacing of text to the specified value. The distance between the baselines of successive lines of text, sometimes also called 'leading'. In some circles, the term 'leading' is used to describe the extra space inserted between lines. To get this sort of leading in Arbortext LD, set your line spacing values like this: fLength('2pt+h'), fLength('5mm+h'), fLength('1pc+h'), etc.

leading
Access	read-only
Returns	fLength

letterSpace attribute

PI: tlsb

Sets the basic letter spacing value. This is the basic amount of space added to the right of a letter that will be applied when formatting a line. The extra space at the end of the line is not used, providing for correctly justified or centred lines.

letterSpace
Access	read-only
Returns	fLength

letterSpaceExtra attribute

PI: tlse

Sets the maximum amount of extra space that can be added to the letter spacing when justifying a line. LD will avoid letter spacing whenever possible

letterSpaceExtra
Access	read-only
Returns	fLength

letterSpaceSquash attribute

PI: tlss

Sets the the maximum amount of space that can be removed from the letter spacing when justifying a line. LD will avoid letter spacing whenever possible.

letterSpaceSquash
Access	read-only
Returns	fLength

ligatureGroup attribute

PI: tklgp

Define a level of ligature to be applied to text by confirming which ligature group(s) are to be applied. See fStyle.LigatureGroups. LD defaults to a setting of 255, which adds together all the group numbers allowed and therefore turns all levels on.

ligatureGroup
Access	read-only
Returns	int

ligatureTable attribute

PI: tlig

Specifies which of the current document's ligature tables will be used.

ligatureTable
Access	read-only
Returns	fStream

lineBackgroundColor attribute

PI: tubgc

Sets the background colour of underline, doubleUnderline, overline and strikethrough, used when the lineStyle is not solid.

lineBackgroundColor
Access	read-only
Returns	fColor

lineColor attribute

PI: tuc

Sets the colour of underline, doubleUnderline, overline and strikethrough.

lineColor
Access	read-only
Returns	fColor

lineEndPattern attribute

This is the pattern to use at the end of each rule segment (caused by line breaks, etc.)

This has no effect upon the backgroundRule.

lineEndPattern
Access	read-only
Returns	fRuleLinePattern

lineNumberSkip attribute

Ignore this paragraph for line numbering.

lineNumberSkip
Access	read-only
Returns	boolean

lineStartPattern attribute

This is the pattern to use at the start of each rule segment (caused by line breaks, etc.)

This has no effect upon the backgroundRule.

lineStartPattern
Access	read-only
Returns	fRuleLinePattern

lineStyle attribute

PI: tuls

The line style used by underline, doubleUnderline, overline and strikethrough.

lineStyle
Access	read-only
Returns	String

lineThickness attribute

PI: tut

Sets the line thickness of underline, doubleUnderline , overline and strikethrough. It is often a good idea to change the underline thickness to a setting that is the same as the narrowest part of the letters in a font.

lineThickness
Access	read-only
Returns	fLength

linkColor attribute

PI: tbklnkcol

Sets the colour of highlight for the hot area of a link in PDFs. If "none" (the default), the link colour specified in the PDF Printer options will be used.

linkColor
Access	read-only
Returns	fColor

lowercaseMap attribute

PI: ttolower

The map to use when converting characters to lower case with fdTextProperties.capsMode. If this is null or undefined, a default map will be used.

If the fStream type is fTag.TYPE_JS_FUNCTION, then the function will be called with arguments[0] set to the character to be mapped, and arguments[1] set to the current fdTextProperties.capsMode. The return value will be conveted to a string, and the first character will be used as a result of the map.

lowercaseMap
Access	read-only
Returns	fStream

marginBottom attribute

PI: tpb

Sets the paragraph bottom margin for the current paragraph. If used with formatting.currentParagraph, this attribute may be set anywhere in a paragraph.

marginBottom
Access	read-only
Returns	fLength

marginColumnTop attribute

PI: tpct

Sets the top margin for a paragraph that starts at the top of a column. The attribute must appear at the start of a paragraph, or be included in the paragraph style itself.

marginColumnTop
Access	read-only
Returns	fLength

marginLeft attribute

PI: tpl

Sets the left margin for a paragraph. If used with formatting.currentParagraph, this attribute should be set at the start of a paragraph.

marginLeft
Access	read-only
Returns	fLength

marginRight attribute

PI: tpr

Sets the right margin for a paragraph. If used with formatting.currentParagraph, this attribute should be set at the start of a paragraph.

marginRight
Access	read-only
Returns	fLength

marginTop attribute

PI: tpt

Sets the top margin for a paragraph that is not at the top of a column. If used with formatting.currentParagraph, this attribute should be set at the start of a paragraph. It has no effect in paragraphs for which the fFormatting::breakTop() has been called with BREAK_COLUMN or BREAK_PAGE.

marginTop
Access	read-only
Returns	fLength

maxHeight attribute

PI: tpmaxh

Sets the maximum paragraph height. The paragraph will not be allowed to extend beyond this height. This attribute, similar to minHeight, is useful for classified advertising. Another use could be to format address labels in which even long addresses get squeezed onto the label (replacing carriage returns with soft returns, so that each address just uses one paragraph).

maxHeight
Access	read-only
Returns	fLength

maximumGap attribute

PI: tpkpallmax

Specifies the maximum size of a region that is allowed to be left empty, possibly as the result of applying keeps. If this maximum is exceeded an error will be logged and the text will be allowed to extend beyond the bottom of the frame.

So specifying a value of 2in will ensure that only small frames are allowed to be formatted without any resulting content.

maximumGap
Access	read-only
Returns	fLength

minHeight attribute

PI: tpminh

Sets the minimum paragraph height. This is the height that a paragraph must always fit and is particularly useful for things like paid classified advertising or chapter headings. This attribute is similar to maxHeight.

minHeight
Access	read-only
Returns	fLength

mirror attribute

PI: tchrmirror

Mirror character horizontally within the outline of the character.

mirror
Access	read-only
Returns	int

opacity attribute

Specifies the percentage opacity to use on supported output drivers.

opacity
Access	read-only
Returns	float

openTypeFeatures attribute

The features to enable in the OpenType font. The list of feature tables are in fTypeface-OpenTypeFeatureNames, and multiple values can be enabled at the same time by separating them with semicolons.

openTypeFeatures
Access	read-only
Returns	String

openTypeLanguage attribute

The language to enable in the OpenType font. Values are in fTypeface-OpenTypeLanguages.

openTypeLanguage
Access	read-only
Returns	String

openTypeScript attribute

The script to enable in the OpenType font. Values are in fTypeface-OpenTypeScripts.

openTypeScript
Access	read-only
Returns	String

openTypeShapeShiftTable attribute

Specifies the OpenType shift table which will be used to adjust the kerning of shaped glyphs.

openTypeShapeShiftTable
Access	read-only
Returns	fStream

openTypeUseCustomKerning attribute

If true, the custom kerning table specified in fStyle.kerningTable will be applied before shaping occurs. Note that any kerning applied from this table will split the word being shaped up at that point, effectively treating it as different words.

openTypeUseCustomKerning
Access	read-only
Returns	boolean

orphanLines attribute

PI: tpor

The orphanLines attribute enables you to define the minimum number of orphan lines for the current paragraph. Orphans are the first lines of a paragraph which occur at the bottom of a column or page.

orphanLines
Access	read-only
Returns	int

orphanPriority attribute

PI: tporphp

Sets the priority on widows and orphans. Orphan is a typographical term that describes a single word appearing at the bottom of a paragraph or column. A widow is a single word or short phrase appearing alone at the top of column. See OrphanPriorities.

orphanPriority
Access	read-only
Returns	int

orphanWordLength attribute

PI: tporwl

The maximum word length to be considered an orphan.

orphanWordLength
Access	read-only
Returns	int

outlineColor attribute

PI: toc

Sets the outline colour for characters. The default setting of none will not draw any outlines. Any other setting will cause the outline to be drawn. Characters drawn with outlines are considerably slower than those without. To get characters to appear in outline only, use color to set the inside colour of the characters to none.

outlineColor
Access	read-only
Returns	fColor

outlineThickness attribute

PI: tot

Sets the outline thickness for characters. The default setting of '0' will draw outlines as hairlines (as thin as possible). For outlines to appear at all, they must be given a colour with outlineColor.

outlineThickness
Access	read-only
Returns	fLength

overflowFormat attribute

PI: tpofmt

This command allows the text in a frame or a cell to overflow. According to the specific parameters, the text is placed on a single line that can overflow a frame or a cell.

Do not overflow.

Overflow to the right.

Overflow to the left.

Overflow on both sides.

overflowFormat
Access	read-only
Returns	int

overhang attribute

PI: overhang

This command, as its name suggests, allows text lines to overhang frames and/or columns. See OverhangMode.

overhang
Access	read-only
Returns	int

overline attribute

PI: tulo

Switches overlining on or off. Text will be overlined using the current lineColor and lineThickness.

overline
Access	read-only
Returns	boolean

overlinePosition attribute

PI: tovp

Changes the position of the overbar. The colour and thickness of the overbar are the same as those set for the underline with lineColor and lineThickness.

overlinePosition
Access	read-only
Returns	fLength

overlineRule attribute

PI: toverline

The fTextRule object to control the style of the overline rule.

This is independant of the overline property.

overlineRule
Access	read-only
Returns	fTextRule

overprint attribute

PI: tovpr

Enables you to specify overprint in composite files. Overprint can be specified on any form of colour in 3B2 by setting fColor::overprint.

overprint
Access	read-only
Returns	boolean

preserveProperties attribute

PI: tpprop, tpattr

Specifies whether LD should reset properties at the start of new paragraphs. If 1, LD does not reset properties at the start of new paragraphs. If 2, properties will also be preserved into blocks and tables

preserveProperties
Access	read-only
Returns	int

pseudoBold attribute

PI: twt

Sets a weight for text to create pseudo bold characters, generated by drawing a character twice, with a small horizontal distance in between. This attribute actually specifies that distance.

pseudoBold
Access	read-only
Returns	fLength

pseudoItalic attribute

PI: ts

Sets a shear percentage for text to create pseudo (fake) italic characters.

pseudoItalic
Access	read-only
Returns	float

relativeIndent attribute

PI: ri

Relative indent. Will make the subsequent lines of text align from the point of insertion.

relativeIndent
Access	read-only
Returns	fLength

rotate attribute

PI: tchrrot

Sets character rotation mode, see CharacterRotation.

rotate
Access	read-only
Returns	int

ruleAll attribute

PI: tprall

When you have a very large paragraph with rules set with rounded or outside corners with a large radius, this macro makes the rules more aesthetically pleasing.

ruleAll
Access	read-only
Returns	boolean

ruleHashWidth attribute

PI: tprhash

Positions hash rules precisely around text, (hash rules are not governed by the margins of a paragraph style). Hash rules are measured exactly from the edge of text at the start and end of a line. See RuleHashWidths for the various values.

ruleHashWidth
Access	read-only
Returns	int

ruleMarginBottom attribute

PI: trub

Sets the bottom position for paragraph rules relative to the paragraph's bottom margin.

ruleMarginBottom
Access	read-only
Returns	fLength

ruleMarginLeft attribute

PI: trul

Sets the left-hand starting position for paragraph rules relative to the paragraph's left margin.

ruleMarginLeft
Access	read-only
Returns	fLength

ruleMarginRight attribute

PI: trur

Sets the right-hand starting position for paragraph rules relative to the paragraph's right margin.

ruleMarginRight
Access	read-only
Returns	fLength

ruleMarginTop attribute

PI: trut

Sets the top position for paragraph rules relative to the top margin.

ruleMarginTop
Access	read-only
Returns	fLength

rules attribute

PI: tprules

Provides access to the rules around this paragraph.

rules
Access	read-only
Returns	fRules

showMissingGlyphs attribute

If true, missing glyphs will be shown as a Unicode Hex character.

showMissingGlyphs
Access	read-only
Returns	boolean

sizeMode attribute

PI: tdsz

Changes the interpretation of text sizing attributes.

Text sizing attributes refer to the character cell height of a font.

Text sizing attributes refer to the height of capital letters of a font.

sizeMode
Access	read-only
Returns	int

spaceFlags attribute

Which whitespace characters to ignore during formatting. Valid values are in fStyle-StyleSpaceFlags.

spaceFlags
Access	read-only
Returns	int

spanColumns attribute

PI: tpacr

Allows a paragraph to straddle two or more columns in a frame.

spanColumns
Access	read-only
Returns	boolean

spanColumnsNum attribute

PI: tcspan

Sets the column span of paragraphs, allowing the paragraph to span a specified number of columns in a frame.

The attribute is only effective if used within a paragraph style or immediately in front of any text in the paragraph.

In Fill Mode Arbortext LD will always find the highest space that can accommodate the full column span. The columns can be different widths, or have different gutters, with no adverse effects. The default column span is 0, meaning that any available space can be used for the paragraph. A column span of 1 means that the space chosen must be exactly one whole column wide. Partial columns (widthwise), such as those created when another frame is being avoided, can only be filled with column span 0 paragraphs.

spanColumnsNum
Access	read-only
Returns	int

squash attribute

PI: tpsquash

Allows you to specify a value which restricts justification of lines in a paragraph. The space between the words can be increased or decreased accordingly.

The following example specifies that 3B2 should use 5mm less than normal when evaluating how much text fits on a line, although it will still justify to the full measure afterwards.

formatting.currentParagraph.squash = '5mm'

squash
Access	read-only
Returns	fLength

stretch attribute

PI: tfstretch

Set the stretch of the text font using one of the FontStretch constants.

stretch
Access	read-only
Returns	int

stretchZwsp attribute

PI: tstretchzwsp

Activates/deactivates justification of Unicode ZWSP charater using word space extra.

stretchZwsp
Access	read-only
Returns	boolean

strikethrough attribute

PI: tult

Switches strike-through on or off. Text will be struck out using the current lineColor and lineThickness.

strikethrough
Access	read-only
Returns	boolean

strikethroughRule attribute

PI: tstrikethrough

The fTextRule object to control the style of the strikethrough rule.

This is independant of the strikethough property.

strikethroughRule
Access	read-only
Returns	fTextRule

tabs attribute

An Array that contains the active tab stops in this paragraph.

tabs
Access	read-only
Returns	fArray

tabstops attribute

PI: tptabstops

Specifies the distance between automatic tabstops that get used when tabs are encountered and the text has already gone past the location of all specified tabs.

So specifying a value of 10mm will create tabstops every 10mm from the left hand measure, but starting after the last defined tab.

tabstops
Access	read-only
Returns	fLength

textAlign attribute

PI: tpfmt

Sets the paragraph format structure. In most cases the attribute affects the line after which it is set. Except when it appears at the start of the paragraph where the whole paragraph will be affected. Possible values are in fParagraph-HorizontalAlignment.

textAlign
Access	read-only
Returns	int

topDrop attribute

PI: tpdt

Specifies a distance that lines up the top of the upper-case letters in a column with the column top margin when an exact column-top to text-baseline distance has been specified for a column. This has the effect of dropping the top of a paragraph.

A value of around .68h will usually align the characters as required, although this will vary according to the font used

topDrop
Access	read-only
Returns	fLength

topDropCell attribute

PI: tpdtc

Works in the same way as topDrop, but this one will be used instead if it's non-zero and occurs at the top of a table cell.

topDropCell
Access	read-only
Returns	fLength

triggerDisable attribute

PI: ttrigdis

In some circumstances it is preferable for Arbortext LD to handle alignment automatically, such as fixed-format sections of text, for example a table containing financial information. Tab triggers enable automatic alignment. Tab triggers are tabs which are automatically applied when Arbortext LD encounters specific trigger characters within the text stream. For more information see fTableColumn::tabs and tstd.

triggerDisable
Access	read-only
Returns	boolean

typeface attribute

PI: tf

The absolute typeface to use. This property will override fdTextProperties.font, fdTextProperties.weight, fdTextProperties.italic, and fdTextProperties.variant.

typeface
Access	read-only
Returns	fTypeface

underline attribute

PI: tul

Switches underlining on or off. Text will be underlined using the current lineColor, underlinePosition and lineThickness.

underline
Access	read-only
Returns	boolean

underlineKernMode attribute

PI: tul_kernmode

If true, the rule will be expanded to cover kerns that go outside of the normal line area, otherwise it will start at the text position where the rule was enabled, and end at the text position where the last character was formatted. This property applies to the fStyle.underline, doubleUnderline, strikethrough, and overline properties.

underlineKernMode
Access	read-only
Returns	boolean

underlinePosition attribute

PI: tup

Sets the position of an underline in relation to the baselines of characters. Using a negative value for an underline will draw the line above the baseline.

underlinePosition
Access	read-only
Returns	fLength

underlineRule attribute

PI: tunderline

The fTextRule object to control the style of the underline rule.

This is independant of the underline property.

underlineRule
Access	read-only
Returns	fTextRule

unipairTable attribute

PI: tunipar

Specifies which of the current document’s unipair tables should be used to override the global unipairs loaded at startup from the sunipair.3ad file.

unipairTable
Access	read-only
Returns	fStream

uppercaseMap attribute

PI: ttoupper

The map to use when converting characters to upper case with fdTextProperties.capsMode. If this is null or undefined, a default map will be used.

uppercaseMap
Access	read-only
Returns	fStream

useLigatureGroups attribute

PI: tklig

Allows you define the whether ligatures groups are used. If false it allows system ligatures only. If true it allows ligature groups 2+ to be used when defined via fStyle.ligatureGroup.

useLigatureGroups
Access	read-only
Returns	boolean

useOpenType attribute

If true, the word will be shaped using features contained in the OpenType font, instead of LD's built-in ligatures.

useOpenType
Access	read-only
Returns	boolean

variant attribute

PI: tfqs

When using a fFontFamily, set the index of the desired variant.

variant
Access	read-only
Returns	String

verticalFormat attribute

PI: tpvf

Specifies the way text is formatted vertically within its minimum or maximum paragraph heights. Possible values are in fParagraph-VerticalFormatMode.

verticalFormat
Access	read-only
Returns	int

verticalFormatAuto attribute

PI: tpvauto

Specifies the point at which vertical formatting of text within its minimum or maximum paragraph heights switches from being 'Justified In' to the more economical 'Justified Out'. This macro works in conjunction with verticalFormat, which must be set to 5 (VERTICALFORMAT_AUTO).

verticalFormatAuto
Access	read-only
Returns	int

vjAbsolute attribute

PI: tpabsvj

Turns absolute vertical justification mode on and off. By default, if the sum of all VJ margins is less than the space available, all margins will be proportionately increased to take up the remaining space. The vjAbsolute property will prevent this from happening.

vjAbsolute
Access	read-only
Returns	boolean

vjForce attribute

PI: tpfvj

Switches force vertical justification for the current paragraph on or off. If the paragraph is the last in a column when the page is formatted, the column will be forced to vertically justify using any vertical justification settings that have been specified for text in the column.

Vertical justification must have been enabled either by applying vj attribute to any one of the paragraphs used in a column of text or at frame level with the fFrame.vjType attribute. The justification settings of each paragraph style are automatically taken into account when a column of text is vertically justified, whether or not that particular paragraph has vj enabled.

vjForce
Access	read-only
Returns	boolean

vjLeading attribute

PI: tvjmline

Specifies maximum amount by which the space between lines of a paragraph can be stretched when a column is vertically justified.

vjLeading
Access	read-only
Returns	fLength

vjLeadingPriority attribute

PI: tvjpline

Determines the position of the leading to receive extra space during vertical justification. Priority 0 is the first position to receive extra space ("highest priority"), and 9 is the last position to receive extra space ("lowest priority").

vjLeadingPriority
Access	read-only
Returns	int

vjLimit attribute

PI: tpfvjl

If a paragraph is the last in a column, you can set the vjLimit property to force vertical justification. You will need to set a limit for the minimum amount of space that is to be left in the column before vertical justification is forced.

Instructs Arbortext LD the minimum amount of space that is to be left in the column before vertical justification should be forced. If a unit of measurement has not been specified then the default will be used.

vjLimit
Access	read-only
Returns	fLength

vjMarginAlignmentFill attribute

PI: tvjafill

Alignment in Arbortext LD allows you to align text horizontally between multiple streams. The principle within alignment (VJ) vertical justification is to vertically spread out all of the streams together so that the text fills the page whilst maintaining the horizontal alignment at each level. Using vjAlignmentFill = true tells Arbortext LD to spread the shorter paragraph of text at each alignment level, to align with the deepest one.

vjMarginAlignmentFill
Access	read-only
Returns	boolean

vjMarginAlignmentMiddle attribute

PI: tvjmamid

With vertical justification on multiple streams, space can be assigned inside the alignment levels with a fixed margin.

vjMarginAlignmentMiddle
Access	read-only
Returns	fLength

vjMarginAlignmentMiddlePriority attribute

PI: tvjpamid

Determines the position of the middle alignment margin to receive extra space during vertical justification. Priority 0 is the first position to receive extra space ("highest priority"), and 9 is the last position to receive extra space ("lowest priority").

vjMarginAlignmentMiddlePriority
Access	read-only
Returns	int

vjMarginAlignmentNested attribute

PI: tvjanest

For allocating space within alignment groups, you can pick up the paragraph margins from within the blocks on the critical path. This is done by setting "Nested VJ using internal settings" vjAlignmentNested = true.

vjMarginAlignmentNested
Access	read-only
Returns	boolean

vjMarginAlignmentProportionalPriority attribute

PI: tvjpaprop

In vertical justification, if you want to extend the depth of all the alignment groups in proportion to their size, you can do so by setting the Proportional Nested VJ Priority. This defaults to 10 which is off but setting it to a lower value brings it into effect.

vjMarginAlignmentProportionalPriority
Access	read-only
Returns	int

vjMarginAlignmentTop attribute

PI: tvjmatop

With vertical justification on multiple streams, space can be controlled between the alignment levels with the align top margin.

vjMarginAlignmentTop
Access	read-only
Returns	fLength

vjMarginAlignmentTopPriority attribute

PI: tvjpatop

Determines the position of the top alignment margin to receive extra space during vertical justification. Priority 0 is the first position to receive extra space ("highest priority"), and 9 is the last position to receive extra space ("lowest priority").

vjMarginAlignmentTopPriority
Access	read-only
Returns	int

vjMarginBottom attribute

PI: tvjmbot

Specifies the maximum amount by which the paragraph bottom margin can be stretched when a column is vertically justified.

vjMarginBottom
Access	read-only
Returns	fLength

vjMarginBottomPriority attribute

PI: tvjpbot

Determines the position of the bottom margin to receive extra space during vertical justification. Priority 0 is the first position to receive extra space ("highest priority"), and 9 is the last position to receive extra space ("lowest priority").

vjMarginBottomPriority
Access	read-only
Returns	int

vjMarginColumnTop attribute

PI: tvjmctop

Specifies the maximum amount by which the paragraph column top margin can be stretched when a column is vertically justified.

vjMarginColumnTop
Access	read-only
Returns	fLength

vjMarginColumnTopPriority attribute

PI: tvjpctop

Determines the position of the column top margin to receive extra space during vertical justification. Priority 0 is the first position to receive extra space ("highest priority"), and 9 is the last position to receive extra space ("lowest priority").

vjMarginColumnTopPriority
Access	read-only
Returns	int

vjMarginRuleBottom attribute

PI: tvjmrbot

Specifies the maximum amount of space that can be added between the paragraph and its bottom rule (irrespective of whether the paragraph is at the bottom of a column or not) when a column is vertically justified.

vjMarginRuleBottom
Access	read-only
Returns	fLength

vjMarginRuleBottomPriority attribute

PI: tvjprbot

Determines the position of the bottom rule margin to receive extra space during vertical justification. Priority 0 is the first position to receive extra space ("highest priority"), and 9 is the last position to receive extra space ("lowest priority").

vjMarginRuleBottomPriority
Access	read-only
Returns	int

vjMarginRuleColumnTop attribute

PI: tvjmrctop

Specifies the maximum amount of space that can be added between the paragraph and any top rule, (if the paragraph is at the top of a column or table cell or just underneath a paragraph with break across columns set) when a column is vertically justified.

vjMarginRuleColumnTop
Access	read-only
Returns	fLength

vjMarginRuleColumnTopPriority attribute

PI: tvjprctop

Determines the position of the column top rule margin to receive extra space during vertical justification. Priority 0 is the first position to receive extra space ("highest priority"), and 9 is the last position to receive extra space ("lowest priority").

vjMarginRuleColumnTopPriority
Access	read-only
Returns	int

vjMarginRuleTop attribute

PI: tvjmrtop

Specifies the maximum amount of space that can be added between the paragraph and any top rule (if the conditions for a column top margin are not met (see vjMarginRuleColumnTop) when a column is vertically justified.

vjMarginRuleTop
Access	read-only
Returns	fLength

vjMarginRuleTopPriority attribute

PI: tvjprtop

Determines the position of the top rule margin to receive extra space during vertical justification. Priority 0 is the first position to receive extra space ("highest priority"), and 9 is the last position to receive extra space ("lowest priority").

vjMarginRuleTopPriority
Access	read-only
Returns	int

vjMarginTop attribute

PI: tvjmtop

Specifies the maximum amount by which the paragraph top margin can be stretched when a column is vertically justified.

vjMarginTop
Access	read-only
Returns	fLength

vjMarginTopPriority attribute

PI: tvjptop

Determines the position of the top margin to receive extra space during vertical justification. Priority 0 is the first position to receive extra space ("highest priority"), and 9 is the last position to receive extra space ("lowest priority").

vjMarginTopPriority
Access	read-only
Returns	int

weight attribute

PI: tfweight

Set the weight of the text font using one of the FontWeight constants.

weight
Access	read-only
Returns	int

widowLines attribute

PI: tpwid

Allows you to set up the minimum number of widow lines for the current paragraph. Widows are the last lines of a paragraph which overflow to the top of a column or page.

Specifying a value of '1' effectively means that widows should be avoided.

widowLines
Access	read-only
Returns	int

width attribute

PI: tw

Changes the text width of a font. Any other attributes that depend on the text width will also change.

width
Access	read-only
Returns	fLength

widthFormat attribute

PI: tchrwf

Width format of character - shift the character left or right. This only tends to have an effect when a fixed width is being used, otherwise the character already fits exactly within its width and so no shifting is needed.

When the character is rotated by 90° or 270°, LD uses the outline of the character and how far it extends above and below the baseline to work out how to align it.

When the character is not rotated or rotated by 180°, LD will make its calculations with the width of the character for modes 1-3 and will use the outline for modes 5-7.

In vertical mode the baseline has been rotated, so this actually affects the vertical position of the character.

By default, opening brackets and punctuation are code 3 and closing brackets and punctuation are code 1, so that they still group their contents when a fixed width is being used.

widthFormat
Access	read-only
Returns	int

wordSpace attribute

PI: twb

Sets the basic word spacing value. This is the basic amount of space that will be substituted for every space character when formatting a line.

wordSpace
Access	read-only
Returns	fLength

wordSpaceExtra attribute

PI: twe

Sets the word spacing stretchability. This is the maximum amount of extra space that can be added to the basic word spacing when justifying a line.

wordSpaceExtra
Access	read-only
Returns	fLength

wordSpaceSquash attribute

PI: tws

Sets the word spacing 'squashability'. This is the maximum amount of space that can be removed from the basic word spacing when justifying a line.

wordSpaceSquash
Access	read-only
Returns	fLength

wordSpaceSquashMode attribute

When set, word squash is only applied to paragraphs that are being justified.

wordSpaceSquashMode
Access	read-only
Returns	boolean

yakumonoWidth attribute

PI: tyakw

Specifies the width used for a Yakumono character whenever it is switched to 'half' width. Therefore the default value is 0.5w, although if required you can specify an alternative measurement.

Yakumono is the name for a class of Japanese characters which includes brackets, punctuation and other symbols. These characters have the option of being set half width or full width when used in text.

yakumonoWidth
Access	read-only
Returns	fLength