Add Property

Build 1501 on 14/Nov/2017  This topic last edited on: 23/Mar/2016, at 12:23

Description

Maximum vertical space that can be added above the tabulation rows when vertically justifiyng the whole text.

See also TopAdd and BottomAdd for the vertical justification of cells, and also TopAdd and BottomAdd on the cell level.

Syntax

object.Add(iRowType) [ =Value ]

object

Required. Object name, returned by Text.GetNewTable or Text.GetCurTable.

iRowType

0 = Odd (defrow 0), 1 = First (defrow -2), 2 = Last (defrow -3), 3 = Even (defrow -1).

Please note that if you want to set the same values for entire table, use iRowType = 0, that corresponds to odd rows, but if it's only specified, than it sets all row types.

Value

The value can be an integer, in millipoints not greater than 65000 = 65pt, or a string as one of the five special 'infinite' values: InfA or InfB or InfC or InfD or InfE whereas InfA = 65531, InfB = 65532, InfC = 65533, InfD = 65534, and InfE = 65535.

Examples

On a new table

This script creates a new table with 4 columns and 8 rows, and the maximum space that can be added when vertically justifying the whole text as 1pt for odd rows, 2pt for the first row, 3pt for the last row, 4pt for even rows:

Dim oTable = Text.GetNewTable

otable.NColumns = 4

oTable.NRows = 8

oTable.Add(0) = units.toval("1pt") ' odd rows, defrow 0

oTable.Add(1) = units.toval("2pt") ' first row, defrow -2

oTable.Add(2) = units.toval("3pt") ' last row, defrow - 3

oTable.Add(3) = units.toval("4pt") ' even rows, defrow -1

Text.InsTable (oTable)

Please note that if you want to set the same values for entire table, use iRowType = 0, that corresponds to odd rows, but if it's only specified, than it sets all row types.

On an existing table

This script edits the current table setting the maximum space that can be added when vertically justifying the whole text as 11pt for odd rows, 12pt for the first row, 13pt for the last row, 14pt for even rows:

Dim oTable = Text.GetCurTable

oTable.Add(0) = units.toval("11pt") ' defrow 0

oTable.Add(1) = units.toval("12pt") ' defrow -2

oTable.Add(2) = units.toval("13pt") ' defrow - 3

oTable.Add(3) = units.toval("14pt") ' defrow -1

Text.UpdateTable (oTable)

See also

AddSub for the justification of whole text on the table level.

TopAdd and BottomAdd for the vertical justification of cells on the table level.

Add and Sub on the row level.

TopAdd and BottomAdd on the cell level.