Script Methods for Text Fields
The following methods are specific to Text fields, such as Fixed Text, Variable Text, and Text Box fields. For methods common to all fields, see Script Methods for Fields and Script Methods for Field Formats.
Tip: If using these script methods in a business rule, select the Rhino script engine.
Tip: Script methods with names beginning with get or is retrieve the current value for a property. Script methods with names beginning with set or move configure a value for the property.
Fixed Text Fields
|
Method |
Value |
Description |
|---|---|---|
|
getType() |
"text" |
The type of field. |
Variable Text Fields
|
Method |
Value |
Description |
|---|---|---|
|
getType() |
"text" |
The type of field. |
|
getMaxLength() setMaxLength(int) |
int |
The max number of characters. |
|
getNewStylePadding() setNewStylePadding(string) |
String |
The padding style. Accepted values are:
|
Text Format
|
Method |
Value |
Description |
|---|---|---|
|
getFormatType() |
"textFormat" |
The type of format. |
|
getLines() setLines(int) |
int |
The number of lines supported by the format. |
|
getLinespacing() setLinespacing(float) |
float |
The spacing between lines. |
|
getJustify() setJustify(String) |
String |
The justification for the line. Acceptable values are:
|
|
getCharsPerLine() setCharsPerLine(int) |
int |
The number of characters allowed per line. |
|
getFont() |
Font object |
The font object. See the following "Font" section. |
Font
|
Method |
Value |
Description |
|---|---|---|
|
getName() setName(String) |
String |
The name of the font. |
|
getCategory() |
String |
The name of the font category. Note: This method is not related to tag categories. |
|
getBold() setBold(Boolean) |
Boolean |
Whether the font is bold. |
|
isItalic() setItalic(boolean) |
Boolean |
Whether the font is italicized. |
|
isInverse() setInverse(boolean) |
Boolean |
Whether the font is inverse. |
|
isStrikeout() setStrikeout(boolean) |
Boolean |
Whether the strikeout effect is applied to the font. |
|
isUnderline() setUnderline(boolean) |
Boolean |
Whether the font is underlined. |
|
getPointSize() setPointSize(int) |
Int |
The point size of the font. |
|
getScaleHeight() |
float |
The font height percentage divided by 100. |
|
getScaleWidth() |
float |
The font width percentage divided by 100. |
DotFont
|
Method |
Value |
Description |
|---|---|---|
|
getXmagnification setXmagnification(int) |
Int |
The magnification factor (1 to 10). |
|
getYmagnification setYmagnification(int) |
Int |
The magnification factor (1 to 10). |
FlexiFont
|
Method |
Value |
Description |
|---|---|---|
|
getScaleHeight() setScaleHeight(float) |
float |
The font height percentage divided by 100. |
|
getScaleWidth() setScaleWidth(float) |
float |
The font height percentage divided by 100. |
TrueTypeFont
|
Method |
Value |
Description |
|---|---|---|
|
getScaleHeight() setScaleHeight(float) |
float |
The font height percentage divided by 100. |
|
getScaleWidth() setScaleWidth(float) |
float |
The font height percentage divided by 100. |
more