Adobe FrameMaker Scripting Guide Frame Maker 2017 En

User Manual: adobe FrameMaker - 2017 - Scripting Guide Free User Guide for Adobe FrameMaker Software, Manual

Open the PDF directly: View PDF PDF.
Page Count: 1092 [warning: Documents this large are best viewed by clicking the View PDF Link!]

January 31, 2017
Adobe FrameMaker Scripting
Guide
i ADOBE FRAMEMAKER (2017 RELEASE)
Contents
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
About this document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Naming conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Typographic conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Scripting support in FrameMaker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Development and debugging tools in ExtendScript toolkit . . . . . . . . . . . . . . . . . . . 2
ExtendScript capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Creating Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Accessing ESTK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Connect ESTK to FrameMaker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
To write, edit, and run scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Using script library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Using object model viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
ExtendScript use cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
What’s new in ESTK 2017 release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Setting gripper bar visibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Additional list view constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Sample ESTK scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Adding text to a document and enabling change bars . . . . . . . . . . . . . . . . . . . . . . . 7
Changing the table properties in a document . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Differences between scripts and FDK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Naming differences between scripts and FDK . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Menus and Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
ADOBE FRAMEMAKER (2017 RELEASE)ii
Object Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
AFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
AFrame methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Arc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Arc methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
AttrCondExpr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
AttrCondExpr methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Attribute methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
AttributeDef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
AttributeDef methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
AttributeDefs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
AttributeDefs methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
AttributeEx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Attributes methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
AttributesEx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
AttributesEx methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
BodyPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
BodyPage methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Book methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
BookComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
BookComponent methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Cell methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
CharFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
CharFmt methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
CMSCheckinParam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
CMSDeleteParam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
CMSInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
CMSMenuItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
CMSProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
CMSProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
CMSRegistration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
CMSResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
CMSSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Color methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Column methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
CombinedFont . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
CombinedFont methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
CombinedFontDefn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
CombinedFontDefn methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
CombinedFonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
iii ADOBE FRAMEMAKER (2017 RELEASE)
CombinedFonts methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Command methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
CompareRet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
CompareRet methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
CondFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
CondFmt methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Doc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Doc methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
Element methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
ElementCatalogEntries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
ElementCatalogEntries methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
ElementCatalogEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
ElementCatalogEntry methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
ElementDef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
ElementDef methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
ElementLoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
ElementLoc methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
ElementRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
ElementRange methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
Ellipse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
Ellipse methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
FCodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
FilterArgs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
FilterArgs methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
Flow methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
FmtChangeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
FmtChangeList methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
FmtRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
FmtRule methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
FmtRuleClause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
FmtRuleClause methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
Fn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
Fn methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
Font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
Font methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
Fonts methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
Group methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
HiddenPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
HiddenPage methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
GraphicsFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
ADOBE FRAMEMAKER (2017 RELEASE)iv
InlineComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
InlineComponent methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
Inset methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
IdValuePair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
IdValuePair methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
IdValuePairs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
Inset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
Inset methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
Ints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
Ints methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
KeyCatalog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
Line methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
Marker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
Marker methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
MarkerType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
MarkerType methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
MasterPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
MasterPage methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
Math . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
Math methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
MathML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
MathML methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
Menu methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
MenuItemSeparator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
MenuItemSeparator methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
Metrics methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
Pgf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
Pgf methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
PgfFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
PgfFmt methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
Point methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
Points methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
Polygon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
Polygon methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
Polyline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
Polyline methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
PropIdent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
PropIdent methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
PropVal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
PropVal methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
PropVals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
v ADOBE FRAMEMAKER (2017 RELEASE)
PropVals methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
Rectangle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
Rectangle methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
RefPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
RefPage methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
RoundRect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
RoundRect methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
Row . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
Row methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
Rubi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
Rubi methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
RulingFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
RulingFmt methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
Strings methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
SubCol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
SubCol methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537
Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537
Tab methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
Tabs methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
Tbl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
Tbl methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
TblFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
TblFmt methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
TextFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
TextFrame methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
TextItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
TextItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
TextItems methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
TextLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
TextLine methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
TextLoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
TextLoc methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
TextRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
TextRange methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
TiApiClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
TiApiClient methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
TiFlow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
TiFlow methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
TiText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
TiText methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
TiTextTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
TiTextTable methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
TypedVal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
TypedVals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
ADOBE FRAMEMAKER (2017 RELEASE)vi
TypedVals methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
UBytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
UBytes methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
UInts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
UInts methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
UnanchoredFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
UnanchoredFrame methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
Var . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
Var methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
VarFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
VarFmt methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
XRef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
XRef methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
XRefFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
XRefFmt methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
app . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
app methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
Function Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
AFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Arc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
vii ADOBE FRAMEMAKER (2017 RELEASE)
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
AttrCondExpr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
ApplyAttributeExpression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
AttributeDef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
AttributeDef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
AttributeDefs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
concat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
pop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
ADOBE FRAMEMAKER (2017 RELEASE)viii
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
concat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
pop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
AttributesEx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
concat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
pop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
BodyPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
ix ADOBE FRAMEMAKER (2017 RELEASE)
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
ApplyPageLayout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
Compare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613
NewBookComponentInHierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
SilentPrintDoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
SimpleGenerate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
SimpleImportFormats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617
SimpleImportElementDefs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
GetUniqueObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
ADOBE FRAMEMAKER (2017 RELEASE) x
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
SimpleSave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
NewSeriesObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
NewSeriesBookComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
NewBookComponentOfTypeInHierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
GetConditionalSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
ApplyConditionalSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
ManageConditionalExpressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627
GetConditionalExpression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
xi ADOBE FRAMEMAKER (2017 RELEASE)
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
Save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
UpdateBook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
BookComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
MoveComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
ADOBE FRAMEMAKER (2017 RELEASE)xii
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
Cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
StraddleCells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
UnStraddleCells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
GetText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
CharFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
xiii ADOBE FRAMEMAKER (2017 RELEASE)
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
CMSObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
CMSSetProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
CMSSetProperties() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
CMSGetProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
CMSGetProperties() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
CMSEnableCommand() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
CMSDisableCommand() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667
CMSShowCheckoutUI() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
CMSShowCheckinUI() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
ADOBE FRAMEMAKER (2017 RELEASE)xiv
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
CMSShowCancelCheckoutUI() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
CMSShowDeleteUI() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671
CMSShowCommonListUI() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
CMSShowPropertyUI() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673
CMSShowPropertyUIWithTitle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
CMSRegistration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
CMSGetCMSInfo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
CMSConfigLoginUI() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
CMSSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
CMSLogout() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
GetCMSObjectFromPath() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
xv ADOBE FRAMEMAKER (2017 RELEASE)
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
CMSShowBrowseRepositoryUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
CMSCreateObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
CMSGetCmsIdFromSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
CombinedFont . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
CombinedFont . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
CombinedFontDefn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
CombinedFamilyFonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
ADOBE FRAMEMAKER (2017 RELEASE)xvi
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
CombinedFonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
concat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
pop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
xvii ADOBE FRAMEMAKER (2017 RELEASE)
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
CompareRet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
CompareRet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
CondFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
DeleteCondTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
Doc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
AddText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
CenterOnText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
ADOBE FRAMEMAKER (2017 RELEASE)xviii
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
Clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
ClearAllChangebars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
Compare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
Copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
Cut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698
DeleteText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
DemoteElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
GetTextForRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 700
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 700
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
GetTextForRange2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
xix ADOBE FRAMEMAKER (2017 RELEASE)
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
GetTextProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707
GetTextPropVal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
GetTextVal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
HypertextCommand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710
MergeIntoFirst . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
MergeIntoLast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
NewTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
Paste . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
PromoteElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
QuickSelect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
ADOBE FRAMEMAKER (2017 RELEASE)xx
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
Redisplay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
Reformat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
Rehyphenate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
ResetEqnSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
ResetReferenceFrames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
RestartPgfNumbering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
ScrollToText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
SetTextProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
SetTextPropVal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
SetTextVal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725
xxi ADOBE FRAMEMAKER (2017 RELEASE)
SilentPrintDoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
SimpleImportFormats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
SplitElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
TextLocToElementLoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
UnWrapElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
UpdateXRefs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
UpdateDITAReferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
SimpleImportElementDefs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
GetUniqueObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
ADOBE FRAMEMAKER (2017 RELEASE)xxii
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
SimpleSave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
NewGraphicObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738
NewArc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
NewEllipse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
NewFlow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
NewGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
NewInlineComponentOfType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
NewInset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
NewLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
xxiii ADOBE FRAMEMAKER (2017 RELEASE)
NewMath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
NewMathML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
NewPolyline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
NewPolygon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746
NewRectangle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747
NewRoundRect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747
NewTextFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748
NewTextLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
NewUnanchoredFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
NewAnchoredFormattedObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
ADOBE FRAMEMAKER (2017 RELEASE)xxiv
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 750
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 750
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 750
NewAnchoredFormattedVar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
NewAnchoredFormattedXRef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
NewAnchoredFormattedTbl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
NewAnchoredObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
NewAnchoredAFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
NewAnchoredFn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
NewAnchoredMarker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
NewAnchoredTiApiClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
NewAnchoredTbl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
xxv ADOBE FRAMEMAKER (2017 RELEASE)
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
NewSeriesObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757
NewSeriesBodyPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 758
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 758
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 758
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 758
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 758
NewSeriesPgf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 758
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 758
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
GetNamedObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
GetNamedAttrCondExpr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
GetNamedCharFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
GetNamedColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
GetNamedCombinedFontDefn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
GetNamedCondFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
ADOBE FRAMEMAKER (2017 RELEASE)xxvi
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 763
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 763
GetNamedElementDef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 763
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 763
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 763
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 763
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 763
GetNamedFmtChangeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 763
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 763
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 763
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
GetNamedMasterPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
GetNamedPgfFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
GetNamedRefPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
GetNamedRulingFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766
GetNamedTblFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766
GetNamedUnanchoredFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
GetNamedVarFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
xxvii ADOBE FRAMEMAKER (2017 RELEASE)
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
GetNamedXRefFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 768
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 768
GetNamedMarkerType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 768
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 768
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 768
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 768
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 768
NewNamedObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 768
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 768
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 769
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 769
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
NewNamedAttrCondExpr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
NewNamedCharFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771
NewNamedCombinedFontDefn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771
NewNamedColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
NewNamedCondFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
NewNamedElementDef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
ADOBE FRAMEMAKER (2017 RELEASE)xxviii
NewNamedFmtChangeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
NewNamedMasterPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
NewNamedPgfFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
NewNamedRefPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 775
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 775
NewNamedRulingFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 775
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 775
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 775
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 775
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 775
NewNamedTblFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 775
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 775
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 775
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
NewNamedVarFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
NewNamedXRefFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
NewNamedMarkerType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
DeleteUnusedFmts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
xxix ADOBE FRAMEMAKER (2017 RELEASE)
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
DeleteUnusedCharFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
DeleteUnusedPgfFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779
DeleteUnusedTblFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779
Find . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 782
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 782
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 782
SetElementRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 782
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 782
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 783
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 783
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 783
ElementLocToTextLoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 783
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 783
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 784
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 784
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 784
UpdateVariables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 784
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 784
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 784
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785
TrackChangesAcceptAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785
TrackChangesRejectAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785
UpdateXRef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 786
ADOBE FRAMEMAKER (2017 RELEASE)xxx
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 786
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 786
UpdateDITAReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787
UpdateDITAReferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788
Save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790
AddNewBuildExpr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791
DeleteBuildExpr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791
SetActiveBuildExpr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
GetActiveBuildExpr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793
GetBuildExpr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793
GetBuildExprCatalog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794
xxxi ADOBE FRAMEMAKER (2017 RELEASE)
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 795
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 795
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 795
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 795
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 795
Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 795
GetAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 795
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 795
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 796
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 796
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797
UpdateDITAReferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797
GetText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 798
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 798
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 798
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 798
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 798
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 798
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 798
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 798
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 798
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 798
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 798
ElementCatalogEntries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799
concat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799
ADOBE FRAMEMAKER (2017 RELEASE)xxxii
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799
pop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799
push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
ElementCatalogEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
ElementCatalogEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 801
ElementDef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 801
NewTextFmtRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 801
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 801
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802
NewObjectFmtRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 803
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 803
NewPrefixRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 803
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 803
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804
NewSuffixRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804
NewFirstPgfRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 805
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 805
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 805
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 805
NewLastPgfRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 805
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 805
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 806
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 806
ElementDefIsText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 806
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 806
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 806
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 806
xxxiii ADOBE FRAMEMAKER (2017 RELEASE)
NewElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 807
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 807
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 808
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 808
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 808
NewElementInHierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 808
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 808
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809
WrapElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810
GetAttributeDefs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 811
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 811
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
ElementLoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
ElementLoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 814
ElementRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 814
ElementRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 814
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 814
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 814
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 814
ADOBE FRAMEMAKER (2017 RELEASE)xxxiv
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 814
Ellipse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
FilterArgs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
FilterArgs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 817
Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 817
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 817
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 817
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 817
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 817
GetText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
xxxv ADOBE FRAMEMAKER (2017 RELEASE)
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
FmtChangeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821
FmtRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821
NewFmtRuleClauses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 822
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 822
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 822
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 822
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 822
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 822
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 822
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 822
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 822
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 822
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 822
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 822
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 822
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 823
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 823
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 823
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 823
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 823
FmtRuleClause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 823
NewSubFmtRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 823
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 823
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 824
ADOBE FRAMEMAKER (2017 RELEASE)xxxvi
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 824
NewFmtChangeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 824
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 824
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 826
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 826
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 826
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 826
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 826
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 826
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 826
Fn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 826
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 826
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 826
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 826
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
GetText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 828
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 828
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 828
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 828
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 828
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 828
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 828
Font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 828
xxxvii ADOBE FRAMEMAKER (2017 RELEASE)
Font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 828
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 828
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 829
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 829
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 829
Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 829
concat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 829
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 829
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 829
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 829
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 829
pop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832
HiddenPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832
ADOBE FRAMEMAKER (2017 RELEASE)xxxviii
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 833
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 833
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 833
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 833
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 833
ApplyPageLayout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 833
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 833
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 834
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 834
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 834
Inset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 834
GetIntByName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 834
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 834
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 835
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 835
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 835
GetMetricByName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 835
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 835
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836
GetUBytesByName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 837
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 837
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 837
SetIntByName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 837
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 837
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 838
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 838
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 838
SetMetricByName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 838
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 838
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 839
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 839
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 839
SetUBytesByName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 839
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 839
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 840
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 840
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 840
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 840
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 840
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 841
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 841
xxxix ADOBE FRAMEMAKER (2017 RELEASE)
DeletePropByName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 841
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 841
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 841
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 841
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 841
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843
Ints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843
concat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843
pop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844
push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844
Iterator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844
GetNextIteratorItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
ADOBE FRAMEMAKER (2017 RELEASE)xl
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 846
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 846
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 846
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 846
KeyCatalog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 846
NewKeyDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 846
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 846
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 846
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 846
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 846
UpdateKeyDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 848
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 848
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 848
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 848
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 848
GetKeyDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 849
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 849
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 849
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 849
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 850
GetAllKeyDefinitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 851
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 851
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 851
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 851
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 851
DeleteAllKeyDefinitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 853
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 853
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 853
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 853
GetAllKeys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 853
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 853
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 853
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 853
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 853
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 853
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
xli ADOBE FRAMEMAKER (2017 RELEASE)
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
Marker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
MarkerType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
ADOBE FRAMEMAKER (2017 RELEASE)xlii
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
MasterPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
ApplyPageLayout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
Math . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
xliii ADOBE FRAMEMAKER (2017 RELEASE)
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 863
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 863
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 863
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 863
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 863
MathML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 863
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 863
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 863
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 863
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 863
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 863
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 863
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 864
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 864
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 864
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 864
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 864
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 864
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 864
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 864
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 864
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 864
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 864
Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 865
DefineAndAddCommand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 865
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 865
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 866
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 866
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 866
AddCommandToMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 867
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 867
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 868
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 868
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 868
AddMenuToMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 868
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 868
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 869
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 869
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 869
ADOBE FRAMEMAKER (2017 RELEASE)xliv
DefineAndAddMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 869
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 869
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 871
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 871
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 871
MenuItemInMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 871
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 871
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 872
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 872
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 872
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 872
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 872
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 872
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 872
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
MenuItemSeparator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875
xlv ADOBE FRAMEMAKER (2017 RELEASE)
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875
Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876
concat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876
pop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876
push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
Pgf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
GetText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 878
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 878
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 878
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 878
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 878
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 878
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 878
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 878
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 878
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 878
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
PgfFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
ADOBE FRAMEMAKER (2017 RELEASE)xlvi
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 880
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 880
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 880
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 880
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 880
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 880
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 880
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 880
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 880
Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 880
Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 880
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 880
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881
Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881
concat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881
pop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
Polygon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
xlvii ADOBE FRAMEMAKER (2017 RELEASE)
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884
Polyline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
PropIdent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
PropIdent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 886
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 886
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 886
PropVal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 886
PropVal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 886
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 886
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 886
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 886
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 886
PropVals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
concat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
pop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
ADOBE FRAMEMAKER (2017 RELEASE)xlviii
push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 888
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 888
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 888
Rectangle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 888
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 888
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 888
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 888
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 888
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 888
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 888
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 888
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889
RefPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
ApplyPageLayout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
xlix ADOBE FRAMEMAKER (2017 RELEASE)
RoundRect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893
Row . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893
AddRows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 894
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 894
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 894
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 894
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 894
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 894
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 894
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 896
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 896
Rubi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 896
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 896
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 896
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 896
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 896
ADOBE FRAMEMAKER (2017 RELEASE) l
GetText2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 896
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 896
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 897
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 897
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 897
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
RulingFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
concat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 901
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 901
pop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 901
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 901
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 901
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 901
li ADOBE FRAMEMAKER (2017 RELEASE)
push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 901
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 901
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 901
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 901
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 901
SubCol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
GetText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 903
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 903
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 903
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 903
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 903
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 903
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 903
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 903
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 903
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 903
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 903
Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904
Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904
Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 905
concat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 905
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 905
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 905
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 905
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 905
pop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 905
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 905
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
ADOBE FRAMEMAKER (2017 RELEASE)lii
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
Tbl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
AddCols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 907
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 907
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 907
DeleteCols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 907
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 907
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 908
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 908
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 908
DeleteRows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 908
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 908
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 909
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 909
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 909
GetTableColumnByColNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 909
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 909
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 910
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 910
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 910
MakeTblSelection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 910
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 910
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 911
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 911
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 911
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
liii ADOBE FRAMEMAKER (2017 RELEASE)
TblFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 914
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 914
TextFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 914
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 914
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 914
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 914
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 914
GetText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 914
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 914
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 914
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 914
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 915
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 915
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 915
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 915
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 915
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 915
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 915
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 915
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 915
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 915
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 916
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 916
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 916
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 916
TextItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 916
concat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 916
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 916
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 916
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 916
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 916
pop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
TextLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
ADOBE FRAMEMAKER (2017 RELEASE)liv
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
GetText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
TextLoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
TextLoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
TextRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
TextRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
TiApiClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
GetText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
DeleteTextInsetContents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922
UpdateTextInset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
ConvertToText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
lv ADOBE FRAMEMAKER (2017 RELEASE)
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
DeletePropByName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
TiFlow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
GetText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
DeleteTextInsetContents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
UpdateTextInset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
ConvertToText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
DeletePropByName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
TiText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
GetText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
DeleteTextInsetContents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
UpdateTextInset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
ConvertToText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
DeletePropByName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
TiTextTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
GetText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927
DeleteTextInsetContents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927
UpdateTextInset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927
ConvertToText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927
ADOBE FRAMEMAKER (2017 RELEASE)lvi
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927
DeletePropByName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927
TypedVals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927
concat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
pop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 929
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 929
UBytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 929
concat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 929
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 929
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 929
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 929
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 929
pop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 929
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 929
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
UInts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
concat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
pop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
lvii ADOBE FRAMEMAKER (2017 RELEASE)
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
UnanchoredFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
Var . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
GetText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 935
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 935
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 935
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 935
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 935
VarFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 935
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 935
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 935
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 935
ADOBE FRAMEMAKER (2017 RELEASE)lviii
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 935
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 935
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 935
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936
XRef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
GetText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
XRefFmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
lix ADOBE FRAMEMAKER (2017 RELEASE)
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 940
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 940
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 940
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 940
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 940
app . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 940
Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 940
GetNamedObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 940
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 940
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 941
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 941
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 941
GetNamedBook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 941
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 941
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 941
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 941
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942
GetNamedCommand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942
GetNamedMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943
GetNamedMenuItemSeparator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 944
NewNamedObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 944
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 944
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 944
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 944
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 944
NewNamedBook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945
ADOBE FRAMEMAKER (2017 RELEASE)lx
NewNamedCommand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
NewNamedMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
NewNamedMenuItemSeparator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 947
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 947
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 947
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 947
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 947
GetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 947
SetProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 947
ObjectValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 947
global . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 948
Alert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 948
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 948
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 948
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 948
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 949
Alive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 949
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 949
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 949
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 949
CallClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 949
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 949
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 950
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 950
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 950
CallClientEx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 950
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 950
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
CheckStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952
ClientDir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952
lxi ADOBE FRAMEMAKER (2017 RELEASE)
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952
ClientName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 953
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 953
CMSRegister . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 953
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 953
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 953
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 953
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 953
CMSGetCmsIdFromName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 953
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 953
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 953
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
CMSAddMenuEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
CustomDoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 956
DefineMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 956
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 956
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
DisconnectFromSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
Err . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
FamilyFonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
GetKeyCatalog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
ADOBE FRAMEMAKER (2017 RELEASE)lxii
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
GetEncodingForFamily . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 960
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 960
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 960
GetEncodingForFont . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 960
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 960
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 960
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 960
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
GetImportDefaultParams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
GetOpenDefaultParams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
GetPropIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 962
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 962
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 962
GetSaveDefaultParams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 962
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 962
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 967
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 967
GetSupportedEncodings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 967
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 967
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 967
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
GetUpdateBookDefaultParams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
GetNewXMLDefaultParams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
IsEncodingSupported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 969
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 969
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 969
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 969
lxiii ADOBE FRAMEMAKER (2017 RELEASE)
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 969
LoadMenuCustomizationFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 969
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 969
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 970
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 970
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 970
NewKeyCatalog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 971
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 971
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 971
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 971
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 971
NewXML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 971
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 971
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 971
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 971
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 972
Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 972
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 972
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 979
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 979
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 979
PopClipboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 979
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 979
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980
PrintFAErrno . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
PrintImportStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
PrintOpenStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
PrintPropVal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
ADOBE FRAMEMAKER (2017 RELEASE)lxiv
PrintPropVals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 983
PrintSaveStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 983
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 983
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 983
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 983
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 983
PrintTextItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 983
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 983
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 983
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 983
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
PrintTextItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
PrintUpdateBookStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 985
PushClipboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 985
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 985
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 985
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 985
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 985
ReturnValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 985
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 985
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 987
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 987
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 987
ShutDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988
SimpleNewDoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 989
UserCancel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 989
lxv ADOBE FRAMEMAKER (2017 RELEASE)
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 989
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 989
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 989
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 989
SimpleOpen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 989
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 989
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 990
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 990
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 990
UpdateMenus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 990
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 990
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 990
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991
AddMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 992
RemoveMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 992
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 992
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 992
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 992
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 992
MenuExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 993
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 993
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 993
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 993
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 993
ShortcutExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 993
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 993
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 993
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 993
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 993
GetExportDefaultParams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 994
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 994
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 994
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 994
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 994
PrintExportStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 994
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 994
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 994
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 994
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 994
ErrorName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 994
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 994
ADOBE FRAMEMAKER (2017 RELEASE)lxvi
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995
PrintErrno . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995
NotificationName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 996
AllocatePropVals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 996
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 996
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 996
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 996
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 996
Open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 996
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 996
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1003
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1003
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1003
ScrollBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1004
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1004
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1004
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1004
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1004
ChooseFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1005
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1005
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1005
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1005
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1006
PromptInt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1006
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1006
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1006
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1007
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1007
PromptMetric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1007
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1007
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1007
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1007
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1008
PromptString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1008
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1008
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1008
lxvii ADOBE FRAMEMAKER (2017 RELEASE)
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1008
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1009
Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1009
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1009
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1009
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1009
FileScrollBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1009
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1009
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1009
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1009
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1010
CMS Connector Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1011
CMS API Data Structures and Enum Constants . . . . . . . . . . . . . . . . . . . . . . . . . 1011
CMSResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1011
CMSResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1011
CMSItemFileType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1012
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1012
CMSProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1013
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1013
CMSMenuItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1013
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1013
CMSCheckinParam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1013
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1013
CMSDeleteParam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1014
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1014
CMSInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1014
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1014
CMSInfos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1014
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1014
Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1014
CMS API functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1015
APIs to automate CMS connector functionality . . . . . . . . . . . . . . . . . . . . . . . . . 1016
CMSLogin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1016
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1016
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1016
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1016
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1017
CMSLogout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1017
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1017
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1017
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1017
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1018
CMSCheckout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1018
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1018
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1018
ADOBE FRAMEMAKER (2017 RELEASE)lxviii
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1018
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1018
CMSCheckin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1018
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1018
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1018
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1018
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1019
CMSCancelCheckout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1019
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1019
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1019
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1019
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1019
CMSDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1020
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1020
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1020
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1020
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1020
CMSOpenFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1020
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1020
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1020
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1020
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1021
CMSUploadObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1021
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1021
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1021
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1021
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1021
CMSDownloadObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1021
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1021
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1022
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1022
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1022
GetCMSObjectFromPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1022
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1022
Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1022
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1022
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1022
Legal notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1023
1
ABOUT THIS DOCUMENT
CHAPTER 1 OVERVIEW
1. Overview
A script is a series of commands that instructs Adobe® FrameMaker® to perform a set of specified
actions. Scripts automate repetitive tasks, such as counting the images in a book or adding an indent to
all the para tags in a file. Use scripts as a creative tool to streamline time-consuming tasks.
If you are new to scripting, you can acquaint yourself with the basic scripting concepts provided in the
Introduction to Scripting manual.
1.1. About this document
Naming conventions
To help you identify the structures, constants, and functions defined by the ESTK, this document adheres
to the following naming conventions:
Type Naming Convention Example
API error codes Prefix: Constants.FE
Suffix: Error number in
parentheses
Constants.FE_BadName(-3
3)
API functions Suffix: () UpdateTextInset()
API scriptable
function property
names
Prefix: Constants.FS_
Suffix: Enumerated value in
parentheses
Constants.FS_ForceImpor
tAsText (17)
Flags used by API
functions
Prefix: Constants.FF_
Suffix: Enumerated value in
parentheses
Constants.FF_UFF_VAR()
Initialization
constants
Prefix: Constants.FA_Init
Suffix: Enumerated value in
parentheses
Constants.FA_Init_First
(1)
Notification constants Prefix: Constants.FA_Note Constants.FA_Note_PreFi
leType (9)
Object types Prefix: Constants.FO_
Suffix: Enumerated value in
parentheses
Constants.FO_Doc (4)
Property value
constants
Prefix: Constants.FV_
Suffix: Enumerated value in
parentheses
Constants.FV_Doc_Type_M
IF (0x03)
2
SCRIPTING SUPPORT IN FRAMEMAKER
CHAPTER 1 OVERVIEW
Typographic conventions
Notice the use of different fonts to represent different types of information:
• What you type is shown in text like this.
• Function names, property names, structure names, returned values, constants, filter names,
program names, paths, and filenames are also shown in text like this.
1.2. Scripting support in FrameMaker
FrameMaker supports ExtendScript, which is an extended implementation of JavaScript. While JavaScript
files have .js extension, ExtendScript files have .jsx extension.
For more information on JavaScript modules, tools, utilities, and features that are available to all JavaS-
cript-enabled Adobe applications, see JavaScript Tools Guide.
Development and debugging tools in ExtendScript toolkit
For assistance in developing, debugging, and testing scripts, Adobe provides the ExtendScript Toolkit.
ExtendScript Toolkit is an interactive development and testing environment for ExtendScript, which is
installed with FrameMaker and all JavaScript-enabled applications. For details, see Chapter 2, “The
ExtendScript Toolkit” and Chapter 8, “ExtendScript Tools and Features ” in JavaScript Tools Guide.
ExtendScript capabilities
Using ExtendScript Toolkit, you can develop and debug ExtendScript. ExtendScript provides the following
features that make scripting easy:
•User interface development tools: The ScriptUI module defines Window objects that represent
platform-specific windows and various control elements, such as buttons and static text. Resource
specification allows you to create user-interface elements. Using the event-handling callback func-
tions, you can define the behavior of your user-interaction controls. ScriptUI provides a rich set of
containers (such as Group, Panel, and TabbedPanel) and user interface controls (such as Button,
Image, Scrollbar, Treeview, and FlashPlayer). ScriptUI works with the ExtendScript JavaScript inter-
preter to provide JavaScript programs with the ability to create and interact with user interface
elements. The Graphic customization objects provide the ability to customize the appearance of
user-interface controls before they are drawn. For details, see Chapter 4, “User-Interface Tools” in
JavaScript Tools Guide.
•Extensions:
– ExtendScript offers tools for communicating with other computers or the Internet using stan-
dard protocols. The Socket object supports low-level TCP connections. For details, see
Chapter 6, “External Communication Tools” in JavaScript Tools Guide.
3
CREATING SCRIPTS
CHAPTER 1 OVERVIEW
– Adobe ExtendScript defines classes that simplify cross-platform file-system access. These
classes are available to all applications that support a JavaScript interface. For details, see
Chapter 3, “File System Access” in JavaScript Tools Guide.
– You can extend the JavaScript DOM for an application. To extend the JavaScript DOM, write
a C or C++ shared library, compile it for the relevant platform, and load it into JavaScript as an
ExternalObject instance. A shared library is implemented by a DLL in Windows, a bundle or
framework in Mac OS, or a SharedObject in UNIX. For details, see Chapter 7, “Integrating
External Libraries” in JavaScript Tools Guide.
•Inter-application communication and messaging: ExtendScript provides a common scripting envi-
ronment for all Adobe JavaScript-enabled applications. The cross-DOM API allows implementation
of functions, such as open files and execute scripts, that are common across message-enabled
applications. Using simple syntax you can implement application-specific functionality for
message-enabled application. The BridgeTalk class of the messaging API has globally available static
properties and functions that provide access to environmental information relevant for communi-
cation between applications. The error codes defined by the interapplication messaging protocol
are compatible with the ExtendScript error codes. For details, see Chapter 5, “Interapplication
Communication with Scripts” in JavaScript Tools Guide
1.3. Creating Scripts
Adobe provides ExtendScript Toolkit (ESTK) with its applications as a scripting utility. ESTK has many
features that make it easier to use than a text editor. ESTK has a built-in syntax checker that identifies
where the problems are in your script and tries to explain how to fix them. You can run your scripts right
from the ESTK without saving the file. Running scripts without saving them first saves you time, especially
when you are learning to work with ESTK.
1.4. Accessing ESTK
Connect ESTK to FrameMaker
When you launch ExtendScript Toolkit from FrameMaker (File > Script ...), ExtendScript Toolkit is already
connected to FrameMaker. Only when you launch ExtendScript Toolkit from Windows (Start >
Programs...), complete the following steps to connect ESTK to FrameMaker.
1) In the ExtendScript Toolkit, select Adobe FrameMaker <Version#> in the pop-up menu.
2) Click ,
If FrameMaker is not already running, a message appears: “Target Adobe FrameMaker <Version#>
is not running. Do you want to launch Adobe FrameMaker <Version#>?”
3) Click Yes.
FrameMaker is launched and connected to ESTK.
4
USING SCRIPT LIBRARY
CHAPTER 1 OVERVIEW
To write, edit, and run scripts
In FrameMaker, do the following:
1) Click File > Script > New Script.
The ESTK editor opens.
2) Write the script in the editor.
3) To run the script, click the Play button.
You can also start ExtendScript Toolkit from Windows (Start > Programs). When you start Extend-
Script Toolkit from Windows, connect ESTK to FrameMaker.
1.5. Using script library
In FrameMaker, select File > Script > Catalog to display the script library.
Using the script catalog, you can manage your existing scripts:
• Favorites: Scripts you tag as your favorite appear here.
• Autorun: These scripts run when FrameMaker is launched.
• Registered: Scripts that run on certain triggers, such as on opening a file or saving a file.
1.6. Using object model viewer
Object Model Viewer in ESTK helps you to get the information on different classes and the methods in
ExtendScript. Press F1 or click Help > Object Model Viewer to open Object Model Viewer.
5
EXTENDSCRIPT USE CASES
CHAPTER 1 OVERVIEW
In the Object Model Viewer, select an object model under Browse to you can do the following to locate
information:
• Under Browser, select the object model for which you want the information. Object Model Viewer
displays the classes in the object model and details such as type, properties, method, and descrip-
tion of the class.
• Search for a class, method, or property.
• Bookmark a class, method, or property. It then appears under the Bookmarks section.
1.7. ExtendScript use cases
Some of the ExtendScript use cases can be:
•Scripts to automate repetitive tasks: You can write utilities to automate repetitive tasks, such as
change alignment of all the tables in a FrameMaker document.
•Notification-based scripts: You can write scripts that are triggered on FrameMaker events such as
such as opening, printing, or saving a document.
•Menu command scripts/scripts to extend FrameMaker functionality: Using these scripts, you can
add menus and commands in FrameMaker.
•Startup scripts: These scripts get executed when FrameMaker starts. You can set up scripts to run
at startup by copying them at the following location: <FMINSTALL_DIR>\startup. Alternatively, you
can use the Script Library dialog to register Autorun scripts.
6
SETTING GRIPPER BAR VISIBILITY
CHAPTER 2 WHAT’S NEW IN ESTK 2017 RELEASE
2. What’s new in ESTK 2017 release
2.1. Setting gripper bar visibility
ESTK now provides a gripper bar property that allows you to show or hide the gripper bar.
2.2. Additional list view constants
The following constants have been added to the list view property:
1) FP_SelectedRow: Return the index of first selected row in the list.
2) FP_SelectedRowId: Return the row ID of the first selected row in the list.
3) FV_ListViewSelectFirstRow: Select the first row in the list.
4) FV_ListViewSelectRowFromRowId: Select the row in the list from the row ID.
5) FV_ListViewSelectRowFromColData: Select the row in the list as per the parameters defined in the
column index and string.
Resize Gripper
Visibility
Specify whether the resize gripper is to be made visible or not for pods
created using FDK. The default value is FP_ResizeGripperBarVisibility.
•Constants.FV_DIALOG_GRIPPERBAR_TRUE - Used to
display resize gripper.
•Constants.FV_DIALOG_GRIPPERBAR_FLASE - Used to
hide the resize gripper.
7
ADDING TEXT TO A DOCUMENT AND ENABLING CHANGE BARS
CHAPTER 3 SAMPLE ESTK SCRIPTS
3. Sample ESTK scripts
ExtendScript is similar to JavaScript. You can easily develop ExtendScript for any of the applications in
FrameMaker if you are familiar with JavaScript.
Following are examples for scripts that automate specific activities in FrameMaker.
NOTE: Sample scripts shipped with FrameMaker are at the following location: <FMINSTALL_DIR>\samples
3.1. Adding text to a document and enabling change bars
The following script adds a sample text to a FrameMaker document and then enables the change bar.
Open a FrameMaker document before running the script.
Copy and paste the script to ESTK and select FrameMaker <Version#> as the target application. Click the
Play button to run the script.
var doc = app.ActiveDoc;
var firstPgf = doc.MainFlowInDoc.FirstTextFrameInFlow.FirstPgf;
var tl = new TextLoc(firstPgf, 0);
doc.AddText (tl, "Hello");
doc.AutoChangeBars = 1;
The script creates a text location using the new TextLoc()method. Assign the first page of the docu-
ment as the text location. Using the AddText() method, add a sample text. Set the
AutoChangeBarsproperty to 1 to enable the change bar.
3.2. Changing the table properties in a document
The following script changes the left indentation of all the tables in a FrameMaker body page by 1 inch.
It also changes the width of the columns to 2 inches. Open a FrameMaker document that has tables with
two columns before running the script.
var doc = app.ActiveDoc;
var flow = doc.MainFlowInDoc;
var tbl = 0;
var textItems = flow.GetText(Constants.FTI_TblAnchor);
for (var i = 0; i < textItems.len; i += 1)
{
tbl = textItems[i].obj;
tbl.TblLeftIndent = (2*72 * 65536);
var tblColWidths = new Metrics (2 * 72 * 65536, 2 * 72 * 65536);
tbl.TblColWidths = tblColWidths;
}
The script creates the document’s main flow using the MainFlowInDoc method. Use the
GetText(FTI_TblAnchor) method to list all tables in the main flow. Using a for loop, for each
table, use the TblLeftIndent()method to change the left indentation.
8
CHANGING THE TABLE PROPERTIES IN A DOCUMENT
CHAPTER 3 SAMPLE ESTK SCRIPTS
Use the TblColWidths() method to change the width of the column. This method accepts the argu-
ment in a metric form. So, create the arguments as a metric object using the new Metrics()method.
NOTE: By convention, there are 72 points per inch. Multiply the inch value with 65536 to get the correct
value. 1 inch is equal to 1 * 72 * 65536 points.
9
NAMING DIFFERENCES BETWEEN SCRIPTS AND FDK
CHAPTER 4 DIFFERENCES BETWEEN SCRIPTS AND FDK
4. Differences between scripts and FDK
If you are familiar with the FDK (FrameMaker Developer Kit) object model, this chapter will help you get
quickly get familiarized with ESTK. Adobe FrameMaker scripts are modeled closely on the FrameMaker
FDK. These scripts act as wrappers to the FDK and hide the complexity of using FDK functions from users.
This chapter documents the differences between using scripts and using FDK.
4.1. Naming differences between scripts and FDK
FDK Scripts
Every FDK object is identified by an
object ID.
Every script entity is identified as an object.
Every property in FDK starts with
FP_.
For example, FP_CharTag.
Properties are used directly, in scripts. Remove the FP_
prefix before using the properties in scripts.
For example, FP_CharTag in FDK becomes just
CharTag in scripts.
Every property has its own data type. The properties can
either be read-only or read-write.NOTE: All FDK properties
can be used in FrameMaker scripts.
Every API in FDK starts with
F_APImethodname.
Methods are used directly in scripts. Remove the F_API
prefix before using the methods in scripts.
For example, F_ApiSplitElement becomes just
SplitElement in scripts.
Every object in FDK starts with
FO_.
For example, FO_Doc.
Use objects directly in scripts. Remove the FO_ prefix
before using the objects in scripts.
For example, FO_Doc in FDK becomes just Doc in scripts.
NOTE: FDK object FO_Session is mapped to app and not
to Session. This app script object is readily available for
all FrameMaker scripts to use.
Every structure in FDK starts with
F_ and ends with a T.
For example, F_AttributeT.
Structures are used directly in scripts. Remove the F_
prefix and the ending ‘T’ before using the structures in
scripts.
For example, F_AttributeT in FDK becomes just Attribute
in scripts.
Some FDK structures contain other FDK structures within
themselves. In a script, the structures within a structure
are treated as an object data type.
See the F_TextRangeT structure in Example 3 below.
10
NAMING DIFFERENCES BETWEEN SCRIPTS AND FDK
CHAPTER 4 DIFFERENCES BETWEEN SCRIPTS AND FDK
The following examples clearly highlight the differences between scripts and the FDK.
Example 1:
The app property is readily available to all FrameMaker scripts and maps to the FO_Session object in
FDK.
In this example, you query the ActiveDoc property that returns the Active Document
Object(Doc) in the current FrameMaker Session. The reference to this object is stored in the variable
doc.
doc = app.ActiveDoc;
flow = doc.MainFlowInDoc;
sync = flow.FlowIsSynchronized;
Explanation:
• Line 1 stores the reference to the Active Document Object.
• Line 2 creates an object called flow by querying a property of the doc object.
• Line 3 queries a property of the newly created flow object (created in line 2).
You can query each of the object references as a new object recursively, until you reach the desired
object property:
sync = app.ActiveDoc.MainFlowInDoc.FlowIsSynchronized;
The same example in FDK is as follows:
F_ObjHandleT docId, flowId;
IntT sync;
docId = F_ApiGetId(0, FV_SessionId, FP_ActiveDoc);
flowId = F_ApiGetId(FV_SessionId, docId, FP_MainFlowInDoc);
sync = F_ApiGetInt(docId, flowId, FP_ FlowIsSynchronized);
As discussed in the table above, Example 1 demonstrates how FDK properties [FP_ActiveDoc,
FP_MainFlowInDoc and FP_FlowIsSynchronized] are mapped to script properties
[ActiveDoc, MainFlowInDocand FlowIsSynchronized].
Example 2:
Example 2 builds on Example 1 and shows how methods are called in scripts.
Every object has some methods of its own. These methods can be invoked in the same way as properties
are invoked.
In Example 1, you created the doc object. To invoke a method, use doc.methodname(). For
example, doc.UpdateVariables();
FDK uses data types such as
StrngT for strings and IntT,
UintT for numbers.
Scripts map the FDK data types as follows:
StringT is mapped to Javascript String.
IntT andUinT are mapped to Javascript Number.
ObjHandleT is mapped to Javascript Object.
FDK Scripts
11
NAMING DIFFERENCES BETWEEN SCRIPTS AND FDK
CHAPTER 4 DIFFERENCES BETWEEN SCRIPTS AND FDK
This code calls the UpdateVariables method of the doc object.
FDK users can relate these methods to FDK APIs. The same code in FDK becomes:
F_ApiUpdateVariables(FV_SessionId, docId);
Notice how the FDK API F_ApiUpdateVariables becomes the method name UpdateVariables
in scripts, as mentioned in the table above.
Global Methods:
Not every method is accessible through a specific object. There are some methods that are not called
through any objects but are called directly. These methods are called Global Methods. Examples of
Global Methods include ChooseFile(), CallClent() and Sleep().
In addition to these methods, all FDK Variables and Macros are available as Global Methods. These Vari-
ables usually start with FV_ in FDK.
Consider the following line of code for FDK:
F_ApiSetInt(FV_SessionId, docId, FP_Capitalization,
FV_CAPITAL_CASE_SMALL);
The same code can be written in scripts as follows:
doc.Capitalization = FV_CAPITAL_CASE_SMALL;
However, there is a separate class called Constants that can be used to access these Global Methods.
The script code can also be written as:
doc.Capitalization = Constants.FV_CAPITAL_CASE_SMALL;
Example 3:
Every FDK Structure such as F_TextItemT, and F_TextLocT are also mapped to objects in scripts.
All the fields of these structures are mapped to the read or write properties of these objects.
For example, structure F_PointT:
typedef struct {
MetricT x,y; /* The coordinate pair */
} F_PointT;
is mapped to the Point object in scripting. The Point object has two properties x and y.
See another FDK structure called F_TextRangeT:
typedef struct {
F_TextLocT beg; /* The beginning of the range */
F_TextLocT end; /* The end of the range */
} F_TextRangeT;
This structure is mapped to the TextRange object with both the properties beg and end being of type
TextLoc.
Notice that F_TextLocT itself is another structure.
NOTE: Structure objects do not have any methods associated with them.
The following example script fetches an Active Document and adds some text in the first paragraph of
the first flow of this document.
12
NOTIFICATIONS
CHAPTER 4 DIFFERENCES BETWEEN SCRIPTS AND FDK
doc = app.ActiveDoc;
flow = doc.MainFlowInDoc;
textFrame = flow.FirstTextFrameInFlow;
pgf = textFrame.FirstPgf;
textLoc = new TextLoc();
textLoc.obj = pgf;
textLoc.offset = 0;
doc.AddText(textLoc, ‘Sample Text’);
Notice how theF_TextLocT FDK structure maps to the TextLoc object in scripts.
Lines 1, 2, 3, 4 can be combined and written as:
pgf = app.ActicveDoc.MainFlowInDoc.FirstTextFrameInFlow.FirstPgf;
Lines 6, 7, 8 can be combined and written by passing parameters in the constructor of the TextLoc object
as:
textLoc = new TextLoc(pgf, 0);
Scripts have advanced features such as notifications and commands.
4.2. Notifications
Notifications is the internal mechanism through which a script registered for a particular event is run
when the event is triggered.
As an example, consider the following script:
/*
Sample script to demonstrate how to use notification mechanism of
FrameMaker though ExtendScript
*/
/*
There are basically two parts to a notification script.
1. Registering for a desired notification. (This is done by calling
'Notification()' with desired notifications as argument.)
2. Implement a handler for these notifications in your script. ( Implement
'Notify()' in script)
*/
/*
Part 1. Registering for Notifications
Notification()' is a global function and is available readily in
scripting. (Similar to F_ApiNotification())
The Syntax for Notification() is: Notification(int, int,.....,int, bool);
it takes:
a.)list of notifications(FA_Note_PreOpenDoc, FA_Note_PostOpenDoc etc.)
and
b.) param bool: true = register for provided notification list, false =
unregister for provided notification list.
(This parameter is optional and by default 'true')
Note: for more details please see F_ApiNotification() in FDK reference
13
NOTIFICATIONS
CHAPTER 4 DIFFERENCES BETWEEN SCRIPTS AND FDK
guide.
*/
/*
Notification(FA_Note_PreOpenDoc,true);
This is same as Notification(FA_Note_PreSaveDoc)
or you can register for more than one notification at once
Notification(FA_Note_PostOpenDoc,FA_Note_PreSaveDoc);
Here we register for the notification: FA_Note_PostOpenDoc - this
notification is
triggered just after a document is opened.
Notification(FA_Note_PostOpenDoc,true);
*/
/*
Part 2: handler
This can be done by implementing function 'Notify()' that are called by
FrameMaker when any desired even occurs.(Similar to F_ApiNotify())
Syntax for this callback function is:
@params
note: notification id to identify the event.
object: current document or book object which generated the event.
sparam: The string, if any, associated with the notification
(For example, if the notification is for an Open or Save operation, sparm
specifies the pathname of the affected file. If the notification is for
text entry, sparm specifies the text the user typed.)
iparam: The Integer, if any, associated with the notification. Probably
the fcode or bit flags.
Notify(note, doc, sparam, iparam)
Note: for more details please see F_ApiNotify() in FDK reference guide.
*/
function Notify(note, object, sparam, iparam)
{
switch (note) {
case FA_Note_PostOpenDoc:
alert("Opened document " + sparam);
break;
}
The line of code:
Notification(FA_Note_PostOpenDoc,true);
registers this script for the FA_Note_PostOpenDoc notification. This notification is triggered just
after any document is opened in FrameMaker.
The lines of code:
function Notify(note, object, sparam, iparam)
{
switch (note) {
case FA_Note_PostOpenDoc:
14
MENUS AND COMMANDS
CHAPTER 4 DIFFERENCES BETWEEN SCRIPTS AND FDK
alert("Opened document " + sparam);
break;
}
pops up an alert with the file name just after the file is opened.
4.3. Menus and Commands
Scripting allows you to add custom menus and associate commands with these menus. In addition, you
can implement your own handlers for commands in a similar way as the FDK.
The following script adds two menus and associated commands to the FrameMaker main menu.
/*
In this script, we add two menu items to FrameMaker Session and associate
two different commands to these menu items
*/
// Main menu bar
/* First we get the object associated with Main menubar in FrameMaker*/
mMenu = app.GetNamedMenu("!MakerMainMenu") ;
// F_ApiGetNamedMenu(FV_SessionId, FO_Menu, (ConStringT)"!MakerMainMenu")
/*
Defining new menu items
DefineAndAddMenu(name, label)
FDK equivalent : F_ApiDefineAndAddMenu(F_ObjHandleT toMenuId, StringT
name, StringT label)
*/
nMenu1 = mMenu.DefineAndAddMenu("Menu1", "Menu1");
nMenu2 = mMenu.DefineAndAddMenu("Menu2", "Menu2");
// Adding command to menus
/*
DefineAndAddCommand(cmdID, name, label, shortcut)
FDK equivalent: F_ApiDefineAndAddCommand(IntT cmdID, F_ObjHandleT
toMenuId, StringT name, StringT label, StringT shortcut)
cmdID is a integer that will be passed to Command() function defined in
your script. It should be unique to the script.
*/
nMenu1.DefineAndAddCommand(1,"cmd1","command1","");
nMenu2.DefineAndAddCommand(2,"cmd2","command2","");
// Another way for creating a command and adding it to menu items.
//cmd3 = DefineCommand(3, "cmd3", "cmd3", "");
// FDK equivalent : F_ApiDefineCommand(IntT cmdID, StringT name, StringT
label, StringT shortcut)
// add the command to different menu items
//nMenu1.AddCommandToMenu(cmd3);
// FDK equivalent : ApiAddCommandToMenu(F_ObjHandleT toMenuId,
F_ObjHandleT commandId)
//nMenu2.AddCommandToMenu(cmd3);
// must call if script has been run through ESTK, redundant otherwise.
UpdateMenus();
15
MENUS AND COMMANDS
CHAPTER 4 DIFFERENCES BETWEEN SCRIPTS AND FDK
// Call back equivalent to F_ApiCommand(command)
function Command(cmd){
switch(cmd) {
case 1:
alert("Command1 executed");
break;
case 2:
alert("Command2 executed");
break;
}
}
Let us examine the script in detail:
1) The line: mMenu = app.GetNamedMenu("!MakerMainMenu") ; fetches the name of the
FrameMaker main menu and stores it in the variable mMenu.
2) The lines:
nMenu1 = mMenu.DefineAndAddMenu("Menu1", "Menu1");
nMenu2 = mMenu.DefineAndAddMenu("Menu2", "Menu2");
add two new menu entries Menu1 and Menu2, under the main menu. The name of the main menu
is already stored in step 1.
3) The commands:
nMenu1.DefineAndAddCommand(1,"cmd1","command1","");
nMenu2.DefineAndAddCommand(2,"cmd2","command2","");
add two new menu entries called Command 1 and Command 2 under the menu entries Menu1 and
Menu2, that were defined in step 2.
4) Finally, the block of code:
function Command(cmd) {
case 1: alert("Command 1 executed");
break;
case 2: alert("command 2 executed");
break;
}
assigns the relevant commands to the menu entries defined in step 3.
The number after the keyword case is the menu ID. Look at the command in step 3:
nMenu1.DefineAndAddCommand(1,"cmd1","command1","");
The first value within the parenthesis is the menuID. This value is passed to the case statement.
The system pops up the relevant alert when the corresponding menu entry is clicked.
16
AFRAME
CHAPTER 5 OBJECT REFERENCE
5. Object Reference
5.1. AFrame
Property name Data Type Description
AFrameIsCropped bool Indicates whether the anchored
frame is cropped or not.
Possible values are:
0 - (Default) Indicates the frame is not
cropped.
1 - Indicates the frame is cropped.
AFrameIsFloating bool Indicates whether the anchored
frame is set to be floatable or not.
Possible values are:
0 - (Default) Indicates the frame is not
floatable.
1 - Indicates the frame is floatable.
Alignment number Indicates how the anchored frame is
aligned.
Possible values are:
• Constants.FV_ALIGN_LEFT (0)
• Constants.FV_ALIGN_CENTER
(1)
• Constants.FV_ALIGN_RIGHT (2)
• Constants.FV_ALIGN_INSIDE (3)
• Constants.FV_ALIGN_OUTSIDE
(4)
17
AFRAME
CHAPTER 5 OBJECT REFERENCE
AnchorType number Indicates the location where the
frame is anchored.
Possible values are:
• Constants.FV_ANCHOR_INLINE
(1)
• Constants.FV_ANCHOR_TOP (2)
• Constants.FV_ANCHOR_-
BELOW (3)
• Constants.FV_AN-
CHOR_BOTTOM (4)
• Constants.FV_ANCHOR_SUB-
COL_LEFT (5)
• Constants.FV_ANCHOR_SUB-
COL_RIGHT (6)
• Constants.FV_ANCHOR_SUB-
COL_NEAREST (7)
• Constants.FV_ANCHOR_SUBCOL_-
FARTHEST (8)
• Constants.FV_ANCHOR_SUB-
COL_INSIDE (9)
• Constants.FV_ANCHOR_SUB-
COL_OUTSIDE (10)
• Constants.FV_ANCHOR_TEXT-
FRAME_LEFT (11)
• Constants.FV_ANCHOR_TEXT-
FRAME_RIGHT (12)
• Constants.FV_ANCHOR_TEXT-
FRAME_NEAREST (13)
• Constants.FV_ANCHOR_TEXT-
FRAME_FARTHEST (14)
• Constants.FV_ANCHOR_TEXT-
FRAME_INSIDE (15)
• Constants.FV_ANCHOR_TEXT-
FRAME_OUTSIDE (16)
• Constants.FV_ANCHOR_RUN_IN-
TO_PARAGRAPH (17)
BaselineOffset number Baseline Offset
Property name Data Type Description
18
AFRAME
CHAPTER 5 OBJECT REFERENCE
Element Element If the anchored frame is in a
structured flow in a FrameMaker
document, Element indicates the
element containing the anchored
frame.
InTextFrame TextFrame Indicates the text frame in which the
anchored frame is placed.
InTextObj FMObject Indicates the column or text frame in
which the anchored frame is placed.
NextAFrame AFrame Contains the next anchored frame in
the text frame.
PrevAFrame AFrame Contains the previous anchored
frame in the text frame.
SideOffset number Denotes the near side offset.
TextLoc TextLoc Contains the location of the anchor
symbol.
FirstGraphicInFrame FMObject Contains the first object in the
anchored frame.
LastGraphicInFrame FMObject Contains the last object in the
anchored frame.
Angle number Indicates the angle of rotation of the
graphic object.
ArrowBaseAngle number Denotes the arrowhead base angle in
degrees.
ArrowLength number Denotes the arrowhead length
(always rounded down to the nearest
1/256 point).
ArrowScaleFactor number Indicates the factor by which the
arrowhead is scaled as line width
changes (always rounded down to
nearest 1/16 point). It is not used if
the ArrowScaleHead property is
False.
ArrowScaleHead number Set to 1 if arrowhead is scaled as the
line width changes. Set to 0,
otherwise.
Property name Data Type Description
19
AFRAME
CHAPTER 5 OBJECT REFERENCE
ArrowTipAngle number Denotes the arrowhead tip angle in
degrees.
ArrowType number Denotes the style of the arrowhead.
Possible values are:
• Constants.FV_ARROW_STICK
(0x1)
• Constants.FV_AR-
ROW_HOLLOW (0x2)
• Constants.FV_ARROW_FILLED
(0x3)
BorderWidth number Indicates the border width specified
in points. The permissible range is
0.015 pt to 360 points.
Color Color Denotes the spot color.
Dash Metrics Specifies a dash pattern that is
repeated for the length of an object's
border. The pattern is stored in a
MetricsT structure. The 0th element
of the MetricsT.MetricsT_val array
stores the length of the first dash; the
1st element stores the following
space; the 2nd element stores the
next dash; and so on for an even
number of elements.
Fill number Denotes the fill pattern (numbers
between 0 and 15).
Constants are provided for fill
patterns 0, 7 and 15, as follows:
• Constants.FV_FILL_BLACK (0)
• Constants.FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
FrameParent FMObject Denotes the frame containing the
graphic object.
GraphicCantBeSelected number Set to 1 if the graphic object cannot
be selected. Set to 0, otherwise.
GraphicIsSelected number Set to 1, if the graphic object is
selected. Else, set to 0.
Property name Data Type Description
20
AFRAME
CHAPTER 5 OBJECT REFERENCE
GroupParent Group Specifies the group to which the
object belongs.
Note: Anchored frames do NOT have
this property.
HeadArrow number Set to 1 if the line has an arrow head.
Set to 0, otherwise.
Height number Denotes the height of the object
denoted in points. The permissible
range is from 0.125 points to 3600
points.
HotspotCmdStr StringT The command string for a hotspot.
Thismust be a valid hypertext
command string.
HotspotTitle StringT The tooltip text for the hotspot in the
outputs that support it (for example
HTML). This property is 0ptional.
IsHotspot Bool Whether the object is a hotspot or
not. If this property is turned off, the
object is no longer a hotspot even if
command string is non-empty.
LineCap number Specifies the type of the end of the
line. The possible values are:
• Constants.FV_CAP_BUTT (0x00)
• Constants.FV_CAP_ROUND
(0x01)
• Constants.FV_CAP_SQUARE
(0x02)
LocX number Specifies the distance of the object
from the left side of the parent frame
(in inches). The permissible range is –
216 inches to 216 inches.
If the graphic object is an anchored
frame, the distance is automatically
calculated from the left side of the
page frame. You cannot set this value
manually for anchored frames.
Property name Data Type Description
21
AFRAME
CHAPTER 5 OBJECT REFERENCE
LocY number Distance of the object from the top of
the parent frame (in inches) The
permissible range is –216 inches to
216 inches.
If the graphic object is an anchored
frame, the distance is automatically
calculated from the top of the page
frame. You cannot set this value
manually for anchored frames.
NextGraphicInDoc FMObject Denotes the next graphic object in
the document.
NextGraphicInFrame FMObject Denotes the next graphic object in
the frame.
NextGraphicInGroup FMObject Denotes the next graphic object in
the group.
NextSelectedGraphicInDoc FMObject Denotes the next selected graphic
object in the document.
ObjectAttributes Strings A list of strings. Each string expresses
an attribute that is specified for an
anchored frame in the Object
Properties > Object Attributes dialog
box. Each string is in the form of
string_text.You can use the backslash
to escape characters such as \n, \r, or
\t for newline, carriage return, and
tab, respectively. For a backslash
character in the string text, type \\.
Overprint number Specifies the overprint settings for
the object. The possible values are:
• Constants.FV_KNOCKOUT
(0x00)
• Constants.FV_OVERPRINT
(0x01)
• Constants.FV_FROMCOLOR
(0x02)
Property name Data Type Description
22
AFRAME
CHAPTER 5 OBJECT REFERENCE
Pen number Specifies the pen pattern (numbers
between 0 and 7).
Constants are provided for pen
patterns 0, 7 and 15, as follows:
• Constants.FV_FILL_BLACK (0)
• Constants. FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
PrevGraphicInFrame FMObject Denotes the previous graphic object
in the frame.
PrevGraphicInGroup FMObject Denotes the previous graphic object
in the group.
Runaround number Specifies whether text can flow
around the object and, if so, whether
the text follows the contour of the
object or a box shape surrounding
the object. The possible values are:
• Constants.FV_TR_NONE (0x01)
• Constants.FV_TR_CONTOUR
(0x02)
• Constants.FV_TR_BBOX (0x03)
RunaroundGap number Denotes the width of the runaround
gap, if the object is a runaround
object.
TailArrow number Set to 1 if the arrowhead is enabled
at the begining of the line; Set to 0
otherwise.
TintPercent number Specifies the tint percentage.
Unique number Indicates the graphic object's internal
unique number.
Width number Denotes the width of the object. The
permissible range is from 0.125
points to 3600 points.
FirstGraphicInFrame FMObject Contains the first object in the
anchored frame.
LastGraphicInFrame FMObject Contains the last object in the
anchored frame.
Property name Data Type Description
23
ARC
CHAPTER 5 OBJECT REFERENCE
AFrame methods
Delete, GetProps, SetProps, ObjectValid.
5.2. Arc
UserString string A string to which clients can store
private data.
Property name Data Type Description
DTheta number Denotes the arc angle length in
degrees. The permissible range is –
360 degrees to +360 degrees.
Theta number Specifies the start angle in degrees.
The permissible range is 0 degrees to
360 degrees.
Angle number Specifies the angle of the object's
rotation.
ArrowBaseAngle number Indicates the arrowhead base angle in
degrees.
ArrowLength number Denotes the arrowhead length
(always rounded down to the nearest
1/256 point).
ArrowScaleHead number Set to 1 if the arrowhead is scaled as
the line width changes. Set to 0,
otherwise.
ArrowScaleFactor number Specifies the factor by which
arrowhead is scaled as line width
changes (always rounded down to
nearest 1/16 point). It is not used if
the ArrowScaleHead property is set
to False.
ArrowTipAngle number Specifies the arrowhead tip angle in
degrees.
Property name Data Type Description
24
ARC
CHAPTER 5 OBJECT REFERENCE
ArrowType number Denotes the Arrowhead style.
Possible values are:
• Constants.FV_ARROW_STICK
(0x01)
• Constants.FV_AR-
ROW_HOLLOW (0x02)
• Constants.FV_ARROW_FILLED
(0x03)
BorderWidth number Specifies the border width in points.
The permissible range is 0.015 point
to 360 point.
Color Color Indicates the spot color.
Dash Metrics Specifies a dash pattern that is
repeated for the length of an object's
border. The pattern is stored in a
Metrics object. The 0th element of
the MetricsT.MetricsT_val
array stores the length of the first
dash; the 1st element stores the
following space; the 2nd element
stores the next dash; and so on for an
even number of elements.
Fill number Denotes the fill pattern. The patterns
are denoted by numbers between 0
and 15.
The following constants are provided
for the fill patterns 0, 7 and 15:
• Constants.FV_FILL_BLACK (0)
• Constants.FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
FrameParent FMObject Specifies the frame containing the
graphic object.
GraphicCantBeSelected number Set to 1 if the graphic object cannot
be selected. Else, set to 0.
GraphicIsSelected number Set to 1 if the graphic object is
selected, else set to 0.
Property name Data Type Description
25
ARC
CHAPTER 5 OBJECT REFERENCE
GroupParent Group Indicates the group to which the
object belongs. Anchored and
unanchored frames do not have this
property.
HeadArrow number Set to 1 if line has an arrowhead, set
to 0 otherwise.
Height number Specifies the height of the object in
points. The permissible range is from
0.125 pt to 3600 pt.
HotspotCmdStr StringT The command string for a hotspot.
This must be a valid hypertext
command string.
HotspotTitle StringT The tooltip text for the hotspot in the
outputs that support it (for example
HTML). This property is 0ptional.
IsHotspot Bool Whether the object is a hotspot or
not. If this property is turned off, the
object is no longer a hotspot even if
command string is non-empty.
LineCap number Indicates the type of line end. The
possible values are:
• Constants.FV_CAP_BUTT (0x00)
• Constants.FV_CAP_ROUND
(0x01)
• Constants.FV_CAP_SQUARE
(0x02)
LocX number Specifies the distance of the object
from the left side of the parent, in
inches. The permissible range is from
–216 inches to 216 inches.
If the graphic object is an anchored
frame, the distance is automatically
calculated from the left side of the
page frame. You cannot set the LocX
property for anchored frames.
Property name Data Type Description
26
ARC
CHAPTER 5 OBJECT REFERENCE
LocY number Specifies the distance of the object
from the top of the parent frame, in
inches. The permissible range is from
–216 inches to 216 inches.
If the graphic object is an anchored
frame, the distance is automatically
calculated from the top of the page
frame. You CANNOT set the LocY
property for anchored frames.
NextGraphicInDoc FMObject Indicates the next graphic object in
the document.
NextGraphicInFrame FMObject Denotes the next graphic object in
the frame.
NextGraphicInGroup FMObject Indicates the next graphic object in
the group.
NextSelectedGraphicInDoc FMObject Specifies the next selected graphic
object in the document.
ObjectAttributes Strings Contains a list of strings, each string
expressing an attribute that is
specified for an anchored frame in
the Object Properties > Object
Attributes dialog box. Each string is in
the form of string_text .You can use
the backslash to escape characters
such as \n, \r, or \t for newline,
carriage return, and tab, respectively.
For a backslash character in the string
text, type \\.
Overprint number Specifies the overprint settings for
the object. The possible values are:
• Constants.FV_KNOCKOUT
(0x00)
• Constants.FV_OVERPRINT
(0x01)
• Constants.FV_FROMCOLOR
(0x02)
Property name Data Type Description
27
ARC
CHAPTER 5 OBJECT REFERENCE
Arc methods
Delete, GetProps, ObjectValid, SetProps.
Pen number Indicates the pen pattern, denoted by
numbers between 0 and 7.
Constants are provided for some of
the fill patterns:
• Constants.FV_FILL_BLACK (0)
• Constants.FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
PrevGraphicInFrame FMObject Specifies the previous graphic object
in the frame.
PrevGraphicInGroup FMObject Indicates the previous graphic object
in the group.
Runaround number Specifies whether text can flow
around the object and, if so, whether
the text follows the contour of the
object or a box shape surrounding
the object. Possible values are:
• Constants.FV_TR_NONE (0x01)
• Constants.FV_TR_CONTOUR
(0x02)
• Constants.FV_TR_BBOX (0x03)
RunaroundGap number Denotes the width of the runaround
gap, if the object is a runaround
object.
TailArrow number Set to 1 if the arrowhead is enabled
at the beginning of the line. Set to 0,
otherwise.
TintPercent number Specifies the tint percentage.
Unique number Denotes the internal identifier of the
graphic object.
Width number Specifies the width of the object in
points. The permissible range is 0.125
point to 3600 point.
Property name Data Type Description
28
ATTRCONDEXPR
CHAPTER 5 OBJECT REFERENCE
5.3. AttrCondExpr
AttrCondExpr methods
ApplyAttributeExpression, GetProps, ObjectValid, SetProps.
5.4. Attribute
Attribute methods
Attribute.
Property name Data Type Description
NextAttrCondExprInDoc AttrCondEx
pr
Indicates the pointer to the next
AttrCondExpr object in the
document.
AttrCondExprStr string The AttrCondExpr expression in
string format.
AttrCondExprIsActive bool Set to True if this expression is
applied to the document.
(Application will mean filtering the
document according the constraints
in the expression). Set to False,
otherwise.
Property name Data Type Description
name string The name of the attribute.
values Strings The attribute value.
valflags uint The validation error flags. This
property is read only.
allow uint Allow error as special case to
suppress reporting by validation.
29
ATTRIBUTEDEF
CHAPTER 5 OBJECT REFERENCE
5.5. AttributeDef
Property name Data Type Description
name string Name of the attribute
required number Set to 1 if the attribute is required.
Else, set to 0.
flags uint The flag value determines whether an
attribute is hidden, read-only or
neither.
The following are the values that an
attribute can have:
• Constants.FV_AF_READ_ONLY
(0x0001) - The attribute value is
read-only.
• Constants.FV_AF_HIDDEN
(0x0002) - The attribute value is
hidden.
• NULL - The attribute value is
neither read-only nor hidden.
30
ATTRIBUTEDEF
CHAPTER 5 OBJECT REFERENCE
attrType number Denotes the attribute value’s type.
The value is one of:
• Constants.FV_AT_STRING (0) -
Any arbitratry text string.
• Constants.FV_AT_STRINGS (1) -
One or more arbitrary text
strings.
• Constants.FV_AT_CHOICES (2) -
A value from a list of choices.
• Constants.FV_AT_INTEGER (3) -
A signed whole number (option-
ally restricted to a range of
values).
• Constants.FV_AT_INTEGERS (4)
- One or more integers (option-
ally restricted to a range of
values).
• Constants.FV_AT_REAL (5) - A
real number (optionally
restricted to a range of values).
• Constants. FV_AT_REALS (6) -
One or more real numbers
(optionally restricted to a range
of values).
• Constants.FV_AT_UNIQUE_ID
(7) - A string that uniquely iden-
tifies an element.
• Constants.FV_AT_UNIQUE_IDREF (8
) - A reference to a UniqueID
attribute.
• Constants.FV_AT_UNIQUE_IDREFS (
9) - One or more references to a
UniqueID attribute.
choices Strings The choices from which to select, if
the Type parameter is set to
Constants.FV_AT_CHOICES
(2).
defValues Strings Default value of the attribute.
Property name Data Type Description
31
ATTRIBUTEDEFS
CHAPTER 5 OBJECT REFERENCE
AttributeDef methods
AttributeDef.
5.6. AttributeDefs
An Array of AttributeDef objects with integer indexing and a length property.
AttributeDefs methods
concat, pop, push.
5.7. AttributeEx
5.8. Attributes
An Array of Attribute objects with integer indexing and a length property.
rangeMin string The minimum permissible value, if
any.
rangeMax string The maximum permissible value, if
any.
Property name Data Type Description
length number The length of the array
Property name Data Type Description
name string The name of the attribute.
values Strings The attribute value.
valflags uint The validation error flags. This
property is read only.
allow uint Allow error as special case to
suppress reporting by validation.
Property name Data Type Description
32
ATTRIBUTESEX
CHAPTER 5 OBJECT REFERENCE
Attributes methods
concat, pop, push.
5.9. AttributesEx
An Array of AttributeEx objects with integer indexing and a length property.
AttributesEx methods
concat, pop, push.
5.10. BodyPage
Property name Data Type Description
length number The length of the array.
Property name Data Type Description
length number The length of the array.
Property name Data Type Description
MasterPage string Denotes the name of the master page
background for the body page if the
PageBackground property is set to
Constants.FV_BGD_OTHER
(0x02).
The value is null if the
PageBackgroundproperty is set
to either
Constants.FV_BGD_DEFAULT
(0x00) or
Constants.FV_BGD_NONE
(0x01).
33
BODYPAGE
CHAPTER 5 OBJECT REFERENCE
PageBackground number Indicates the type of master page
background. The possible values are:
• Constants.FV_BGD_DEFAULT
(0x00): The page has a Left or
Right master page background if
the document is double-sided,
or a Right master page back-
ground if the document is
single-sided.
• Constants.FV_BGD_NONE
(0x01): The page has no master
page background.
• Constants.FV_BGD_OTHER
(0x02): The page has the custom
master page background speci-
fied by the MasterPage prop-
erty.
To determine whether a body page
has a Left or a Right master page
background, when its
PageBackground property is set to
Constants.FV_BGD_DEFAULT (0x00),
query its PageIsRecto property.
PageFrame Unanchored
Frame
Denotes the page frame for the page.
PageHeight number Indicates the height of the page.
PageIsRecto number Set to 1 if the page is a Right page; Set
to 0 if the page is a Left page.
PageNext BodyPage Denotes the next body page in the
document.
PageNum number Contains the current page number.
PageNumString string Contains the page number string.
PagePrev BodyPage Denotes the previous body page in
the document.
PageWidth number Denotes the width of the page.
PointPageNum number Indicates the point page number.
Property name Data Type Description
34
BOOK
CHAPTER 5 OBJECT REFERENCE
BodyPage methods
ApplyPageLayout, Delete, GetProps, ObjectValid, SetProps.
5.11. Book
Property name Data Type Description
BookDontUpdateReferences number Set to 0 if FrameMaker is set to
update cross-references when it
opens the book; Set to 1, otherwise.
BookIsModified number Set to 1 if the book has been
modified; Set to 0, otherwise.
BookIsSelected number Set to 1 if the book icon in the book
window is selected; Set to 0
otherwise.
FirstComponentInBook BookCompon
ent
Denotes the first component in the
book.
FirstSelectedComponentInBook BookCompon
ent
Denotes the first selected component
in the book.
IsIconified number Set to 1 if the book window is
iconified; set to 0 otherwise.
IsInFront number Set to 1 if the book window is in front
of other windows in the FrameMaker
product session; Set to 0 otherwise.
IsOnScreen number Set to 1 if the document is visible on
the screen; Set to 0 otherwise.
Note: The IsOnScreen property is
always 1 for books, and setting it to 0
has no effect.
Label string Denotes the title in the book window
title bar.
Name string Indicates the path of the book.
NextOpenBookInSession Book Denotes the next open book in
FrameMaker session's list of open
books.
35
BOOK
CHAPTER 5 OBJECT REFERENCE
StatusLine string String that appears in the book status
bar. Querying this string returns the
status string.
ScreenHeight number Denotes the height of the book
window in pixels.
ScreenWidth number Denotes the width of the book
window in pixels.
ScreenX number Specifies the offset of the book
window in pixels from the left side of
the screen (or the left of the
FrameMaker product application
window).
If you set a value that results in the
book window being off the screen,
that value is ignored and the old
value is retained.
ScreenY number Indicates the offset of the book
window in pixels from the top of the
screen (or the top of the FrameMaker
product application window ).
If you set a value that results in the
book window being off the screen,
that value is ignored and the old
value is retained.
TypeOfDisplayText number Specifies the type of text snippet to
display for each icon in the book
window. The two possible values are:
• Constants.FV_BK_FILENAME
(1)- displays the book compo-
nent's filename
• Constants.FV_BK_TEXT (2) -
displays the first paragraph of
the component's first flow.
AcrobatBookmarkDisplayTags number Set to 1 if the
IncludeParagraphTagsinBoo
kmarkText property is set to 1 (the
paragraph tag is added before the
paragraph text in each bookmark);
Set to 0 otherwise.
Property name Data Type Description
36
BOOK
CHAPTER 5 OBJECT REFERENCE
DocAcrobatColumnArticleThreads number Set to 1 if you want separate article
threads for each column; set to 0 if
you want separate article threads for
each text frame.
NOTE: The
DocPDFNoArticleThread
property must be set to FALSE, when
setting this option.
DocAcrobatDefaultsChanged number Set to 1 if the default heuristics for
determining the paragraph level are
disabled; Set to 0, otherwise.
DocAcrobatElementList Strings Contains a list of the element tags
and context labels to include in
bookmarks.
NOTE: The DocPDFElementList
property applies only to structured
FrameMaker documents.
DocAcrobatElements number Set to 1 if elements rather than
paragraphs are used for bookmarks;
Set to 0 otherwise.
NOTE: The DocPDFElements
property applies only to structured
FrameMaker documents.
DocAcrobatNoArticleThreads number Set to 1 if you do not want article
threads in the resulting PDF; Set to 0
otherwise.
Property name Data Type Description
37
BOOK
CHAPTER 5 OBJECT REFERENCE
GenerateAcrobatInfo number Set to 1 if the
GenerateAdobeAcrobatData
property is set to True. Else, set to 0.
To generate PDF data, you must set
the other document print properties
as follows:
• PrintToFile - True
• PrintThumbnails - False
• PrintSeps - False
• PrintBlankPages - True
• PrintLastSheetFirst - False
• PrintNumCopies - 1
• PrintOddPages - True
• PrintEvenPages - True
• PrintScale - 100%
PDFBookmark bool Set to True if FrameMaker is set to
generate bookmarks when saving as
PDF. Set to False, otherwise.
PDFBookmarksOpenLevel number Denotes the level of bookmarks to be
expanded when Acrobat opens the
generated PDF document. The value
can be any integer, or one of the
following constants:
• Constants.FV_PDFBookmarksOpen-
DefaultLevel (-1)
• Constants.FV_PDFBookmarksOpe-
nAllLevels (-2)
• Constants.FV_PDFBookmarksOpen-
NoneLevel (-3)
If you specify an integer that is
greater than the number of levels in
the Bookmarks Settings, the
Constants.PDFBookmarksOpenAllLev
els (-2) value takes effect.
PDFConvertCMYKtoRGB number When set to 1, the
PDFConvertCMYKtoRGB property
corresponds with the setting
"Convert CMYK colors to
RGB" in the Save As PDF dialog box.
Property name Data Type Description
38
BOOK
CHAPTER 5 OBJECT REFERENCE
PDFDestsMarked number Set to 1 if the document has
paragraphs or elements marked
through the
MarkedForNamedDestination
property.
One of two things must occur in
order for this property to be True:
1. The document must have been
created and opened in FrameMaker
6.0 or later.
2. The PDF FileSize
Optimization client must have
been run over it to mark all
paragraphs or elements that are
targets of hypertext links.
PDFDistillerAbsent number A value of 1 indicates that there is no
Acrobat Distiller available. Any other
value indicates that Acrobat Distiller
is available.
PDFDocInfo Strings Contains a list of strings expressing
values to be set in the PDF Document
Info dictionary when you save the
book as PDF. Each dictionary entry is
expressed as a pair of strings; the first
string expresses the field name, and
the second string expresses the field
value.
PDFEndPage string Denotes the last page in the range of
pages to be printed, in the
FrameMaker numbering style.
PDFJobOption string Specifies the name of the Distiller Job
Options. If the specified name does
not exist in the Distiller Job Options
list, then the first Distiller Job Option
in the list is used.
PDFJobOptionsAbsent number A value of 1 indicates that PDF Job
Options are not available. Any other
value indicates that PDF Job Options
are available.
Property name Data Type Description
39
BOOK
CHAPTER 5 OBJECT REFERENCE
PDFOpenPage string Denotes the PDF page number, in the
FrameMaker numbering style, at
which Acrobat opens the generated
PDF document.
PDFPageHeight number Denotes the page height for the
generated PDF document.
PDFPageWidth number Indicates the page width for the
generated PDF document.
PDFPrintPageRange number Specifies the page range for
generating the PDF document. If set,
the PDF file contains only the
specified pages. Else, FrameMaker
generates PDF for the entire
document or book.
PDFRegistrationMarks number Contains the registration marks for
the generated PDF. The permissible
values are:
• Constants.FV_PDFRegistra-
tionMarksNone (0)
• Constants.FV_PDFRegistra-
tionMarksWestern (1)
• Constants.FV_PDFRegistra-
tionMarksTombo (2)
PDFSeparateFiles number Set to 1, if a separate PDF file should
be generated for each document in a
book; Set to 0 otherwise. This
property can be set for single
documents, but is ignored in that
case.
PDFStartPage string Denotes the first page of the printing
page range, in the FrameMaker
numbering style.
Property name Data Type Description
40
BOOK
CHAPTER 5 OBJECT REFERENCE
PDFZoomFactor number When the PDFZoomType property
is set to
Constants.FV_PDFZoomNone
(0), the PDFZoomFactor
property denotes the zoom
percentage of the PDF document
(metric 25% to 1600%). If the value is
negative or zero, the value of
Constants.FV_PDFZoomDefau
lt (1) takes effect.
PDFZoomType number Denotes the PDF zoom setting at
which Acrobat opens the generated
PDF document. Permissible values
are:
• Constants.FV_PDFZoomNone
(0)
• Constants.FV_PDFZoomDefault
(1)
• Constants.FV_PDFZoomPage (2)
• Constants.FV_PDFZoomWidth
(3)
• Constants.FV_PDFZoomHeight
(4)
If a value other than these is
specified,
Constants.FV_PDFZoomDefault (1)
takes effect.
PDFAllNamedDestinations number Set to 1 if the generated PDF
document should include Named
Destinations for every paragraph and
FrameMaker structure element in the
book. This results in a larger PDF
filesize.
If set to 0, the generated PDF
document will have Named
Destinations only for those
paragraphs and objects that have
already been marked with
PDFDestsMarked set to True.
Property name Data Type Description
41
BOOK
CHAPTER 5 OBJECT REFERENCE
PrintBlankPages number Set to 1 if the
PageRoundingproperty is set to
allow empty pages at the end of
documents; set to 0 otherwise.
PrintCollated number Set to 1 if Collate is enabled; Set to 0
otherwise.
PrintEmulsion number Denotes the direction of the print
emulsion. The possible value are:
• Constants.FV_EMUL_UP (0) -
Emulsion side up
• Constants.FV_EMUL_DOWN (1)
- Emulsion side down
PrinterName string This property has no effect.
PrintEvenPages number Set to 1 if Print Even-Numbered Pages
is enabled.
PrintFileName string Specifies the filename to print to. You
can set the filename to be the default
filename by specifying the
PrintFileName value as null.
PrintImaging number Denotes the type of print imaging.
The permissible values are:
• Constants.FV_IMG_POSITIVE
(0)
• Constants.FV_IMG_NEGATIVE
(1)
PrintLastSheetFirst number Set to 1 to print the last sheet first.
Else, set to 0.
PrintLowRes number Set to 1 to print in low resolution.
Else, set to 0.
PrintNumCopies number Denotes the number of copies to
print.
PrintOddPages number Set to 1 if Print Odd-Numbered Pages
is enabled.
PrintPaperHeight number Specifies the height of the printing
paper.
Property name Data Type Description
42
BOOK
CHAPTER 5 OBJECT REFERENCE
PrintPaperWidth number Indicates the width of the printing
paper.
PrintRegistrationMarks number Set to 1 if Registration Marks is
enabled; Set to 0 otherwise.
PrintScale number Denotes the Print scale factor
expressed as a percentage metric (0%
to 100%).
For print scale percentages, the value
1<<16 or 0x10000 specifies 100%.
PrintSeps number Set to 1 if Print Separations is
enabled.
PrintToFile number Set to 1 if Print Only to File is
enabled.
SkipBlankSeps number Set to 1 if Skip Blank Separations (do
not print blank color separations) is
enabled.
CustomElementList Strings Contains the list of tags to display
when ElementCatalogDisplay
is set to
Constants.FV_ELCAT_CUSTOM
(0x04).
ElementCatalog ElementCat
alogEntrie
s
Contains a list of elements in the
Element Catalog.
Property name Data Type Description
43
BOOK
CHAPTER 5 OBJECT REFERENCE
ElementCatalogDisplay number Catalog display options. Show tags
for:
• Constants.FV_ELCAT_STRICT
(0x00): Valid children for
working from start to finish.
• Constants.FV_ELCAT_LOOSE
(0x01): Valid children for
working in any order.
• Constants.FV_ELCAT_CHIL-
DREN (0x02): Children allowed
anywhere in parent.
• Constants.FV_ELCAT_ALL
(0x03): All elements.
• Constants.FV_ELCAT_CUSTOM
(0x04): List of tags specified by
the CustomElementList prop-
erty.
FileExtensionOverride string Denotes the filename extension to
use when saving the document as
XML. Typically, this property is used
to save XHTML with a .htm extension
rather than .xml. This setting should
be set in the structure application for
the document's DOCTYPE.
ElementSelection ElementRan
ge
Indicates the currently selected
element range in the book.
FirstFmtChangeListInDoc FmtChangeL
ist
Specifies the ID of the first format
change list in the list of format
change lists in the book.
FirstElementDefInDoc ElementDef Denotes the first element definition
in the list of element definitions in
the document (FO_ElementDef ID).
HighestLevelElement Element Denotes the top most element for a
structured book/document.
Property name Data Type Description
44
BOOK
CHAPTER 5 OBJECT REFERENCE
NewElemAttrDisplay number Specifies the attribute display
properties for new elements. The
permissible values are:
• Constants.FV_ATTR_DISP_-
NONE (1): Do not display attri-
butes.
• Constants.FV_AT-
TR_DISP_REQSPEC (2): Display
required and specified attri-
butes.
• Constants.FV_ATTR_DISP_ALL
(3): Display all attributes.
NewElemAttrEditing number Specifies when the Edit Attributes
dialog box appears for new elements.
The permissible values are:
• Constants.FV_ATTR_EDIT_-
NONE (0)
• Constants.FV_ATTR_EDIT_RE-
QUIRED (1)
• Constants.FV_ATTR_EDIT_AL-
WAYS (2)
SeparateInclusions number Set to 1 if inclusions are listed
separately in the element catalog; set
to 0 otherwise.
StructuredApplication string Contains the name of the structured
application that is associated with the
book. If the book has no associated
structure application,
GetString() returns an empty
string.
UseInitialStructure number Set to 1 if FrameMaker inserts the
initial structure for new elements; set
to 0 otherwise.
XmlDocType string Contains the DOCTYPE parameter
from the source XML.
Property name Data Type Description
45
BOOK
CHAPTER 5 OBJECT REFERENCE
XmlEncoding string Specifies the encoding parameter of
the XML Declaration for the source
XML. The string is empty if no
encoding is specified. If this property
is set, the XML Declaration contains
the encoding parameter with this
value on Save As XML.
XmlFileEncoding string Specifies the encoding that is
detected for the source XML book. If
no encoding is specified for the
source XML, XmlEncoding is an
empty string. In that case, if this value
is set, it determines the encoding to
use when saving as XML. If
XmlEncoding has a value, this string
may be empty.
XmlPublicId string Contains the DOCTYPE public
identifier for the source XML
document.
XmlStandAlone number Indicates an integer that specifies the
XML standalone parameter for the
XML document, that is the source of
the current document. The
permissible values are:
• Constants.FV_XML_STAND-
ALONE_YES (1)
• Constants.FV_XML_STAND-
ALONE_NO (2)
• Constants.FV_XML_STANDALONE_-
NONE (3)
• Constants.FV_XML_STAND-
ALONE_NODEC (4)
The standalone parameter is declared
in the XML Declaration. For a file with
no XML declaration, the value is
Constants.FV_XML_STANDALONE_N
ODEC (4). For an XML declaration
with no standalone parameter, this
value is
Constants.FV_XML_STANDALONE_N
ONE (3).
Property name Data Type Description
46
BOOK
CHAPTER 5 OBJECT REFERENCE
XmlStyleSheet string Specifies the XML stylesheet
processing instruction to write out to
XML when saving the book as XML.
Note; The ESTK does not verify that
you are using the correct syntax in
this string.
The string you set should not include
the PI delimiters, <? and ?>. For
example, the string you supply for
my.css may be:
"type=\"text\\css\"
href=\"my.css\""
Only use this string to set a specific
stylesheet specification. GetString()
always returns null for this
parameter. To get the list of
stylesheet specifications associated
with a book, use XmlStyleSheetList.
XmlStyleSheetList Strings Contains a list of stylesheet
processing instructions for the
current book. One book can have
more than one stylesheet
specification associated with it.
Note: The ESTK does not verify that
you are using the correct syntax in
these strings.
The strings should not include the PI
delimiters, <? and ?>.
For example, the string you supply for
my.css may be:
"type=\"text\\css\"
href=\"my.css\""
Setting a list as the value to the
XmlStyleSheetList property
completely overwrites the preceding
list.
XmlSystemId string Contains the DOCTYPE system
identifier for the source XML
document.
Property name Data Type Description
47
BOOK
CHAPTER 5 OBJECT REFERENCE
XmlUseBOM number Indicates whether a byte order mark
was detected when opening the
source XML. The permissible values
are:
• Constants.FV_XML_USE-
BOM_YES (1)
• Constants.FV_XML_USE-
BOM_NO (2)
• Constants.FV_XML_USE-
BOM_UTF8 (3)
• Constants.FV_XML_USE-
BOM_UTF16BE (4)
• Constants.FV_XML_USE-
BOM_UTF16LE (5)
• Constants.FV_XML_USE-
BOM_UTF32BE (6)
• Constants.FV_XML_USE-
BOM_UTF32LE (7)
When saving as XML, if this property
is set to
Constants.FV_XML_USEBOM_YES (1),
FrameMaker writes a byte order
mark in the resulting XML.
XmlVersion string Depicts the XML Version that is
specified in the XML Declaration
when the file is opened. If no XML
version is specified, GetString()
returns an empty string.
If this string contains an invalid XML
declaration, a parsing error occurs
when the book is saved as XML.
XmlWellFormed number Indicates whether the source XML is
qualified as well formed. The
permissible values are:
• Constants.FV_XML_WELL-
FORMED_YES (1)
• Constants.FV_XML_WELL-
FORMED_NO (2)
BookIsViewOnly number Set to 1 if the book is view-only; set
to 0 otherwise.
Property name Data Type Description
48
BOOK
CHAPTER 5 OBJECT REFERENCE
Book methods
Close, Compare, GetProps, GetUniqueObject, Import, NewBookComponentInHierarchy, NewBookCom-
ponentOfTypeInHierarchy, NewSeriesBookComponent, NewSeriesObject, ObjectValid, Save, SetProps,
SilentPrintDoc, SimpleGenerate, SimpleImportElementDefs, SimpleImportFormats, SimpleSave, Update-
Book.
ViewOnlyDeadCodes UInts Contains a list of F-codes that cannot
be executed in the book.
ViewOnlyWinBorders number Set to 1 if the book has normal
window borders; Set to 0 if the book's
border buttons are suppressed.
ViewOnlyWinPopup number Set to 1 if the book window pop-up
menu is available; set to 0 otherwise.
PDFGenerateForReview number This property is used to generate a
PDF for review workflow that is
getting review comments in PDF and
importing them back to FrameMaker
document.
The property helps in importing back
the comments correctly. When this
flag is turned ON, the behavior is
same as if the "Generate for review
only" checkbox is ON in the PDF
setup dialog.
ShowElementDescriptiveNames bool Set to True to show descriptive
names for elements; Set to False,
otherwise.
NOTE: The
ShowElementDescriptiveNames
property is applicable only for
structured FrameMaker.
UseInitialStructureOfAutoInsertedEle
ments
bool If set to True, auto-insertion rules will
be processed recursively. For
example: If an element is inserted
automatically, and auto-insertion
rules exist for this element, in the
element definition, then those rules
would also be processed.
Property name Data Type Description
49
BOOKCOMPONENT
CHAPTER 5 OBJECT REFERENCE
5.12. BookComponent
Property name Data Type Description
BookComponentIsGeneratable number Set to 1 if the book component is a
generated file (BookComponentType
is not set to
Constants.FV_BK_NOT_GENERATABL
E (16)); set to 0, otherwise.
50
BOOKCOMPONENT
CHAPTER 5 OBJECT REFERENCE
BookComponentType number Depicts the type of the book
component. The possible values are:
• Constants.FV_BK_TOC (0) -
Table of contents.
• Constants.FV_BK_LIST_FIGURE
(1) - List of figures.
• Constants.FV_BK_LIST_TABLE
(2) - List of tables.
• Constants.FV_BK_LIST_PGF (3) -
List of paragraphs.
• Constants.FV_B-
K_LIST_MARKER (4) - List of
markers.
• Constants.FV_BK_LIST_MARK-
ER_ALPHA (5) - Alphabetical list
of markers.
• Constants.FV_BK_LIST_PG-
F_ALPHA (6) - Alphabetical list
of paragraphs.
• Constants.FV_BK_INDEX_STAN
(7) - Standard index
• Constants.FV_BK_INDEX_AU-
THOR (8) - Index of authors.
• Constants.FV_BK_INDEX_SUB-
JECT (9) - Subject index.
• Constants.FV_BK_INDEX-
_MARKER (10) - Index of
markers.
• Constants.FV_BK_LIST_FOR-
MATS (11) - List of formats
• Constants.FV_BK_LIST_REFER-
ENCES (12) - List of references.
• Constants.FV_BK_INDEX_FOR-
MATS (13) - Index of formats.
• Constants.FV_BK_INDEX_REFER-
ENCES (14) - Index of refer-
ences.
• Constants.FV_BK_NOT_GENERAT-
ABLE (16) - Book component is
not a generated file.
Property name Data Type Description
51
BOOKCOMPONENT
CHAPTER 5 OBJECT REFERENCE
BookParent Book Specifies the book that contains the
component (Constants.FO_BookID).
ChapNumComputeMethod number The component document's chapter
numbering type. The possible values
are:
• Constants.FV_NUM_READ_FROM_-
FILE (0x00) - Use the numbering
properties from the document
associated with this book
component.
• Constants.FV_NUM_CONTINUE
(0x01) - Continue numbering
from the previous chapter.
• Constants.FV_NUM_RESTART
(0x02) - Use the value specified
for the ChapterNumber prop-
erty.
• Constants.FV_NUM_SAME
(0x03) - Use the same chapter
number as for the previous file.
ChapterNumber number If the ChapNumComputeMethod
property is set to
Constants.FV_NUM_RESTART (0x02),
use the ChapterNumberproperty
as the chapter number.
Property name Data Type Description
52
BOOKCOMPONENT
CHAPTER 5 OBJECT REFERENCE
ChapterNumStyle number Denotes the chapter numbering
style. The possible value are:
• Constants.FV_NUMSTYLE_NU-
MERIC (0x00) - Arabic
• Constants.FV_NUMSTYLE_RO-
MAN_UC (0x01) - Roman,
uppercase
• Constants.FV_NUMSTYLE_RO-
MAN_LC (0x02)- Roman,lower-
case
• Constants.FV_NUMSTYLE_AL-
PHA_UC (0x03) - Alphabetic,
uppercase
• Constants.FV_NUMSTYLE_AL-
PHA_LC (0x04) - Alphabetic,
lowercase
• Constants.FV_NUM-
STYLE_KANJI (0x05) - Kanji
• Constants.FV_NUMSTYLE_ZEN-
KAKU (0x06) - Zenkaku
• Constants.FV_NUMSTYLE_ZENKA-
KU_UC (0x07) - Zenkaku, upper-
case
• Constants.FV_NUMSTYLE_ZENKA-
KU_LC (0x08) - Zenkaku, lower-
case
• Constants.FV_NUMSTYLE_KAN-
JI_KAZU (0x09) - Kazu
• Constants.FV_NUMSTYLE_DAIJI
(0x0a) - Daiji
• Constants.FV_NUMSTYLE_TEXT
(0x0b)- Text. This property is
only for volume/chapter
numbers.
ChapterNumText string If the ChapNumStyle property is set
to Constants.FV_NUMSTYLE_TEXT
(0x0b), use the string specified in the
ChapterNumText property as the
chapter number.
Property name Data Type Description
53
BOOKCOMPONENT
CHAPTER 5 OBJECT REFERENCE
ComponentDisplayText string Specifies the text that displays in the
book window when the value of the
TypeOfDisplayText property is set to
Constants.FV_BK_TEXT (2).
Set the ComponentDisplayText
property to an empty string ("") to
allow FrameMaker to automatically
update the text line with normal
information.
ComponentIsSelected number Set to 1 if the component is selected
in the book window; otherwise set to
0.
ExtractTags Strings List of paragraph tags or markers type
names that are used to set up a
generatable file (for example, table of
contents, list of figures, standard
index or index of authors).
FirstPageNum number Number for the first page in the
component; used when the
PageNumComputeMethod property
is set to
Constants.FV_NUM_RESTART
(0x02).
FnFirstNum string Number for the first footnote in the
component; used when the
FnNumComputeMethod property
is set to
Constants.FV_NUM_RESTART
(0x02).
FnCustNumString string Indicates the characters for custom
document footnote numbers.
Property name Data Type Description
54
BOOKCOMPONENT
CHAPTER 5 OBJECT REFERENCE
FnNumStyle number Footnote numbering style. The
possible values are:
• Constants.FV_FN_NUM_NU-
MERIC (0x00) - Arabic
• Constants.FV_FN_NUM_RO-
MAN_UC (0x01) - Roman upper-
case
• Constants.FV_FN_NUM_RO-
MAN_LC (0x02) - Roman lower-
case
• Constants.FV_FN_NUM_AL-
PHA_UC (0x03) - Alphabetic
uppercase
• Constants.FV_FN_NUM_AL-
PHA_LC (0x04) - Alphabetic
lowercase
• Constants.FV_FN_NUM_-
CUSTOM (0x05) - Custom
numbering
• Constants.FV_FN_NUM_KANJI
(0x06) - Kanji characters
• Constants.FV_FN_NUM_ZEN-
KAKU (0x07) - Zenkaku
• Constants.FV_FN_NUM_ZENKA-
KU_UC (0x08) - Zenkaku upper-
case
• Constants.FV_FN_NUM_ZENKA-
KU_LC (0x09) - Zenkaku lower-
case
• Constants.FV_FN_NUM_KAN-
JI_KAZU (0x0A) - Kazu
• Constants.FV_FN_NUM_DAIJI
(0x0B) - Daiji
Property name Data Type Description
55
BOOKCOMPONENT
CHAPTER 5 OBJECT REFERENCE
FnNumComputeMethod number The component document's footnote
numbering type. The possible values
are:
• Constants.FV_NUM_READ_FROM_-
FILE (0x00) - Use the numbering
properties from the document
associated with this book
component.
• Constants.FV_NUM_CONTINUE
(0x01) - Continue numbering
from the previous file.
• Constants.FV_NUM_RESTART
(0x02) - Use the number speci-
fied by the FnFirstNum prop-
erty.
• Constants.FV_NUM_PER_PAGE
(0x03) - Restart numbering on
each page.
GenerateInclude number Set to 1 if the document appears in
the scroll list of files to be generated
by the Generate/Update command
for the book; otherwise set to 0.
ImportFmtInclude number Set to 1 if the book component is
included in the list of components to
be updated with imported formats or
element definitions, when the user or
a client executes Import Formats or
Import Element Definitions;
otherwise set to 0.
InsertLinks number Set to 1 if hypertext links are
automatically inserted in generated
files; otherwise set to 0.
Name string Indicates the path of the document
that the component represents.
NextComponentInBook BookCompon
ent
Specifies the next component in the
book file.
NextSelectedComponentInBook BookCompon
ent
Specifies the next selected
component in the book window.
Property name Data Type Description
56
BOOKCOMPONENT
CHAPTER 5 OBJECT REFERENCE
PageNumComputeMethod number The component document's page
numbering type. The possible values
are:
• Constants.FV_NUM_READ_FROM_-
FILE (0x00) - Use the numbering
properties from the document
associated with this book
component.
• Constants.FV_NUM_CONTINUE
(0x01) - Continue the
numbering from the previous
file.
• Constants.FV_NUM_RESTART
(0x02) - Restart numbering at
the value specified by the
FirstPageNum property.
Property name Data Type Description
57
BOOKCOMPONENT
CHAPTER 5 OBJECT REFERENCE
PageNumStyle number Page numbering style. The possible
values are:
• Constants.FV_PAGE_NUM_NU-
MERIC (0x00) - Arabic
• Constants.FV_PAGE_NUM_RO-
MAN_UC (0x01) - Roman upper-
case
• Constants.FV_PAGE_NUM_RO-
MAN_LC (0x02) - Roman lower-
case
• Constants.FV_PAGE_NUM_AL-
PHA_UC (0x03) - Alphabetic
uppercase
• Constants.FV_PAGE_NUM_AL-
PHA_LC (0x04) - Alphabetic
lowercase
• Constants.FV_PAGE_NUM_KANJI (0
x05) - Kanji characters
• Constants.FV_PAGE_NUM_ZEN-
KAKU (0x06) - Zenkaku
• Constants.FV_PAGE_NUM_ZENKA-
KU_UC (0x07) - Zenkaku upper-
case
• Constants.FV_PAGE_NUM_ZENKA-
KU_LC (0x08) - Zenkaku lower-
case
• Constants.FV_PAGE_NUM_KAN-
JI_KAZU (0x09) - Kazu
• Constants.FV_PAGE_NUM_-
DAIJI (0x0a) - Daiji
Property name Data Type Description
58
BOOKCOMPONENT
CHAPTER 5 OBJECT REFERENCE
PageSide number Specifies the page side on which to
start the component document. The
possible values are:
• Constants.FV_BK_START_FROM_-
FILE (0x01)
• Constants.FV_BK_START_NEX-
T_AVAILABLE (0x02)
• Constants.FV_BK_START_LEFT
(0x03)
• Constants.FV_B-
K_START_RIGHT (0x04)
PgfNumComputeMethod number The type of numbering for the
component document's paragraph.
Possible values are:
• Constants.FV_NUM_READ_FROM_-
FILE (0x00) - Use the numbering
properties from the document
associated with this book
component.
• Constants.FV_NUM_CONTINUE
(0x01) - Continue the
numbering from the previous
file.
• Constants.FV_NUM_RESTART
(0x02) - Restart numbering at 1.
PrevComponentInBook BookCompon
ent
Denotes the previous component in
the book file.
PrintInclude number Set to 1 if the component document
is included in the list of book files to
be printed; otherwise set to 0.
TblFnCustNumString string Specifies the characters for custom
table footnote numbers.
Property name Data Type Description
59
BOOKCOMPONENT
CHAPTER 5 OBJECT REFERENCE
TblFnNumStyle number Table footnote numbering style. The
possible values are:
• Constants.FV_FN_NUM_NU-
MERIC (0x00) - Arabic
• Constants.FV_FN_NUM_RO-
MAN_UC (0x01) - Roman upper-
case
• Constants.FV_FN_NUM_RO-
MAN_LC (0x02) - Roman lower-
case
• Constants.FV_FN_NUM_AL-
PHA_UC (0x03) - Alphabetic
uppercase
• Constants.FV_FN_NUM_AL-
PHA_LC (0x04) - Alphabetic
lowercase
• Constants.FV_FN_NUM_-
CUSTOM (0x05)- Custom
numbering
• Constants.FV_FN_NUM_KANJI
(0x06) - Kanji characters
• Constants.FV_FN_NUM_ZEN-
KAKU (0x07) - Zenkaku
• Constants.FV_FN_NUM_ZENKA-
KU_UC (0x08) - Zenkaku upper-
case
• Constants.FV_FN_NUM_ZENKA-
KU_LC (0x09) - Zenkaku lower-
case
• Constants.FV_FN_NUM_KAN-
JI_KAZU (0x0A) - Kazu
• Constants.FV_FN_NUM_DAIJI
(0x0B) - Daiji
Property name Data Type Description
60
BOOKCOMPONENT
CHAPTER 5 OBJECT REFERENCE
TblFnNumComputeMethod number The numbering type of the
component document's table
footnote. Possible values are:
• Constants.FV_NUM_READ_FROM_-
FILE (0x00) - Use the numbering
properties from the document
associated with this book
component.
• Constants.FV_NUM_RESTART
(0x02) - Start at 1.
Unique number Represents the Unique ID of the book
component.
VolNumComputeMethod number The component document's volume
numbering type. The possible values
are:
• Constants.FV_NUM_READ_FROM_-
FILE (0x00) - Use the numbering
properties from the document
associated with this book
component.
• Constants.FV_NUM_CONTINUE
(0x01) - Continue numbering
from the previous volume.
• Constants.FV_NUM_RESTART
(0x02) - Use the value specified
for the VolumeNumber prop-
erty.
• Constants.FV_NUM_SAME
(0x03) - Use the same volume
number as for the previous file.
VolumeNumber number If the VolNumComputeMethod
property is set to
Constants.FV_NUM_RESTART
(0x02), use the value specified in
the VolumeNumber property as the
volume number.
Property name Data Type Description
61
BOOKCOMPONENT
CHAPTER 5 OBJECT REFERENCE
VolumeNumStyle number The volume numbering style. The
possible values are:
• Constants.FV_NUMSTYLE_NU-
MERIC (0x00) - Arabic
• Constants.FV_NUMSTYLE_RO-
MAN_UC (0x01) - Roman upper-
case
• Constants.FV_NUMSTYLE_RO-
MAN_LC (0x02) - Roman lower-
case
• Constants.FV_NUMSTYLE_AL-
PHA_UC (0x03) - Alphabetic
uppercase
• Constants.FV_NUMSTYLE_AL-
PHA_LC (0x04) - Alphabetic
lowercase
• Constants.FV_NUM-
STYLE_KANJI (0x05) - Kanji
• Constants.FV_NUMSTYLE_ZEN-
KAKU (0x06) - Zenkaku
• Constants.FV_NUMSTYLE_ZENKA-
KU_UC (0x07) - Zenkaku upper-
case
• Constants.FV_NUMSTYLE_ZENKA-
KU_LC (0x08) - Zenkaku lower-
case
• Constants.FV_NUMSTYLE_KAN-
JI_KAZU (0x09) - Kazu
• Constants.FV_NUMSTYLE_DAIJI
(0x0a) - Daiji
• Constants.FV_NUMSTYLE_TEXT
(0x0b) - Text
VolumeNumText string If the VolNumStyle property is set
to
Constants.FV_NUMSTYLE_TEX
T (0x0b), use the string specified
in the VolumeNumText property as
the chapter number.
ComponentElement Element Specifies the component element
(FO_Element ID).
Property name Data Type Description
62
BOOKCOMPONENT
CHAPTER 5 OBJECT REFERENCE
ExtractElementTags Strings List of element tags that are used to
set up a generatable file (for example,
table of contents, list of figures, or list
of tables).
FirstComponentInBookComponent BookCompon
ent
Denotes the first component of the
hierarchy for which the current
component is the parent.
BookComponentParent BookCompon
ent
Denotes the parent of the current
book element.
ExcludeBookComponent number Specifies the component to exclude
when printing the book.
BookComponentTemplatePath string The path to the file that is used as a
template for a folder.
BookComponentTitle string The name of a folder or a group
component.
ComponentType number Indicates whether the component is a
folder, group, or a document. The
value is one of:
• Constants.FV_BK_FOLDER
(0x02) - Folder
• Constants.FV_BK_GROUP
(0x40) - Group
• Constants.FV_BK_FM (0x8) -
FrameMaker document
• Constants.FV_BK_MIF (0x10) -
MIF document
• Constants.FV_BK_XML (0x20) -
XML document
XmlApplicationForBookComponent string The application name for the XML
that is set as template for the folder.
Property name Data Type Description
63
BOOKCOMPONENT
CHAPTER 5 OBJECT REFERENCE
SecNumComputeMethod number Indicates the type of numbering
applied to a particular book
component. The value is one of:
• Constants.FV_NUM_CONTINUE
(0x01)
• Constants.FV_NUM_RESTART
(0x02)
• Constants.FV_NUM_SAME
(0x03)
SectionNumStyle number Denotes the section numbering style.
Possible values are:
• Constants.FV_PAGE_NUM_NU-
MERIC (0x00) - Arabic
• Constants.FV_PAGE_NUM_RO-
MAN_UC (0x01) - Roman upper-
case
• Constants.FV_PAGE_NUM_RO-
MAN_LC (0x02) - Roman lower-
case
• Constants.FV_PAGE_NUM_AL-
PHA_UC (0x03) - Alphabetic
uppercase
• Constants.FV_PAGE_NUM_AL-
PHA_LC (0x04) - Alphabetic
lowercase
• Constants.FV_PAGE_NUM_KANJI (0
x05) - Kanji characters
• Constants.FV_PAGE_NUM_ZEN-
KAKU (0x06) - Zenkaku
• Constants.FV_PAGE_NUM_ZENKA-
KU_UC (0x07) - Zenkaku upper-
case
• Constants.FV_PAGE_NUM_ZENKA-
KU_LC (0x08) - Zenkaku lower-
case
• Constants.FV_PAGE_NUM_KAN-
JI_KAZU (0x09) - Kazu
• Constants.FV_PAGE_NUM_-
DAIJI (0x0a) - Daiji
Property name Data Type Description
64
BOOKCOMPONENT
CHAPTER 5 OBJECT REFERENCE
SectionNumber number Denotes the section number of the
specified component.
SectionNumText string The text to use for the
SectionNumber property.
SubsecNumComputeMethod number Indicates the type of numbering
applied to a particular book
component. The value is one of:
• Constants.FV_NUM_CONTINUE
(0x01)
• Constants.FV_NUM_RESTART
(0x02)
• Constants.FV_NUM_SAME
(0x03)
Property name Data Type Description
65
BOOKCOMPONENT
CHAPTER 5 OBJECT REFERENCE
SubsectionNumStyle number Denotes the subsection numbering
style. Possible values are:
• Constants.FV_PAGE_NUM_NU-
MERIC (0x00) - Arabic
• Constants.FV_PAGE_NUM_RO-
MAN_UC (0x01) - Roman upper-
case
• Constants.FV_PAGE_NUM_RO-
MAN_LC (0x02) - Roman lower-
case
• Constants.FV_PAGE_NUM_AL-
PHA_UC (0x03) - Alphabetic
uppercase
• Constants.FV_PAGE_NUM_AL-
PHA_UC (0x03) - Alphabetic
uppercase
• Constants.FV_PAGE_NUM_AL-
PHA_LC (0x04) - Alphabetic
lowercase
• Constants.FV_PAGE_NUM_KANJI (0
x05) - Kanji characters
• Constants.FV_PAGE_NUM_ZEN-
KAKU (0x06) - Zenkaku
• Constants.FV_PAGE_NUM_ZENKA-
KU_UC (0x07) - Zenkaku upper-
case
• Constants.FV_PAGE_NUM_ZENKA-
KU_LC (0x08) - Zenkaku lower-
case
• Constants.FV_PAGE_NUM_KAN-
JI_KAZU (0x09) - Kazu
• Constants.FV_PAGE_NUM_-
DAIJI (0x0a) - Daiji
SubsectionNumber number Denotes the subsection number of
the specified component.
SubsectionNumText string The text to use for the
SubsectionNumber property.
Property name Data Type Description
66
BOOKCOMPONENT
CHAPTER 5 OBJECT REFERENCE
BookComponent methods
Delete, GetProps, MoveComponent, ObjectValid, SetProps.
NextBookComponentInDFSOrder BookCompon
ent
Denotes the pointer to traverse
through book components in a
hierarchal manner (top to bottom).
BookComponentFileType number Determines the file type of the
document. The possible values are:
• Constants.FV_BK_FM (0x8) -
FrameMaker document
• Constants.FV_BK_MIF (0x10) -
MIF document
• Constants.FV_BK_XML (0x20) -
XML document
• Constants.FV_BK_XML (0x20) -
Ditamap
PrevBookComponentInDFSOrder BookCompon
ent
Denotes the pointer to traverse
through book components in an
heirarchial manner (bottom to top).
BookComponentIsFolderWithTempla
te
number Determines whether a template is
associated with a book. Returns 1 if
the BookComponent is a folder and
a template is associated with the
component. Returns 0, otherwise.
BookComponentIsFolderWithoutTem
plate
number Determines whether a template is
not associated with a book. Returns 1
if the BookComponent is a folder
and a template is not associated.
Returns 0 otherwise.
ComponentIsDitaMap bool Determines whether a book
component is a ditamap. Set to 1 if
the book component is a ditamap; set
to 0 otherwise.
Property name Data Type Description
67
CELL
CHAPTER 5 OBJECT REFERENCE
5.13. Cell
Property name Data Type Description
CellAboveInCol Cell Denotes the cell above the current
cell (FO_CellID).
CellAngle number Indicates the angle of rotation of the
cell.
CellBelowInCol Cell Denotes the cell below the current
cell (FO_CellID).
CellColNum number Represents the cell's column number.
CellDefaultBottomRuling RulingFmt Indicates the cell's default bottom
ruling (FO_RulingFmt ID).
CellDefaultLeftRuling RulingFmt Specifies the cell's default left ruling
(FO_RulingFmt ID).
CellDefaultRightRuling RulingFmt Indicates the cell's default right ruling
(FO_RulingFmt ID).
CellDefaultTopRuling RulingFmt Represents the cell's default top
ruling (FO_RulingFmt ID).
CellIsShown number Returns 1 if the cell is conditional and
is visible; returns 0 otherwise.
CellIsStraddled number Returns 1 if the cell is in a straddle
but is not the first cell; returns 0 if the
cell is the first cell in a straddle, or is
not in a straddle.
CellNumColsStraddled number Specifies the number of columns in
the straddle, if the cell is the first cell
in a horizontal straddle; Otherwise
the value is 1.
CellNumRowsStraddled number Specifies the number of rows in the
straddle, if the cell is the first cell in a
vertical straddle; Otherwise the value
is 1.
ContentHeight number Denotes the distance between the
top of the cell and the baseline of the
last line in the cell.
68
CELL
CHAPTER 5 OBJECT REFERENCE
CellOverrideBottomRuling RulingFmt Represents the cell's bottom ruling
(FO_RulingFmt ID), if there is an
override. The value is null if there is
no override.
CellOverrideFill number Indicates the cell's fill pattern. The
value is null if there is no override fill
pattern.
CellOverrideLeftRuling RulingFmt Indicates the cell's left ruling
(FO_RulingFmt ID), if there is an
override. The value is null if there is
no override.
CellOverrideRightRuling RulingFmt Specifies the cell's right ruling
(FO_RulingFmt ID), if there is an
override. The value is null if there is
no override.
CellOverrideShading Color Denotes the cell's spot color
(FO_Color ID). The value is null if
there is no override shading.
CellOverrideTopRuling RulingFmt Denotes the cell's top ruling
(FO_RulingFmt ID), if there is an
override. The value is null if there is
no override.
CellRow Row Denotes the row containing the cell
(FO_RowID).
CellUseOverrideBRuling number Set to 1 if the cell's bottom ruling
(specified by the
CellOverrideBottomRuling
property) overrides the default ruling
specified by the table format; set to 0
otherwise.
CellUseOverrideFill number Set to 1 if the cell's fill pattern
(specified by the
CellOverrideFill property)
overrides the default fill pattern
specified by the table format; set to 0
otherwise.
Property name Data Type Description
69
CELL
CHAPTER 5 OBJECT REFERENCE
CellUseOverrideLRuling number Set to 1 if the cell's left ruling
(specified by the
CellOverrideLeftRuling
property) overrides the ruling
specified by the table format; set to 0
otherwise.
CellUseOverrideRRuling number Set to 1 if the cell's right ruling
(specified by the
CellOverrideRightRuling
property) overrides the ruling
specified by the table format; set to 0
otherwise.
CellUseOverrideShading number Set to 1 if the cell's shading (specified
by the CellOverrideShading
property) overrides the default
shading specified by the table format;
set to 0 otherwise.
CellUseOverrideTRuling number Set to 1 if the cell's top ruling
(specified by the
CellOverrideTopRuling property)
overrides the default top ruling
specified by the table format; set to 0
otherwise.
Element Element Denotes the element containing the
cell, if the cell is in a FrameMaker
document.
FirstPgf Pgf Represents the first paragraph in the
cell (FO_Pgf ID).
InTextFrame TextFrame Represents the text frame containing
the cell (FO_TextFrame ID).
InTextObj SubCol Represents the text object containing
the cell (FO_SubCol ID).
LastPgf Pgf Indicates the last paragraph in the cell
(FO_Pgf ID).
NextCellInRow Cell Denotes the next cell in current row
from left to right (FO_Cell ID).
Property name Data Type Description
70
CELL
CHAPTER 5 OBJECT REFERENCE
Cell methods
GetProps, GetText, ObjectValid, SetProps, StraddleCells, UnStraddleCells.
NextCellInTbl Cell Represents the next cell from left to
right (FO_Cell ID). If the cell is at the
end of a row, the next cell is the first
cell in the next row.
NextCell Cell Represents the next cell in the text
frame (FO_Cell ID).
Overflowed number Specifies whether the text in the cell
overflows. Set to 1 if the row Height
Limit Maximum is too low to display
all the text in the cell; set to 0
otherwise.
PrevCellInRow Cell Represents the previous cell in the
current row (FO_Cell ID).
PrevCell Cell Denotes the previous cell in the text
frame (FO_Cell ID).
Unique number Represents the cell's unique ID.
UserString string A string to which clients can store
private data.
Property name Data Type Description
71
CHARFMT
CHAPTER 5 OBJECT REFERENCE
5.14. CharFmt
Property name Data Type Description
Capitalization number The capitalization type. The possible
values are:
• Constants.FV_CAPITAL_-
CASE_NORM (0) - Normal capi-
talization (mixed uppercase and
lowercase)
• Constants.FV_CAPITAL_-
CASE_SMALL (1) - Small caps
• Constants.FV_CAPITAL_-
CASE_LOWER (2) - Lowercase
letters only
• Constants.FV_CAPITAL_-
CASE_UPPER (3) - Uppercase
letters only
ChangeBar number Returns 1 if Change Bars are on.
CharTag string Denotes the character format's tag
name.
Color Color Indicates the spot color ((FO_Color
ID).
CombinedFontFamily CombinedFo
ntDefn
Denotes the combined font definition
(FO_CombinedFontDefn).
FontAngle number Represents the font angle (specifies
an index into the array of font angles
provided by the session property
FontAngleNames).
FontEncodingName string Indicates the encoding of the font.
FontFamily number Specifies the font family (specifies an
index into the array of font families
provided by the session property
FontFamilyNames).
FontPlatformName string Name that uniquely identifies a font
on a specific platform. For combined
fonts, the name is the Asian font
name.
72
CHARFMT
CHAPTER 5 OBJECT REFERENCE
FontPostScriptName string Name given to a font when it is sent
to a PostScript printer. For combined
fonts, the name is the Asian font
name.
WesternFontPlatformName string Name that uniquely identifies the
Roman component of a combined
font on a specific platform.
WesternFontPostScriptName string Name given to the Roman
component of a combined font when
it is sent to a PostScript printer.
FontSize number Denotes the font size (2 point to 400
point).
FontVariation number Indicates the font variation (specifies
an index into the array of font
variations provided by the session
property
FontVariationNames).
FontWeight number Indicates the font weight (specifies an
index into the array of font weights
provided by the session property
FontWeightNames).
Property name Data Type Description
73
CHARFMT
CHAPTER 5 OBJECT REFERENCE
Language number Denotes the hyphenation and
spell-checking language to use. The
possible languages are:
• Constants.FV_LANG_NOLAN-
GUAGE (0x00)
• Constants.FV_LANG_ENGLISH
(0x01)
• Constants.FV_LANG_BRITISH
(0x02)
• Constants.FV_LANG_GERMAN
(0x03)
• Constants.FV_LANG_SWISS_-
GERMAN (0x04)
• Constants.FV_LANG_FRENCH
(0x05)
• Constants.FV_LANG_CANADIAN_-
FRENCH (0x06)
• Constants.FV_LANG_SPANISH
(0x07)
• Constants.FV_LANG_CATALAN
(0x08)
• Constants.FV_LANG_ITALIAN
(0x09)
• Constants.FV_LANG_FINNISH
(0x10)
• Constants.FV_LANG_SWEDISH
(0x11)
• Constants.FV_LANG_JAPANESE
(0x12)
• Constants.FV_LANG_TRADITION-
AL_CHINESE (0x13)
• Constants.FV_LANG_SIMPLI-
FIED_CHINESE (0x14)
• Constants.FV_LANG_KOREAN
(0x15)
• Constants.FV_LANG_PORTU-
GUESE (0x0A)
• Constants.FV_LANG_BRA-
ZILIAN (0x0B)
• Constants.FV_LANG_DANISH
(0x0C)
• Constants.FV_LANG_DUTCH
(0x0D)
• Constants.FV_LANG_NORWE-
GIAN (0x0E)
Property name Data Type Description
74
CHARFMT
CHAPTER 5 OBJECT REFERENCE
KernX number Horizontal kern value for manual
kerning expressed as a percentage of
an em (metric –1000% to 1000%). A
positive value moves a character right
and a negative value moves a
character left.
KernY number Vertical kern value for manual
kerning expressed as a percentage of
an em (metric –1000% to 1000%). A
positive value moves characters up
and a negative value moves
characters down.
Name string Specifies the character format's
name.
NextCharFmtInDoc CharFmt Denotes the next character format in
the document (FO_CharFmt ID).
Overline number Returns 1 if Overlineis enabled;
returns 0 otherwise.
PairKern number Returns 1 if PairKern is enabled;
returns 0 otherwise.
Position number Denotes the vertical position of the
character. Possible values are:
• Constants.FV_POS_NORM (0) -
Normal
• Constants.FV_POS_SUPER (1) -
Superscript
• Constants.FV_POS_SUB (2) -
Subscript
Stretch number Denotes the character stretch (set
width) expressed as a percentage of
normal stretch for the font (metric –
10% to 1000%).
Strikethrough number Returns True if Strikethrough is
enabled; otherwise returns False.
Underlining number Indicates the character tracking
expressed as a percentage of an em
(metric –100% to 1000%).
Property name Data Type Description
75
CHARFMT
CHAPTER 5 OBJECT REFERENCE
UseCapitalization number Returns 1 if the Capitalization
property overrides the default value;
returns 0 if the "As Is" setting is
used.
UseChangeBar number Returns 1 if the ChangeBar
property overrides the default value;
returns 0 if the "As Is" setting is
used.
UseColor number Returns 1 if the Color property
overrides the default value; returns 0
if the "As Is" setting is used.
UseFontAngle number Returns 1 if the FontAngle
property overrides the default value;
returns 0 if the "As Is" setting is
used.
UseFontFamily number Returns 1 if the
FontFamilyproperty overrides the
default value; returns 0 if the "As
Is" setting is used.
UseFontSize number Returns 1 if the FontSize property
overrides the default value; returns 0
if the "As Is" setting is used.
UseFontVariation number Returns 1 if the FontVariation
property overrides the default value;
returns 0 if the "As Is" setting is
used.
UseFontWeight number Returns 1 if the FontWeight
property overrides the default value;
returns 0 if the "As Is" setting is
used.
UseKernX number Returns 1 if the KernX property
overrides the default value; returns 0
if the "As Is" setting is used.
UseKernY number Returns 1 if the KernY property
overrides the default value; returns 0
if the "As Is" setting is used.
Property name Data Type Description
76
CHARFMT
CHAPTER 5 OBJECT REFERENCE
UseOverline number Returns 1 if the Overline property
overrides the default value; returns 0
if the "As Is" setting is used.
UsePairKern number Returns 1 if the PairKern property
overrides the default value; returns 0
if the "As Is" setting is used.
UsePosition number Returns 1 if the Position property
overrides the default value; returns 0
if the "As Is" setting is used.
UserString string A string to which clients can store
private data.
UseStretch number Returns 1 if the Stretchproperty
overrides the default value; returns 0
if the "As Is" setting is used.
UseStrikethrough number Returns 1 if the Strikethrough
property overrides the default value;
returns 0 if the "As Is" setting is
used.
UseUnderlining number Returns 1 if the Underlining
property overrides the default value;
returns 0 if the "As Is" setting is
used.
BkColor FMObject Denotes the text background color. If
this property is applied on a
paragraph format, it denotes the
background color of the whole
paragraph; if it is applied on a
character format, it denotes the
background color of the text over
which the character format is
applied.
Property name Data Type Description
77
CMSCHECKINPARAM
CHAPTER 5 OBJECT REFERENCE
CharFmt methods
Delete, GetProps, ObjectValid, SetProps.
5.15. CMSCheckinParam
UseBkColor bool The UseBkColor is a Boolean flag
which indicates whether the
BkColor property is set or not. A
value of 1 indicates the text has some
background color. A value of 0
indicates a transparent background.
NOTE: When the UseBkColor
property is set to 0, the BkColor
value is not used.
Property name Data Type Description
version int Denotes the version of the checked-in
document. This property uses values
from the CMSVersioningStrategy
enumeration:
CMSSameVersion: Same version
CMSMinorVersion: Minor version
CMSMajorVersion: Major version
versionLabel string Specifies the label of the document
version
description string Specifies the description of the
document version
checkinComment string Specifies the check-in comments of
the document version
makeThisCurrentVersion bool Determines whether the specified
version is the current version. Set to
True to make this checked-in
document the current version; else
set to False
Property name Data Type Description
78
CMSDELETEPARAM
CHAPTER 5 OBJECT REFERENCE
5.16. CMSDeleteParam
5.17. CMSInfo
5.18. CMSMenuItem
Property name Data Type Description
deleteAllVersion bool Determines whether to delete all
versions of the current document. Set
to True if user want to delete all the
version of a file.; else set to False.
deleteAllDependents bool Determines whether to delete all
dependents of the current document.
True if user wants to delete all the
dependents of a file; else set to False
Property name Data Type Description
cmsName string Specifies the name of the content
management system.
userFields string Specifies the list of optional user
fields. If no user fields is specified
then its value is NULL.
userLoginUi bool Determines if the default Connection
manager dialog is used for login.
False if default Connection manager
dialog is used for login; else set to
True.
Property name Data Type Description
id int Specifies the ID of the menu item.
name string Specifies the name of the menu item.
79
CMSPROPERTY
CHAPTER 5 OBJECT REFERENCE
5.19. CMSProperty
5.20. CMSProperties
An Array of objects with integer indexing and a length property.
flags int Specifies the type of menu. Uses the
values from the following
enumeration:
FV_CMSMenu_Is_Item: Custom
menu is single item
FV_CMSMenu_Is_Disabled: Custom
menu is disabled
FV_CMSMenu_Is_Separator: Custom
menu is separator
FV_CMSMenu_Is_SubMenu: Custom
menu is of type submenu
Property name Data Type Description
prop int Specifies the CMS Property Id.
Use the value of enum
F_CMSItemPropertyT (See following
enum) or custom property added by
the user (pending - peterb)
label string Specifies the label of the property
isMultiValue bool Determines if the property is
multivalue. Set to True if the property
is multivalue; else set to False.
isEditable bool Determines if the property is
editable. Set to True if the property is
editable; else set to False.
values TypedVals Specifies the values of the property
Property name Data Type Description
length number The length of the array
Property name Data Type Description
80
CMSREGISTRATION
CHAPTER 5 OBJECT REFERENCE
5.21. CMSRegistration
5.22. CMSResult
Property name Data Type Description
CMSRegistration object CMSRegistration object created when
user registers a new Content
Management System using
CMSRegister.
Property name Data Type Description
status StatusT Specifies the Command status
opResult int Specifies the Operation result.
If CMS Command needs CMSTree
update, assign F_CMSOpResultT
values (See following enum),else can
return any value depending on
operation.
For example:
opResult = True/False for
FA_CMSIsValidCommand, opResult =
CMSPropertyNewMaxOpCode for
FA_CMSGetPropertyMaxOpCode.
etc.
message string If operation fails, user can send error
message to FrameMaker.For
FA_CMSObjectOpenReadOnly,
FA_CMSObjectEdit command, user
can return file-name which is
downloaded
cmsItems CMSResult List of CMS objects
81
CMSSESSION
CHAPTER 5 OBJECT REFERENCE
5.23. CMSSession
5.24. Color
Property name Data Type Description
CMSSession object CMSSession object created when
user creates a new content
management session
Property name Data Type Description
Black number Represents the percentage of black
(metric 0% to 100%).
ColorOverprint number Overprint setting for the color.
Possible values are:
• Constants.FV_COLOR_-
KNOCKOUT (0x00)
• Constants.FV_COLOR_OVER-
PRINT (0x01)
ColorPrintCtl number Indicates the type of color printing
used in the document. Possible
values are:
• Constants.FV_PRINT_SPOT
(0x0)
• Constants.FV_PRINT_PROCESS
(0x1)
• Constants.FV_PRINT_NO (0x2)
ColorTintPercent number Specifies the percentage of the
TintBaseColor to use for tinting.
Possible values are the tint
percentage (0% to 100%) or
Constants.FV_COLOR_NOT_TI
NTED (0x7fffffff) if the color is
not a tint.
82
COLOR
CHAPTER 5 OBJECT REFERENCE
ColorViewCtl number A 12-bit number for spot color views.
The least significant 2 bits are View 1,
the next 2 bits are View 2, and so on.
The values of each 2-bit setting are
one of the following:
• Constants.FV_SEP_NORMAL
(0x0)
• Constants.FV_SEP_NONE (0x1)
• Constants.FV_SEP_WHITE (0x2)
Cyan number Indicates the percentage of cyan
(metric 0% to 100%).
FamilyName string Color library name. Note that you
must specify the full ink name,
including any trademark symbols. For
example, use "MUNSELL\xa8 Book of
Color’ for "MUNSELL® Book of Color."
InkName string Specifies the name of the color
library pigment. Use this name
instead of Pantone.
Magenta number Represents the percentage of
magenta (metric 0% to 100%).
Name string Denotes the name of the color.
NextColorInDoc Color Indicates the next color in the
document (FO_Color ID).
Property name Data Type Description
83
COLUMN
CHAPTER 5 OBJECT REFERENCE
Color methods
Delete, GetProps, ObjectValid, SetProps.
5.25. Column
ReservedColor number Color names reserved by
FrameMaker. The values are:
• Constants.FV_COLOR_NOT_RE-
SERVED (0)
• Constants.FV_COLOR_CYAN (1)
• Constants.FV_COLOR_MA-
GENTA (2)
• Constants.FV_COLOR_YELLOW
(3)
• Constants.FV_COLOR_BLACK
(4)
• Constants.FV_COLOR_WHITE
(5)
• Constants.FV_COLOR_RED (6)
• Constants.FV_COLOR_GREEN
(7)
• Constants.FV_COLOR_BLUE (8)
TintBaseColor Color Denotes the color from which the tint
is derived (FO_Color ID), or
Constants.FV_NO_BASE_COLOR
(0x00) if the color is not a tint.
UserString string A string to which clients can store
private data.
Yellow number Percentage of yellow (metric 0% to
100%).
Property name Data Type Description
InCond Objects Condition tags for row (array of
FO_CondFmt IDs).
Property name Data Type Description
84
COMBINEDFONT
CHAPTER 5 OBJECT REFERENCE
Column methods
Delete, GetProps, ObjectValid, SetProps.
5.26. CombinedFont
CombinedFont methods
CombinedFont.
PrevColumnInTbl Column Indicates the previous column in the
table
NextColumnInTbl Column Indicates the next column in the table
PrevVisibleColumnInTbl Column Indicates the previous visible column
in the table
NextVisibleColumnInTbl Column Indicates the next visible column in
the table
ColumnIsShown int Indicates the visible columns in the
table
ColumnTbl Tbl Table containing the column
Property name Data Type Description
combinedFont CombinedFo
ntDefn
ID of the combined font.
variation uint Index of the font variation.
weight uint Index of the font weight.
angle uint Index of the font angle.
Property name Data Type Description
85
COMBINEDFONTDEFN
CHAPTER 5 OBJECT REFERENCE
5.27. CombinedFontDefn
CombinedFontDefn methods
CombinedFamilyFonts, Delete, GetProps, ObjectValid, SetProps.
Property name Data Type Description
NextCombinedFontDefnInDoc CombinedFo
ntDefn
Represents the next combined font
definition instance in the document
(FO_CombinedFontDefn ID).
Name string Indicates the name of the combined
font.
BaseFamily number Asian font family (specifies index into
the arrays of font families provided by
the session property,
FontFamilyNames)
WesternFamily number Specifies the western font family
(specifies index into the arrays of font
families provided by the session
property, FontFamilyNames).
ViewHotspotIndicators Bool Turns on hotspot indicators. Hotspot
indicators are small square boxes at
the centre of an object to indicate
that the object is actually a hotspot.
WesternSize number Represents the scaling factor for
Roman text expressed as a
percentage of base font size (metric
1% to 1000%).
WesternShift number Indicates the baseline offset of
Roman text expressed as a
percentage of base font size (metric
1% to 1000%).
FontEncodingName string Specifies the combined font's
encoding, based on the BaseFamily
property.
UserString string Represents a string that your client
can set as the value for the
FO_CombinedFontDefn object.
86
COMBINEDFONTS
CHAPTER 5 OBJECT REFERENCE
5.28. CombinedFonts
An Array of CombinedFont objects with integer indexing and a length property.
CombinedFonts methods
concat, pop, push.
5.29. Command
Property name Data Type Description
length number The length of the array.
Property name Data Type Description
CanHaveCheckMark number Returns True if the menu item can
have a check mark. If the menu item
is defined by FrameMaker, you can
read this property, but not set it.
CheckMarkIsOn number Returns 1 if the menu item can have a
check mark and the check mark is on.
If the menu item is defined by
FrameMaker, you can read this
property, but not set it.
CommandNum number Represents the integer that you
specified for the cmd parameter of
DefineAndAddCommand() or
DefineCommand(). When the
user executes the command,
FrameMaker passes this integer to
your client's Command() function.
If the menu item is defined by
FrameMaker, you can read this
property, but not set it.
87
COMMAND
CHAPTER 5 OBJECT REFERENCE
EnabledWhen number The context in which the menu item
is enabled.. If the menu item is
defined by FrameMaker, you can read
this property, but not set it.
The following are the values that the
EnabledWhen property can have
and the corresponding contexts in
which a menu item is active.
• Constants.FV_ENABLE_OB-
J_PROPS (8) - The insertion
point is in text, a table, or a
math object, or a graphic object
is selected.
• Constants.FV_EN-
ABLE_IN_TABLE (9) - The inser-
tion point or selection is in any
part of a table.
• Constants.FV_EN-
ABLE_IN_TABLE_TITLE (10) -
The insertion point or selection
is in the table title.
• Constants.FV_ENABLE_IN_CELL_-
TEXT (11) - The insertion point
or selection is in a table cell.
• Constants.FV_ENABLE_IS_CELL
(12) - A single cell in a table is
selected.
• Constants.FV_ENABLE_IS_-
CELLS (13) - One or more cells in
a table are selected.
Property name Data Type Description
88
COMMAND
CHAPTER 5 OBJECT REFERENCE
• Constants.FV_EN-
ABLE_IS_TABLE(14) - An entire
table is selected.
• Constants.FV_ENABLE_IS_OBJ
(15) - An object is selected.
• Constants.FV_ENABLE_IS_TEXT_-
FRAME (16) - A text frame is
selected.
• Constants.FV_ENABLE_IS_OR_IN_-
FRAME (17) - The selected
object is a graphic frame or is in
a graphic frame that is not a
page frame.
• Constants.FV_ENABLE_IS_A-
FRAME (18) - The first selected
object is an anchored frame.
• Constants.FV_ENABLE_IS_TEX-
T_INSET (19) - The first selected
object is a text inset.
• Constants.FV_ENABLE_IS_GRAPH-
IC_INSET (20) - The first selected
object is a graphic inset.
• Constants.FV_ENABLE_IN_-
FLOW (21) - A text frame is
selected, or the insertion point
or selection is in a paragraph.
• Constants.FV_ENABLE_COPY
(22) - Some text or an object is
selected.
Property name Data Type Description
89
COMMAND
CHAPTER 5 OBJECT REFERENCE
• Constants.FV_ENABLE_COPY_-
FONT (23) - The insertion point
or selection is in the text of a
paragraph, a math object, a
table, or a text line.
• Constants.FV_ENABLE_-
CAN_PASTE(24) - The Clipboard
contains an object or text that
can be pasted at the insertion
point.
• Constants.FV_EN-
ABLE_IS_VIEW_ONLY (25) - The
current document is locked.
• Constants.FV_EN-
ABLE_NEEDS_DOCP_ONLY (26)
- A document is open.
• Constants.FV_ENABLE_NEEDS_-
BOOKP_ONLY (27) - A book is
open.
• Constants.FV_EN-
ABLE_NEEDS_DOCP_OR_-
BOOKP (28) - A document or a
book is open.
ExpandOMaticParent Command Denotes the virtual parent object, if
the menu item is an expandomatic
menu item.
Fcode uint Specifies an f-code that FrameMaker
executes when the user chooses the
menu item or presses the keyboard
shortcut.
Fcodes UInts The list of f-codes that the
FrameMaker product executes when
the user chooses the menu item or
presses the keyboard shortcut.
Normally, the first f-code in the list is
the same as the f-code specified by
the Fcode property.
Property name Data Type Description
90
COMMAND
CHAPTER 5 OBJECT REFERENCE
HasShiftOrUnshiftCommand number Specifies whether a command has an
accompanying shift command or
unshift command. The value is one
of:
• Constants.FV_ITEM_HAS_-
SHIFT_COMMAND (1)
• Constants.FV_ITEM_HAS_UN-
SHIFT_COMMAND (2)
• Constants.FV_ITEM_HAS_NO_-
SHIFT_OR_UNSHIFT_COM-
MAND (3)
HelpLink string The hypertext link to call when the
user requests context-sensitive help
for the command.
If you set the HelpLink property,
specify the destination file and an
optional page number or linkname.
For example, specify
foo.doc:lastpage. Do not specify
hypertext commands such
asgotopage.
FrameMaker automatically prefixes
the appropriate hypertext command
to the HelpLink string when the user
requests context-sensitive help.
If the destination file is not in the
client directory, FrameMaker looks
for the file in the FrameMaker
product help directory.
NOTE: The HelpLink property is valid
only for commands created by clients,
and is not valid for commands
created directly by FrameMaker.
KeyboardShortcutLabel string The keyboard shortcut string that
appears on the menu. This string
need not be one of the actual
shortcuts specified by the
KeyboardShortcuts property.
Property name Data Type Description
91
COMMAND
CHAPTER 5 OBJECT REFERENCE
KeyboardShortcuts Strings The list of keyboard shortcuts that
the user can press to execute the
command. To add a shortcut, append
it to the list.
NOTE: ESTK does not allow you to
delete shortcuts from the list.
Labels Strings If the command is a menu item, the
Labels property depicts the list of
labels the menu item can have in
different contexts. If the menu item
has only one label in all contexts,
Labels specifies only the string for
that specific label.
If the menu item has different labels
in different contexts, Labels specifies
pairs of strings with the following
format:
Context,Label
where Label specifies the menu item
label
and Context specifies the context in
which the label appears on the menu.
MenuItemType number The type of command or menu item.
The value is one of:
• Constants.FV_MENUITEM_-
FRAME (1) - the command is a
menu item defined by
FrameMaker.
• Constants.FV_MENUITEM_API
(2) - the command is a menu
item defined by a client.
• Constants.FV_MENU-
ITEM_MACRO (3) - the menu
item is not a command; it calls a
macro.
• Constants.FV_MENUITEM_EXPAN-
DOMATIC (4) - the menu item is
an expandomatic menu item
(such as
!ShowParagraphTags)
defined by FrameMaker.
Property name Data Type Description
92
COMMAND
CHAPTER 5 OBJECT REFERENCE
Mode number The mode in which keyboard
shortcuts are recorded. The value is
one of:
• Constants.FV_MODE_MATH (1)
• Constants.FV_MODE_NON-
MATH (2)
• Constants.FV_MODE_ALL (3)
NextCommandInSession Command Represents the next command in the
list of commands in the session.
ShiftOrUnshiftCommand Command If the
HasShiftOrUnshiftCommand
property is set to
Constants.FV_ITEM_HAS_SHIFT_CO
MMAND (1), the
ShiftOrUnshiftCommand
property, represents the command to
use when the user holds down the
Shift key.
If the
HasShiftOrUnshiftCommand
property is set to
Constants.FV_ITEM_HAS_UNSHIFT_C
OMMAND (2), the
ShiftOrUnshiftCommand
denotes the command to use when
the user is not holding down the Shift
key.
Label string Indicates the dialog box title.
MenuItemIsEnabled number Returns 1 if the menu or menu item is
enabled. Returns 0 if the menu or
menu item is disabled (dimmed).
Name string Represents the name of the
command, menu, or menu item
separator.
NextMenuItemInMenu FMObject Indicates the next menu item, menu,
or separator in the menu.
NextMenuItemInSession FMObject Specifies the next menu item, menu,
or separator in the list of menu items,
menus, and separators in the session.
Property name Data Type Description
93
COMMAND
CHAPTER 5 OBJECT REFERENCE
PrevMenuItemInMenu FMObject Specifies the previous menu item,
menu, or separator in the list of
menu items, menus, and separators
in the session.
Product int Specifies the Product to add the
command.
Values:
Constants.FV_PRODUCT_UNSTRUCT
URED
Constants.FV_PRODUCT_STRUCTURE
D
Constants.FV_PRODUCT_XMLAUTHO
R
Constants.FV_PRODUCT_ALL
(Equivalent to:
Constants.FV_PRODUCT_UNSTRUCT
URED |
Constants.FV_PRODUCT_STRUCTURE
D |
Constants.FV_PRODUCT_XMLAUTHO
R)
View int Specifies the View to add the
command.
Values:
Constants.FV_VIEW_WYSIWYG
Constants.FV_VIEW_AUTHOR
Constants.FV_VIEW_XML
Constants.FV_VIEW_ALL (Equivalent
to: Constants.FV_VIEW_WYSIWYG |
Constants.FV_VIEW_AUTHOR |
Constants.FV_VIEW_XML)
Window int Specifies the Window to add the
command.
Values:
Constants.FV_WINDOW_DOC
Constants.FV_WINDOW_BOOK
Constants.FV_WINDOW_DITAMAP
Constants.FV_WINDOW_ALL
(Equivalent to:
Constants.FV_WINDOW_DOC |
Constants.FV_WINDOW_BOOK |
Constants.FV_WINDOW_DITAMAP)
Property name Data Type Description
94
COMPARERET
CHAPTER 5 OBJECT REFERENCE
Command methods
Delete, Delete, GetProps, ObjectValid, SetProps.
5.30. CompareRet
CompareRet methods
CompareRet.
5.31. CondFmt
Property name Data Type Description
sum Doc Specifies the summary document.
comp Doc Specifies the composite document.
Property name Data Type Description
CondFmtIsShown number Returns True if the condition is
shown. To hide text with a specified
condition, set this property and the
ShowAll property of the Doc object
to False.
Name string Denotes the name of the condition
format.
NextCondFmtInDoc CondFmt Denotes the next condition format in
the document (FO_CondFmt ID).
SepOverride Color Indicates the color separation format
override (FO_Color ID).
95
CONDFMT
CHAPTER 5 OBJECT REFERENCE
StyleOverride number The style condition indicators for
conditional text. The possible values
are:
• Constants.FV_CN_NO_OVER-
RIDE (0)
• Constants.FV_CN_OVERLINE (1)
• Constants.FV_CN_STRIKE-
THROUGH (2)
• Constants.FV_CN_SINGLE_UNDER-
LINE (3)
• Constants.FV_CN_DOUBLE_UNDER-
LINE (4)
• Constants.FV_CN_CHANGEBAR
(5)
• Constants.FV_CN_NUMER-
IC_UNDERLINE (6)
• Constants.FV_CN_N-
MRIC_AND_CHNGBAR (7)
UseSepOverride number Returns 1 if color specified by the
SepOverride property is used
instead of the default color.
BkColor Color BkColor is the text background
color property whose value is the
color to be used.
If this property is applied on a
paragraph format, the color is applied
as the background color of the whole
paragraph.
If this property is applied on a
character format, the color is applied
as the background color of the text
over which the character format is
applied.
Property name Data Type Description
96
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
CondFmt methods
Delete, GetProps, ObjectValid, SetProps.
5.32. Constants
UseBkColor bool The UseBkColor is a Boolean flag
which indicates whether the
BkColor is set or not.
UseBkColor=1 indicates the text
has some background color.
UseBkColor=0 indicates
transparent background.
When UseBkColor=0, the
BkColor value is not used.
UserString string A string to which clients can store
private data.
Property name Data Type
Constants.FDK_LIBRARY_VERSION int
Value:0x11000000
Constants.FE_Success int
Value:0
Constants.FE_Transport int
Value:-1
Constants.FE_BadDocId int
Value:-2
Constants.FE_BadObjId int
Value:-3
Constants.FE_BadPropNum int
Value:-4
Constants.FE_BadPropType int
Value:-5
Constants.FE_ReadOnly int
Value:-6
Property name Data Type Description
97
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FE_OutOfRange int
Value:-7
Constants.FE_DocModified int
Value:-8
Constants.FE_GroupSelect int
Value:-9
Constants.FE_WithinFrame int
Value:-10
Constants.FE_NotGraphic int
Value:-11
Constants.FE_NotFrame int
Value:-12
Constants.FE_NotGroup int
Value:-13
Constants.FE_BadNewFrame int
Value:-14
Constants.FE_BadNewGroup int
Value:-15
Constants.FE_BadNewSibling int
Value:-16
Constants.FE_BadDelete int
Value:-17
Constants.FE_BadPageDelete int
Value:-18
Constants.FE_TypeUnNamed int
Value:-19
Constants.FE_NameNotFound int
Value:-20
Constants.FE_OffsetNotFound int
Value:-21
Constants.FE_SomeUnresolved int
Value:-22
Constants.FE_BadNew int
Value:-23
Property name Data Type
98
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FE_NotBodyPage int
Value:-24
Constants.FE_NotPgf int
Value:-25
Constants.FE_NotBookComponent int
Value:-26
Constants.FE_BadOperation int
Value:-27
Constants.FE_BadElementDefId int
Value:-28
Constants.FE_BadElementId int
Value:-29
Constants.FE_BadNotificationNum int
Value:-30
Constants.FE_BadContainer int
Value:-104
Constants.FE_BadTemplatePath int
Value:-105
Constants.FE_BadXmlApplication int
Value:-106
Constants.FE_DupName int
Value:-32
Constants.FE_BadName int
Value:-33
Constants.FE_CompareTypes int
Value:-34
Constants.FE_BadCompare int
Value:-35
Constants.FE_BadRange int
Value:-36
Constants.FE_PageFrame int
Value:-37
Constants.FE_CantSmooth int
Value:-38
Property name Data Type
99
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FE_NotTextFrame int
Value:-39
Constants.FE_HiddenPage int
Value:-40
Constants.FE_NotTextObject int
Value:-41
Constants.FE_SystemError int
Value:-42
Constants.FE_BadParameter int
Value:-43
Constants.FE_Canceled int
Value:-44
Constants.FE_FailedState int
Value:-45
Constants.FE_WantsCustom int
Value:-46
Constants.FE_WantsLandscape int
Value:-47
Constants.FE_WantsPortrait int
Value:-48
Constants.FE_ViewOnly int
Value:-49
Constants.FE_BadSaveFileName int
Value:-50
Constants.FE_GenRuleItemExpected int
Value:-51
Constants.FE_GenRuleMixedConnecto
rs
int
Value:-52
Constants.FE_GenRuleLeftBracketExp
ected
int
Value:-53
Constants.FE_GenRuleRightBracketEx
pected
int
Value:-54
Constants.FE_GenRuleAmbiguous int
Value:-55
Property name Data Type
100
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FE_GenRuleSyntaxError int
Value:-56
Constants.FE_GenRuleConnectorExpe
cted
int
Value:-57
Constants.FE_InvalidString int
Value:-58
Constants.FE_BadSelectionForOperati
on
int
Value:-59
Constants.FE_WrongProduct int
Value:-60
Constants.FE_BookStructured int
Value:-61
Constants.FE_BadRefFlowId int
Value:-62
Constants.FE_FlowStructured int
Value:-63
Constants.FE_BadRefElementId int
Value:-64
Constants.FE_BadInsertPos int
Value:-65
Constants.FE_BadBookId int
Value:-66
Constants.FE_BookUnStructured int
Value:-67
Constants.FE_BadCompPath int
Value:-68
Constants.FE_BadElementSelection int
Value:-69
Constants.FE_FileClosedByClient int
Value:-70
Constants.FE_NotPgfOrFlow int
Value:-71
Constants.FE_NotMenu int
Value:-72
Property name Data Type
101
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FE_NotCommand int
Value:-73
Constants.FE_NotApiCommand int
Value:-74
Constants.FE_NotInMenu int
Value:-75
Constants.FE_BadShortcut int
Value:-76
Constants.FE_BadMenuBar int
Value:-77
Constants.FE_PropNotSet int
Value:-78
Constants.FE_InvAttributeDef int
Value:-79
Constants.FE_InvAttribute int
Value:-80
Constants.FE_CircularReference int
Value:-81
Constants.FE_NoSuchFlow int
Value:-82
Constants.FE_BadFileType int
Value:-83
Constants.FE_MissingFile int
Value:-84
Constants.FE_CantUpdateMacEdition int
Value:-85
Constants.FE_CanceledByClient int
Value:-86
Constants.FE_EmptyTextObject int
Value:-87
Constants.FE_Busy int
Value:-88
Constants.FE_FilterFailed int
Value:-89
Property name Data Type
102
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FE_AsianSystemRequired int
Value:-90
Constants.FE_TintedColor int
Value:-91
Constants.FE_NoColorFamily int
Value:-92
Constants.FE_StringTooLong int
Value:-93
Constants.FE_InternalErrorFailedToWr
iteInsets
int
Value:-94
Constants.FE_NotFound int
Value:-95
Constants.FE_LanguageNotAvailable int
Value:-96
Constants.FE_BadBaseColor int
Value:-97
Constants.FE_BadFamilyName int
Value:-98
Constants.FE_BadInkName int
Value:-99
Constants.FE_ReservedColor int
Value:-100
Constants.FE_TableInLockedTi int
Value:-101
Constants.FE_XRefUnresolved int
Value:-102
Constants.FE_BadXRefSrcDocId int
Value:-103
Constants.FE_InvalidAttrExpr int
Value:-107
Constants.FE_DocAlreadyHasTrackedE
dits
int
Value:-108
Constants.FE_BookComponentAlready
HasTrackedEdits
int
Value:-109
Property name Data Type
103
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FE_AcceptRejectCalledOnW
rongPreviewState
int
Value:-110
Constants.FE_FailedExportedFileInvali
d
int
Value:-111
Constants.FE_BadKey int
Value:-177
Constants.FE_BadKeyField int
Value:-178
Constants.FE_BadValue int
Value:-179
Constants.FE_KeyCatalogNotLoaded int
Value:-180
Constants.FE_KeyCatalogIsStale int
Value:-181
Constants.FE_KeyDefinitionDoesNotEx
ist
int
Value:-182
Constants.FE_KeyDefinitionAlreadyExi
sts
int
Value:-183
Constants.FE_BadFilterType int
Value:-184
Constants.FE_KeyCatalogNotSpecified int
Value:-185
Constants.FE_NonDITADocument int
Value:-186
Constants.FE_UpdateDITAReferenceFa
iledInvalidElementType
int
Value:-187
Constants.FE_UpdateDITAReferenceFa
iledCannotResolveReference
int
Value:-188
Constants.FE_UpdateDITAReferenceFa
iledCannotFindReferencedFile
int
Value:-189
Constants.FE_UpdateDITAReferenceFa
iledCannotOpenReferencedFile
int
Value:-190
Constants.FE_UpdateDITAReferenceFa
iledCannotConvertToFMObject
int
Value:-191
Property name Data Type
104
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FE_UpdateDITAReferenceFa
iled
int
Value:-192
Constants.FE_FDKUndoNotAllowed int
Value:-193
Constants.FR_DialogStayUp int
Value:-10000
Constants.FR_ModalStayUp int
Value:-10000
Constants.FR_CancelOperation int
Value:-10001
Constants.FR_DisplayedTiDialog int
Value:-10002
Constants.FR_ECMImportSuccess int
Value:-10003
Constants.FR_SkipStep int
Value:-10004
Constants.FR_YesOperation int
Value:-10005
Constants.FR_NoOperation int
Value:-10006
Constants.FR_DisplayedXRefDialog int
Value:-10007
Constants.FR_ClosedXRefDialog int
Value:-10008
Constants.FR_DisplayedModelessDial
ogForNonContainerElem
int
Value:-10009
Constants.FR_CancelInsertElementOp
eration
int
Value:-10010
Constants.FR_HideDialogOnClose int
Value:-10011
Constants.FR_DisplayedModalDialogF
orNonContainerElem
int
Value:-10012
Constants.FR_UpdateDITAReferenceSu
ccess
int
Value:-10013
Property name Data Type
105
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FR_UpdateDITAReferenceFa
iled
int
Value:-10014
Constants.FR_UpdateDITAReferenceFa
iledInvalidElementType
int
Value:-10015
Constants.FR_UpdateDITAReferenceFa
iledCannotResolveReference
int
Value:-10016
Constants.FR_UpdateDITAReferenceFa
iledCannotFindReferencedFile
int
Value:-10017
Constants.FR_UpdateDITAReferenceFa
iledCannotOpenReferencedFile
int
Value:-10018
Constants.FR_UpdateDITAReferenceFa
iledCannotConvertToFMObject
int
Value:-10019
Constants.FR_KeyCatalogLoaded int
Value:-10020
Constants.FR_CommandEnabled int
Value:-10021
Constants.FR_CommandDisabled int
Value:-10022
Constants.FV_ACCESSBAR_OPEN int
Value:1
Constants.FV_ACCESSBAR_CLOSE int
Value:2
Constants.FV_MATH int
Value:3
Constants.FV_FORMATBAR_OPEN int
Value:4
Constants.FV_FORMATBAR_CLOSE int
Value:5
Constants.FV_CHAR_CATALOG int
Value:6
Constants.FV_PGF_CATALOG int
Value:7
Constants.FV_ELEMENT_CATALOG int
Value:8
Property name Data Type
106
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_GRAPHIC int
Value:9
Constants.FV_THESAURUS int
Value:10
Constants.FV_TEMPLATE_BROWSER int
Value:11
Constants.FV_HIST int
Value:12
Constants.FV_TBL_CATALOG int
Value:13
Constants.FV_GRAPHICS_CATALOG int
Value:14
Constants.FV_HELP_INDEX int
Value:0
Constants.FV_HELP_KEYS int
Value:1
Constants.FV_HELP_SAMPLES int
Value:2
Constants.FV_HELP_OVERVIEW int
Value:3
Constants.FV_HELP_ONLINE_MANUA
LS
int
Value:4
Constants.FV_HELP_CONTEXT int
Value:5
Constants.FV_HELP_INIT_CONTEXT int
Value:6
Constants.FV_HELP_HYPERTEXT int
Value:7
Constants.FV_HELP_WEBWORKS int
Value:8
Constants.FP_DockDialog int
Value:2344
Constants.FV_DIALOG_DOCK_NONE int
Value:0x00
Property name Data Type
107
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_DIALOG_DOCK_LEFT int
Value:0x1
Constants.FV_DIALOG_DOCK_RIGHT int
Value:(0x1 << 1)
Constants.FV_DIALOG_DOCK_TOP int
Value:(0x1 << 2)
Constants.FV_DIALOG_DOCK_BOTTO
M
int
Value:(0x1 << 3)
Constants.FV_DIALOG_DOCK_ALL int
Value:0xFF
Constants.FP_IsDialogDocked int
Value:2345
Constants.FP_IsDialogVisible int
Value:2346
Constants.FP_GroupDialog int
Value:2349
Constants.FV_DIALOG_GROUP_NONE int
Value:0x0
Constants.FV_DIALOG_GROUP_SPECI
AL
int
Value:0x1
Constants.FV_DIALOG_GROUP_CATAL
OGS
int
Value:(0x1 << 1)
Constants.FV_DIALOG_GROUP_DESIG
NERS
int
Value:(0x1 << 2)
Constants.FV_DIALOG_GROUP_ATTRI
BUTES
int
Value:(0x1 << 3)
Constants.FV_DIALOG_GROUP_PODS int
Value:(0x1 << 4)
Constants.FV_DIALOG_GROUP_PODS
RIGHT
int
Value:(0x1 << 5)
Constants.FV_DIALOG_GROUP_EDIT int
Value:(0x1 << 6)
Constants.FV_DIALOG_GROUP_ALLPA
NELS
int
Value:(0x1 << 7)
Property name Data Type
108
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_DIALOG_GROUP_RMKIT
S
int
Value:(0x1 << 8)
Constants.FV_DIALOG_GROUP_RIGHT
_TOP
int
Value:(0x1 << 9)
Constants.FV_DIALOG_GROUP_RIGHT
_BOTTOM
int
Value:(0x1 << 10)
Constants.FV_DIALOG_GROUP_ALL int
Value:0xFF
Constants.FP_ResizeGripperBarVisibili
ty
int
Value:2395
Constants.FV_DIALOG_GRIPPERBAR_T
RUE
int
Value:0
Constants.FV_DIALOG_GRIPPERBAR_F
ALSE
int
Value:1
Constants.FP_ResizeGripperPos int
Value:2350
Constants.FV_DIALOG_RESIZEGRIPPER
POS_NONE
int
Value:0
Constants.FV_DIALOG_RESIZEGRIPPER
POS_FRONT
int
Value:1
Constants.FV_DIALOG_RESIZEGRIPPER
POS_BELOW
int
Value:2
Constants.FP_MinSize int
Value:2351
Constants.FP_MaxSize int
Value:2352
Constants.FP_Focus int
Value:2358
Constants.FP_AlertClientUnique int
Value:2290
Constants.FP_AlertClientName int
Value:2291
Constants.FP_AlertString int
Value:2292
Property name Data Type
109
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_AlertType int
Value:2293
Constants.FV_AlertOneButton int
Value:1
Constants.FV_AlertTwoButton int
Value:2
Constants.FV_AlertThreeButton int
Value:3
Constants.FF_ALERT_OK_DEFAULT int
Value:0
Constants.FF_ALERT_CANCEL_DEFAUL
T
int
Value:1
Constants.FF_ALERT_CONTINUE_NOT
E
int
Value:2
Constants.FF_ALERT_CONTINUE_WAR
N
int
Value:3
Constants.FF_ALERT_YES_DEFAULT int
Value:4
Constants.FF_ALERT_NO_DEFAULT int
Value:5
Constants.FF_ALERT_YES_NO_CANCEL int
Value:6
Constants.FF_XRUI_INTERNAL int
Value:0x01
Constants.FF_XRUI_OPEN_DOCS int
Value:0x02
Constants.FF_XRUI_CLOSED_DOCS int
Value:0x04
Constants.FF_XRUI_FORCE_UPDATE int
Value:0x08
Constants.FF_XRUI_EVERYTHING int
Value:(0x01|0x02|0x04)
Constants.FF_Custom_SingleSided int
Value:0
Property name Data Type
110
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FF_Custom_FirstPageRight int
Value:1
Constants.FF_Custom_FirstPageLeft int
Value:2
Constants.FF_CLOSE_MODIFIED int
Value:1
Constants.FF_CMP_SUMMARY_ONLY int
Value:0x01
Constants.FF_CMP_CHANGE_BARS int
Value:0x02
Constants.FF_CMP_HYPERLINKS int
Value:0x04
Constants.FF_CMP_SUMKIT int
Value:0x08
Constants.FF_CMP_COMPKIT int
Value:0x10
Constants.FF_CMP_ATTRIBUTES int
Value:0x20
Constants.FF_IMAGE_BACKGROUND int
Value:0x0001
Constants.FF_IMAGE_MASTER int
Value:0x0002
Constants.FF_IMAGE_CLIP int
Value:0x0004
Constants.FF_IMAGE_NOTRIM int
Value:0x0008
Constants.FF_IMAGE_PAGEFRAME int
Value:0x000F
Constants.FV_INTERACT_ROTATE int
Value:1
Constants.FV_INTERACT_ROTATE_CO
NSTRAIN
int
Value:2
Constants.FF_ATTACH_BORDER_STAT
US
int
Value:0x0001
Property name Data Type
111
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FF_ATTACH_BORDER_PAGE
NUM
int
Value:0x0002
Constants.FF_ATTACH_BORDER_ZOO
M
int
Value:0x0004
Constants.FF_ATTACH_BORDER_PAGE
UPDOWN
int
Value:0x0008
Constants.FF_ATTACH_BORDER_RIGH
TICONS
int
Value:0x0010
Constants.FF_ATTACH_ALL int
Value:(0x0001|0x0002|0x0004|0x0008|0x0010)
Constants.FF_UFF_PGF int
Value:0x0001
Constants.FF_UFF_FONT int
Value:0x0002
Constants.FF_UFF_PAGE int
Value:0x0004
Constants.FF_UFF_TABLE int
Value:0x0008
Constants.FF_UFF_COND int
Value:0x0010
Constants.FF_UFF_REFPAGE int
Value:0x0020
Constants.FF_UFF_VAR int
Value:0x0040
Constants.FF_UFF_XREF int
Value:0x0080
Constants.FF_UFF_COLOR int
Value:0x0100
Constants.FF_UFF_MATH int
Value:0x0200
Constants.FF_UFF_DOCUMENT_PROP
S
int
Value:0x0400
Constants.FF_UFF_COMBINED_FONTS int
Value:0x0800
Property name Data Type
112
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FF_UFF_FBA int
Value:0x1000
Constants.FF_UFF_REMOVE_PAGE_BR
EAKS
int
Value:0x4000
Constants.FF_UFF_REMOVE_EXCEPTI
ONS
int
Value:0x8000
Constants.FF_UFF_ALL int
Value:0xFFFF
Constants.FF_INTERACTIVE int
Value:0x0001
Constants.FF_CUT_TBL_CELLS int
Value:0x0002
Constants.FF_DONT_DELETE_HIDDEN
_TEXT
int
Value:0x0004
Constants.FF_INSERT_BELOW_RIGHT int
Value:0x0008
Constants.FF_VISIBLE_ONLY int
Value:0x0010
Constants.FF_REPLACE_CELLS int
Value:0x0020
Constants.FF_DONT_APPLY_ALL_ROW
S
int
Value:0x0040
Constants.FF_STRIP_HYPERTEXT int
Value:0x0080
Constants.FF_SELECT_WHOLE_TABLE int
Value:0x80000000
Constants.FF_CLEAR_SEL int
Value:0
Constants.FF_TEXT_SEL int
Value:1
Constants.FF_TEXT_EXT int
Value:2
Constants.FF_TEXT_Q_COPY int
Value:3
Property name Data Type
113
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FF_CONTEXT_DRAGTXT int
Value:4
Constants.FF_PASTE_SEL_TEXT int
Value:11
Constants.FF_PASTE_CLIP_TEXT int
Value:12
Constants.FF_COPY_TO_CLIP int
Value:13
Constants.FF_CELL_SEL int
Value:21
Constants.FF_CELL_EXT int
Value:22
Constants.FF_TABLE_SELALL int
Value:23
Constants.FF_CELL_RES int
Value:24
Constants.FF_CELLS_RES int
Value:25
Constants.FF_VIEWER_MENU int
Value:32
Constants.FF_CONTEXT_MENU int
Value:33
Constants.FF_STRUCTURE_MENU int
Value:34
Constants.FF_HYPERTEXT int
Value:41
Constants.FF_ELEMENT_CONTEXT int
Value:47
Constants.FF_ELEMENT_EXT_CONTEX
T
int
Value:48
Constants.FF_BUBBLE_CONTEXT int
Value:49
Constants.FF_BUBBLE_EXT_CONTEXT int
Value:50
Property name Data Type
114
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FF_ELEMENT_SEL int
Value:51
Constants.FF_ELEMENT_EXT int
Value:52
Constants.FF_BUBBLE_SEL int
Value:53
Constants.FF_BUBBLE_EXT int
Value:54
Constants.FF_BUBBLE_COPY int
Value:55
Constants.FF_COLLAPSE_ELEM int
Value:56
Constants.FF_COLLAPSE_ALL int
Value:57
Constants.FF_OPEN_BOOK_COMP int
Value:58
Constants.FF_PASTE_CLIP_OBJ int
Value:61
Constants.FF_OBJ_SEL int
Value:62
Constants.FF_OBJ_EXT int
Value:63
Constants.FF_OBJ_EXT_BOR int
Value:64
Constants.FF_OBJ_Q_COPY int
Value:65
Constants.FF_OBJ_ROTATE int
Value:66
Constants.FF_OBJ_CROTATE int
Value:67
Constants.FF_BOR_SEL int
Value:71
Constants.FF_BOR_EXT int
Value:72
Property name Data Type
115
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FF_CONTEXT_DRAG int
Value:73
Constants.FF_CONTEXT_DRAG_EXT int
Value:74
Constants.FF_RES_MOVE int
Value:81
Constants.FF_RES_MOVE1 int
Value:82
Constants.FF_RES_VERTEX int
Value:83
Constants.FF_RES_ADD int
Value:84
Constants.FF_RES_DEL int
Value:85
Constants.FF_SHIFT_KEY int
Value:0x0001
Constants.FF_CONTROL_KEY int
Value:0x0002
Constants.FF_ALT_KEY int
Value:0x0004
Constants.FF_CMD_KEY int
Value:0x0010
Constants.FF_ATTRDISP int
Value:86
Constants.FF_ATTRDISP_ALL int
Value:87
Constants.FF_EDIT_ATTRIBUTE int
Value:88
Constants.FF_ATTR_SEL int
Value:89
Constants.FS_ShowBrowser int
Value:1
Constants.FS_AlertUserAboutFailure int
Value:2
Property name Data Type
116
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FS_DontNotifyAPIClients int
Value:3
Constants.FS_UpdateBrowserDirector
y
int
Value:4
Constants.FS_MakeVisible int
Value:5
Constants.FS_MakeIconic int
Value:6
Constants.FS_DisallowMIF int
Value:7
Constants.FS_DisallowDoc int
Value:8
Constants.FS_DisallowBookMIF int
Value:9
Constants.FS_DisallowBookDoc int
Value:10
Constants.FS_DisallowFilterTypes int
Value:11
Constants.FS_DisallowPlainText int
Value:12
Constants.FS_ForceOpenAsText int
Value:13
Constants.FS_UseRecoverFile int
Value:14
Constants.FS_UseAutoSaveFile int
Value:15
Constants.FV_DoCancel int
Value:0
Constants.FV_DoOK int
Value:1
Constants.FV_DoYes int
Value:2
Constants.FV_DoNo int
Value:3
Property name Data Type
117
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_DoShowDialog int
Value:4
Constants.FV_OpenViewOnly int
Value:5
Constants.FS_FileIsText int
Value:16
Constants.FV_TextFile_EOLisEOP int
Value:12
Constants.FV_TextFile_EOLisNotEOP int
Value:13
Constants.FS_FileIsInUse int
Value:17
Constants.FV_ResetLockAndContinue int
Value:7
Constants.FV_OpenEditableCopy int
Value:8
Constants.FS_BookIsInUse int
Value:18
Constants.FS_LockCantBeReset int
Value:19
Constants.FS_FileIsOldVersion int
Value:20
Constants.FS_FileIsStructured int
Value:21
Constants.FV_StripStructureAndOpen int
Value:10
Constants.FS_FontNotFoundInDoc int
Value:22
Constants.FS_FontChangedMetric int
Value:23
Constants.FS_RefFileNotFound int
Value:24
Constants.FV_AllowAllRefFilesUnFinda
ble
int
Value:11
Property name Data Type
118
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FS_LanguageNotAvailable int
Value:25
Constants.FS_OpenInNewWindow int
Value:26
Constants.FS_OpenId int
Value:27
Constants.FS_FontNotFoundInCatalog int
Value:28
Constants.FS_NewDoc int
Value:29
Constants.FS_OpenDocViewOnly int
Value:30
Constants.FS_NameStripe int
Value:31
Constants.FS_BeefyDoc int
Value:32
Constants.FS_DisallowSgml int
Value:33
Constants.FS_FileTypeHint int
Value:34
Constants.FS_UpdateTextReferences int
Value:35
Constants.FS_UpdateXRefs int
Value:36
Constants.FS_OpenDocFluid int
Value:37
Constants.FV_DoUserPreference int
Value:12
Constants.FS_StructuredOpenApplicat
ion
int
Value:38
Constants.FS_SgmlBookFileName int
Value:39
Constants.FS_OpenFileNotWritable int
Value:40
Property name Data Type
119
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FS_OpenAsType int
Value:41
Constants.FV_AUTORECOGNIZE int
Value:0x00
Constants.FV_TYPE_BINARY int
Value:0x01
Constants.FV_TYPE_MIF int
Value:0x02
Constants.FV_TYPE_TEXT int
Value:0x03
Constants.FV_TYPE_SGML int
Value:0x04
Constants.FV_TYPE_XML int
Value:0x05
Constants.FV_TYPE_FILTER int
Value:0xFF
Constants.FS_OpenBookViewOnly int
Value:42
Constants.FS_DisallowXml int
Value:43
Constants.FS_NoStructuredErrorLog int
Value:44
Constants.FS_VerifyInsets int
Value:45
Constants.FS_IsErrorDoc int
Value:46
Constants.FS_TemplateShouldInsertRo
ot
int
Value:47
Constants.FS_CMSId int
Value:48
Constants.FS_CMSSessionId int
Value:49
Constants.FS_NumOpenParams int
Value:49
Property name Data Type
120
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FS_OpenedFileName int
Value:1
Constants.FS_OpenNativeError int
Value:2
Constants.FS_OpenStatus int
Value:3
Constants.FS_NumOpenReturnParams int
Value:3
Constants.FV_NumOpenStatusFields int
Value:5
Constants.FV_LockWasReset int
Value:0
Constants.FV_LockNotReset int
Value:1
Constants.FV_LockCouldntBeReset int
Value:2
Constants.FV_FileWasInUse int
Value:3
Constants.FV_FileIsViewOnly int
Value:4
Constants.FV_LockWasInvalid int
Value:5
Constants.FV_FileIsNotWritable int
Value:6
Constants.FV_FileModDateChanged int
Value:7
Constants.FV_FileHasNewName int
Value:32
Constants.FV_RecoverFileUsed int
Value:33
Constants.FV_AutoSaveFileUsed int
Value:34
Constants.FV_FileWasFiltered int
Value:35
Property name Data Type
121
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_FontsWereMapped int
Value:36
Constants.FV_FontMetricsChanged int
Value:37
Constants.FV_FontsMappedInCatalog int
Value:38
Constants.FV_LanguagesWerentFound int
Value:39
Constants.FV_BeefyDoc int
Value:40
Constants.FV_FileIsOldVersion int
Value:41
Constants.FV_FileStructureStripped int
Value:42
Constants.FV_FileIsText int
Value:43
Constants.FV_OpenedViewOnly int
Value:44
Constants.FV_EditableCopyOpened int
Value:45
Constants.FV_BadFileRefsWereMappe
d
int
Value:46
Constants.FV_ReferencedFilesWerent
Found
int
Value:47
Constants.FV_FileAlreadyOpen int
Value:48
Constants.FV_UnresolvedXRefs int
Value:49
Constants.FV_UnresolvedTextInsets int
Value:50
Constants.FV_OpenedFluid int
Value:51
Constants.FV_FontsWithUnavailableE
ncodingsUsed
int
Value:53
Property name Data Type
122
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_FileHadStructure int
Value:64
Constants.FV_FileAlreadyOpenThisSes
sion
int
Value:65
Constants.FV_BadFileType int
Value:66
Constants.FV_BadFileName int
Value:67
Constants.FV_CantNewBooks int
Value:68
Constants.FV_CantOpenBooksViewOn
ly
int
Value:69
Constants.FV_BadScriptValue int
Value:70
Constants.FV_MissingScript int
Value:71
Constants.FV_CantForceOpenAsText int
Value:72
Constants.FV_DisallowedType int
Value:73
Constants.FV_DocDamagedByTextFilte
r
int
Value:74
Constants.FV_DocHeadersDamaged int
Value:75
Constants.FV_DocWrongSize int
Value:76
Constants.FV_ChecksumDamage int
Value:77
Constants.FV_CantOpenBooksFluid int
Value:78
Constants.FV_CancelUseRecoverFile int
Value:96
Constants.FV_CancelUseAutoSaveFile int
Value:97
Property name Data Type
123
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_CancelFileIsText int
Value:98
Constants.FV_CancelFileIsInUse int
Value:99
Constants.FV_CancelFileHasStructure int
Value:100
Constants.FV_CancelReferencedFilesN
otFound
int
Value:101
Constants.FV_CancelLanguagesNotFo
und
int
Value:102
Constants.FV_CancelFontsMapped int
Value:103
Constants.FV_CancelFontMetricsChan
ged
int
Value:104
Constants.FV_CancelFontsMappedInC
atalog
int
Value:105
Constants.FV_CancelFileIsDoc int
Value:106
Constants.FV_CancelFileIsMIF int
Value:107
Constants.FV_CancelBook int
Value:108
Constants.FV_CancelBookMIF int
Value:109
Constants.FV_CancelFileIsFilterable int
Value:110
Constants.FV_CancelFileIsOldVersion int
Value:111
Constants.FV_UserCanceled int
Value:112
Constants.FV_CancelFileBrowser int
Value:113
Constants.FV_CancelBeefyDoc int
Value:114
Property name Data Type
124
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_CancelFileIsSgml int
Value:115
Constants.FV_CancelFontsWithUnavai
lableEncodings
int
Value:116
Constants.FV_CancelOpenFileNotWrit
able
int
Value:117
Constants.FV_CancelTempDiskFull int
Value:118
Constants.FV_CancelFileIsXml int
Value:119
Constants.FV_TooManyWindows int
Value:128
Constants.FV_BadTemplate int
Value:129
Constants.FV_FileNotReadable int
Value:130
Constants.FS_FileType int
Value:1
Constants.FV_SaveFmtBinary int
Value:0
Constants.FV_SaveFmtInterchange int
Value:1
Constants.FV_SaveFmtStationery int
Value:3
Constants.FV_SaveFmtViewOnly int
Value:4
Constants.FV_SaveFmtText int
Value:6
Constants.FV_SaveFmtSgml int
Value:7
Constants.FV_SaveFmtFilter int
Value:8
Constants.FV_SaveFmtPdf int
Value:9
Property name Data Type
125
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_SaveFmtXml int
Value:10
Constants.FV_SaveFmtBinary60 int
Value:11
Constants.FV_SaveFmtBinary70 int
Value:12
Constants.FV_SaveFmtBinary80 int
Value:13
Constants.FV_SaveFmtInterchange70 int
Value:14
Constants.FV_SaveFmtInterchange80 int
Value:15
Constants.FV_SaveFmtBinary90 int
Value:16
Constants.FV_SaveFmtInterchange90 int
Value:17
Constants.FV_SaveFmtCompositeDoc int
Value:18
Constants.FV_SaveFmtBookWithXml int
Value:19
Constants.FV_SaveFmtBookWithFm int
Value:20
Constants.FV_SaveFmtBinary100 int
Value:21
Constants.FV_SaveFmtInterchange100 int
Value:22
Constants.FV_SaveFmtBinary110 int
Value:23
Constants.FV_SaveFmtInterchange110 int
Value:24
Constants.FS_SaveMode int
Value:4
Constants.FV_ModeSave int
Value:0
Property name Data Type
126
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_ModeSaveAs int
Value:1
Constants.FS_SaveAsModeName int
Value:5
Constants.FV_SaveAsNameAskUser int
Value:0
Constants.FV_SaveAsUseFileName int
Value:1
Constants.FV_SaveAsNameProvided int
Value:2
Constants.FS_AutoBackupOnSave int
Value:6
Constants.FV_SaveYesAutoBackup int
Value:0
Constants.FV_SaveNoAutoBackup int
Value:1
Constants.FV_SaveUserPrefAutoBacku
p
int
Value:2
Constants.FS_MakePageCount int
Value:7
Constants.FV_UseCurrentSetting int
Value:0
Constants.FV_DontChangePageCount int
Value:1
Constants.FV_MakePageCountEven int
Value:2
Constants.FV_MakePageCountOdd int
Value:3
Constants.FV_DeleteEmptyPages int
Value:4
Constants.FS_ShowSaveTextDialog int
Value:8
Constants.FS_SaveTextTblSetting int
Value:9
Property name Data Type
127
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_SaveTblUserPref int
Value:0
Constants.FV_SaveTblRowsAsPgfs int
Value:1
Constants.FV_SaveTblColsAsPgfs int
Value:2
Constants.FV_SaveSkipTbls int
Value:3
Constants.FS_SaveTextExtraBlankLine
AtEOP
int
Value:10
Constants.FS_UseDefaultUNIXpermissi
ons
int
Value:11
Constants.FS_RetainNameStripe int
Value:12
Constants.FS_UNIXpermissions int
Value:13
Constants.FS_UpdateFRVList int
Value:14
Constants.FS_SaveFileTypeHint int
Value:16
Constants.FS_StructuredSaveApplicati
on
int
Value:18
Constants.FS_SaveFileNotWritable int
Value:20
Constants.FS_ModDateChanged int
Value:21
Constants.FS_DitavalFile int
Value:22
Constants.FS_DitavalCondTag int
Value:23
Constants.FS_DitaGenerateFlatBook int
Value:25
Constants.FS_DitaGenerateComponen
tsAtOneLoc
int
Value:26
Property name Data Type
128
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FS_DitaPostProcessingOnBo
ok
int
Value:27
Constants.FS_DitaSavePdfViaBook int
Value:28
Constants.FS_HasUnsupportedHotspo
tShapes
int
Value:29
Constants.FS_NumSaveParams int
Value:29
Constants.FS_SavedFileName int
Value:1
Constants.FS_SaveNativeError int
Value:2
Constants.FS_SaveStatus int
Value:3
Constants.FS_NumSaveReturnParams int
Value:3
Constants.FV_NumSaveStatusFields int
Value:2
Constants.FV_ProductIsViewer int
Value:32
Constants.FV_FileNotWritable int
Value:33
Constants.FV_BadSaveFileName int
Value:34
Constants.FV_BadFileId int
Value:35
Constants.FV_BadSaveScriptValue int
Value:36
Constants.FV_NonPortableSaveName int
Value:37
Constants.FV_NonPortableFileRefs int
Value:38
Constants.FV_ProductIsMaker int
Value:39
Property name Data Type
129
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_BadSaveObjectId int
Value:40
Constants.FV_Unstructured int
Value:41
Constants.FV_InvalidSaveFilter int
Value:42
Constants.FV_UserCanceledSave int
Value:48
Constants.FV_FileWasExported int
Value:49
Constants.FV_CancelSaveFileIsInUse int
Value:50
Constants.FV_CancelSaveFileNotWrita
ble
int
Value:51
Constants.FV_CancelSaveModDateCh
anged
int
Value:52
Constants.FV_CancelSaveExportedFile
Invalid
int
Value:53
Constants.FS_HowToImport int
Value:4
Constants.FV_DoByRef int
Value:5
Constants.FV_DoByCopy int
Value:6
Constants.FV_DoUserChoice int
Value:7
Constants.FS_ManualUpdate int
Value:5
Constants.FS_TextInsetName int
Value:6
Constants.FS_DisallowGraphicTypes int
Value:9
Constants.FS_DisallowMacEditions int
Value:10
Property name Data Type
130
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FS_FileIsGraphic int
Value:13
Constants.FS_FitGraphicInSelectedRec
t
int
Value:14
Constants.FS_GraphicDpi int
Value:15
Constants.FV_DoImportAsTable int
Value:8
Constants.FS_ForceImportAsText int
Value:17
Constants.FS_FileIsMakerDoc int
Value:18
Constants.FS_UseMainFlow int
Value:19
Constants.FS_ImportFlowTag int
Value:20
Constants.FS_ImportFlowPageSpace int
Value:21
Constants.FV_ReferencePage int
Value:9
Constants.FV_BodyPage int
Value:10
Constants.FS_FormatImportedText int
Value:22
Constants.FV_SourceDoc int
Value:0
Constants.FV_EnclosingDoc int
Value:1
Constants.FV_PlainText int
Value:2
Constants.FS_RemoveManualPageBre
aks
int
Value:23
Constants.FS_RemoveOverrides int
Value:24
Property name Data Type
131
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FS_ImportTblTag int
Value:25
Constants.FS_TblNumHeadingRows int
Value:26
Constants.FS_LeaveHeadingRowsEmpt
y
int
Value:27
Constants.FS_TreatParaAsRow int
Value:28
Constants.FS_CellSeparator int
Value:29
Constants.FS_NumCellSeparators int
Value:30
Constants.FS_NumColumns int
Value:31
Constants.FS_FileIsSgmlDoc int
Value:32
Constants.FS_StructuredImportApplic
ation
int
Value:35
Constants.FS_ImportAsType int
Value:36
Constants.FS_FileIsXmlDoc int
Value:37
Constants.FS_RasterDpi int
Value:38
Constants.FS_RasterImageWidth int
Value:39
Constants.FS_RasterImageHeight int
Value:40
Constants.FS_ShowRasterDpiDialog int
Value:41
Constants.FS_ClientUpdateSilent int
Value:47
Constants.FS_NumImportParams int
Value:47
Property name Data Type
132
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FS_InsetData int
Value:50
Constants.FS_UseHTTP int
Value:51
Constants.FS_InsetElementDef int
Value:52
Constants.FS_PDFPageNum int
Value:45
Constants.FS_ImportedFileName int
Value:1
Constants.FS_ImportNativeError int
Value:2
Constants.FS_ImportStatus int
Value:3
Constants.FS_NumImportReturnPara
ms
int
Value:3
Constants.FV_NumImportStatusFields int
Value:2
Constants.FV_ImportedByCopy int
Value:0
Constants.FV_ImportedText int
Value:1
Constants.FV_ImportedTextTable int
Value:2
Constants.FV_ImportedMIF int
Value:3
Constants.FV_ImportedMakerDoc int
Value:4
Constants.FV_ImportedFilteredFile int
Value:5
Constants.FV_ImportedGraphicFile int
Value:6
Constants.FV_ImportedMacEdition int
Value:7
Property name Data Type
133
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_ImportedSgmlDoc int
Value:8
Constants.FV_ImportedXmlDoc int
Value:9
Constants.FV_BadImportFileName int
Value:16
Constants.FV_BadImportFileType int
Value:17
Constants.FV_BadImportScriptValue int
Value:18
Constants.FV_MissingImportScript int
Value:19
Constants.FV_CantForceImportAsText int
Value:20
Constants.FV_DisallowedImportType int
Value:21
Constants.FV_NoMainFlow int
Value:22
Constants.FV_NoFlowWithSpecifiedN
ame
int
Value:23
Constants.FV_InsertionPointNotInText int
Value:24
Constants.FV_InsertionPointInTableCe
ll
int
Value:25
Constants.FV_InsertionPointInFootnot
e
int
Value:26
Constants.FV_InsufficientMemory int
Value:27
Constants.FV_BadEnclosingDocId int
Value:28
Constants.FV_BadTextFileTypeHint int
Value:29
Constants.FV_FlowUnstructured int
Value:30
Property name Data Type
134
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_CancelFileText int
Value:32
Constants.FV_CancelFileDoc int
Value:33
Constants.FV_CancelFileMIF int
Value:34
Constants.FV_CancelFileFilterable int
Value:35
Constants.FV_CancelFileGraphic int
Value:36
Constants.FV_UserCanceledImport int
Value:37
Constants.FV_CancelImportBrowser int
Value:38
Constants.FV_CancelFileIsMacEdition int
Value:39
Constants.FV_CancelFileSgml int
Value:40
Constants.FV_CancelFileXml int
Value:41
Constants.FV_ImportFileNotReadable int
Value:48
Constants.FS_Export int
Value:4
Constants.FV_ExportDocument int
Value:0
Constants.FV_ExportObject int
Value:1
Constants.FS_ExportType int
Value:5
Constants.FS_ExportTextRange int
Value:6
Constants.FS_ExportObjectId int
Value:7
Property name Data Type
135
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FS_ExportObjectNeedsDpi int
Value:12
Constants.FS_ExportFileTypeHint int
Value:14
Constants.FS_StructuredExportApplica
tion
int
Value:16
Constants.FS_ImportExportVersion int
Value:17
Constants.FS_NumExportParams int
Value:17
Constants.FS_ExportFileName int
Value:1
Constants.FS_ExportNativeError int
Value:2
Constants.FS_ExportStatus int
Value:3
Constants.FV_NumExportStatusFields int
Value:2
Constants.FS_NumExportReturnParam
s
int
Value:3
Constants.FV_ExportFileHasNewNam
e
int
Value:0
Constants.FV_ExportProductIsViewer int
Value:1
Constants.FV_ExportFileNotWritable int
Value:2
Constants.FV_InsufficientMem int
Value:3
Constants.FV_BadExportFileName int
Value:16
Constants.FV_MissingExportScript int
Value:17
Constants.FV_BadExportObjectId int
Value:18
Property name Data Type
136
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_InvalidTextRange int
Value:19
Constants.FV_BadExportDocId int
Value:20
Constants.FV_BadExportScriptValue int
Value:21
Constants.FV_FilterFailed int
Value:22
Constants.FV_InvalidExportFilter int
Value:23
Constants.FV_UserCanceledExport int
Value:32
Constants.FV_CanceledExportObjectN
eedsDpi
int
Value:33
Constants.FV_ApiClientCanceledExpor
t
int
Value:34
Constants.FS_AllowNonFMFiles int
Value:1
Constants.FS_AllowViewOnlyFiles int
Value:3
Constants.FS_ShowBookErrorLog int
Value:4
Constants.FS_AllowInconsistentNumP
rops
int
Value:6
Constants.FS_UpdateBookGeneratedF
iles
int
Value:7
Constants.FS_UpdateBookNumbering int
Value:8
Constants.FS_UpdateBookOleLinks int
Value:9
Constants.FS_UpdateBookTextReferen
ces
int
Value:10
Constants.FS_UpdateBookXRefs int
Value:11
Property name Data Type
137
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FS_UpdateBookMasterPage
s
int
Value:12
Constants.FS_NumUpdateBookParams int
Value:12
Constants.FS_UpdateBookStatus int
Value:1
Constants.FS_NumUpdateBookReturn
Params
int
Value:1
Constants.FV_NumUpdateBookStatus
Fields
int
Value:4
Constants.FV_BookNotSelfConsistent int
Value:0
Constants.FV_DuplicateFileInBook int
Value:1
Constants.FV_NoNonGeneratedFilesIn
Book
int
Value:2
Constants.FV_CancelNonFMFileInBoo
k
int
Value:32
Constants.FV_CancelViewOnlyFileInB
ook
int
Value:33
Constants.FV_CancelInconsistentNum
PropsInFileInBook
int
Value:34
Constants.FV_UserCanceledUpdateBo
ok
int
Value:35
Constants.FV_BadUpdateBookFileId int
Value:64
Constants.FV_BadUpdateBookScriptVa
lue
int
Value:65
Constants.FV_FileInBookNotOpened int
Value:96
Constants.FV_FileInBookNotSaved int
Value:97
Constants.FV_TooManyWindowsUpda
teBook
int
Value:98
Property name Data Type
138
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_Body int
Value:1237
Constants.FV_Heading int
Value:1238
Constants.FV_Footing int
Value:1239
Constants.FV_Above int
Value:1240
Constants.FV_Below int
Value:1241
Constants.FV_Left int
Value:1242
Constants.FV_Right int
Value:1243
Constants.FV_ChooseSelect int
Value:0x00000000
Constants.FV_ChooseOpen int
Value:0x00000001
Constants.FV_ChooseSave int
Value:0x00000002
Constants.FV_ChooseOpenDir int
Value:0x00000004
Constants.FV_ChooseMultiSelect int
Value:0x00000008
Constants.FV_ChooseMultiOpen int
Value:0x00000010
Constants.FV_BrowseLocalOnly int
Value:0x00010000
Constants.FV_BrowseCmsOnly int
Value:0x00020000
Constants.FV_BrowseLocalWithWebd
avOnly
int
Value:0x00040000
Constants.FA_Init_First int
Value:1
Property name Data Type
139
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FA_Init_Subsequent int
Value:2
Constants.FA_Init_TakeControl int
Value:3
Constants.FA_Init_DocReport int
Value:4
Constants.FA_Note_PreOpenDoc int
Value:1
Constants.FA_Note_PostOpenDoc int
Value:2
Constants.FA_Note_PreOpenMIF int
Value:3
Constants.FA_Note_PostOpenMIF int
Value:4
Constants.FA_Note_PreSaveDoc int
Value:5
Constants.FA_Note_PostSaveDoc int
Value:6
Constants.FA_Note_PreSaveMIF int
Value:7
Constants.FA_Note_PostSaveMIF int
Value:8
Constants.FA_Note_PreFileType int
Value:9
Constants.FA_Note_PostFileType int
Value:10
Constants.FA_Note_PreQuitDoc int
Value:11
Constants.FA_Note_DirtyDoc int
Value:12
Constants.FA_Note_ClientCall int
Value:13
Constants.FA_Note_FilterIn int
Value:14
Property name Data Type
140
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FA_Note_FilterOut int
Value:15
Constants.FA_Note_PreOpenBook int
Value:16
Constants.FA_Note_PostOpenBook int
Value:17
Constants.FA_Note_PreOpenBookMIF int
Value:18
Constants.FA_Note_PostOpenBookMI
F
int
Value:19
Constants.FA_Note_PreSaveBook int
Value:20
Constants.FA_Note_PostSaveBook int
Value:21
Constants.FA_Note_PreSaveBookMIF int
Value:22
Constants.FA_Note_PostSaveBookMIF int
Value:23
Constants.FA_Note_PreQuitBook int
Value:24
Constants.FA_Note_DirtyBook int
Value:25
Constants.FA_Note_PreQuitSession int
Value:26
Constants.FA_Note_PostQuitSession int
Value:27
Constants.FA_Note_PreRevertDoc int
Value:28
Constants.FA_Note_PostRevertDoc int
Value:29
Constants.FA_Note_PreRevertBook int
Value:30
Constants.FA_Note_PostRevertBook int
Value:31
Property name Data Type
141
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FA_Note_PreAutoSaveDoc int
Value:32
Constants.FA_Note_PostAutoSaveDoc int
Value:33
Constants.FA_Note_BackToUser int
Value:34
Constants.FA_Note_DisplayClientTiDia
log
int
Value:35
Constants.FA_Note_UpdateAllClientTi int
Value:36
Constants.FA_Note_UpdateClientTi int
Value:37
Constants.FA_Note_PreImport int
Value:38
Constants.FA_Note_PostImport int
Value:39
Constants.FA_Note_PostQuitDoc int
Value:40
Constants.FA_Note_PostQuitBook int
Value:41
Constants.FA_Note_PreFunction int
Value:42
Constants.FA_Note_PostFunction int
Value:43
Constants.FA_Note_PreMouseComma
nd
int
Value:44
Constants.FA_Note_PostMouseComm
and
int
Value:45
Constants.FA_Note_PreHypertext int
Value:46
Constants.FA_Note_PostHypertext int
Value:47
Constants.FA_Note_PrePrint int
Value:48
Property name Data Type
142
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FA_Note_PostPrint int
Value:49
Constants.FA_Note_BodyPageAdded int
Value:50
Constants.FA_Note_BodyPageDeleted int
Value:51
Constants.FA_Note_PreInsertElement int
Value:52
Constants.FA_Note_PostInsertElemen
t
int
Value:53
Constants.FA_Note_PreChangeEleme
nt
int
Value:54
Constants.FA_Note_PostChangeEleme
nt
int
Value:55
Constants.FA_Note_PreWrapElement int
Value:56
Constants.FA_Note_PostWrapElement int
Value:57
Constants.FA_Note_PreDragElement int
Value:58
Constants.FA_Note_PostDragElement int
Value:59
Constants.FA_Note_PreCopyElement int
Value:60
Constants.FA_Note_PostCopyElement int
Value:61
Constants.FA_Note_PreSetAttrValue int
Value:62
Constants.FA_Note_PostSetAttrValue int
Value:63
Constants.FA_Note_PreImportElemDe
fs
int
Value:64
Constants.FA_Note_PostImportElemD
efs
int
Value:65
Property name Data Type
143
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FA_Note_ECMInternal int
Value:66
Constants.FA_Note_PreExport int
Value:67
Constants.FA_Note_PostExport int
Value:68
Constants.FA_Note_PreInlineTypeIn int
Value:69
Constants.FA_Note_PostInlineTypeIn int
Value:70
Constants.FA_Note_PreSaveAsPDFDial
og
int
Value:71
Constants.FA_Note_PostSaveAsPDFDi
alog
int
Value:72
Constants.FA_Note_PreDistill int
Value:73
Constants.FA_Note_PostDistill int
Value:74
Constants.FA_Note_FilterFileToFile int
Value:75
Constants.FA_Note_PreBookCompone
ntOpen
int
Value:76
Constants.FA_Note_PostBookCompon
entOpen
int
Value:77
Constants.FA_Note_PreGenerate int
Value:78
Constants.FA_Note_PostGenerate int
Value:79
Constants.FA_Note_PreGoToXrefSrc int
Value:80
Constants.FA_Note_PostGoToXrefSrc int
Value:81
Constants.FA_Note_PreOpenSGML int
Value:82
Property name Data Type
144
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FA_Note_PostOpenSGML int
Value:83
Constants.FA_Note_Dialog int
Value:84
Constants.FA_Note_Alert int
Value:85
Constants.FA_Note_Palette int
Value:86
Constants.FA_Note_ToolBar int
Value:87
Constants.FA_Note_ConsoleMessage int
Value:88
Constants.FA_Note_Help int
Value:89
Constants.FA_Note_URL int
Value:90
Constants.FA_Note_CursorChange int
Value:91
Constants.FA_Note_FontSubstitution int
Value:92
Constants.FA_Note_UndoCheckpoint int
Value:93
Constants.FA_Note_FileOpen int
Value:94
Constants.FA_Note_PreOpenXML int
Value:95
Constants.FA_Note_PostOpenXML int
Value:96
Constants.FA_Note_PreSaveXML int
Value:97
Constants.FA_Note_PostSaveXML int
Value:98
Constants.FA_Note_PreSaveSGML int
Value:99
Property name Data Type
145
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FA_Note_PostSaveSGML int
Value:100
Constants.FA_Note_U3DCommand int
Value:101
Constants.FA_Note_Not_U3DComma
nd
int
Value:102
Constants.FA_Note_Not_RSC_Support
ed_File
int
Value:103
Constants.FA_Note_RSC_Supported_F
ile
int
Value:104
Constants.FA_Note_PostActiveDocCha
nge
int
Value:105
Constants.FA_Note_PreUpdateXRefs int
Value:106
Constants.FA_Note_PostUpdateXRefs int
Value:107
Constants.FA_Note_DisplayClientXRef
Dialog
int
Value:108
Constants.FA_Note_QuitModelessDial
og
int
Value:109
Constants.FA_Note_InsertTopicRef int
Value:110
Constants.FA_Note_InsertConRef int
Value:111
Constants.FA_Note_GenerateFM int
Value:112
Constants.FA_Note_OpenAllTopicrefs int
Value:113
Constants.FA_Note_UpdateRefs int
Value:114
Constants.FA_Note_AssignId int
Value:115
Constants.FA_Note_DITAOptions int
Value:116
Property name Data Type
146
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FA_Note_NewDitamapFile int
Value:117
Constants.FA_Note_NewBookmapFile int
Value:118
Constants.FA_Note_NewTopicFile int
Value:119
Constants.FA_Note_NewTaskFile int
Value:120
Constants.FA_Note_NewConceptFile int
Value:121
Constants.FA_Note_NewReferenceFile int
Value:122
Constants.FA_Note_NewGlossEntryFil
e
int
Value:123
Constants.FA_Note_SWF_File int
Value:124
Constants.FA_Note_Not_SWF_File int
Value:125
Constants.FA_Note_Enable_Disable_D
ITA_Menu_Commands
int
Value:126
Constants.FA_Note_Dialog_Create int
Value:127
Constants.FA_Note_SetAttrValue int
Value:128
Constants.FA_Note_UpdateRefs_On_S
ave
int
Value:129
Constants.FA_Note_Read_Struct_App int
Value:130
Constants.FA_Note_Struct_Wizard int
Value:131
Constants.FA_Note_Open_Dtd int
Value:132
Constants.FA_Note_Open_Schema int
Value:133
Property name Data Type
147
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FA_Note_Open_EDD_For_A
pp
int
Value:134
Constants.FA_Note_PostSetPropertyV
alue
int
Value:135
Constants.FA_Note_Not_AI_Supporte
d_File
int
Value:136
Constants.FA_Note_AI_Supported_Fil
e
int
Value:137
Constants.FA_Note_Poster_Applied int
Value:138
Constants.FA_Note_PrePublishDitama
p
int
Value:139
Constants.FA_Note_PostPublishDitam
ap
int
Value:140
Constants.FA_Note_UpdateDITARefer
ence
int
Value:141
Constants.FA_Note_UpdateDITARefer
ences
int
Value:142
Constants.FA_Note_LoadKeyCatalog int
Value:143
Constants.FA_Note_ReLoadKeyCatalo
g
int
Value:144
Constants.FA_Note_EnumeratedComp
onent
int
Value:145
Constants.FA_Note_PreSwitchView int
Value:146
Constants.FA_Note_PostSwitchView int
Value:147
Constants.FA_Note_IsCommandEnabl
ed
int
Value:148
Constants.FA_Note_Num int
Value:149
Constants.FTI_String int
Value:0x00000001
Property name Data Type
148
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FTI_LineBegin int
Value:0x00000002
Constants.FTI_LineEnd int
Value:0x00000004
Constants.FTI_PgfBegin int
Value:0x00000008
Constants.FTI_PgfEnd int
Value:0x00000010
Constants.FTI_FlowBegin int
Value:0x00000020
Constants.FTI_FlowEnd int
Value:0x00000040
Constants.FTI_PageBegin int
Value:0x00000080
Constants.FTI_PageEnd int
Value:0x00000100
Constants.FTI_SubColBegin int
Value:0x00000200
Constants.FTI_SubColEnd int
Value:0x00000400
Constants.FTI_FrameAnchor int
Value:0x00000800
Constants.FTI_FnAnchor int
Value:0x00001000
Constants.FTI_TblAnchor int
Value:0x00002000
Constants.FTI_MarkerAnchor int
Value:0x00004000
Constants.FTI_XRefBegin int
Value:0x00008000
Constants.FTI_XRefEnd int
Value:0x00010000
Constants.FTI_VarBegin int
Value:0x00020000
Property name Data Type
149
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FTI_VarEnd int
Value:0x00040000
Constants.FTI_ElementBegin int
Value:0x00080000
Constants.FTI_ElementEnd int
Value:0x00100000
Constants.FTI_CharPropsChange int
Value:0x00200000
Constants.FTI_TextFrameBegin int
Value:0x00400000
Constants.FTI_TextFrameEnd int
Value:0x00800000
Constants.FTI_TextObjId int
Value:0x01000000
Constants.FTI_TextInsetBegin int
Value:0x02000000
Constants.FTI_TextInsetEnd int
Value:0x04000000
Constants.FTI_ElemPrefixBegin int
Value:0x08000000
Constants.FTI_ElemPrefixEnd int
Value:0x10000000
Constants.FTI_ElemSuffixBegin int
Value:0x20000000
Constants.FTI_ElemSuffixEnd int
Value:0x40000000
Constants.FTI2_RubiTextBegin int
Value:0x80000001
Constants.FTI2_RubiTextEnd int
Value:0x80000002
Constants.FTI2_RubiCompositeBegin int
Value:0x80000004
Constants.FTI2_RubiCompositeEnd int
Value:0x80000008
Property name Data Type
150
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FTI_HardLineEnd int
Value:1
Constants.FTI_HyphenLineEnd int
Value:2
Constants.FTF_FAMILY int
Value:0x80000000
Constants.FTF_VARIATION int
Value:0x40000000
Constants.FTF_WEIGHT int
Value:0x20000000
Constants.FTF_ANGLE int
Value:0x10000000
Constants.FTF_UNDERLINING int
Value:0x08000000
Constants.FTF_STRIKETHROUGH int
Value:0x04000000
Constants.FTF_OVERLINE int
Value:0x02000000
Constants.FTF_CHANGEBAR int
Value:0x01000000
Constants.FTF_OUTLINE int
Value:0x00800000
Constants.FTF_SHADOW int
Value:0x00400000
Constants.FTF_PAIRKERN int
Value:0x00200000
Constants.FTF_SIZE int
Value:0x00100000
Constants.FTF_KERNX int
Value:0x00080000
Constants.FTF_KERNY int
Value:0x00040000
Constants.FTF_SPREAD int
Value:0x00020000
Property name Data Type
151
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FTF_COLOR int
Value:0x00010000
Constants.FTF_CHARTAG int
Value:0x00008000
Constants.FTF_CAPITALIZATION int
Value:0x00004000
Constants.FTF_POSITION int
Value:0x00002000
Constants.FTF_STRETCH int
Value:0x00001000
Constants.FTF_LANGUAGE int
Value:0x00000800
Constants.FTF_TSUME int
Value:0x00000400
Constants.FTF_ENCODING int
Value:0x00000200
Constants.FTF_IIF int
Value:0x00000002
Constants.FTF_CONDITIONTAG int
Value:0x00000001
Constants.FTF_ALL int
Value:0xFFFFFE03
Constants.FV_OBJ_END_OFFSET int
Value:0x50000000
Constants.FT_Bad int
Value:0
Constants.FT_Integer int
Value:1
Constants.FT_Metric int
Value:2
Constants.FT_String int
Value:3
Constants.FT_Id int
Value:4
Property name Data Type
152
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FT_Metrics int
Value:5
Constants.FT_Strings int
Value:6
Constants.FT_Points int
Value:7
Constants.FT_Tabs int
Value:8
Constants.FT_TextLoc int
Value:9
Constants.FT_TextRange int
Value:10
Constants.oldFT_ElementFmts int
Value:11
Constants.FT_ElementCatalog int
Value:12
Constants.FT_Ints int
Value:13
Constants.FT_UBytes int
Value:14
Constants.FT_UInts int
Value:15
Constants.FT_FormatBranches int
Value:16
Constants.FT_AttributeDefs int
Value:17
Constants.FT_Attributes int
Value:18
Constants.FT_ElementRange int
Value:19
Constants.FT_Vals int
Value:20
Constants.FT_AttributesEx int
Value:21
Property name Data Type
153
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FT_Num int
Value:22
Constants.FI_PLUGIN_PRODUCTNAME int
Value:1
Constants.FI_PLUGIN_NAME int
Value:2
Constants.FI_PLUGIN_TYPE int
Value:3
Constants.FI_PLUGIN_DESCRIPTION int
Value:4
Constants.FI_PLUGIN_PRODUCTS int
Value:5
Constants.FI_PLUGIN_FACET int
Value:6
Constants.FI_PLUGIN_FORMATID int
Value:7
Constants.FI_PLUGIN_VENDOR int
Value:8
Constants.FI_PLUGIN_SUFFIX int
Value:9
Constants.FI_PLUGIN_INFORMAT int
Value:10
Constants.FI_PLUGIN_OUTFORMAT int
Value:11
Constants.FO_Session int
Value:0
Constants.FO_StringResource int
Value:1
Constants.FO_Book int
Value:2
Constants.FO_BookComponent int
Value:3
Constants.FO_Doc int
Value:4
Property name Data Type
154
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FO_BodyPage int
Value:5
Constants.FO_MasterPage int
Value:6
Constants.FO_RefPage int
Value:7
Constants.FO_HiddenPage int
Value:8
Constants.FO_Last_Page int
Value:8
Constants.FO_UnanchoredFrame int
Value:9
Constants.FO_Group int
Value:10
Constants.FO_Arc int
Value:11
Constants.FO_Rectangle int
Value:12
Constants.FO_Ellipse int
Value:13
Constants.FO_RoundRect int
Value:14
Constants.FO_Polyline int
Value:15
Constants.FO_Polygon int
Value:16
Constants.FO_Line int
Value:17
Constants.FO_TextLine int
Value:18
Constants.FO_TextFrame int
Value:19
Constants.FO_Inset int
Value:20
Property name Data Type
155
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FO_Math int
Value:21
Constants.FO_DBGroup int
Value:22
Constants.FO_Last_Graphic int
Value:22
Constants.FO_AFrame int
Value:23
Constants.FO_XLast_Graphic int
Value:23
Constants.FO_Marker int
Value:24
Constants.FO_Fn int
Value:25
Constants.FO_XRef int
Value:26
Constants.FO_XRefFmt int
Value:27
Constants.FO_Var int
Value:28
Constants.FO_VarFmt int
Value:29
Constants.FO_Flow int
Value:30
Constants.FO_Pgf int
Value:31
Constants.FO_PgfFmt int
Value:32
Constants.FO_CharFmt int
Value:33
Constants.FO_CondFmt int
Value:34
Constants.FO_Color int
Value:35
Property name Data Type
156
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FO_Tbl int
Value:36
Constants.FO_TblFmt int
Value:37
Constants.FO_Row int
Value:38
Constants.FO_Cell int
Value:39
Constants.FO_RulingFmt int
Value:40
Constants.FO_ElementDef int
Value:41
Constants.FO_Element int
Value:42
Constants.FO_DialogResource int
Value:43
Constants.FO_DlgBox int
Value:44
Constants.FO_DlgButton int
Value:45
Constants.FO_DlgTriBox int
Value:46
Constants.FO_DlgCheckBox int
Value:47
Constants.FO_DlgPopUp int
Value:48
Constants.FO_DlgScrollBox int
Value:49
Constants.FO_DlgEditBox int
Value:50
Constants.FO_DlgRadioButton int
Value:51
Constants.FO_DlgLabel int
Value:52
Property name Data Type
157
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FO_DlgImage int
Value:53
Constants.FO_DlgScrollBar int
Value:54
Constants.FO_Menu int
Value:55
Constants.FO_Command int
Value:56
Constants.FO_MenuItemSeparator int
Value:57
Constants.FO_FmtChangeList int
Value:58
Constants.FO_FmtRule int
Value:59
Constants.FO_FmtRuleClause int
Value:60
Constants.FO_TiFlow int
Value:61
Constants.FO_TiText int
Value:62
Constants.FO_TiTextTable int
Value:63
Constants.FO_TiApiClient int
Value:64
Constants.FO_SubCol int
Value:65
Constants.FO_MarkerType int
Value:66
Constants.FO_CombinedFontDefn int
Value:67
Constants.FO_Rubi int
Value:68
Constants.FO_Alert int
Value:69
Property name Data Type
158
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FO_CursorResource int
Value:70
Constants.FO_AttrCondExpr int
Value:71
Constants.FO_DlgListView int
Value:72
Constants.FO_GraphicsFmt int
Value:73
Constants.FO_CMSRegistration int
Value:74
Constants.FO_CMSSession int
Value:75
Constants.FO_CMSObject int
Value:76
Constants.FO_KeyCatalog int
Value:77
Constants.FO_Iterator int
Value:78
Constants.FO_Num int
Value:79
Constants.FO_First_Internal int
Value:79
Constants.FO_Page int
Value:(79+0)
Constants.FO_Graphic int
Value:(79+1)
Constants.FO_Frame int
Value:(79+2)
Constants.FO_Cblock int
Value:(79+3)
Constants.FO_SubCond int
Value:(79+4)
Constants.FO_SubStyle int
Value:(79+5)
Property name Data Type
159
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FO_SubDash int
Value:(79+6)
Constants.FO_SubCell int
Value:(79+7)
Constants.FO_SubTbl int
Value:(79+8)
Constants.FO_SubPblock int
Value:(79+9)
Constants.FO_SubTextDef int
Value:(79+10)
Constants.FO_MenuCell int
Value:(79+11)
Constants.FO_TextInset int
Value:(79+12)
Constants.FO_DitaMap int
Value:(79+13)
Constants.FO_Last_Internal int
Value:(79+14)
Constants.FO_CMSConnection int
Value:(79+15)
Constants.FO_CMSObject2 int
Value:(79+16)
Constants.FO_Bad int
Value:255
Constants.FO_AnchoredFrame int
Value:23
Constants.FO_UFrame int
Value:9
Constants.FP_Name int
Value:20
Constants.FP_Unique int
Value:21
Constants.FP_UserString int
Value:22
Property name Data Type
160
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_ObjectAttributes int
Value:23
Constants.FP_Label int
Value:30
Constants.FP_IsIconified int
Value:31
Constants.FP_IsInFront int
Value:32
Constants.FP_ScreenX int
Value:33
Constants.FP_ScreenY int
Value:34
Constants.FP_ScreenWidth int
Value:35
Constants.FP_ScreenHeight int
Value:36
Constants.FV_SessionId int
Value:0
Constants.FP_VersionRevision int
Value:41
Constants.FP_ProductName int
Value:42
Constants.FP_VersionMajor int
Value:43
Constants.FP_VersionMinor int
Value:44
Constants.FP_Platform int
Value:45
Constants.FP_OperatingSystem int
Value:46
Constants.FP_WindowSystem int
Value:47
Constants.FP_AutoSave int
Value:48
Property name Data Type
161
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_AutoSaveSeconds int
Value:49
Constants.FP_AutoBackup int
Value:50
Constants.FP_ActiveDoc int
Value:51
Constants.FP_ProgId int
Value:2421
Constants.FP_IsFMRunningAsServer int
Value:2348
Constants.FP_ActiveView int
Value:2422
Constants.FP_CurrentDoc int
Value:2401
Constants.FP_PDFPageNum int
Value:2402
Constants.FP_UndoFDKRecording int
Value:2403
Constants.FP_StackWarningLevel int
Value:2404
Constants.FP_NoFlashInPDF int
Value:2405
Constants.FP_No3DInPDF int
Value:2406
Constants.FP_InsetURL int
Value:2407
Constants.FP_DontShowWelcomeScre
en
int
Value:2408
Constants.FP_TechSuiteInternal int
Value:2409
Constants.FP_IsTechnicalSuiteLicensed int
Value:2410
Constants.FP_TechSuiteInternal2 int
Value:2411
Property name Data Type
162
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_IsFMRunningInTrialPerio
d
int
Value:2412
Constants.FP_EnableAutoSpellCheck int
Value:2413
Constants.FP_CustomDelimiter int
Value:2420
Constants.FV_WarnNever int
Value:0
Constants.FV_WarnAlways int
Value:1
Constants.FV_WarnOnce int
Value:2
Constants.FV_UndoAll int
Value:3
Constants.FV_RedoAll int
Value:4
Constants.FP_ActiveBook int
Value:52
Constants.FP_FirstOpenDoc int
Value:53
Constants.FP_FirstOpenBook int
Value:54
Constants.FP_FontFamilyNames int
Value:55
Constants.FP_FontVariationNames int
Value:56
Constants.FP_FontWeightNames int
Value:57
Constants.FP_FontAngleNames int
Value:58
Constants.FP_MarkerNames int
Value:59
Constants.FP_FontFamilyAttributes int
Value:60
Property name Data Type
163
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_FAMILY_VISIBLE int
Value:0x00000001
Constants.FV_FAMILY_SELECTABLE int
Value:0x00000002
Constants.FV_FAMILY_MAPPED int
Value:0x00000004
Constants.FV_FAMILY_SURROGATE int
Value:0xFFFF0000
Constants.FP_RememberMissingFont
Names
int
Value:61
Constants.FP_Mif8bitOutput int
Value:62
Constants.FP_GreekSize int
Value:63
Constants.FP_RetainUndoState int
Value:64
Constants.FP_ProductIsStructured int
Value:65
Constants.FP_ProductIsDemo int
Value:66
Constants.FP_DisableAutofitAfterZoo
m
int
Value:67
Constants.FP_DefaultFontFamily int
Value:68
Constants.FP_DefaultFontVariation int
Value:69
Constants.FP_DefaultFontWeight int
Value:70
Constants.FP_DefaultFontAngle int
Value:71
Constants.FP_CTFontContext int
Value:72
Constants.FP_FontFamilyFullNames int
Value:73
Property name Data Type
164
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_RpcPropertyName int
Value:76
Constants.FP_RpcProgramNumber int
Value:77
Constants.FP_DisplayName int
Value:78
Constants.FP_ProcessNumber int
Value:79
Constants.FP_OpenDir int
Value:80
Constants.FP_HostName int
Value:81
Constants.FP_UserName int
Value:82
Constants.FP_UserLogin int
Value:83
Constants.FP_UserHomeDir int
Value:84
Constants.FP_UserSettingsDir int
Value:152
Constants.FP_Path int
Value:85
Constants.FP_TmpDir int
Value:86
Constants.FP_FM_HomeDir int
Value:87
Constants.FP_FM_BinDir int
Value:88
Constants.FP_FM_InitDir int
Value:89
Constants.FP_FM_CurrentDir int
Value:90
Constants.FP_FM_SgmlDir int
Value:100
Property name Data Type
165
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_FM_StructureDir int
Value:2031
Constants.FP_FM_XmlDir int
Value:2032
Constants.FP_Reformatting int
Value:91
Constants.FP_Displaying int
Value:92
Constants.FP_ApplyFormatRules int
Value:93
Constants.FP_ApplyEOPRules int
Value:2030
Constants.FP_Validating int
Value:94
Constants.FP_ToolBar int
Value:95
Constants.FP_FirstMenuItemInSession int
Value:97
Constants.FP_FirstCommandInSession int
Value:98
Constants.FP_CurrentMenuSet int
Value:99
Constants.FV_MENU_QUICK int
Value:1
Constants.FV_MENU_COMPLETE int
Value:2
Constants.FV_MENU_CUSTOM int
Value:3
Constants.FP_IconBarOn int
Value:101
Constants.FP_HelpPending int
Value:102
Constants.FP_FM_HelpDir int
Value:103
Property name Data Type
166
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_PercentDone int
Value:104
Constants.FP_ActiveAlert int
Value:105
Constants.FP_Snap int
Value:151
Constants.FP_Gravity int
Value:107
Constants.FP_KByteAllocationSize int
Value:106
Constants.FP_ImportFilters int
Value:2288
Constants.FP_ExportFilters int
Value:2289
Constants.FP_UIColorBackground int
Value:2297
Constants.FP_UIColorRuler int
Value:2298
Constants.FP_BIBGetAddressProc int
Value:2299
Constants.FP_RasterFilterDpi int
Value:2400
Constants.FV_Hint_HintVersion int
Value:0
Constants.FV_Hint_VendorId int
Value:1
Constants.FV_Hint_FormatId int
Value:2
Constants.FV_Hint_Platform int
Value:3
Constants.FV_Hint_FilterVersion int
Value:4
Constants.FV_Hint_FilterName int
Value:5
Property name Data Type
167
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_DefaultKeyCatalog int
Value:2871
Constants.FP_FirstKeyCatalogInSessio
n
int
Value:2872
Constants.FP_KeyCatalogWorkflow int
Value:2859
Constants.FV_KeyCatalogWorkflowAu
thoring
int
Value:0
Constants.FV_KeyCatalogWorkflowPu
blishing
int
Value:1
Constants.FV_KeyCatalogWorkflowSe
arching
int
Value:2
Constants.FV_KeyCatalogWorkflowMa
x
int
Value:3
Constants.FP_StatusLine int
Value:108
Constants.FP_TextSelection int
Value:109
Constants.FP_IsOnScreen int
Value:110
Constants.FP_NextOpenDocInSession int
Value:111
Constants.FP_FirstGraphicInDoc int
Value:112
Constants.FP_FirstPgfInDoc int
Value:113
Constants.FP_FirstMarkerInDoc int
Value:114
Constants.FP_FirstVarInDoc int
Value:115
Constants.FP_FirstVarFmtInDoc int
Value:116
Constants.FP_FirstXRefInDoc int
Value:117
Property name Data Type
168
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_FirstXRefFmtInDoc int
Value:118
Constants.FP_FirstFnInDoc int
Value:119
Constants.FP_FirstTblInDoc int
Value:120
Constants.FP_FirstFlowInDoc int
Value:121
Constants.FP_FirstPgfFmtInDoc int
Value:122
Constants.FP_FirstCharFmtInDoc int
Value:123
Constants.FP_FirstCondFmtInDoc int
Value:124
Constants.FP_FirstTblFmtInDoc int
Value:125
Constants.FP_FirstRulingFmtInDoc int
Value:126
Constants.FP_FirstColorInDoc int
Value:127
Constants.FP_FirstSelectedGraphicInD
oc
int
Value:128
Constants.FP_SelectedTbl int
Value:129
Constants.FP_FileExtensionOverride int
Value:2813
Constants.FP_FirstAttrCondExprInDoc int
Value:2815
Constants.FP_DocOpenType int
Value:130
Constants.FV_DOC_TYPE_BINARY int
Value:0x01
Constants.FV_DOC_TYPE_TEXT int
Value:0x02
Property name Data Type
169
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_DOC_TYPE_MIF int
Value:0x03
Constants.FV_DOC_TYPE_FILTER int
Value:0x04
Constants.FP_DocSaveFormat int
Value:2415
Constants.FP_DocIsModified int
Value:131
Constants.FP_DocIsHelp int
Value:132
Constants.FP_DocIsViewOnly int
Value:133
Constants.FP_ViewOnlyWinPalette int
Value:134
Constants.FP_ViewOnlyWinMenubar int
Value:135
Constants.FP_ViewOnlyWinBorders int
Value:136
Constants.FP_ViewOnlyWinPopup int
Value:137
Constants.FP_ViewOnlyXRef int
Value:138
Constants.FV_VOX_NOT_ACTIVE int
Value:0
Constants.FV_VOX_GOTO_BEHAVIOR int
Value:1
Constants.FV_VOX_OPEN_BEHAVIOR int
Value:2
Constants.FV_VOX_ALERT int
Value:3
Constants.FP_ViewOnlySelect int
Value:139
Constants.FV_VOS_USER_ONLY int
Value:1
Property name Data Type
170
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_VOS_NONE int
Value:2
Constants.FV_VOS_YES int
Value:3
Constants.FP_ViewOnlyDeadCodes int
Value:140
Constants.FP_FirstTiInDoc int
Value:141
Constants.FP_FirstSelectedTiInDoc int
Value:142
Constants.FP_DocIsViewOnlyWinPalet
te
int
Value:134
Constants.FP_MenuBar int
Value:143
Constants.FP_ViewOnlyMenuBar int
Value:144
Constants.FP_DocSaveType int
Value:145
Constants.FP_Untouchable int
Value:146
Constants.FP_DocFluidFlow int
Value:147
Constants.FP_FirstMarkerTypeInDoc int
Value:148
Constants.FP_MarkerTypeNames int
Value:149
Constants.FP_AddMarkerTypeToStand
ardMarkers
int
Value:150
Constants.FP_ShowAll int
Value:155
Constants.FP_ShowCondIndicators int
Value:156
Constants.FP_DontUpdateXRefs int
Value:159
Property name Data Type
171
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_DontUpdateTextInsets int
Value:160
Constants.FP_LineBreakAfter int
Value:177
Constants.FP_SuperScriptSize int
Value:178
Constants.FP_SuperScriptShift int
Value:179
Constants.FP_SubScriptSize int
Value:180
Constants.FP_SubScriptShift int
Value:181
Constants.FP_SmallCapsSize int
Value:182
Constants.FP_SuperScriptStretch int
Value:183
Constants.FP_SubScriptStretch int
Value:184
Constants.FP_SmallCapsStretch int
Value:185
Constants.FP_RubiSize int
Value:186
Constants.FP_RubiFixedSize int
Value:187
Constants.FP_NarrowRubiSpaceForJap
anese
int
Value:188
Constants.FP_WideRubiSpaceForJapa
nese
int
Value:189
Constants.FP_NarrowRubiSpaceForOt
her
int
Value:190
Constants.FP_WideRubiSpaceForOthe
r
int
Value:191
Constants.FV_WIDE int
Value:0
Property name Data Type
172
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_NARROW int
Value:1
Constants.FV_PROPORTIONAL int
Value:2
Constants.FP_RubiOverhang int
Value:192
Constants.FP_RubiAlignAtLineBounds int
Value:193
Constants.FP_FirstRubiInDoc int
Value:194
Constants.FP_ScreenCaptureDocToFile int
Value:195
Constants.FP_Dictionary int
Value:203
Constants.FP_VolNumComputeMetho
d
int
Value:211
Constants.FV_NUM_READ_FROM_FIL
E
int
Value:0x00
Constants.FV_NUM_CONTINUE int
Value:0x01
Constants.FV_NUM_RESTART int
Value:0x02
Constants.FV_NUM_SAME int
Value:0x03
Constants.FV_NUM_PERPAGE int
Value:0x03
Constants.FP_VolumeNumber int
Value:212
Constants.FP_VolumeNumStyle int
Value:213
Constants.FP_VolumeNumText int
Value:214
Constants.FP_ChapNumComputeMet
hod
int
Value:215
Property name Data Type
173
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_ChapterNumber int
Value:216
Constants.FP_ChapterNumStyle int
Value:217
Constants.FV_NUMSTYLE_NUMERIC int
Value:0x00
Constants.FV_NUMSTYLE_ROMAN_U
C
int
Value:0x01
Constants.FV_NUMSTYLE_ROMAN_LC int
Value:0x02
Constants.FV_NUMSTYLE_ALPHA_UC int
Value:0x03
Constants.FV_NUMSTYLE_ALPHA_LC int
Value:0x04
Constants.FV_NUMSTYLE_KANJI int
Value:0x05
Constants.FV_NUMSTYLE_ZENKAKU int
Value:0x06
Constants.FV_NUMSTYLE_ZENKAKU_
UC
int
Value:0x07
Constants.FV_NUMSTYLE_ZENKAKU_L
C
int
Value:0x08
Constants.FV_NUMSTYLE_KANJI_KAZ
U
int
Value:0x09
Constants.FV_NUMSTYLE_DAIJI int
Value:0x0a
Constants.FV_NUMSTYLE_TEXT int
Value:0x0b
Constants.FV_NUMSTYLE_FULLWIDTH int
Value:0x0c
Constants.FV_NUMSTYLE_FULLWIDTH
_UC
int
Value:0x0d
Constants.FV_NUMSTYLE_FULLWIDTH
_LC
int
Value:0x0e
Property name Data Type
174
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_NUMSTYLE_CHINESE_N
UMERIC
int
Value:0x10
Constants.FP_ChapterNumText int
Value:218
Constants.FP_FirstPageNum int
Value:224
Constants.FP_PageNumStyle int
Value:225
Constants.FV_PAGE_NUM_NUMERIC int
Value:0x00
Constants.FV_PAGE_NUM_ROMAN_U
C
int
Value:0x01
Constants.FV_PAGE_NUM_ROMAN_L
C
int
Value:0x02
Constants.FV_PAGE_NUM_ALPHA_UC int
Value:0x03
Constants.FV_PAGE_NUM_ALPHA_LC int
Value:0x04
Constants.FV_PAGE_NUM_KANJI int
Value:0x05
Constants.FV_PAGE_NUM_ZENKAKU int
Value:0x06
Constants.FV_PAGE_NUM_ZENKAKU_
UC
int
Value:0x07
Constants.FV_PAGE_NUM_ZENKAKU_
LC
int
Value:0x08
Constants.FV_PAGE_NUM_KANJI_KAZ
U
int
Value:0x09
Constants.FV_PAGE_NUM_DAIJI int
Value:0x0a
Constants.FV_PAGE_NUM_FULLWIDT
H
int
Value:0x0c
Constants.FV_PAGE_NUM_FULLWIDT
H_UC
int
Value:0x0d
Property name Data Type
175
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_PAGE_NUM_FULLWIDT
H_LC
int
Value:0x0e
Constants.FV_PAGE_NUM_CHINESE_
NUMERIC
int
Value:0x10
Constants.FP_DocIsDoubleSided int
Value:226
Constants.FP_FirstPageVerso int
Value:227
Constants.FP_PointPageNumStyle int
Value:228
Constants.FV_POINT_PAGE_NUM_NU
MERIC
int
Value:0x00
Constants.FV_POINT_PAGE_NUM_RO
MAN_UC
int
Value:0x01
Constants.FV_POINT_PAGE_NUM_RO
MAN_LC
int
Value:0x02
Constants.FV_POINT_PAGE_NUM_ALP
HA_UC
int
Value:0x03
Constants.FV_POINT_PAGE_NUM_ALP
HA_LC
int
Value:0x04
Constants.FV_POINT_PAGE_NUM_KA
NJI
int
Value:0x05
Constants.FV_POINT_PAGE_NUM_ZE
NKAKU
int
Value:0x06
Constants.FV_POINT_PAGE_NUM_ZE
NKAKU_UC
int
Value:0x07
Constants.FV_POINT_PAGE_NUM_ZE
NKAKU_LC
int
Value:0x08
Constants.FV_POINT_PAGE_NUM_KA
NJI_KAZU
int
Value:0x09
Constants.FV_POINT_PAGE_NUM_DAI
JI
int
Value:0x0a
Constants.FV_POINT_PAGE_FULLWIDT
H
int
Value:0x0c
Property name Data Type
176
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_POINT_PAGE_FULLWIDT
H_UC
int
Value:0x0d
Constants.FV_POINT_PAGE_FULLWIDT
H_LC
int
Value:0x0e
Constants.FV_POINT_PAGE_CHINESE_
NUMERIC
int
Value:0x10
Constants.FP_PageRounding int
Value:229
Constants.FV_PR_DEL_EMPTY int
Value:0x01
Constants.FV_PR_KEEP_NUM_EVEN int
Value:0x02
Constants.FV_PR_KEEP_NUM_ODD int
Value:0x03
Constants.FV_PR_DONT_CHANGE int
Value:0x04
Constants.FP_TopMargin int
Value:230
Constants.FP_BottomMargin int
Value:231
Constants.FP_LeftMargin int
Value:232
Constants.FP_RightMargin int
Value:233
Constants.FP_ColGap int
Value:234
Constants.FP_NumCols int
Value:235
Constants.FP_CurrentPage int
Value:236
Constants.FP_SmartQuotes int
Value:237
Constants.FP_AutoChangeBars int
Value:238
Property name Data Type
177
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_SmartSpaces int
Value:239
Constants.FP_CurrentInset int
Value:240
Constants.FP_ChangeBarDistance int
Value:259
Constants.FP_ChangeBarPosition int
Value:260
Constants.FV_CB_COL_LEFT int
Value:0x00
Constants.FV_CB_COL_RIGHT int
Value:0x01
Constants.FV_CB_COL_NEAREST int
Value:0x02
Constants.FV_CB_COL_FURTHEST int
Value:0x03
Constants.FP_ChangeBarThickness int
Value:261
Constants.FP_ChangeBarColor int
Value:262
Constants.FP_FnFmt int
Value:283
Constants.FP_FnFirstNum int
Value:284
Constants.FP_FnCustNumString int
Value:285
Constants.FP_FnRefPrefix int
Value:286
Constants.FP_FnInstancePosition int
Value:287
Constants.FV_FN_POS_SUPER int
Value:0x00
Constants.FV_FN_POS_BASELINE int
Value:0x01
Property name Data Type
178
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_FN_POS_SUB int
Value:0x02
Constants.FP_FnInstanceSuffix int
Value:288
Constants.FP_FnHeightPerCol int
Value:289
Constants.FP_FnNumStyle int
Value:290
Constants.FV_FN_NUM_NUMERIC int
Value:0x00
Constants.FV_FN_NUM_ROMAN_UC int
Value:0x01
Constants.FV_FN_NUM_ROMAN_LC int
Value:0x02
Constants.FV_FN_NUM_ALPHA_UC int
Value:0x03
Constants.FV_FN_NUM_ALPHA_LC int
Value:0x04
Constants.FV_FN_NUM_CUSTOM int
Value:0x05
Constants.FV_FN_NUM_KANJI int
Value:0x06
Constants.FV_FN_NUM_ZENKAKU int
Value:0x07
Constants.FV_FN_NUM_ZENKAKU_UC int
Value:0x08
Constants.FV_FN_NUM_ZENKAKU_LC int
Value:0x09
Constants.FV_FN_NUM_KANJI_KAZU int
Value:0x0A
Constants.FV_FN_NUM_DAIJI int
Value:0x0B
Constants.FV_FN_NUM_FULL_WIDTH int
Value:0x0C
Property name Data Type
179
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_FN_NUM_FULL_WIDTH
_UC
int
Value:0x0D
Constants.FV_FN_NUM_FULL_WIDTH
_LC
int
Value:0x0E
Constants.FV_FN_NUM_CHINESE_NU
MERIC
int
Value:0x10
Constants.FP_FnNumberingPerPage int
Value:291
Constants.FP_FnRefPosition int
Value:292
Constants.FP_FnRefSuffix int
Value:293
Constants.FP_FnInstancePrefix int
Value:294
Constants.FP_FnNumComputeMetho
d
int
Value:295
Constants.FP_TblFnFmt int
Value:315
Constants.FP_TblFnNumStyle int
Value:316
Constants.FP_TblFnCustNumString int
Value:317
Constants.FP_TblFnCellPosition int
Value:318
Constants.FP_TblFnCellSuffix int
Value:319
Constants.FP_TblFnCellPrefix int
Value:320
Constants.FP_TblFnPosition int
Value:321
Constants.FP_TblFnPrefix int
Value:322
Constants.FP_TblFnSuffix int
Value:323
Property name Data Type
180
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_TblFnNumComputeMet
hod
int
Value:324
Constants.FP_Symbols int
Value:334
Constants.FP_SymbolsList int
Value:335
Constants.FP_Variables int
Value:336
Constants.FP_Strings int
Value:337
Constants.FP_Numbers int
Value:338
Constants.FP_Functions int
Value:339
Constants.FP_HorizontalSpreadSmall int
Value:340
Constants.FP_HorizontalSpreadMed int
Value:341
Constants.FP_HorizontalSpreadLarge int
Value:342
Constants.FP_VerticalSpreadSmall int
Value:343
Constants.FP_VerticalSpreadMed int
Value:344
Constants.FP_VerticalSpreadLarge int
Value:345
Constants.FP_EqnIntegralSizeSmall int
Value:346
Constants.FP_EqnIntegralSizeMed int
Value:347
Constants.FP_EqnIntegralSizeLarge int
Value:348
Constants.FP_EqnSigmaSizeSmall int
Value:349
Property name Data Type
181
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_EqnSigmaSizeMed int
Value:350
Constants.FP_EqnSigmaSizeLarge int
Value:351
Constants.FP_EqnLevel1SizeSmall int
Value:352
Constants.FP_EqnLevel1SizeMed int
Value:353
Constants.FP_EqnLevel1SizeLarge int
Value:354
Constants.FP_EqnLevel2SizeSmall int
Value:355
Constants.FP_EqnLevel2SizeMed int
Value:356
Constants.FP_EqnLevel2SizeLarge int
Value:357
Constants.FP_EqnLevel3SizeSmall int
Value:358
Constants.FP_EqnLevel3SizeMed int
Value:359
Constants.FP_EqnLevel3SizeLarge int
Value:360
Constants.FP_ViewBorders int
Value:382
Constants.FP_ViewHotspotIndicators int
Value:2357
Constants.FP_ViewRulers int
Value:383
Constants.FP_ViewNoGraphics int
Value:384
Constants.FP_ViewPageScrolling int
Value:385
Constants.FV_SCROLL_VARIABLE int
Value:0
Property name Data Type
182
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_SCROLL_HORIZONTAL int
Value:1
Constants.FV_SCROLL_VERTICAL int
Value:2
Constants.FV_SCROLL_FACING int
Value:3
Constants.FP_ViewGridUnits int
Value:386
Constants.FP_Zoom int
Value:387
Constants.FV_NO_ZOOM_MANGLING int
Value:-1
Constants.FV_ZOOM_TO_FIT_TO_WIN
DOW
int
Value:-2
Constants.FV_FIT_WINDOW_TO_PAG
E
int
Value:-3
Constants.FP_ViewTextSymbols int
Value:388
Constants.FP_ViewGrid int
Value:389
Constants.FP_ViewDisplayUnits int
Value:390
Constants.FP_TrackChangesOn int
Value:2819
Constants.FP_PreviewState int
Value:2820
Constants.FV_PREVIEW_OFF_TRACK_
CHANGE
int
Value:0
Constants.FV_PREVIEW_ON_ORIGINA
L
int
Value:1
Constants.FV_PREVIEW_ON_FINAL int
Value:2
Constants.FP_ReviewerNameList int
Value:2825
Property name Data Type
183
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_TrackChangesAddedCol
or
int
Value:2826
Constants.FP_TrackChangesDeletedCo
lor
int
Value:2827
Constants.FP_ViewRulerUnits int
Value:391
Constants.FP_SpotColorView int
Value:392
Constants.FP_SnapGridUnits int
Value:393
Constants.FP_SnapAngle int
Value:394
Constants.FP_ViewLinkBoundaries int
Value:395
Constants.FP_ViewFontSizeUnits int
Value:396
Constants.FP_LeftMasterPage int
Value:413
Constants.FP_RightMasterPage int
Value:414
Constants.FP_FirstBodyPageInDoc int
Value:415
Constants.FP_LastBodyPageInDoc int
Value:416
Constants.FP_FirstMasterPageInDoc int
Value:417
Constants.FP_LastMasterPageInDoc int
Value:418
Constants.FP_FirstRefPageInDoc int
Value:419
Constants.FP_LastRefPageInDoc int
Value:420
Constants.FP_HiddenPage int
Value:421
Property name Data Type
184
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_MainFlowInDoc int
Value:422
Constants.FP_PrintStartPageName int
Value:439
Constants.FP_PrintEndPageName int
Value:440
Constants.FP_PrintCols int
Value:441
Constants.FP_PrintRows int
Value:442
Constants.FP_PrintStartPage int
Value:443
Constants.FP_PrintStartPoint int
Value:444
Constants.FP_PrintOddPages int
Value:445
Constants.FP_PrintCollated int
Value:446
Constants.FP_PrintLowRes int
Value:447
Constants.FP_PrintThumbnails int
Value:448
Constants.FP_PrinterName int
Value:449
Constants.FP_PrintScale int
Value:450
Constants.FP_PrintFileName int
Value:451
Constants.FP_PrintDitavalFileName int
Value:2343
Constants.FP_PrintScope int
Value:452
Constants.FV_PR_ALL int
Value:1
Property name Data Type
185
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_PR_RANGE int
Value:2
Constants.FP_PrintEndPage int
Value:453
Constants.FP_PrintEndPoint int
Value:454
Constants.FP_PrintEvenPages int
Value:455
Constants.FP_PrintLastSheetFirst int
Value:456
Constants.FP_PrintRegistrationMarks int
Value:457
Constants.FP_PrintManualFeed int
Value:458
Constants.FP_PrintNumCopies int
Value:459
Constants.FP_PrintToFile int
Value:460
Constants.FP_PrintPaperWidth int
Value:461
Constants.FP_PrintPaperHeight int
Value:462
Constants.FP_PrintSeps int
Value:463
Constants.FP_SkipBlankSeps int
Value:464
Constants.FP_PrintImaging int
Value:465
Constants.FV_IMG_POSITIVE int
Value:0
Constants.FV_IMG_NEGATIVE int
Value:1
Constants.FP_PrintEmulsion int
Value:466
Property name Data Type
186
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_EMUL_UP int
Value:0
Constants.FV_EMUL_DOWN int
Value:1
Constants.FP_PrintBlankPages int
Value:467
Constants.FP_PrintTomboMarks int
Value:468
Constants.FP_PrintRegMarkDate int
Value:469
Constants.FP_TrapwiseCompatibility int
Value:495
Constants.FP_DownloadFonts int
Value:496
Constants.FP_PrintSpotBW int
Value:498
Constants.FV_PR_DOWNLOAD_NONE int
Value:1
Constants.FV_PR_DOWNLOAD_ALL int
Value:2
Constants.FV_PR_DOWNLOAD_ALL_B
UT_STANDARD_13
int
Value:3
Constants.FV_PR_DOWNLOAD_ALL_B
UT_STANDARD_35
int
Value:4
Constants.FP_PrintDownloadAsianFon
ts
int
Value:501
Constants.FP_PrintDownloadTrueType
AsType1
int
Value:502
Constants.FP_GenerateAcrobatInfo int
Value:2250
Constants.FP_AcrobatBookmarkDispla
yTags
int
Value:2251
Constants.FP_DocAcrobatDefaultsCha
nged
int
Value:2252
Property name Data Type
187
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_DocAcrobatElements int
Value:2253
Constants.FP_DocAcrobatElementList int
Value:2254
Constants.FP_DocAcrobatNoArticleTh
reads
int
Value:2255
Constants.FP_DocAcrobatColumnArtic
leThreads
int
Value:2256
Constants.FP_PDFAllNamedDestinatio
ns
int
Value:2257
Constants.FP_PDFDestsMarked int
Value:2258
Constants.FP_PDFStructure int
Value:2259
Constants.FP_PDFDocInfo int
Value:2260
Constants.FP_PDFBookmark int
Value:2261
Constants.FP_FileInfoPacket int
Value:2262
Constants.FP_PDFJobOption int
Value:2263
Constants.FP_PDFOpenPage int
Value:2264
Constants.FP_PDFZoomType int
Value:2265
Constants.FV_PDFZoomNone int
Value:0
Constants.FV_PDFZoomDefault int
Value:1
Constants.FV_PDFZoomPage int
Value:2
Constants.FV_PDFZoomWidth int
Value:3
Property name Data Type
188
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_PDFZoomHeight int
Value:4
Constants.FV_PDFZoomMaxValue int
Value:4
Constants.FV_PDFRegistrationMarksN
one
int
Value:0
Constants.FV_PDFRegistrationMarksW
estern
int
Value:1
Constants.FV_PDFRegistrationMarksT
ombo
int
Value:2
Constants.FV_PDFRegistrationMarksM
ax
int
Value:2
Constants.FP_PDFZoomFactor int
Value:2266
Constants.FP_PDFSeparateFiles int
Value:2267
Constants.FP_PDFRegistrationMarks int
Value:2268
Constants.FP_PDFPageWidth int
Value:2269
Constants.FP_PDFPageHeight int
Value:2270
Constants.FP_PDFPrintPageRange int
Value:2271
Constants.FP_PDFStartPage int
Value:2272
Constants.FP_PDFEndPage int
Value:2273
Constants.FP_PDFConvertCMYKtoRGB int
Value:2274
Constants.FP_PDFBookmarksOpenLev
el
int
Value:2275
Constants.FP_PDFDistillerAbsent int
Value:2276
Property name Data Type
189
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_PDFJobOptionsAbsent int
Value:2277
Constants.FP_PDFViewPDF int
Value:2278
Constants.FP_PDFGenerateForReview int
Value:2279
Constants.FV_PDFBookmarksOpenDef
aultLevel
int
Value:-1
Constants.FV_PDFBookmarksOpenAllL
evels
int
Value:-2
Constants.FV_PDFBookmarksOpenNo
neLevel
int
Value:-3
Constants.FP_MaxFirstIndent int
Value:472
Constants.FP_MinFirstIndent int
Value:473
Constants.FP_MaxLeftIndent int
Value:474
Constants.FP_MinLeftIndent int
Value:475
Constants.FP_MaxRightIndent int
Value:476
Constants.FP_MinRightIndent int
Value:477
Constants.FP_MaxSpaceAbove int
Value:478
Constants.FP_MinSpaceAbove int
Value:479
Constants.FP_MaxSpaceBelow int
Value:480
Constants.FP_MinSpaceBelow int
Value:481
Constants.FP_MaxLeading int
Value:482
Property name Data Type
190
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_MinLeading int
Value:483
Constants.FP_MaxFontSize int
Value:484
Constants.FP_MinFontSize int
Value:485
Constants.FP_MaxSpread int
Value:486
Constants.FP_MinSpread int
Value:487
Constants.FP_MaxTabPosition int
Value:701
Constants.FP_MinTabPosition int
Value:702
Constants.FP_MaxLeftMargin int
Value:703
Constants.FP_MinLeftMargin int
Value:704
Constants.FP_MaxRightMargin int
Value:705
Constants.FP_MinRightMargin int
Value:706
Constants.FP_MaxTopMargin int
Value:707
Constants.FP_MinTopMargin int
Value:708
Constants.FP_MaxBottomMargin int
Value:709
Constants.FP_MinBottomMargin int
Value:710
Constants.FP_MaxStretch int
Value:711
Constants.FP_MinStretch int
Value:712
Property name Data Type
191
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_MagicMarker int
Value:488
Constants.FP_XmlVersion int
Value:2800
Constants.FP_XmlEncoding int
Value:2801
Constants.FP_XmlStandAlone int
Value:2802
Constants.FV_XML_STANDALONE_YES int
Value:1
Constants.FV_XML_STANDALONE_NO int
Value:2
Constants.FV_XML_STANDALONE_NO
NE
int
Value:3
Constants.FV_XML_STANDALONE_NO
DEC
int
Value:4
Constants.FP_XmlStyleSheet int
Value:2803
Constants.FP_XmlStyleSheetList int
Value:2804
Constants.FP_XmlUseBOM int
Value:2805
Constants.FV_XML_USEBOM_YES int
Value:1
Constants.FV_XML_USEBOM_NO int
Value:2
Constants.FV_XML_USEBOM_UTF8 int
Value:3
Constants.FV_XML_USEBOM_UTF16B
E
int
Value:4
Constants.FV_XML_USEBOM_UTF16L
E
int
Value:5
Constants.FV_XML_USEBOM_UTF32B
E
int
Value:6
Property name Data Type
192
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_XML_USEBOM_UTF32L
E
int
Value:7
Constants.FP_XmlWellFormed int
Value:2806
Constants.FV_XML_WELLFORMED_YE
S
int
Value:1
Constants.FV_XML_WELLFORMED_N
O
int
Value:2
Constants.FP_XmlFileEncoding int
Value:2809
Constants.FP_XmlDocType int
Value:2810
Constants.FP_XmlPublicId int
Value:2811
Constants.FP_XmlSystemId int
Value:2812
Constants.FP_XmlLock int
Value:2841
Constants.FP_ServerUrl int
Value:2807
Constants.FP_ServerState int
Value:2808
Constants.FV_URL_CHECKED_IN int
Value:1
Constants.FV_URL_CHECKED_OUT int
Value:2
Constants.FP_KeyCatalog int
Value:2856
Constants.FP_KeyCatalogType int
Value:2857
Constants.FP_SpecifiedKeyCatalog int
Value:2858
Constants.FP_NextOpenBookInSessio
n
int
Value:490
Property name Data Type
193
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_FirstComponentInBook int
Value:491
Constants.FP_BookIsModified int
Value:492
Constants.FP_FirstSelectedComponen
tInBook
int
Value:493
Constants.FP_BookDontUpdateRefere
nces
int
Value:494
Constants.FP_BookIsViewOnly int
Value:497
Constants.FP_BookIsSelected int
Value:499
Constants.FP_TypeOfDisplayText int
Value:500
Constants.FV_BK_FILENAME int
Value:1
Constants.FV_BK_TEXT int
Value:2
Constants.FP_BookParent int
Value:515
Constants.FP_ExtractTags int
Value:516
Constants.FP_GenerateInclude int
Value:517
Constants.FP_ImportFmtInclude int
Value:518
Constants.FP_PrintInclude int
Value:519
Constants.FP_BookComponentIsGene
ratable
int
Value:520
Constants.FP_PagePrefix int
Value:521
Constants.FP_PageSuffix int
Value:522
Property name Data Type
194
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_PageSide int
Value:523
Constants.FV_BK_START_FROM_FILE int
Value:0x01
Constants.FV_BK_START_NEXT_AVAIL
ABLE
int
Value:0x02
Constants.FV_BK_START_LEFT int
Value:0x03
Constants.FV_BK_START_RIGHT int
Value:0x04
Constants.FP_PageNumComputeMeth
od
int
Value:524
Constants.FP_PgfNumComputeMetho
d
int
Value:525
Constants.FP_PrevComponentInBook int
Value:526
Constants.FP_NextComponentInBook int
Value:527
Constants.FP_InsertLinks int
Value:528
Constants.FP_ComponentIsSelected int
Value:529
Constants.FP_NextSelectedComponen
tInBook
int
Value:530
Constants.FP_BookComponentType int
Value:531
Constants.FV_BK_TOC int
Value:0
Constants.FV_BK_LIST_FIGURE int
Value:1
Constants.FV_BK_LIST_TABLE int
Value:2
Constants.FV_BK_LIST_PGF int
Value:3
Property name Data Type
195
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_BK_LIST_MARKER int
Value:4
Constants.FV_BK_LIST_MARKER_ALPH
A
int
Value:5
Constants.FV_BK_LIST_PGF_ALPHA int
Value:6
Constants.FV_BK_INDEX_STAN int
Value:7
Constants.FV_BK_INDEX_AUTHOR int
Value:8
Constants.FV_BK_INDEX_SUBJECT int
Value:9
Constants.FV_BK_INDEX_MARKER int
Value:10
Constants.FV_BK_LIST_FORMATS int
Value:11
Constants.FV_BK_LIST_REFERENCES int
Value:12
Constants.FV_BK_INDEX_FORMATS int
Value:13
Constants.FV_BK_INDEX_REFERENCES int
Value:14
Constants.FV_BK_NUM_BOOK_LIST int
Value:15
Constants.FV_BK_NOT_GENERATABLE int
Value:16
Constants.FP_ComponentDisplayText int
Value:532
Constants.FP_FirstComponentInBookC
omponent
int
Value:2324
Constants.FP_BookComponentParent int
Value:2325
Constants.FP_ExcludeBookComponen
t
int
Value:2326
Property name Data Type
196
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_BookComponentTempla
tePath
int
Value:2327
Constants.FP_BookComponentTitle int
Value:2328
Constants.FP_ComponentType int
Value:2329
Constants.FP_ComponentIsDitaMap int
Value:2331
Constants.FP_CorrespondingXmlPath int
Value:1158
Constants.FV_BK_GENERAL int
Value:0x1
Constants.FV_BK_FOLDER int
Value:0x2
Constants.FV_BK_BOOK int
Value:0x4
Constants.FV_BK_FM int
Value:0x8
Constants.FV_BK_MIF int
Value:0x10
Constants.FV_BK_XML int
Value:0x20
Constants.FV_BK_GROUP int
Value:0x40
Constants.FV_BK_DITAMAP int
Value:0x80
Constants.FV_BK_BOOKMAP int
Value:0x100
Constants.FV_BK_FILE int
Value:0x200
Constants.FP_NextBookComponentIn
DFSOrder
int
Value:2333
Constants.FP_BookComponentFileTyp
e
int
Value:2339
Property name Data Type
197
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_PrevBookComponentIn
DFSOrder
int
Value:2340
Constants.FP_BookComponentIsFolde
rWithTemplate
int
Value:2341
Constants.FP_BookComponentIsFolde
rWithoutTemplate
int
Value:2342
Constants.FP_XmlApplicationForBook
Component
int
Value:2330
Constants.FP_BookComponentSequen
ceLevel
int
Value:2353
Constants.FP_DocSequenceLevel int
Value:2356
Constants.FA_COMPONENT_MOVEUP int
Value:1
Constants.FA_COMPONENT_MOVEDO
WN
int
Value:2
Constants.FA_COMPONENT_PROMOT
E
int
Value:3
Constants.FA_COMPONENT_DEMOTE int
Value:4
Constants.FP_PgfAlignment int
Value:547
Constants.FV_PGF_LEFT int
Value:0x01
Constants.FV_PGF_RIGHT int
Value:0x02
Constants.FV_PGF_CENTER int
Value:0x03
Constants.FV_PGF_JUSTIFIED int
Value:0x04
Constants.FP_AutoNumString int
Value:548
Constants.FP_AutoNumChar int
Value:549
Property name Data Type
198
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_LetterSpace int
Value:550
Constants.FP_KeepWithPrev int
Value:551
Constants.FP_NextTag int
Value:552
Constants.FP_SpaceAbove int
Value:553
Constants.FP_TopSeparator int
Value:554
Constants.FP_LeftIndent int
Value:555
Constants.FirstInlineComponentInDoc int
Value:2897
Constants.FP_OptSpace int
Value:557
Constants.FP_Leading int
Value:558
Constants.FP_AdjHyphens int
Value:559
Constants.FP_HyphMinSuffix int
Value:560
Constants.FP_BlockLines int
Value:561
Constants.FP_PgfIsAutoNum int
Value:562
Constants.FP_NumAtEnd int
Value:563
Constants.FP_Hyphenate int
Value:564
Constants.FP_KeepWithNext int
Value:565
Constants.FP_UseNextTag int
Value:566
Property name Data Type
199
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_Start int
Value:567
Constants.FV_PGF_ANYWHERE int
Value:0x00
Constants.FV_PGF_TOP_OF_COL int
Value:0x01
Constants.FV_PGF_TOP_OF_PAGE int
Value:0x02
Constants.FV_PGF_TOP_OF_LEFT_PA
GE
int
Value:0x03
Constants.FV_PGF_TOP_OF_RIGHT_P
AGE
int
Value:0x04
Constants.FP_SpaceBelow int
Value:568
Constants.FP_BottomSeparator int
Value:569
Constants.FP_RightIndent int
Value:570
Constants.FP_MinSpace int
Value:571
Constants.FP_MaxSpace int
Value:572
Constants.FP_NumTabs int
Value:573
Constants.FP_Tabs int
Value:574
Constants.FP_HyphMinPrefix int
Value:575
Constants.FP_HyphMinWord int
Value:576
Constants.FP_Language int
Value:577
Constants.FV_LANG_NOLANGUAGE int
Value:0x00
Property name Data Type
200
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_LANG_ENGLISH int
Value:0x01
Constants.FV_LANG_BRITISH int
Value:0x02
Constants.FV_LANG_GERMAN int
Value:0x03
Constants.FV_LANG_SWISS_GERMAN int
Value:0x04
Constants.FV_LANG_FRENCH int
Value:0x05
Constants.FV_LANG_CANADIAN_FREN
CH
int
Value:0x06
Constants.FV_LANG_SPANISH int
Value:0x07
Constants.FV_LANG_CATALAN int
Value:0x08
Constants.FV_LANG_ITALIAN int
Value:0x09
Constants.FV_LANG_PORTUGUESE int
Value:0x0A
Constants.FV_LANG_BRAZILIAN int
Value:0x0B
Constants.FV_LANG_DANISH int
Value:0x0C
Constants.FV_LANG_DUTCH int
Value:0x0D
Constants.FV_LANG_NORWEGIAN int
Value:0x0E
Constants.FV_LANG_NYNORSK int
Value:0x0F
Constants.FV_LANG_FINNISH int
Value:0x10
Constants.FV_LANG_SWEDISH int
Value:0x11
Property name Data Type
201
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_LANG_JAPANESE int
Value:0x12
Constants.FV_LANG_TRADITIONAL_C
HINESE
int
Value:0x13
Constants.FV_LANG_SIMPLIFIED_CHI
NESE
int
Value:0x14
Constants.FV_LANG_KOREAN int
Value:0x15
Constants.FV_LANG_NEW_GERMAN int
Value:0x16
Constants.FV_LANG_NEW_SWISS_GE
RMAN
int
Value:0x17
Constants.FV_LANG_NEW_DUTCH int
Value:0x18
Constants.FV_LANG_GREEK int
Value:0x19
Constants.FV_LANG_RUSSIAN int
Value:0x1A
Constants.FV_LANG_CZECH int
Value:0x1B
Constants.FV_LANG_POLISH int
Value:0x1C
Constants.FV_LANG_HUNGARIAN int
Value:0x1D
Constants.FV_LANG_TURKISH int
Value:0x1E
Constants.FV_LANG_SLOVAK int
Value:0x1F
Constants.FV_LANG_SLOVENIAN int
Value:0x20
Constants.FV_LANG_BULGARIAN int
Value:0x21
Constants.FV_LANG_CROATIAN int
Value:0x22
Property name Data Type
202
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_LANG_ESTONIAN int
Value:0x23
Constants.FV_LANG_LATVIAN int
Value:0x24
Constants.FV_LANG_LITHUANIAN int
Value:0x25
Constants.FV_LANG_ROMANIAN int
Value:0x26
Constants.FV_LANG_NUM int
Value:0x27
Constants.FP_RunInSeparator int
Value:578
Constants.FP_Placement int
Value:579
Constants.FV_PGF_SIDEBODY int
Value:0
Constants.FV_PGF_SIDEHEAD_TOP int
Value:1
Constants.FV_PGF_SIDEHEAD_FIRST_
BASELINE
int
Value:2
Constants.FV_PGF_SIDEHEAD_LAST_B
ASELINE
int
Value:3
Constants.FV_PGF_RUN_IN int
Value:4
Constants.FV_PGF_STRADDLE int
Value:5
Constants.FV_PGF_STRADDLE_NORM
AL_ONLY
int
Value:6
Constants.FP_NextPgfFmtInDoc int
Value:580
Constants.FP_CellTopMargin int
Value:581
Constants.FP_CellBottomMargin int
Value:582
Property name Data Type
203
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_CellLeftMargin int
Value:583
Constants.FP_CellRightMargin int
Value:584
Constants.FP_CellVAlignment int
Value:585
Constants.FV_PGF_V_ALIGN_TOP int
Value:0
Constants.FV_PGF_V_ALIGN_MIDDLE int
Value:1
Constants.FV_PGF_V_ALIGN_BOTTOM int
Value:2
Constants.FP_CellMarginsFixed int
Value:586
Constants.FV_PGF_FIXED_L_MARGIN int
Value:0x01
Constants.FV_PGF_FIXED_B_MARGIN int
Value:0x02
Constants.FV_PGF_FIXED_R_MARGIN int
Value:0x04
Constants.FV_PGF_FIXED_T_MARGIN int
Value:0x08
Constants.FP_LineSpacing int
Value:587
Constants.FV_PGF_FIXED int
Value:0x00
Constants.FV_PGF_PROPORTIONAL int
Value:0x01
Constants.FV_PGF_FLOATING int
Value:0x02
Constants.FP_Locked int
Value:588
Constants.FP_AcrobatLevel int
Value:589
Property name Data Type
204
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_PDFStructureLevel int
Value:600
Constants.FP_FormatOverride int
Value:590
Constants.FP_MinJRomSpace int
Value:591
Constants.FP_OptJRomSpace int
Value:592
Constants.FP_MaxJRomSpace int
Value:593
Constants.FP_MinJLetSpace int
Value:594
Constants.FP_OptJLetSpace int
Value:595
Constants.FP_MaxJLetSpace int
Value:596
Constants.FP_YakumonoType int
Value:597
Constants.FV_FLOATING_YAKUMONO int
Value:0x00
Constants.FV_MONOSPACE_YAKUMO
NO
int
Value:0x01
Constants.FV_FIXED_YAKUMONO int
Value:0x02
Constants.FP_DialogEncodingName int
Value:598
Constants.FP_FMInterfaceEncodingNa
me
int
Value:599
Constants.FP_CharTag int
Value:602
Constants.FP_NextCharFmtInDoc int
Value:603
Constants.FP_FontFamily int
Value:604
Property name Data Type
205
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_FontVariation int
Value:605
Constants.FP_FontWeight int
Value:606
Constants.FP_FontAngle int
Value:607
Constants.FP_Underlining int
Value:608
Constants.FV_CB_NO_UNDERLINE int
Value:0
Constants.FV_CB_SINGLE_UNDERLINE int
Value:1
Constants.FV_CB_DOUBLE_UNDERLIN
E
int
Value:2
Constants.FV_CB_NUMERIC_UNDERLI
NE
int
Value:3
Constants.FP_Strikethrough int
Value:609
Constants.FP_Overline int
Value:610
Constants.FP_ChangeBar int
Value:611
Constants.FP_Outline int
Value:612
Constants.FP_Shadow int
Value:613
Constants.FP_PairKern int
Value:614
Constants.FP_FontSize int
Value:615
Constants.FP_KernX int
Value:616
Constants.FP_KernY int
Value:617
Property name Data Type
206
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_Spread int
Value:618
Constants.FP_Capitalization int
Value:619
Constants.FV_CAPITAL_CASE_NORM int
Value:0
Constants.FV_CAPITAL_CASE_SMALL int
Value:1
Constants.FV_CAPITAL_CASE_LOWER int
Value:2
Constants.FV_CAPITAL_CASE_UPPER int
Value:3
Constants.FP_Position int
Value:620
Constants.FV_POS_NORM int
Value:0
Constants.FV_POS_SUPER int
Value:1
Constants.FV_POS_SUB int
Value:2
Constants.FP_BkColor int
Value:992
Constants.FP_ReviewerName int
Value:993
Constants.FP_ReviewTime int
Value:994
Constants.FP_UseFontFamily int
Value:621
Constants.FP_UseFontVariation int
Value:622
Constants.FP_UseFontWeight int
Value:623
Constants.FP_UseFontAngle int
Value:624
Property name Data Type
207
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_UseUnderlining int
Value:625
Constants.FP_UseStrikethrough int
Value:626
Constants.FP_UseOverline int
Value:627
Constants.FP_UseChangeBar int
Value:628
Constants.FP_UseOutline int
Value:629
Constants.FP_UseShadow int
Value:630
Constants.FP_UsePairKern int
Value:631
Constants.FP_UseFontSize int
Value:632
Constants.FP_UseKernX int
Value:633
Constants.FP_UseKernY int
Value:634
Constants.FP_UseSpread int
Value:635
Constants.FP_UseCapitalization int
Value:636
Constants.FP_UsePosition int
Value:637
Constants.FP_UseColor int
Value:638
Constants.FP_UseBkColor int
Value:991
Constants.FP_FontPlatformName int
Value:639
Constants.FP_FontPostScriptName int
Value:640
Property name Data Type
208
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_FontPanoseName int
Value:641
Constants.FP_FontEncodingName int
Value:642
Constants.FP_Stretch int
Value:643
Constants.FP_UseStretch int
Value:644
Constants.FP_UseLanguage int
Value:645
Constants.FP_WesternFontPlatformNa
me
int
Value:646
Constants.FP_WesternFontPostScript
Name
int
Value:647
Constants.FP_WesternFontPanoseNa
me
int
Value:648
Constants.FP_Tsume int
Value:649
Constants.FP_UseTsume int
Value:650
Constants.FV_TAB_LEFT int
Value:0x1
Constants.FV_TAB_CENTER int
Value:0x2
Constants.FV_TAB_RIGHT int
Value:0x3
Constants.FV_TAB_DECIMAL int
Value:0x4
Constants.FV_TAB_RELATIVE_LEFT int
Value:0x5
Constants.FV_TAB_RELATIVE_CENTER int
Value:0x6
Constants.FV_TAB_RELATIVE_RIGHT int
Value:0x7
Property name Data Type
209
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_TAB_RELATIVE_DECIMA
L
int
Value:0x8
Constants.FP_PageNum int
Value:687
Constants.FP_PointPageNum int
Value:688
Constants.FP_PageBackground int
Value:689
Constants.FV_BGD_DEFAULT int
Value:0x00
Constants.FV_BGD_NONE int
Value:0x01
Constants.FV_BGD_OTHER int
Value:0x02
Constants.FP_MasterPage int
Value:690
Constants.FP_PageWidth int
Value:691
Constants.FP_PageHeight int
Value:692
Constants.FP_PagePrev int
Value:693
Constants.FP_PageNext int
Value:694
Constants.FP_PageFrame int
Value:695
Constants.FP_PageNumString int
Value:696
Constants.FP_PageIsRecto int
Value:697
Constants.FP_NextPgfInDoc int
Value:716
Constants.FP_NextPgfInFlow int
Value:717
Property name Data Type
210
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_PrevPgfInFlow int
Value:718
Constants.FP_PgfNumber int
Value:719
Constants.FP_PgfSpellChecked int
Value:720
Constants.FP_PgfSplit int
Value:721
Constants.FP_PgfMarkedForNamedDe
stination
int
Value:722
Constants.FP_BorderWidth int
Value:740
Constants.FP_Fill int
Value:741
Constants.FV_FILL_BLACK int
Value:0
Constants.FV_FILL_WHITE int
Value:7
Constants.FV_FILL_CLEAR int
Value:15
Constants.FP_Pen int
Value:742
Constants.FP_HeadArrow int
Value:743
Constants.FP_TailArrow int
Value:744
Constants.FP_ArrowTipAngle int
Value:745
Constants.FP_ArrowBaseAngle int
Value:746
Constants.FP_ArrowScaleFactor int
Value:747
Constants.FP_ArrowLength int
Value:748
Property name Data Type
211
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_ArrowType int
Value:749
Constants.FV_ARROW_STICK int
Value:0x1
Constants.FV_ARROW_HOLLOW int
Value:0x2
Constants.FV_ARROW_FILLED int
Value:0x3
Constants.FP_ArrowScaleHead int
Value:750
Constants.FP_Color int
Value:751
Constants.FP_Dash int
Value:752
Constants.FP_LineCap int
Value:753
Constants.FV_CAP_BUTT int
Value:0x00
Constants.FV_CAP_ROUND int
Value:0x01
Constants.FV_CAP_SQUARE int
Value:0x02
Constants.FP_RunaroundGap int
Value:754
Constants.FP_TintPercent int
Value:755
Constants.FP_Overprint int
Value:756
Constants.FV_KNOCKOUT int
Value:0x00
Constants.FV_OVERPRINT int
Value:0x01
Constants.FV_FROMCOLOR int
Value:0x02
Property name Data Type
212
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_UseBorderWidth int
Value:3001
Constants.FP_UseFill int
Value:3002
Constants.FP_UsePen int
Value:3003
Constants.FP_UseRunaroundGap int
Value:3004
Constants.FP_UseTintPercent int
Value:3005
Constants.FP_UseOverprint int
Value:3006
Constants.FP_UseAngle int
Value:3007
Constants.FP_UseLocX int
Value:3008
Constants.FP_UseLocY int
Value:3009
Constants.FP_UseWidth int
Value:3010
Constants.FP_UseHeight int
Value:3011
Constants.FP_UseRunaround int
Value:3012
Constants.FP_UseAnchorType int
Value:3013
Constants.FP_UseAFrameIsFloating int
Value:3014
Constants.FP_UseAFrameIsCropped int
Value:3015
Constants.FP_UseSideOffset int
Value:3016
Constants.FP_UseBaselineOffset int
Value:3017
Property name Data Type
213
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_UseAlignment int
Value:3018
Constants.FP_UseNumColumns int
Value:3019
Constants.FP_UseColGapWidth int
Value:3020
Constants.FP_UseSideHeadWidth int
Value:3021
Constants.FP_UseSideHeadGap int
Value:3022
Constants.FP_UseTheta int
Value:3023
Constants.FP_UseDTheta int
Value:3024
Constants.FP_UseTextLineType int
Value:3025
Constants.FP_UseMathSize int
Value:3026
Constants.FP_UseInsetDpi int
Value:3027
Constants.FP_UseColumnsAreBalance
d
int
Value:3028
Constants.FP_UseSideHeadPlacement int
Value:3029
Constants.FP_UseRadius int
Value:3030
Constants.FP_UseFlowIsAutoConnect int
Value:3031
Constants.FP_UseFlowIsPostScript int
Value:3032
Constants.FP_FirstGraphicsFmtInDoc int
Value:3101
Constants.FP_NextGraphicsFmtInDoc int
Value:3102
Property name Data Type
214
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_StyleTag int
Value:770
Constants.FP_GraphicIsSelected int
Value:771
Constants.FP_GraphicCantBeSelected int
Value:772
Constants.FP_GraphicIsButton int
Value:773
Constants.FP_FrameParent int
Value:774
Constants.FP_PrevGraphicInFrame int
Value:775
Constants.FP_NextGraphicInFrame int
Value:776
Constants.FP_GroupParent int
Value:777
Constants.FP_PrevGraphicInGroup int
Value:778
Constants.FP_NextGraphicInGroup int
Value:779
Constants.FP_Angle int
Value:780
Constants.FP_LocX int
Value:781
Constants.FP_LocY int
Value:782
Constants.FP_Width int
Value:783
Constants.FP_Height int
Value:784
Constants.FP_NextSelectedGraphicInD
oc
int
Value:785
Constants.FP_NextGraphicInDoc int
Value:786
Property name Data Type
215
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_Runaround int
Value:787
Constants.FV_TR_NONE int
Value:0x01
Constants.FV_TR_CONTOUR int
Value:0x02
Constants.FV_TR_BBOX int
Value:0x03
Constants.FP_DesktopX int
Value:788
Constants.FP_DesktopY int
Value:789
Constants.FP_DesktopWidth int
Value:790
Constants.FP_DesktopHeight int
Value:791
Constants.FP_IsHotspot int
Value:2875
Constants.FP_HotspotCmdStr int
Value:2876
Constants.FP_HotspotTitle int
Value:2877
Constants.FP_FirstGraphicInGroup int
Value:807
Constants.FP_LastGraphicInGroup int
Value:808
Constants.FP_DTheta int
Value:830
Constants.FP_Theta int
Value:831
Constants.FP_InsetEditor int
Value:850
Constants.FP_InsetUpdater int
Value:851
Property name Data Type
216
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_InsetFile int
Value:852
Constants.FP_InsetFileOrigName int
Value:2814
Constants.FP_InsetDpi int
Value:853
Constants.FP_InsetIsFixedSize int
Value:854
Constants.FP_InsetIsFlippedSideways int
Value:855
Constants.FP_InsetIsInverted int
Value:856
Constants.FP_InsetRasterDpi int
Value:857
Constants.FP_INSETinfo int
Value:858
Constants.FP_InsetPosterIsExternal int
Value:2821
Constants.FP_InsetPosterFile int
Value:2822
Constants.FP_InsetSaveDIBFacetToFile int
Value:2823
Constants.FP_InsetPosterFileOrigNam
e
int
Value:2824
Constants.FP_InsetSaveFacetToFile int
Value:2839
Constants.FP_InsetU3dAnimationList int
Value:2844
Constants.FP_InsetU3dPartList int
Value:2845
Constants.FP_InsetU3dViewList int
Value:2846
Constants.FP_InsetCuePointList int
Value:2354
Property name Data Type
217
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_InsetLinkToText int
Value:2355
Constants.FP_MathFullForm int
Value:865
Constants.FP_MathSize int
Value:866
Constants.FV_MATH_MEDIUM int
Value:0
Constants.FV_MATH_SMALL int
Value:1
Constants.FV_MATH_LARGE int
Value:2
Constants.FP_AnchorType int
Value:875
Constants.FV_ANCHOR_INLINE int
Value:1
Constants.FV_ANCHOR_TOP int
Value:2
Constants.FV_ANCHOR_BELOW int
Value:3
Constants.FV_ANCHOR_BOTTOM int
Value:4
Constants.FV_ANCHOR_SUBCOL_LEFT int
Value:5
Constants.FV_ANCHOR_SUBCOL_RIG
HT
int
Value:6
Constants.FV_ANCHOR_SUBCOL_NEA
REST
int
Value:7
Constants.FV_ANCHOR_SUBCOL_FART
HEST
int
Value:8
Constants.FV_ANCHOR_SUBCOL_INSI
DE
int
Value:9
Constants.FV_ANCHOR_SUBCOL_OUT
SIDE
int
Value:10
Property name Data Type
218
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_ANCHOR_TEXTFRAME_
LEFT
int
Value:11
Constants.FV_ANCHOR_TEXTFRAME_
RIGHT
int
Value:12
Constants.FV_ANCHOR_TEXTFRAME_
NEAREST
int
Value:13
Constants.FV_ANCHOR_TEXTFRAME_
FARTHEST
int
Value:14
Constants.FV_ANCHOR_TEXTFRAME_I
NSIDE
int
Value:15
Constants.FV_ANCHOR_TEXTFRAME_
OUTSIDE
int
Value:16
Constants.FV_ANCHOR_RUN_INTO_P
ARAGRAPH
int
Value:17
Constants.FP_AFrameIsFloating int
Value:876
Constants.FP_SideOffset int
Value:877
Constants.FP_AFrameIsCropped int
Value:878
Constants.FP_TextLoc int
Value:879
Constants.FP_PageFramePage int
Value:880
Constants.FP_BaselineOffset int
Value:881
Constants.FP_FirstGraphicInFrame int
Value:882
Constants.FP_LastGraphicInFrame int
Value:883
Constants.FP_PrevAFrame int
Value:884
Constants.FP_NextAFrame int
Value:885
Property name Data Type
219
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_Alignment int
Value:886
Constants.FV_ALIGN_LEFT int
Value:0
Constants.FV_ALIGN_CENTER int
Value:1
Constants.FV_ALIGN_RIGHT int
Value:2
Constants.FV_ALIGN_INSIDE int
Value:3
Constants.FV_ALIGN_OUTSIDE int
Value:4
Constants.FP_MifFileEntity int
Value:2828
Constants.FP_MifFileName int
Value:2829
Constants.FP_MifFileOrigFormat int
Value:2878
Constants.FP_PolyIsBezier int
Value:906
Constants.FP_NumPoints int
Value:907
Constants.FP_Points int
Value:908
Constants.FP_RectangleIsSmoothed int
Value:929
Constants.FP_Radius int
Value:950
Constants.FP_FirstPgf int
Value:972
Constants.FP_LastPgf int
Value:973
Constants.FP_FirstAFrame int
Value:974
Property name Data Type
220
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_LastAFrame int
Value:975
Constants.FP_FirstFn int
Value:976
Constants.FP_LastFn int
Value:977
Constants.FP_FirstCell int
Value:978
Constants.FP_LastCell int
Value:979
Constants.FP_PrevTextFrameInFlow int
Value:980
Constants.FP_NextTextFrameInFlow int
Value:981
Constants.FP_Flow int
Value:982
Constants.FP_NumColumns int
Value:984
Constants.FP_ColGapWidth int
Value:985
Constants.FP_FirstSubCol int
Value:986
Constants.FP_LastSubCol int
Value:987
Constants.FP_LineSpacingFactor int
Value:988
Constants.FP_PgfSpacingFactor int
Value:989
Constants.FP_CellMarginSpacingDelta int
Value:990
Constants.FP_SideHeadPlacement int
Value:1171
Constants.FV_SH_LEFT int
Value:0x00
Property name Data Type
221
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_SH_RIGHT int
Value:0x01
Constants.FV_SH_INSIDE int
Value:0x02
Constants.FV_SH_OUTSIDE int
Value:0x03
Constants.FP_SideHeadWidth int
Value:1172
Constants.FP_SideHeadGap int
Value:1173
Constants.FP_ColumnsAreBalanced int
Value:1175
Constants.FP_InTextObj int
Value:1000
Constants.FP_InTextFrame int
Value:1001
Constants.FP_FnNum int
Value:1002
Constants.FP_NextFnInDoc int
Value:1003
Constants.FP_PrevFn int
Value:1004
Constants.FP_NextFn int
Value:1005
Constants.FP_FnAnchorString int
Value:1006
Constants.FP_OldTypeNum int
Value:1024
Constants.FP_MarkerText int
Value:1025
Constants.FP_NextMarkerInDoc int
Value:1026
Constants.FP_MarkerTypeId int
Value:1027
Property name Data Type
222
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_NextMarkerTypeInDoc int
Value:1028
Constants.FP_InvariantName int
Value:1029
Constants.FP_Public int
Value:1030
Constants.FP_Transient int
Value:1031
Constants.FP_Required int
Value:1032
Constants.FP_NextVarInDoc int
Value:1046
Constants.FP_VarFmt int
Value:1047
Constants.FP_SystemVar int
Value:1049
Constants.FV_VAR_USER_VARIABLE int
Value:0
Constants.FV_VAR_CURRENT_PAGE_N
UM
int
Value:1
Constants.FV_VAR_PAGE_COUNT int
Value:2
Constants.FV_VAR_CURRENT_DATE_L
ONG
int
Value:3
Constants.FV_VAR_CURRENT_DATE_S
HORT
int
Value:4
Constants.FV_VAR_MODIFICATION_D
ATE_LONG
int
Value:5
Constants.FV_VAR_MODIFICATION_D
ATE_SHORT
int
Value:6
Constants.FV_VAR_CREATION_DATE_L
ONG
int
Value:7
Constants.FV_VAR_CREATION_DATE_S
HORT
int
Value:8
Property name Data Type
223
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_VAR_FILE_NAME_LONG int
Value:9
Constants.FV_VAR_FILE_NAME_SHOR
T
int
Value:10
Constants.FV_VAR_HEADER_FOOTER_
1
int
Value:11
Constants.FV_VAR_HEADER_FOOTER_
2
int
Value:12
Constants.FV_VAR_HEADER_FOOTER_
3
int
Value:13
Constants.FV_VAR_HEADER_FOOTER_
4
int
Value:14
Constants.FV_VAR_TABLE_CONTINUA
TION
int
Value:15
Constants.FV_VAR_TABLE_SHEET int
Value:16
Constants.FV_VAR_HEADER_FOOTER_
5
int
Value:19
Constants.FV_VAR_HEADER_FOOTER_
6
int
Value:20
Constants.FV_VAR_HEADER_FOOTER_
7
int
Value:21
Constants.FV_VAR_HEADER_FOOTER_
8
int
Value:22
Constants.FV_VAR_HEADER_FOOTER_
9
int
Value:23
Constants.FV_VAR_HEADER_FOOTER_
10
int
Value:24
Constants.FV_VAR_HEADER_FOOTER_
11
int
Value:25
Constants.FV_VAR_HEADER_FOOTER_
12
int
Value:26
Constants.FV_VAR_HEADER_FOOTER_
13
int
Value:27
Property name Data Type
224
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_VAR_HEADER_FOOTER_
14
int
Value:28
Constants.FV_VAR_HEADER_FOOTER_
15
int
Value:29
Constants.FV_VAR_HEADER_FOOTER_
16
int
Value:30
Constants.FV_VAR_HEADER_FOOTER_
17
int
Value:31
Constants.FV_VAR_HEADER_FOOTER_
18
int
Value:32
Constants.FP_Fmt int
Value:1050
Constants.FP_NextVarFmtInDoc int
Value:1051
Constants.FP_XRefFile int
Value:1070
Constants.FP_TextRange int
Value:1071
Constants.FP_NextXRefInDoc int
Value:1072
Constants.FP_XRefFmt int
Value:1073
Constants.FP_XRefSrcText int
Value:1075
Constants.FP_XRefSrcIsElem int
Value:1076
Constants.FP_XRefIsUnresolved int
Value:1077
Constants.FP_XRefSrcElemNonUnique
Id
int
Value:1152
Constants.FP_XRefAltText int
Value:1153
Constants.FP_XRefClientName int
Value:1154
Property name Data Type
225
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_XRefClientType int
Value:1155
Constants.FP_XRefResolvedWithKeyre
f
int
Value:1156
Constants.FP_XRefRetainKeydefText int
Value:1157
Constants.FP_NextXRefFmtInDoc int
Value:1074
Constants.FP_TextLineType int
Value:1095
Constants.FV_TEXTLINE_LEFT int
Value:0
Constants.FV_TEXTLINE_RIGHT int
Value:1
Constants.FV_TEXTLINE_CENTER int
Value:2
Constants.FV_TEXTLINE_MATH int
Value:3
Constants.FP_BasePointX int
Value:1116
Constants.FP_BasePointY int
Value:1117
Constants.FP_NextCondFmtInDoc int
Value:1138
Constants.FP_CondFmtIsShown int
Value:1139
Constants.FP_SepOverride int
Value:1140
Constants.FP_UseSepOverride int
Value:1141
Constants.FP_StyleOverride int
Value:1142
Constants.FV_CN_NO_OVERRIDE int
Value:0
Property name Data Type
226
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_CN_OVERLINE int
Value:1
Constants.FV_CN_STRIKETHROUGH int
Value:2
Constants.FV_CN_SINGLE_UNDERLINE int
Value:3
Constants.FV_CN_DOUBLE_UNDERLIN
E
int
Value:4
Constants.FV_CN_CHANGEBAR int
Value:5
Constants.FV_CN_NUMERIC_UNDERLI
NE
int
Value:6
Constants.FV_CN_NMRIC_AND_CHNG
BAR
int
Value:7
Constants.FP_NextAttrCondExprInDoc int
Value:2816
Constants.FP_AttrCondExprStr int
Value:2817
Constants.FP_AttrCondExprIsActive int
Value:2818
Constants.FP_InCond int
Value:1150
Constants.FP_StyleOverrides int
Value:1151
Constants.FV_CS_NO_OVERRIDE int
Value:0x00
Constants.FV_CS_OVERLINE int
Value:0x01
Constants.FV_CS_STRIKETHROUGH int
Value:0x02
Constants.FV_CS_SINGLE_UNDERLINE int
Value:0x04
Constants.FV_CS_DOUBLE_UNDERLIN
E
int
Value:0x08
Property name Data Type
227
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_CS_CHANGEBAR int
Value:0x10
Constants.FV_CS_NUMERIC_UNDERLI
NE
int
Value:0x20
Constants.FP_NextFlowInDoc int
Value:1162
Constants.FP_FlowIsSynchronized int
Value:1163
Constants.FP_MinHang int
Value:1164
Constants.FP_FlowIsAutoConnect int
Value:1165
Constants.FP_FlowIsFeathered int
Value:1166
Constants.FP_Spacing int
Value:1167
Constants.FP_FlowIsPostScript int
Value:1168
Constants.FP_FirstTextFrameInFlow int
Value:1169
Constants.FP_LastTextFrameInFlow int
Value:1170
Constants.FP_SideHeadRoomInFlow int
Value:1174
Constants.FP_MaxInterlinePadding int
Value:470
Constants.FP_MaxInterPgfPadding int
Value:471
Constants.FP_CellUseOverrideLRuling int
Value:1190
Constants.FP_CellUseOverrideRRuling int
Value:1191
Constants.FP_CellUseOverrideTRuling int
Value:1192
Property name Data Type
228
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_CellUseOverrideBRuling int
Value:1193
Constants.FP_CellOverrideShading int
Value:1194
Constants.FP_CellOverrideFill int
Value:1195
Constants.FP_CellUseOverrideFill int
Value:1196
Constants.FP_CellUseOverrideShading int
Value:1197
Constants.FP_CellRow int
Value:1198
Constants.FP_NextCellInTbl int
Value:1199
Constants.FP_CellBelowInTbl int
Value:1200
Constants.FP_PrevCellInRow int
Value:1201
Constants.FP_NextCellInRow int
Value:1202
Constants.FP_CellAboveInCol int
Value:1203
Constants.FP_CellBelowInCol int
Value:1204
Constants.FP_CellColNum int
Value:1205
Constants.FP_CellIsStraddled int
Value:1206
Constants.FP_CellNumRowsStraddled int
Value:1207
Constants.FP_CellNumColsStraddled int
Value:1208
Constants.FP_CellAngle int
Value:1209
Property name Data Type
229
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_CellOverrideTopRuling int
Value:1210
Constants.FP_CellOverrideBottomRuli
ng
int
Value:1211
Constants.FP_CellOverrideLeftRuling int
Value:1212
Constants.FP_CellOverrideRightRuling int
Value:1213
Constants.FP_CellDefaultTopRuling int
Value:1214
Constants.FP_CellDefaultBottomRulin
g
int
Value:1215
Constants.FP_CellDefaultLeftRuling int
Value:1216
Constants.FP_CellDefaultRightRuling int
Value:1217
Constants.FP_CellIsShown int
Value:1218
Constants.FP_PrevCell int
Value:1219
Constants.FP_NextCell int
Value:1220
Constants.FP_PrevRowInTbl int
Value:1244
Constants.FP_NextRowInTbl int
Value:1245
Constants.FP_RowTbl int
Value:1246
Constants.FP_FirstCellInRow int
Value:1247
Constants.FP_RowKeepWithNext int
Value:1248
Constants.FP_RowKeepWithPrev int
Value:1249
Property name Data Type
230
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_RowMaxHeight int
Value:1250
Constants.FP_RowMinHeight int
Value:1251
Constants.FP_RowStart int
Value:1252
Constants.FV_ROW_ANYWHERE int
Value:0
Constants.FV_ROW_TOP_OF_COL int
Value:1
Constants.FV_ROW_TOP_OF_PAGE int
Value:2
Constants.FV_ROW_TOP_OF_LEFT_PA
GE
int
Value:3
Constants.FV_ROW_TOP_OF_RIGHT_
PAGE
int
Value:4
Constants.FP_RowType int
Value:1253
Constants.FV_ROW_HEADING int
Value:0
Constants.FV_ROW_BODY int
Value:1
Constants.FV_ROW_FOOTING int
Value:2
Constants.FP_RowIsShown int
Value:1254
Constants.FP_TblTag int
Value:1275
Constants.FP_NextTblFmtInDoc int
Value:1276
Constants.FP_TblLeftIndent int
Value:1278
Constants.FP_TblRightIndent int
Value:1279
Property name Data Type
231
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_TblSpaceAbove int
Value:1280
Constants.FP_TblSpaceBelow int
Value:1281
Constants.FP_TblAlignment int
Value:1282
Constants.FV_ALIGN_TBL_LEFT int
Value:0
Constants.FV_ALIGN_TBL_CENTER int
Value:1
Constants.FV_ALIGN_TBL_RIGHT int
Value:2
Constants.FP_TblPlacement int
Value:1283
Constants.FV_TBL_ANYWHERE int
Value:0
Constants.FV_TBL_TOP_OF_COL int
Value:1
Constants.FV_TBL_TOP_OF_PAGE int
Value:2
Constants.FV_TBL_TOP_OF_LEFT_PAG
E
int
Value:3
Constants.FV_TBL_TOP_OF_RIGHT_PA
GE
int
Value:4
Constants.FV_TBL_FLOAT int
Value:5
Constants.FP_TblInitNumCols int
Value:1284
Constants.FP_TblInitNumHRows int
Value:1285
Constants.FP_TblInitNumBodyRows int
Value:1286
Constants.FP_TblInitNumFRows int
Value:1287
Property name Data Type
232
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_TblNumbering int
Value:1288
Constants.FV_TBL_NUM_BY_ROW int
Value:0
Constants.FV_TBL_NUM_BY_COL int
Value:1
Constants.FP_TblTitlePosition int
Value:1289
Constants.FV_TBL_NO_TITLE int
Value:0
Constants.FV_TBL_TITLE_ABOVE int
Value:1
Constants.FV_TBL_TITLE_BELOW int
Value:2
Constants.FP_TblTitleGap int
Value:1290
Constants.FP_OrphanRows int
Value:1291
Constants.FP_TblCatalogEntry int
Value:1292
Constants.FP_TblColRulingPeriod int
Value:1293
Constants.FP_TblBodyRowRulingPerio
d
int
Value:1294
Constants.FP_TblLastBodyRuling int
Value:1295
Constants.FP_TblHFFill int
Value:1296
Constants.FP_TblHFColor int
Value:1297
Constants.FP_TblBodyFirstFill int
Value:1298
Constants.FP_TblBodyFirstColor int
Value:1299
Property name Data Type
233
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_TblBodyShadeBy int
Value:1300
Constants.FP_TblBodyFirstPeriod int
Value:1301
Constants.FP_TblBodyNextFill int
Value:1302
Constants.FP_TblBodyNextPeriod int
Value:1303
Constants.FP_TblBodyNextColor int
Value:1304
Constants.FP_TblTopRuling int
Value:1305
Constants.FP_TblBottomRuling int
Value:1306
Constants.FP_TblLeftRuling int
Value:1307
Constants.FP_TblRightRuling int
Value:1308
Constants.FP_TblColRuling int
Value:1309
Constants.FP_TblBodyRowRuling int
Value:1310
Constants.FP_TblHFSeparatorRuling int
Value:1311
Constants.FP_TblHFRowRuling int
Value:1312
Constants.FP_TblOtherBodyRowRulin
g
int
Value:1313
Constants.FP_TblOtherColRuling int
Value:1314
Constants.FP_TblCellTopMargin int
Value:1315
Constants.FP_TblCellBottomMargin int
Value:1316
Property name Data Type
234
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_TblCellLeftMargin int
Value:1317
Constants.FP_TblCellRightMargin int
Value:1318
Constants.FP_TblInLockedTi int
Value:1319
Constants.FP_TblNumCols int
Value:1335
Constants.FP_TblNumRows int
Value:1336
Constants.FP_NextTblInDoc int
Value:1337
Constants.FP_FirstRowInTbl int
Value:1338
Constants.FP_LastRowInTbl int
Value:1339
Constants.FP_TblWidth int
Value:1340
Constants.FP_TopRowSelection int
Value:1341
Constants.FP_BottomRowSelection int
Value:1342
Constants.FP_LeftColNum int
Value:1343
Constants.FP_RightColNum int
Value:1344
Constants.FP_TblColWidths int
Value:1345
Constants.FP_TblTitleSelected int
Value:1346
Constants.FP_NextRulingFmtInDoc int
Value:1430
Constants.FP_RulingPenWidth int
Value:1432
Property name Data Type
235
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_RulingGap int
Value:1433
Constants.FP_RulingSep int
Value:1434
Constants.FP_RulingLines int
Value:1435
Constants.FP_NextColorInDoc int
Value:1455
Constants.FP_Pantone int
Value:1456
Constants.FP_Cyan int
Value:1457
Constants.FP_Magenta int
Value:1458
Constants.FP_Yellow int
Value:1459
Constants.FP_Black int
Value:1460
Constants.FP_ColorViewCtl int
Value:1461
Constants.FV_SEP_NORMAL int
Value:0x0
Constants.FV_SEP_NONE int
Value:0x1
Constants.FV_SEP_WHITE int
Value:0x2
Constants.FP_ColorPrintCtl int
Value:1462
Constants.FV_PRINT_SPOT int
Value:0x0
Constants.FV_PRINT_PROCESS int
Value:0x1
Constants.FV_PRINT_NO int
Value:0x2
Property name Data Type
236
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_ReservedColor int
Value:1463
Constants.FV_COLOR_NOT_RESERVED int
Value:0
Constants.FV_COLOR_CYAN int
Value:1
Constants.FV_COLOR_MAGENTA int
Value:2
Constants.FV_COLOR_YELLOW int
Value:3
Constants.FV_COLOR_BLACK int
Value:4
Constants.FV_COLOR_WHITE int
Value:5
Constants.FV_COLOR_RED int
Value:6
Constants.FV_COLOR_GREEN int
Value:7
Constants.FV_COLOR_BLUE int
Value:8
Constants.FV_COLOR_DARKGREY int
Value:9
Constants.FV_COLOR_PALEGREEN int
Value:10
Constants.FV_COLOR_FORESTGREEN int
Value:11
Constants.FV_COLOR_ROYALBLUE int
Value:12
Constants.FV_COLOR_MAUVE int
Value:13
Constants.FV_COLOR_LIGHTSALMON int
Value:14
Constants.FV_COLOR_DARKYELLOW int
Value:15
Property name Data Type
237
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_COLOR_SALMON int
Value:16
Constants.FP_FamilyName int
Value:1464
Constants.FP_InkName int
Value:1465
Constants.FP_ColorTintPercent int
Value:1466
Constants.FP_TintBaseColor int
Value:1467
Constants.FV_NO_BASE_COLOR int
Value:0x00
Constants.FP_ColorOverprint int
Value:1468
Constants.FV_COLOR_KNOCKOUT int
Value:0x00
Constants.FV_COLOR_OVERPRINT int
Value:0x01
Constants.FP_NextRubiInDoc int
Value:1469
Constants.FP_OyamojiTextRange int
Value:1470
Constants.FP_RubiTextRange int
Value:1471
Constants.FP_HypertextDoValidate int
Value:2300
Constants.FP_HypertextCommandText int
Value:2301
Constants.FP_HypertextParsedArgs int
Value:2302
Constants.FP_HypertextParseErr int
Value:2303
Constants.FV_HypertextSyntaxOK int
Value:0
Property name Data Type
238
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_HypertextEmptyComma
nd
int
Value:1
Constants.FV_HypertextUnrecognized
Command
int
Value:2
Constants.FV_HypertextMissingArgum
ents
int
Value:3
Constants.FV_HypertextExtraArgumen
ts
int
Value:4
Constants.FV_HypertextBadSyntaxPat
hSpec
int
Value:10
Constants.FV_HypertextUnanchoredP
artialPath
int
Value:11
Constants.FV_HypertextHelpDirNotFo
und
int
Value:20
Constants.FV_HypertextExpectedANu
mberParam
int
Value:30
Constants.FP_HypertextValidateErr int
Value:2304
Constants.FV_HypertextValid int
Value:0
Constants.FV_HypertextUsesDefaultTe
xt
int
Value:200
Constants.FV_HypertextFileNotRegula
r
int
Value:210
Constants.FV_HypertextFileNotMaker
Doc
int
Value:211
Constants.FV_HypertextCantOpenDes
tFile
int
Value:212
Constants.FV_HypertextDestinationLi
nkNotFound
int
Value:220
Constants.FV_HypertextDuplicateLink
Name
int
Value:221
Constants.FV_HypertextPageNameNo
tFound
int
Value:230
Property name Data Type
239
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_HypertextUnrecognized
ObjectType
int
Value:240
Constants.FV_HypertextObjectIDNotF
ound
int
Value:241
Constants.FV_HypertextBadMatrixSize int
Value:250
Constants.FV_HypertextMatrixComma
ndInvalid
int
Value:251
Constants.FV_HypertextFlowMissingLi
nes
int
Value:252
Constants.FV_HypertextNoNamedFlo
w
int
Value:260
Constants.FV_HypertextRecursiveFlow int
Value:261
Constants.FV_HypertextMissingPopup
Marker
int
Value:270
Constants.FV_HypertextMissingPopup
LabelItem
int
Value:271
Constants.FV_HypertextEmptyLineIn
MiddleOfPopup
int
Value:272
Constants.FV_HypertextCommandIlle
galWithinPopup
int
Value:273
Constants.FV_HypertextFcodeInvalid int
Value:280
Constants.FP_HypertextParseBadPara
m
int
Value:2305
Constants.FP_HypertextParseErrMsg int
Value:2306
Constants.FP_HypertextParsedCmdCo
de
int
Value:2307
Constants.FV_CmdNotTyped int
Value:0
Constants.FV_CmdError int
Value:1
Property name Data Type
240
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_CmdUnknown int
Value:2
Constants.FV_CmdNoop int
Value:3
Constants.FV_CmdAlert int
Value:8
Constants.FV_CmdAlertTitle int
Value:9
Constants.FV_CmdExit int
Value:10
Constants.FV_CmdGoToLink int
Value:11
Constants.FV_CmdGoToLinkFitWin int
Value:12
Constants.FV_CmdGoToNew int
Value:13
Constants.FV_CmdGoToPage int
Value:14
Constants.FV_CmdGoToObjectId int
Value:15
Constants.FV_CmdGoToObjectIdFitWi
n
int
Value:16
Constants.FV_CmdMatrix int
Value:17
Constants.FV_CmdMessage int
Value:18
Constants.FV_CmdNewLink int
Value:19
Constants.FV_CmdNextPage int
Value:20
Constants.FV_CmdPreviousPage int
Value:21
Constants.FV_CmdOpenLink int
Value:22
Property name Data Type
241
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_CmdOpenLinkFitWin int
Value:23
Constants.FV_CmdOpenNew int
Value:24
Constants.FV_CmdOpenObjectId int
Value:25
Constants.FV_CmdOpenObjectIdFitWi
n
int
Value:26
Constants.FV_CmdOpenPage int
Value:27
Constants.FV_CmdPopup int
Value:28
Constants.FV_CmdPreviousLink int
Value:29
Constants.FV_CmdPreviousLinkFitWin int
Value:30
Constants.FV_CmdQuit int
Value:31
Constants.FV_CmdQuitAll int
Value:32
Constants.FV_CmdMultiMedia int
Value:33
Constants.FV_CmdFCodes int
Value:256
Constants.FV_CmdOutCodes int
Value:257
Constants.FV_CmdInCodes int
Value:258
Constants.FV_CmdApplyMathRules int
Value:259
Constants.FV_CmdThesaurusLookup int
Value:260
Constants.FV_CmdNative int
Value:261
Property name Data Type
242
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_CmdHelpLink int
Value:262
Constants.FV_CmdBeginRange int
Value:263
Constants.FV_CmdEndRange int
Value:264
Constants.FP_HypertextParsedCmdDe
st
int
Value:2308
Constants.FV_DestNowhere int
Value:0
Constants.FV_DestMarkerNewLink int
Value:1
Constants.FV_DestFirstPage int
Value:2
Constants.FV_DestLastPage int
Value:3
Constants.FV_DestPageNum int
Value:4
Constants.FV_DestFluidFlow int
Value:5
Constants.FV_DestMarker int
Value:6
Constants.FV_DestObjectId int
Value:7
Constants.FV_DestXRef int
Value:8
Constants.FP_HypertextParsedCmdDe
stObjType
int
Value:2309
Constants.FV_ObjectUnknown int
Value:0
Constants.FV_ObjectMarker int
Value:1
Constants.FV_ObjectPgf int
Value:2
Property name Data Type
243
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_ObjectXref int
Value:3
Constants.FV_ObjectGraphic int
Value:4
Constants.FV_ObjectElement int
Value:5
Constants.FV_ObjectTextInset int
Value:6
Constants.FV_ObjectDataLink int
Value:7
Constants.FP_HypertextParsedCmdDe
stObjID
int
Value:2310
Constants.FP_HypertextParsedCmdM
atrixRows
int
Value:2311
Constants.FP_HypertextParsedCmdM
atrixColumns
int
Value:2312
Constants.FP_HypertextParsedLinkNa
me
int
Value:2313
Constants.FP_HypertextParsedPageNa
me
int
Value:2314
Constants.FP_HypertextParsedFlowNa
me
int
Value:2315
Constants.FP_HypertextParsedRangeN
ame
int
Value:2316
Constants.FP_HypertextParsedClientN
ame
int
Value:2317
Constants.FP_HypertextParsedTitle int
Value:2318
Constants.FP_HypertextParsedMessag
e
int
Value:2319
Constants.FP_HypertextParsedDIFileN
ame
int
Value:2320
Constants.FP_FirstElementDefInDoc int
Value:1483
Property name Data Type
244
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_ElementBoundaryDispla
y
int
Value:1484
Constants.FP_BannerTextDisplay int
Value:1600
Constants.FP_BooleanConditionExpre
ssion
int
Value:2321
Constants.FP_BooleanConditionState int
Value:2322
Constants.FP_BooleanConditionExpre
ssionTag
int
Value:995
Constants.FP_IsDitamapInResourceM
anager
int
Value:2332
Constants.FP_IsDocDitamap int
Value:2879
Constants.FP_IsDocDita int
Value:2880
Constants.FP_DirectOLESupportInXml int
Value:2881
Constants.FP_DocIsStructuredDummy int
Value:2882
Constants.FP_StructuredDummyDocT
ext
int
Value:2883
Constants.FV_ELEM_DISP_NONE int
Value:0
Constants.FV_ELEM_DISP_BRACKETS int
Value:1
Constants.FV_ELEM_DISP_TAGS int
Value:2
Constants.FP_ElementCatalogDisplay int
Value:1485
Constants.FV_ELCAT_STRICT int
Value:0x00
Constants.FV_ELCAT_LOOSE int
Value:0x01
Property name Data Type
245
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_ELCAT_CHILDREN int
Value:0x02
Constants.FV_ELCAT_ALL int
Value:0x03
Constants.FV_ELCAT_CUSTOM int
Value:0x04
Constants.FP_DefaultInclusions int
Value:1486
Constants.FP_DefaultExclusions int
Value:1487
Constants.FP_ElementCatalog int
Value:1488
Constants.FP_FirstFmtChangeListInDo
c
int
Value:1489
Constants.FP_NewElemAttrDisplay int
Value:1490
Constants.FV_ATTR_DISP_NONE int
Value:1
Constants.FV_ATTR_DISP_REQSPEC int
Value:2
Constants.FV_ATTR_DISP_ALL int
Value:3
Constants.FP_NewElemAttrEditing int
Value:1491
Constants.FV_ATTR_EDIT_NONE int
Value:0
Constants.FV_ATTR_EDIT_REQUIRED int
Value:1
Constants.FV_ATTR_EDIT_ALWAYS int
Value:2
Constants.FP_UseInitialStructure int
Value:1492
Constants.FP_SeparateInclusions int
Value:1493
Property name Data Type
246
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_ElementSelection int
Value:1494
Constants.FP_StructuredApplication int
Value:1495
Constants.FP_CustomElementList int
Value:1496
Constants.FP_StructuredApplicationLi
st
int
Value:1497
Constants.FP_StructuredApplicationFo
rOpen
int
Value:1498
Constants.FP_UseInitialStructureOfAu
toInsertedElements
int
Value:1499
Constants.FP_StructAppAttrConfigFile int
Value:1500
Constants.FP_ShowElementDescriptiv
eNames
int
Value:1501
Constants.FP_BkGndColor int
Value:1502
Constants.FP_TextColor int
Value:1503
Constants.FP_DitaMode int
Value:1504
Constants.FP_XSLTTransformationScen
arioFile
int
Value:1505
Constants.FP_XSLTProcessors int
Value:1506
Constants.FV_STRICTLY_VALID int
Value:0x01
Constants.FV_LOOSELY_VALID int
Value:0x02
Constants.FV_ALTERNATIVE int
Value:0x04
Constants.FV_INCLUSION int
Value:0x08
Property name Data Type
247
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_HighestLevelElement int
Value:1509
Constants.FP_ComponentElement int
Value:1551
Constants.FP_ExtractElementTags int
Value:1552
Constants.FP_NextElementDefInDoc int
Value:1572
Constants.FP_ElementInCatalog int
Value:1573
Constants.FP_ValidHighestLevel int
Value:1574
Constants.FP_GeneralRule int
Value:1575
Constants.FP_Exclusions int
Value:1576
Constants.FP_Inclusions int
Value:1577
Constants.FP_GeneralRuleErrorOffsets int
Value:1578
Constants.FP_ElementDefType int
Value:1579
Constants.FP_Comment int
Value:1581
Constants.FP_TextFmtRules int
Value:1582
Constants.FP_ObjectFmtRules int
Value:1583
Constants.FP_AttributeDefs int
Value:1584
Constants.FP_InitStructurePattern int
Value:1585
Constants.FP_TableTagging int
Value:1585
Property name Data Type
248
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_ElementPgfFormat int
Value:1586
Constants.FP_PrefixRules int
Value:1587
Constants.FP_SuffixRules int
Value:1588
Constants.FP_FirstPgfRules int
Value:1589
Constants.FP_LastPgfRules int
Value:1590
Constants.FP_AlsoInsert int
Value:1591
Constants.FP_ParsedGeneralRule int
Value:1592
Constants.FP_ElementDataType int
Value:1593
Constants.FP_AllowedDataRange int
Value:1594
Constants.FP_AlsoInserts int
Value:1595
Constants.FP_DescriptiveTag int
Value:1596
Constants.FP_ElementDescription int
Value:1597
Constants.FP_XMLStructuredApplicati
onList
int
Value:1598
Constants.FP_BannerText int
Value:1599
Constants.FV_FO_UNSPECIFIED int
Value:0
Constants.FV_FO_TEXTNODE int
Value:0
Constants.FV_FO_CONTAINER int
Value:1
Property name Data Type
249
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_FO_SYS_VAR int
Value:2
Constants.FV_FO_XREF int
Value:3
Constants.FV_FO_MARKER int
Value:4
Constants.FV_FO_FOOTNOTE int
Value:5
Constants.FV_FO_GRAPHIC int
Value:6
Constants.FV_FO_EQN int
Value:7
Constants.FV_FO_TBL int
Value:8
Constants.FV_FO_TBL_TITLE int
Value:9
Constants.FV_FO_TBL_HEADING int
Value:10
Constants.FV_FO_TBL_BODY int
Value:11
Constants.FV_FO_TBL_FOOTING int
Value:12
Constants.FV_FO_TBL_ROW int
Value:13
Constants.FV_FO_TBL_CELL int
Value:14
Constants.FV_FO_RUBI_GROUP int
Value:15
Constants.FV_FO_RUBI int
Value:16
Constants.FV_FO_NUMTYPES int
Value:17
Constants.FV_DT_UNSPECIFIED int
Value:0
Property name Data Type
250
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_DT_INTEGER int
Value:1
Constants.FV_DT_FLOAT int
Value:2
Constants.FV_DT_NUMTYPES int
Value:3
Constants.FV_AT_STRING int
Value:0
Constants.FV_AT_STRINGS int
Value:1
Constants.FV_AT_CHOICES int
Value:2
Constants.FV_AT_INTEGER int
Value:3
Constants.FV_AT_INTEGERS int
Value:4
Constants.FV_AT_REAL int
Value:5
Constants.FV_AT_REALS int
Value:6
Constants.FV_AT_UNIQUE_ID int
Value:7
Constants.FV_AT_UNIQUE_IDREF int
Value:8
Constants.FV_AT_UNIQUE_IDREFS int
Value:9
Constants.FV_AT_NUMTYPES int
Value:10
Constants.FV_AF_READ_ONLY int
Value:0x0001
Constants.FV_AF_HIDDEN int
Value:0x0002
Constants.FV_AF_FIXED int
Value:0x0004
Property name Data Type
251
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_FmtRuleType int
Value:2100
Constants.FP_CountElements int
Value:2101
Constants.FP_StopCountingAt int
Value:2102
Constants.FP_FmtRuleClauses int
Value:2103
Constants.FP_FmtRuleClause int
Value:2104
Constants.FV_CONTEXT_RULE int
Value:0
Constants.FV_LEVEL_RULE int
Value:1
Constants.FP_Specification int
Value:2150
Constants.FP_IsTextRange int
Value:2151
Constants.FP_RuleClauseType int
Value:2152
Constants.FP_FormatTag int
Value:2153
Constants.FP_FmtChangeListTag int
Value:2154
Constants.FP_FmtChangeList int
Value:2155
Constants.FP_SubFmtRule int
Value:2156
Constants.FP_ContextLabel int
Value:2157
Constants.FP_ElemPrefixSuffix int
Value:2158
Constants.FP_FmtRule int
Value:2159
Property name Data Type
252
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_ParsedSpecification int
Value:2160
Constants.FP_SpecificationForCSS int
Value:2161
Constants.FP_ContextForCSS int
Value:2162
Constants.FP_ParseFullSpecification int
Value:2163
Constants.FV_RC_TAG int
Value:0
Constants.FV_RC_SUB_FMTRULE int
Value:1
Constants.FV_RC_CHANGELIST int
Value:2
Constants.FV_RC_CHANGELIST_TAG int
Value:3
Constants.FV_EDT_TEXT int
Value:40
Constants.FV_EDT_TEXTONLY int
Value:41
Constants.FV_EDT_ANY int
Value:42
Constants.FV_EDT_ALL int
Value:43
Constants.FV_EDT_FIRST int
Value:44
Constants.FV_EDT_MIDDLE int
Value:45
Constants.FV_EDT_LAST int
Value:46
Constants.FV_EDT_NOTFIRST int
Value:47
Constants.FV_EDT_NOTLAST int
Value:48
Property name Data Type
253
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_EDT_AFTER int
Value:49
Constants.FV_EDT_BEFORE int
Value:50
Constants.FV_EDT_BETWEEN int
Value:53
Constants.FV_EDT_INSERTPAR int
Value:23
Constants.FV_EDT_ONLY int
Value:62
Constants.FV_EDT_ATTRGRPO int
Value:30
Constants.FV_EDT_ELEMENT int
Value:25
Constants.FP_ElementDef int
Value:1621
Constants.FP_ParentElement int
Value:1622
Constants.FP_FirstChildElement int
Value:1623
Constants.FP_LastChildElement int
Value:1624
Constants.FP_PrevSiblingElement int
Value:1625
Constants.FP_NextSiblingElement int
Value:1626
Constants.FP_ElementIsCollapsed int
Value:1627
Constants.FP_BookComponent int
Value:1628
Constants.FP_Object int
Value:1630
Constants.FP_MatchingTextClauses int
Value:1631
Property name Data Type
254
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_MatchingObjectClauses int
Value:1632
Constants.FP_Attributes int
Value:1634
Constants.FP_AttributesEx int
Value:1670
Constants.FP_AttrDisplay int
Value:1635
Constants.FP_ElementType int
Value:1636
Constants.FP_IDAttrValue int
Value:1637
Constants.FP_MatchingFirstPgfClauses int
Value:1638
Constants.FP_MatchingLastPgfClauses int
Value:1639
Constants.FP_MatchingPrefixClauses int
Value:1640
Constants.FP_MatchingSuffixClauses int
Value:1641
Constants.FP_MatchesContextInUserS
tring
int
Value:1642
Constants.FP_Namespace int
Value:1643
Constants.FP_NamespaceScope int
Value:1644
Constants.FP_NumNamespaces int
Value:1645
Constants.FP_NextElementDFS int
Value:2334
Constants.FP_PrevElementDFS int
Value:2335
Constants.FP_ElementIsTopicRef int
Value:2336
Property name Data Type
255
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_ElementIsTopicHead int
Value:2337
Constants.FP_ElementIsTopicGroup int
Value:2338
Constants.FP_TopicRefAbsoluteFilePat
h
int
Value:2347
Constants.FP_Element int
Value:2170
Constants.FP_TblElement int
Value:2171
Constants.FP_TblTitleElement int
Value:2172
Constants.FP_TblHeaderElement int
Value:2173
Constants.FP_TblBodyElement int
Value:2174
Constants.FP_TblFooterElement int
Value:2175
Constants.FP_RubiElement int
Value:2176
Constants.FP_AllowAsSpecialCase int
Value:1649
Constants.FP_ElementIsUndefined int
Value:1650
Constants.FP_ContentIsStrictlyValid int
Value:1651
Constants.FP_ContentIsLooselyValid int
Value:1652
Constants.FP_ContentNeededAtBegin int
Value:1653
Constants.FP_HoleAtEnd int
Value:1654
Constants.FP_ContentNeededAtEnd int
Value:1654
Property name Data Type
256
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_ElementIsExcludedInCo
ntext
int
Value:1655
Constants.FP_ElementIsInvalidInParen
t
int
Value:1656
Constants.FP_ElementIsInvalidInPositi
on
int
Value:1657
Constants.FP_ElementTypeMismatch int
Value:1658
Constants.FP_HoleBeforeElement int
Value:1659
Constants.FP_TextIsInvalidInElement int
Value:1660
Constants.FP_InvalidHighestLevel int
Value:1661
Constants.FP_BookComponentMissin
g
int
Value:1662
Constants.FP_ErrorInBookComponent int
Value:1663
Constants.FP_NextInvalidElement int
Value:1664
Constants.FP_ContentMustBeEmpty int
Value:1665
Constants.FP_AttributeValueRequired int
Value:1666
Constants.FP_AttributeValueInvalid int
Value:1667
Constants.FP_ValidationFlags int
Value:1668
Constants.FP_ElementMarkedForNam
edDestination
int
Value:1669
Constants.FV_ELEM_UNDEFINED int
Value:0x0001
Constants.FV_ELEM_TYPE_MISMATCH int
Value:0x0002
Property name Data Type
257
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_ELEM_EXCLUDED int
Value:0x0004
Constants.FV_ELEM_INVALID_IN_PAR
ENT
int
Value:0x0008
Constants.FV_ELEM_INVALID_AT_POS
ITION
int
Value:0x0010
Constants.FV_ELEM_HAS_TEXT_INVAL
ID
int
Value:0x0020
Constants.FV_ELEM_CONTENT_MUST
_BE_EMPTY
int
Value:0x0040
Constants.FV_ELEM_MISSING_CONTE
NT_BEFORE
int
Value:0x0080
Constants.FV_ELEM_MISSING_CONTE
NT_AT_BEG
int
Value:0x0100
Constants.FV_ELEM_MISSING_CONTE
NT_AT_END
int
Value:0x0200
Constants.FV_ELEM_NOT_VALID_AS_
ROOT
int
Value:0x0400
Constants.FV_ELEM_BOOK_COMP_MI
SSING
int
Value:0x0800
Constants.FV_ELEM_BOOK_COMP_IN
VALID
int
Value:0x1000
Constants.FV_ELEM_ATTRVAL_REQUI
RED
int
Value:0x2000
Constants.FV_ELEM_ATTRVAL_INVALI
D
int
Value:0x4000
Constants.FV_ELEM_CONTENT_STRIC
TLY_VALID
int
Value:0x10000
Constants.FV_ELEM_CONTENT_LOOSE
LY_VALID
int
Value:0x20000
Constants.FV_ELEM_INVISIBLE_ATTRV
AL_REQUIRED
int
Value:0x40000
Constants.FV_ELEM_INVISIBLE_ATTRV
AL_INVALID
int
Value:0x80000
Property name Data Type
258
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_AV_REQUIRED int
Value:1
Constants.FV_AV_INVALID_CHOICE int
Value:2
Constants.FV_AV_INVALID_FORMAT int
Value:3
Constants.FV_AV_IDREF_UNRESOLVE
D
int
Value:4
Constants.FV_AV_ID_DUPLICATE_IN_
DOC
int
Value:5
Constants.FV_AV_ID_DUPLICATE_IN_
BOOK
int
Value:6
Constants.FV_AV_TOO_MANY_TOKEN
S
int
Value:7
Constants.FV_AV_UNDEFINED int
Value:8
Constants.FV_AV_OUT_OF_RANGE int
Value:9
Constants.FV_OVERRIDDEN_DEFAULT int
Value:0x00
Constants.FV_OVERRIDDEN_NOVALUE int
Value:0x01
Constants.FV_OVERRIDDEN_CONREF_
DUCT
int
Value:0x02
Constants.FV_OVERRIDDEN_KEYDEF_
TO_KEYREF
int
Value:0x03
Constants.FV_Element int
Value:0
Constants.FV_ElementsOfType int
Value:1
Constants.FV_AllElements int
Value:2
Constants.FP_NextFmtChangeListInDo
c
int
Value:2000
Property name Data Type
259
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_FmtChangeListInCatalog int
Value:2021
Constants.FP_PgfCatalogReference int
Value:2001
Constants.FP_SpaceAboveChange int
Value:2002
Constants.FP_SpaceBelowChange int
Value:2003
Constants.FP_LeftIndentChange int
Value:2004
Constants.FP_FirstIndentChange int
Value:2005
Constants.FP_RightIndentChange int
Value:2006
Constants.FP_LeadingChange int
Value:2007
Constants.FP_LineSpacingFixed int
Value:2008
Constants.FP_TopSepAtIndent int
Value:2009
Constants.FP_BottomSepAtIndent int
Value:2010
Constants.FP_FontSizeChange int
Value:2012
Constants.FP_SpreadChange int
Value:2013
Constants.FP_MoveTabs int
Value:2014
Constants.FP_CellTopMarginFixed int
Value:2015
Constants.FP_CellBottomMarginFixed int
Value:2016
Constants.FP_CellLeftMarginFixed int
Value:2017
Property name Data Type
260
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_CellRightMarginFixed int
Value:2018
Constants.FP_FirstIndentIsRelative int
Value:2019
Constants.FP_FirstIndentRelPos int
Value:2020
Constants.FP_CellTopMarginChange int
Value:2022
Constants.FP_CellBottomMarginChan
ge
int
Value:2023
Constants.FP_CellLeftMarginChange int
Value:2024
Constants.FP_CellRightMarginChange int
Value:2025
Constants.FP_StretchChange int
Value:2026
Constants.FF_IED_REMOVE_OVERRID
ES
int
Value:0x0001
Constants.FF_IED_REMOVE_BOOK_IN
FO
int
Value:0x0002
Constants.FF_IED_DO_NOT_IMPORT_
EDD
int
Value:0x0004
Constants.FF_IED_NO_NOTIFY int
Value:0x0008
Constants.FF_IED_DELETE_EMPTY_PA
GES
int
Value:0x0010
Constants.FF_IED_DO_NOT_IMPORT_
STRUCTAPP
int
Value:0x0040
Constants.FP_Text int
Value:1701
Constants.FP_State int
Value:1702
Constants.FV_DlgOptNotActive int
Value:0
Property name Data Type
261
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_DlgOptActive int
Value:1
Constants.FV_DlgOptDontCare int
Value:2
Constants.FP_Labels int
Value:1703
Constants.FP_NumLines int
Value:1704
Constants.FP_FirstVis int
Value:1705
Constants.FP_DoubleClick int
Value:1706
Constants.FP_NumItems int
Value:1707
Constants.FP_Sensitivity int
Value:1708
Constants.FP_MinVal int
Value:1709
Constants.FP_MaxVal int
Value:1710
Constants.FP_IncrVal int
Value:1711
Constants.FP_Size int
Value:1712
Constants.FP_Visibility int
Value:1713
Constants.FP_PasswordStyle int
Value:1714
Constants.FP_ReadOnly int
Value:1723
Constants.FP_TabStops int
Value:1715
Constants.FP_Icon int
Value:1716
Property name Data Type
262
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_WindowHandle int
Value:1717
Constants.FP_SortingEnabled int
Value:1718
Constants.FP_SelectedRow int
Value:1730
Constants.FP_SelectedRowId int
Value:1731
Constants.FP_SelectedRowItems int
Value:1719
Constants.FP_LabelColor int
Value:1720
Constants.FP_LabelBold int
Value:1721
Constants.FP_Box_BG_Color int
Value:1722
Constants.FV_DlgClose int
Value:-1
Constants.FV_DlgReset int
Value:-2
Constants.FV_DlgNoChange int
Value:-3
Constants.FV_DlgEnter int
Value:-4
Constants.FV_DlgUndo int
Value:-5
Constants.FV_DlgPrevPage int
Value:-6
Constants.FV_DlgNextPage int
Value:-7
Constants.FV_DlgNeedsUpdate int
Value:-8
Constants.FV_DlgInit int
Value:-9
Property name Data Type
263
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_DlgHide int
Value:-10
Constants.FV_DlgShow int
Value:-11
Constants.FV_DlgResize int
Value:-12
Constants.FV_DlgPrefSetInitialState int
Value:-100
Constants.FV_DlgPrefVerify int
Value:-101
Constants.FV_DlgPrefCommit int
Value:-102
Constants.FV_EvShift int
Value:0x0001
Constants.FV_EvControl int
Value:0x0002
Constants.FV_EvMeta int
Value:0x0004
Constants.FV_EvOption int
Value:0x0004
Constants.FV_EvCaps int
Value:0x0008
Constants.FV_EvCommand int
Value:0x0010
Constants.FV_EvMax int
Value:0x0010
Constants.FP_DbItemNum int
Value:1800
Constants.FP_DbType int
Value:1801
Constants.FP_DbIdentifier int
Value:1802
Constants.FP_DbVarLabelWidth int
Value:1803
Property name Data Type
264
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_DbStuffItem int
Value:1804
Constants.FP_DbSbxNumLines int
Value:1805
Constants.FP_DbRadioButtonGroup int
Value:1806
Constants.FP_DbCheckBoxState int
Value:1807
Constants.FP_DbFirstFocus int
Value:1808
Constants.FP_DbDefaultButton int
Value:1809
Constants.FP_DbOKButton int
Value:1810
Constants.FP_DbCancelButton int
Value:1811
Constants.FP_DbFbTextBox int
Value:1812
Constants.FP_DbFbScrollBox int
Value:1813
Constants.FP_DbFbCurrentDir int
Value:1814
Constants.FP_DbFbStatus int
Value:1815
Constants.FP_DbTitleLabel int
Value:1816
Constants.FP_DbAttributes int
Value:1817
Constants.FP_DbEditable int
Value:1818
Constants.FP_DbNoHelp int
Value:1819
Constants.FP_LineAscent int
Value:1900
Property name Data Type
265
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_LineDescent int
Value:1901
Constants.FP_LineBaseline int
Value:1902
Constants.FP_MenuItemIsEnabled int
Value:1922
Constants.FP_NextMenuItemInMenu int
Value:1923
Constants.FP_PrevMenuItemInMenu int
Value:1924
Constants.FP_NextMenuItemInSessio
n
int
Value:1925
Constants.FP_MenuType int
Value:1926
Constants.FV_MENU_MENUBAR int
Value:1
Constants.FV_MENU_POPUP int
Value:2
Constants.FV_MENU_ADHOCRULER int
Value:3
Constants.FV_MENU_DEFAULT int
Value:4
Constants.FP_FirstMenuItemInMenu int
Value:1927
Constants.FP_CommandNum int
Value:1928
Constants.FP_KeyboardShortcutLabel int
Value:1929
Constants.FP_KeyboardShortcuts int
Value:1930
Constants.FP_CanHaveCheckMark int
Value:1931
Constants.FP_CheckMarkIsOn int
Value:1932
Property name Data Type
266
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_MenuItemType int
Value:1933
Constants.FV_MENUITEM_FRAME int
Value:1
Constants.FV_MENUITEM_API int
Value:2
Constants.FV_MENUITEM_MACRO int
Value:3
Constants.FV_MENUITEM_EXPANDO
MATIC
int
Value:4
Constants.FP_ExpandOMaticParent int
Value:1934
Constants.FP_EnabledWhen int
Value:1935
Constants.FV_ENABLE_ALWAYS_ENAB
LE
int
Value:1
Constants.FV_ENABLE_ALWAYS_DISAB
LE
int
Value:2
Constants.FV_ENABLE_IN_PARA_TEXT int
Value:3
Constants.FV_ENABLE_IN_TEXT_LINE int
Value:4
Constants.FV_ENABLE_IS_TEXT_SEL int
Value:5
Constants.FV_ENABLE_IN_MATH int
Value:6
Constants.FV_ENABLE_IN_TEXT int
Value:7
Constants.FV_ENABLE_OBJ_PROPS int
Value:8
Constants.FV_ENABLE_IN_TABLE int
Value:9
Constants.FV_ENABLE_IN_TABLE_TITL
E
int
Value:10
Property name Data Type
267
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_ENABLE_IN_CELL_TEXT int
Value:11
Constants.FV_ENABLE_IS_CELL int
Value:12
Constants.FV_ENABLE_IS_CELLS int
Value:13
Constants.FV_ENABLE_IS_TABLE int
Value:14
Constants.FV_ENABLE_IS_OBJ int
Value:15
Constants.FV_ENABLE_IS_TEXT_FRAM
E
int
Value:16
Constants.FV_ENABLE_IS_OR_IN_FRA
ME
int
Value:17
Constants.FV_ENABLE_IS_AFRAME int
Value:18
Constants.FV_ENABLE_IS_TEXT_INSET int
Value:19
Constants.FV_ENABLE_IS_GRAPHIC_I
NSET
int
Value:20
Constants.FV_ENABLE_IN_FLOW int
Value:21
Constants.FV_ENABLE_COPY int
Value:22
Constants.FV_ENABLE_COPY_FONT int
Value:23
Constants.FV_ENABLE_CAN_PASTE int
Value:24
Constants.FV_ENABLE_IS_VIEW_ONLY int
Value:25
Constants.FV_ENABLE_NEEDS_DOCP_
ONLY
int
Value:26
Constants.FV_ENABLE_NEEDS_BOOKP
_ONLY
int
Value:27
Property name Data Type
268
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_ENABLE_NEEDS_DOCP_
OR_BOOKP
int
Value:28
Constants.FV_ENABLE_BOOK_HAS_SE
LECTION
int
Value:29
Constants.FV_ENABLE_DOC_OR_BOO
K_HAS_SELECTION
int
Value:30
Constants.FP_Fcode int
Value:1936
Constants.FP_Fcodes int
Value:1937
Constants.FP_HelpLink int
Value:1938
Constants.FP_HasShiftOrUnshiftCom
mand
int
Value:1939
Constants.FV_ITEM_HAS_SHIFT_COM
MAND
int
Value:1
Constants.FV_ITEM_HAS_UNSHIFT_C
OMMAND
int
Value:2
Constants.FV_ITEM_HAS_NO_SHIFT_
OR_UNSHIFT_COMMAND
int
Value:3
Constants.FP_ShiftOrUnshiftComman
d
int
Value:1940
Constants.FP_Mode int
Value:1941
Constants.FV_MODE_MATH int
Value:1
Constants.FV_MODE_NONMATH int
Value:2
Constants.FV_MODE_ALL int
Value:3
Constants.FP_NextCommandInSession int
Value:1942
Constants.FP_Hypertext int
Value:1943
Property name Data Type
269
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_NextTiInDoc int
Value:2050
Constants.FP_TiAutomaticUpdate int
Value:2051
Constants.FV_UpdateAllClientTi int
Value:1
Constants.FV_UpdateAllAutomaticClie
ntTi
int
Value:2
Constants.FV_UpdateAllManualClient
Ti
int
Value:3
Constants.FP_LastUpdate int
Value:2052
Constants.FP_TiFile int
Value:2053
Constants.FP_TiMacEdition int
Value:2054
Constants.FP_ImportHint int
Value:2055
Constants.FP_TiLocked int
Value:2056
Constants.FP_TiFileModDate int
Value:2057
Constants.FP_TiIsNested int
Value:2058
Constants.FP_TiMainFlow int
Value:2059
Constants.FP_TiFlowName int
Value:2060
Constants.FP_TiFlowPageSpace int
Value:2061
Constants.FV_BODY_PAGE int
Value:0x00
Constants.FV_REFERENCE_PAGE int
Value:0x02
Property name Data Type
270
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_TiFormat int
Value:2062
Constants.FP_TiRemovePageBreaks int
Value:2063
Constants.FP_TiRemoveOverrides int
Value:2064
Constants.FP_TiTextEncoding int
Value:2073
Constants.FV_IsoLatin int
Value:1
Constants.FV_ASCII int
Value:2
Constants.FV_ANSI int
Value:3
Constants.FV_MacANSI int
Value:4
Constants.FV_JIS int
Value:5
Constants.FV_Shitf_JIS int
Value:6
Constants.FV_EUC int
Value:7
Constants.FV_BIG5 int
Value:8
Constants.FV_EUC_CNS int
Value:9
Constants.FV_GB int
Value:10
Constants.FV_HZ int
Value:11
Constants.FV_Korean int
Value:12
Constants.FP_TiEOLisEOP int
Value:2065
Property name Data Type
271
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_TiTblTag int
Value:2066
Constants.FP_TiNumHeaderRows int
Value:2067
Constants.FP_TiHeadersEmpty int
Value:2068
Constants.FP_TiByRows int
Value:2069
Constants.FP_TiSeparator int
Value:2070
Constants.FP_TiNumSeparators int
Value:2071
Constants.FP_TiNumCols int
Value:2072
Constants.FP_TiIsUnresolved int
Value:2075
Constants.FP_TiClientName int
Value:2076
Constants.FP_TiClientSource int
Value:2077
Constants.FP_TiClientType int
Value:2078
Constants.FP_TiClientData int
Value:2079
Constants.FP_TiClientUpdateSilent int
Value:2080
Constants.FP_ContentHeight int
Value:2219
Constants.FP_ParentTextFrame int
Value:2200
Constants.FP_PrevSubCol int
Value:2201
Constants.FP_NextSubCol int
Value:2202
Property name Data Type
272
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_Overflowed int
Value:983
Constants.FP_FirstCombinedFontDefn
InDoc
int
Value:2280
Constants.FP_NextCombinedFontDefn
InDoc
int
Value:2281
Constants.FP_BaseFamily int
Value:2282
Constants.FP_AllowBaseFamilyBolded
AndObliqued
int
Value:2283
Constants.FP_WesternFamily int
Value:2284
Constants.FP_WesternSize int
Value:2285
Constants.FP_WesternShift int
Value:2286
Constants.FP_CombinedFontFamily int
Value:2287
Constants.FS_FindText int
Value:1
Constants.FS_FindElementTag int
Value:2
Constants.FV_FindElemTag int
Value:0
Constants.FV_FindAttrName int
Value:1
Constants.FV_FindAttrValue int
Value:2
Constants.FV_NumFindElementItems int
Value:2+1
Constants.FS_FindCharFmt int
Value:3
Constants.FS_FindPgfTag int
Value:4
Property name Data Type
273
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FS_FindCharTag int
Value:5
Constants.FS_FindTableTag int
Value:6
Constants.FS_FindObject int
Value:8
Constants.FV_FindAnyMarker int
Value:0
Constants.FV_FindAnyXRef int
Value:1
Constants.FV_FindUnresolvedXRef int
Value:2
Constants.FV_FindAnyTextInset int
Value:3
Constants.FV_FindUnresolvedTextInse
t
int
Value:4
Constants.FV_FindAnyPub int
Value:5
Constants.FV_FindAnyVariable int
Value:6
Constants.FV_FindAnchoredFrame int
Value:7
Constants.FV_FindFootnote int
Value:8
Constants.FV_FindAnyTable int
Value:9
Constants.FV_FindAutomaticHyphen int
Value:10
Constants.FV_FindAnyRubi int
Value:11
Constants.FV_FindPgfFormatOverride int
Value:12
Constants.FV_FindCharacterFormatOv
erride
int
Value:13
Property name Data Type
274
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_FindTableFormatOverri
de
int
Value:14
Constants.FS_FindMarkerOfType int
Value:9
Constants.FS_FindMarkerText int
Value:10
Constants.FS_FindXRefWithFormat int
Value:11
Constants.FS_FindNamedVariable int
Value:12
Constants.FS_FindCondTextInCondTag
s
int
Value:13
Constants.FS_FindCondTextNotInCond
Tags
int
Value:14
Constants.FS_FindCustomizationFlags int
Value:15
Constants.FS_FindWrap int
Value:16
Constants.FS_SpellOptions int
Value:1000
Constants.FS_TwoInARowString int
Value:1001
Constants.FS_TextBeforeString int
Value:1002
Constants.FS_TextAfterString int
Value:1003
Constants.FS_WordContainString int
Value:1004
Constants.FS_SpellAction int
Value:1005
Constants.FV_CheckDocument int
Value:1
Constants.FV_CheckCurrentPage int
Value:2
Property name Data Type
275
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_WriteUnknownWordsTo
File
int
Value:3
Constants.FS_OutputFilePathName int
Value:1006
Constants.FS_SpellWrap int
Value:1007
Constants.FS_NumSpellParams int
Value:(1007-1000+1)
Constants.FV_SpellMisspelling int
Value:1
Constants.FV_SpellCapitalization int
Value:2
Constants.FV_SpellRepeatedWord int
Value:3
Constants.FV_SpellRepeatedLetter int
Value:4
Constants.FV_SpellHyphenation int
Value:5
Constants.FV_SpellExtraSpace int
Value:6
Constants.FV_SpellSpaceAfter int
Value:7
Constants.FV_SpellSpaceBefore int
Value:8
Constants.FV_SpellStraightQuotes int
Value:9
Constants.FV_UserDictionary int
Value:1
Constants.FV_DocumentDictionary int
Value:2
Constants.FV_WriteDictionaryToFile int
Value:4
Constants.FV_MergeDictionaryConten
ts
int
Value:5
Property name Data Type
276
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_SetDictionaryToNoneDic
tionary
int
Value:6
Constants.FV_ClearDocDictionary int
Value:7
Constants.FV_ChangePersonalDiction
ary
int
Value:8
Constants.FV_GetDictionaryStrings int
Value:9
Constants.FP_CursorData int
Value:2294
Constants.FP_CursorTypes int
Value:2295
Constants.FP_StructureCursorTypes int
Value:2296
Constants.FP_SecNumComputeMetho
d
int
Value:915
Constants.FP_SectionNumStyle int
Value:916
Constants.FP_SectionNumber int
Value:917
Constants.FP_SectionNumText int
Value:918
Constants.FP_SubsecNumComputeMe
thod
int
Value:815
Constants.FP_SubsectionNumStyle int
Value:816
Constants.FP_SubsectionNumber int
Value:817
Constants.FP_SubsectionNumText int
Value:818
Constants.FP_DoNotGenerateErrorLog int
Value:819
Constants.FP_DocOpenClientEncount
eredErrors
int
Value:820
Property name Data Type
277
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_OpenAndSaveXmlBookC
omponentDoc
int
Value:822
Constants.FP_XmlIsBook int
Value:823
Constants.FP_UseFMConsoleForErrorL
og
int
Value:825
Constants.FP_FMConsoleString int
Value:826
Constants.FP_IsTempOpenSave int
Value:827
Constants.FP_AllowNewFileURL int
Value:2416
Constants.FP_DoPostXSLTValidationO
nExport
int
Value:2417
Constants.FP_DoNotExportInvalidXML int
Value:2418
Constants.FP_SuppressXMLParserWar
nings
int
Value:2419
Constants.FP_RemoveExtraWhiteSpac
esOnXMLImport
int
Value:2830
Constants.FP_NoMultiMediaInPDF int
Value:2831
Constants.FP_InsetGenericData int
Value:2832
Constants.FP_InTableSortOperation int
Value:2833
Constants.FP_InsetGfxName int
Value:2834
Constants.FP_InsetGfxPlayWindowInP
df
int
Value:2835
Constants.FP_InsetGfxActiveInPdf int
Value:2836
Constants.FP_InsetJavaScriptAttached int
Value:2837
Property name Data Type
278
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_InsetJavaScriptFile int
Value:2838
Constants.FP_InsetMonikerPath int
Value:2848
Constants.FP_InsetMonikerFilePath int
Value:2849
Constants.FP_IsFateRun int
Value:2847
Constants.FP_DefaultVectorFormatFor
XMLExport
int
Value:2874
Constants.FV_CmdOpenXmlElementId int
Value:821
Constants.FV_FileTypeBinaryDoc int
Value:1
Constants.FV_FileTypeBinaryBook int
Value:2
Constants.FV_FileTypeMif int
Value:3
Constants.FV_FileTypeXml int
Value:4
Constants.FV_FileTypeSgml int
Value:5
Constants.FV_FileTypeText int
Value:6
Constants.FV_FileTypeFilter int
Value:7
Constants.FV_FileTypeFolder int
Value:8
Constants.FV_FileTypeGeneral int
Value:9
Constants.FV_FileTypeErrorDoc int
Value:10
Constants.FV_FileTypeEquation int
Value:11
Property name Data Type
279
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_FileTypeThesaurus int
Value:12
Constants.FV_FileTypeCompositeDoc int
Value:13
Constants.FV_FileTypeSummaryDoc int
Value:14
Constants.FS_StructuredApplication int
Value:1
Constants.FS_Doctype int
Value:2
Constants.FS_PublicId int
Value:3
Constants.FS_SystemId int
Value:4
Constants.FS_Extension int
Value:5
Constants.FS_Visible int
Value:6
Constants.FS_NumNewXMLParams int
Value:6
Constants.FV_ListViewInit int
Value:1
Constants.FV_ListViewAddColumn int
Value:2
Constants.FV_ListViewAddRow int
Value:3
Constants.FV_ListViewDeleteAllRows int
Value:4
Constants.FV_ListViewReSortAllRows int
Value:5
Constants.FV_ListViewSetSortEnabled int
Value:6
Constants.FV_ListViewSelectFirstRow int
Value:7
Property name Data Type
280
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_ListViewSelectRowFrom
ColData
int
Value:8
Constants.FV_ListViewSelectRowFrom
RowID
int
Value:9
Constants.FV_ListViewActionMax int
Value:10
Constants.FV_ListViewInitNumParams int
Value:0
Constants.FV_ListViewAddColumnNu
mParams
int
Value:4
Constants.FV_ListViewAddColumnPar
am1
int
Value:3
Constants.FV_ListViewAddColumnPar
am2
int
Value:1
Constants.FV_ListViewAddColumnPar
am3
int
Value:1
Constants.FV_ListViewAddColumnPar
am4
int
Value:1
Constants.FV_ListViewAddRowNumPa
rams
int
Value:1
Constants.FV_ListViewAddRowParam
1
int
Value:6
Constants.FV_ListViewDeleteAllRows
NumParams
int
Value:0
Constants.FV_ListViewReSortAllRows
NumParams
int
Value:0
Constants.FP_LineNumDistance int
Value:4001
Constants.FP_LineNumRestart int
Value:4002
Constants.FP_LineNumShow int
Value:4003
Constants.FP_LineNumFont int
Value:4004
Property name Data Type
281
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_LineNumSize int
Value:4005
Constants.FP_LineNumColor int
Value:4006
Constants.FP_IsDefault int
Value:2850
Constants.FP_IsStale int
Value:2851
Constants.FP_NextKeyCatalogInSessio
n
int
Value:2852
Constants.FP_NotLoaded int
Value:2853
Constants.FP_Source int
Value:2854
Constants.FP_SourceType int
Value:2855
Constants.FP_KeyCount int
Value:2860
Constants.FP_KeyCatalogClientName int
Value:2873
Constants.FV_KeySrcTypeNone int
Value:0
Constants.FV_KeySrcTypeDitamap int
Value:1
Constants.FV_DocKeyCatalogTypeDefa
ult
int
Value:0
Constants.FV_DocKeyCatalogTypeSpe
cified
int
Value:1
Constants.FV_DocKeyCatalogTypeNon
e
int
Value:2
Constants.FV_DocKeyCatalogTypeMax int
Value:3
Constants.FV_KeydefVariableInfoLen int
Value:3
Property name Data Type
282
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_KeydefVariableInfoTagP
rimary
int
Value:0
Constants.FV_KeydefVariableInfoTagS
econdary
int
Value:1
Constants.FV_KeydefVariableInfoText int
Value:2
Constants.FV_KeyDefFieldsTypePrimar
y
int
Value:0
Constants.FV_KeyDefFieldsTypeAll int
Value:1
Constants.FV_KeyDefFieldsTypeMax int
Value:2
Constants.FV_KeydefKeyTag int
Value:1
Constants.FV_KeydefKeyTarget int
Value:2
Constants.FV_KeydefKeySrcFile int
Value:3
Constants.FV_KeydefKeyDuplicate int
Value:4
Constants.FV_KeyDefMaxPrimaryField
s
int
Value:4+1
Constants.FV_KeydefKeySrcType int
Value:5
Constants.FV_KeydefKeyVarList int
Value:6
Constants.FV_KeydefKeyDefaultText int
Value:7
Constants.FV_KeydefKeyFoundInRefFil
e
int
Value:8
Constants.FV_KeydefKeyInValid int
Value:9
Constants.FV_KeydefKeyAttrs int
Value:10
Property name Data Type
283
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_KeyDefMaxFields int
Value:11
Constants.FV_KeydefKeyTagType int
Value:3
Constants.FV_KeydefKeyTargetType int
Value:3
Constants.FV_KeydefKeySrcFileType int
Value:3
Constants.FV_KeydefKeyDuplicateTyp
e
int
Value:1
Constants.FV_KeydefKeySrcTypeType int
Value:1
Constants.FV_KeydefKeyVarListType int
Value:20
Constants.FV_KeydefKeyDefaultTextTy
pe
int
Value:3
Constants.FV_KeydefKeyFoundInRefFil
eType
int
Value:1
Constants.FV_KeydefKeyInValidType int
Value:1
Constants.FV_KeydefKeyAttrsType int
Value:21
Constants.FV_KeyDefFieldSize int
Value:2
Constants.FF_DUPLICATE_KEY_DEFINI
TION
int
Value:0x01
Constants.FF_FOUND_IN_REFERENCE
D_FILE
int
Value:0x02
Constants.FF_INVALID_KEY int
Value:0x04
Constants.FV_DITAObjTypeAuto int
Value:0
Constants.FV_DITAObjTypeConref int
Value:1
Property name Data Type
284
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_DITAObjTypeXref int
Value:2
Constants.FV_DITAObjTypeLink int
Value:3
Constants.FV_DITAObjTypeTopicref int
Value:4
Constants.FV_DITAObjTypeTopicsetref int
Value:5
Constants.FV_DITAObjTypeMax int
Value:6
Constants.FF_DITAUpdateAllConrefs int
Value:0x01
Constants.FF_DITAUpdateAllXrefs int
Value:0x02
Constants.FF_DITAUpdateAllLinks int
Value:0x04
Constants.FF_DITAUpdateAllTopicrefs int
Value:0x08
Constants.FF_DITAUpdateAllTopicsetr
efs
int
Value:0x10
Constants.FF_DITAUpdateAllReference
s
int
Value:(0x01|0x02|0x04|0x08|0x10)
Constants.FP_FirstDITAConrefElement
InDoc
int
Value:2861
Constants.FP_FirstDITAXrefElementIn
Doc
int
Value:2862
Constants.FP_FirstDITALinkElementIn
Doc
int
Value:2863
Constants.FP_FirstDITATopicrefElemen
tInDoc
int
Value:2864
Constants.FP_FirstDITATopicsetrefEle
mentInDoc
int
Value:2865
Constants.FP_NextDITAConrefElement
InDoc
int
Value:2866
Property name Data Type
285
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_NextDITAXrefElementIn
Doc
int
Value:2867
Constants.FP_NextDITALinkElementIn
Doc
int
Value:2868
Constants.FP_NextDITATopicrefEleme
ntInDoc
int
Value:2869
Constants.FP_NextDITATopicsetrefEle
mentInDoc
int
Value:2870
Constants.FV_DITA_TYPE_GENERAL int
Value:1
Constants.FV_DITA_TYPE_RELTABLE int
Value:2
Constants.FV_DITA_TYPE_KEYDEF int
Value:3
Constants.FV_DITA_TYPE_TOPICGROU
P
int
Value:4
Constants.FV_DITA_TYPE_TOPICHEAD int
Value:5
Constants.FV_DITA_TYPE_TOPICSETRE
F
int
Value:6
Constants.FV_DITA_TYPE_TOPICSET int
Value:7
Constants.FV_DITA_TYPE_MAPREF int
Value:8
Constants.FV_DITA_TYPE_NAVREF int
Value:9
Constants.FV_DITA_TYPE_TITLE int
Value:10
Constants.FV_DITA_TYPE_TOPICREF int
Value:11
Constants.FV_DITA_TYPE_ANCHOR int
Value:12
Constants.FV_ENUMERATE_DITACOM
P_TOPICREF
int
Value:1 << 1
Property name Data Type
286
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_ENUMERATE_DITACOM
P_MAPREF
int
Value:1 << 2
Constants.FV_ENUMERATE_DITACOM
P_TOPICSET
int
Value:1 << 3
Constants.FV_ENUMERATE_DITACOM
P_TOPICSETREF
int
Value:1 << 4
Constants.FV_ENUMERATE_DITACOM
P_KEYDEF
int
Value:1 << 5
Constants.FV_ENUMERATE_COMP_CH
ILDMAP_COMPONENTS
int
Value:1 << 6
Constants.FV_ENUMERATE_COMP_CH
ILDBOOK_COMPONENTS
int
Value:1 << 7
Constants.FV_ENUMERATE_BOOKCO
MP_FOLDER
int
Value:1 << 8
Constants.FV_ENUMERATE_BOOKCO
MP_GROUP
int
Value:1 << 9
Constants.FV_ENUMERATE_COMP_FO
LDER_COMPONENTS
int
Value:1 << 10
Constants.FV_ENUMERATE_COMP_G
ROUP_COMPONENTS
int
Value:1 << 11
Constants.FV_ENUMERATE_COMPFILE
_FMBINARY
int
Value:1 << 12
Constants.FV_ENUMERATE_COMPFILE
_FMMIF
int
Value:1 << 13
Constants.FV_ENUMERATE_COMPFILE
_BOOKBINARY
int
Value:1 << 14
Constants.FV_ENUMERATE_COMPFILE
_BOOKMIF
int
Value:1 << 15
Constants.FV_ENUMERATE_COMPFILE
_XML
int
Value:1 << 16
Constants.FMV_CMDSUPPORTED int
Value:-1
Constants.FF_UNTAGGED_ASK int
Value:0
Property name Data Type
287
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FF_UNTAGGED_UNCOND int
Value:1
Constants.FF_UNTAGGED_DELETE int
Value:2
Constants.FS_IteratorItemFieldBookId int
Value:1
Constants.FS_IteratorItemFieldDocId int
Value:2
Constants.FS_IteratorItemFieldObjId int
Value:3
Constants.FS_IteratorItemMaxFields int
Value:3
Constants.FS_IterParamParseBookInB
ook
int
Value:1
Constants.FS_IterParamParseMapInBo
ok
int
Value:2
Constants.FS_IterParamSkipExcludedB
ookComponents
int
Value:3
Constants.FS_IterParamGetBookComp
onentFolder
int
Value:4
Constants.FS_IterParamGetBookComp
onentGroup
int
Value:5
Constants.FS_IterParamGetBookComp
onentRefBook
int
Value:6
Constants.FS_IterParamGetBookComp
onentRefMap
int
Value:7
Constants.FS_IterParamParseMapInM
ap
int
Value:8
Constants.FS_IterParamSkipResource
OnlyTopicrefs
int
Value:9
Constants.FS_IterParamSkipNonPrintT
opicrefs
int
Value:10
Constants.FS_IterParamSkipTopicsetre
fs
int
Value:11
Property name Data Type
288
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FS_IterParamGetMapRef int
Value:12
Constants.FS_NumIteratorParams int
Value:12
Constants.FV_CMSOpNone int
Value:FV_CMSOpNone
Constants.FV_CMSOpItemUpdated int
Value:FV_CMSOpItemUpdated
Constants.FV_CMSOpDependentsUpd
ated
int
Value:FV_CMSOpDependentsUpdated
Constants.FV_CMSOpDependentsDele
ted
int
Value:FV_CMSOpDependentsDeleted
Constants.FV_CMSOpItemDeleted int
Value:FV_CMSOpItemDeleted
Constants.FV_CMSOpChildAdded int
Value:FV_CMSOpChildAdded
Constants.FV_CMSOpRootUpdated int
Value:FV_CMSOpRootUpdated
Constants.FP_CMSItemProperty_Min int
Value:FP_CMSItemProperty_Min
Constants.FP_CMSItemProperty_Item
Name
int
Value:FP_CMSItemProperty_ItemName
Constants.FP_CMSItemProperty_Item
ServerPath
int
Value:FP_CMSItemProperty_ItemServerPath
Constants.FP_CMSItemProperty_Item
LocalPath
int
Value:FP_CMSItemProperty_ItemLocalPath
Constants.FP_CMSItemProperty_ItemI
sCheckedOut
int
Value:FP_CMSItemProperty_ItemIsCheckedOut
Constants.FP_CMSItemProperty_Item
CheckedOutByCurrentUser
int
Value:FP_CMSItemProperty_ItemCheckedOutByCurre
ntUser
Constants.FP_CMSItemProperty_ItemI
sContainer
int
Value:FP_CMSItemProperty_ItemIsContainer
Property name Data Type
289
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FP_CMSItemProperty_Item
Type
int
Value:FP_CMSItemProperty_ItemType
Constants.FP_CMSItemProperty_Item
FileType
int
Value:FP_CMSItemProperty_ItemFileType
Constants.FP_CMSItemProperty_Item
Version
int
Value:FP_CMSItemProperty_ItemVersion
Constants.FP_CMSItemProperty_Max int
Value:FP_CMSItemProperty_Max
Constants.FV_CMSItemTypeValue_Mi
n
int
Value:FV_CMSItemTypeValue_Min
Constants.FV_CMSItemTypeValue_Ro
ot
int
Value:FV_CMSItemTypeValue_Root
Constants.FV_CMSItemTypeValue_Fol
der
int
Value:FV_CMSItemTypeValue_Folder
Constants.FV_CMSItemTypeValue_File int
Value:FV_CMSItemTypeValue_File
Constants.FV_CMSItemTypeValue_Ge
neral
int
Value:FV_CMSItemTypeValue_General
Constants.FV_CMSItemTypeValue_Ma
x
int
Value:FV_CMSItemTypeValue_Max
Constants.FV_CMSItemFileTypeValue_
Min
int
Value:FV_CMSItemFileTypeValue_Min
Constants.FV_CMSItemFileTypeValue_
Xml
int
Value:FV_CMSItemFileTypeValue_Xml
Constants.FV_CMSItemFileTypeValue_
FmDoc
int
Value:FV_CMSItemFileTypeValue_FmDoc
Constants.FV_CMSItemFileTypeValue_
Mif
int
Value:FV_CMSItemFileTypeValue_Mif
Constants.FV_CMSItemFileTypeValue_
DitaMap
int
Value:FV_CMSItemFileTypeValue_DitaMap
Constants.FV_CMSItemFileTypeValue_
DitaTopic
int
Value:FV_CMSItemFileTypeValue_DitaTopic
Constants.FV_CMSItemFileTypeValue_
FmBook
int
Value:FV_CMSItemFileTypeValue_FmBook
Property name Data Type
290
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_CMSItemFileTypeValue_
Text
int
Value:FV_CMSItemFileTypeValue_Text
Constants.FV_CMSItemFileTypeValue_
Img
int
Value:FV_CMSItemFileTypeValue_Img
Constants.FV_CMSItemFileTypeValue_
General
int
Value:FV_CMSItemFileTypeValue_General
Constants.FV_CMSItemFileTypeValue_
Max
int
Value:FV_CMSItemFileTypeValue_Max
Constants.FA_CMSCommandMin int
Value:FA_CMSCommandMin
Constants.FA_CMSCreateConnection int
Value:FA_CMSCreateConnection
Constants.FA_CMSSetRootObject int
Value:FA_CMSSetRootObject
Constants.FA_CMSCreateConnMgrUI int
Value:FA_CMSCreateConnMgrUI
Constants.FA_CMSGetItemFromPath int
Value:FA_CMSGetItemFromPath
Constants.FA_CMSCloseConnection int
Value:FA_CMSCloseConnection
Constants.FA_CMSGetCommandMax
OpCode
int
Value:FA_CMSGetCommandMaxOpCode
Constants.FA_CMSGetPropertyMaxOp
Code
int
Value:FA_CMSGetPropertyMaxOpCode
Constants.FA_CMSObjectCheckout int
Value:FA_CMSObjectCheckout
Constants.FA_CMSObjectCheckin int
Value:FA_CMSObjectCheckin
Constants.FA_CMSObjectCancelCheck
out
int
Value:FA_CMSObjectCancelCheckout
Constants.FA_CMSObjectEdit int
Value:FA_CMSObjectEdit
Constants.FA_CMSObjectOpenReadO
nly
int
Value:FA_CMSObjectOpenReadOnly
Property name Data Type
291
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FA_CMSObjectDelete int
Value:FA_CMSObjectDelete
Constants.FA_CMSObjectShowVersion int
Value:FA_CMSObjectShowVersion
Constants.FA_CMSObjectShowDepen
dents
int
Value:FA_CMSObjectShowDependents
Constants.FA_CMSObjectShowPropert
ies
int
Value:FA_CMSObjectShowProperties
Constants.FA_CMSObjectShowCheckO
utFiles
int
Value:FA_CMSObjectShowCheckOutFiles
Constants.FA_CMSObjectDownload int
Value:FA_CMSObjectDownload
Constants.FA_CMSObjectDownloadIte
m
int
Value:FA_CMSObjectDownloadItem
Constants.FA_CMSObjectDownloadFo
rOpen
int
Value:FA_CMSObjectDownloadForOpen
Constants.FA_CMSObjectUploadFile int
Value:FA_CMSObjectUploadFile
Constants.FA_CMSObjectUploadFolde
r
int
Value:FA_CMSObjectUploadFolder
Constants.FA_CMSObjectGetChildren int
Value:FA_CMSObjectGetChildren
Constants.FA_CMSObjectIsSame int
Value:FA_CMSObjectIsSame
Constants.FA_CMSObjectRefresh int
Value:FA_CMSObjectRefresh
Constants.FA_CMSSimpleSearch int
Value:FA_CMSSimpleSearch
Constants.FA_CMSAdvancedSearch int
Value:FA_CMSAdvancedSearch
Constants.FA_CMSGetItems int
Value:FA_CMSGetItems
Constants.FA_CMSBuildContextMenu int
Value:FA_CMSBuildContextMenu
Property name Data Type
292
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FA_CMSIsValidCommand int
Value:FA_CMSIsValidCommand
Constants.FA_CMSCommandMax int
Value:FA_CMSCommandMax
Constants.FV_CMSMenu_Min int
Value:FV_CMSMenu_Min
Constants.FV_CMSMenu_Is_Item int
Value:FV_CMSMenu_Is_Item
Constants.FV_CMSMenu_Is_Disabled int
Value:FV_CMSMenu_Is_Disabled
Constants.FV_CMSMenu_Is_Separator int
Value:FV_CMSMenu_Is_Separator
Constants.FV_CMSMenu_Is_SubMenu int
Value:FV_CMSMenu_Is_SubMenu
Constants.FV_CMSMenu_Max int
Value:FV_CMSMenu_Max
Constants.FV_CMSVersion_Min int
Value:FV_CMSVersion_Min
Constants.FV_CMSSameVersion int
Value:FV_CMSSameVersion
Constants.FV_CMSMinorVersion int
Value:FV_CMSMinorVersion
Constants.FV_CMSMajorVersion int
Value:FV_CMSMajorVersion
Constants.FV_CMSVersion_Max int
Value:FV_CMSVersion_Max
Constants.FV_CMSCheckoutUI_Id_Sho
wDependents
int
Value:FV_CMSCheckoutUI_Id_ShowDependents
Constants.FV_CMSCheckinUI_Id_Sam
eVersion
int
Value:FV_CMSCheckinUI_Id_SameVersion
Constants.FV_CMSCheckinUI_Id_Mino
rVersion
int
Value:FV_CMSCheckinUI_Id_MinorVersion
Constants.FV_CMSCheckinUI_Id_Majo
rVersion
int
Value:FV_CMSCheckinUI_Id_MajorVersion
Property name Data Type
293
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_CMSCheckinUI_Id_Versi
onLabel
int
Value:FV_CMSCheckinUI_Id_VersionLabel
Constants.FV_CMSCheckinUI_Id_Desc
ription
int
Value:FV_CMSCheckinUI_Id_Description
Constants.FV_CMSCheckinUI_Id_Chec
kinComment
int
Value:FV_CMSCheckinUI_Id_CheckinComment
Constants.FV_CMSCheckinUI_Id_Mak
eThisCurrentVersion
int
Value:FV_CMSCheckinUI_Id_MakeThisCurrentVersion
Constants.FV_CMSDeleteUI_DeleteAll
Version
int
Value:FV_CMSDeleteUI_DeleteAllVersion
Constants.FV_CMSDeleteUI_DeleteAll
Dependents
int
Value:FV_CMSDeleteUI_DeleteAllDependents
Constants.FV_CMSCommandId_Min int
Value:FV_CMSCommandId_Min
Constants.FV_CMSCommandNameId int
Value:FV_CMSCommandNameId
Constants.FV_CMSCommandConnTyp
eId
int
Value:FV_CMSCommandConnTypeId
Constants.FV_CMSCommandServerId int
Value:FV_CMSCommandServerId
Constants.FV_CMSCommandUserNam
eId
int
Value:FV_CMSCommandUserNameId
Constants.FV_CMSCommandPasswor
dId
int
Value:FV_CMSCommandPasswordId
Constants.FV_CMSCommandUserField
1
int
Value:FV_CMSCommandUserField1
Constants.FV_CMSCommandReposito
ryId
int
Value:FV_CMSCommandRepositoryId
Constants.FV_CMSCommandUserField
2
int
Value:FV_CMSCommandUserField2
Constants.FV_CMSCommandFilePathI
d
int
Value:FV_CMSCommandFilePathId
Constants.FV_CMSCommandSearchSt
ringId
int
Value:FV_CMSCommandSearchStringId
Property name Data Type
294
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_CMSCommandAdvance
dSearchStringId
int
Value:FV_CMSCommandAdvancedSearchStringId
Constants.FV_CMSCommandId int
Value:FV_CMSCommandId
Constants.FV_CMSContextMenuId int
Value:FV_CMSContextMenuId
Constants.FV_CMSContextMenuString int
Value:FV_CMSContextMenuString
Constants.FV_CMSSilentOperation int
Value:FV_CMSSilentOperation
Constants.FV_CMSCommandCheckout
WithDescendentId
int
Value:FV_CMSCommandCheckoutWithDescendentId
Constants.FV_CMSCommandCheckin
MakeCurrentVersionId
int
Value:FV_CMSCommandCheckinMakeCurrentVersionI
d
Constants.FV_CMSCommandCheckinK
eepLocalCopyId
int
Value:FV_CMSCommandCheckinKeepLocalCopyId
Constants.FV_CMSCommandCheckin
MinorVersionId
int
Value:FV_CMSCommandCheckinMinorVersionId
Constants.FV_CMSCommandCheckinV
ersionLabelId
int
Value:FV_CMSCommandCheckinVersionLabelId
Constants.FV_CMSCommandCheckinD
escriptionId
int
Value:FV_CMSCommandCheckinDescriptionId
Constants.FV_CMSCommandCheckinC
ommentId
int
Value:FV_CMSCommandCheckinCommentId
Constants.FV_CMSCommandDeleteAll
VersionId
int
Value:FV_CMSCommandDeleteAllVersionId
Constants.FV_CMSCommandDeleteAll
DependentsId
int
Value:FV_CMSCommandDeleteAllDependentsId
Constants.FV_CMSCommandOpenRea
dOnlyId
int
Value:FV_CMSCommandOpenReadOnlyId
Constants.FV_CMSCommandSilentOp
enId
int
Value:FV_CMSCommandSilentOpenId
Property name Data Type
295
CONSTANTS
CHAPTER 5 OBJECT REFERENCE
Constants.FV_CMSCommandId_Max int
Value:FV_CMSCommandId_Max
Constants.FE_CMSNameAlreadyRegist
ered
int
Value:-112
Constants.FE_CMSBadSessionId int
Value:-113
Constants.FE_CMSBadObjectId int
Value:-114
Constants.FE_CMSSessionFailed int
Value:-115
Constants.FE_CMSBadCommandId int
Value:-116
Constants.FE_CMSObjectCreationFaile
d
int
Value:-117
Constants.FE_CMSRootObjectExists int
Value:-118
Constants.FE_CMSBadItemFileType int
Value:-119
Constants.FE_CMSBadItemType int
Value:-120
Constants.FE_CMSBadItemContainerT
ype
int
Value:-121
Constants.FE_CMSSessionCreationFail
ed
int
Value:-122
Constants.FE_CMSIsValidCMSComma
nd
int
Value:-123
Constants.FE_CMSFailedLogin int
Value:-150
Constants.FE_CMSFailedCheckout int
Value:-151
Constants.FE_CMSFailedCheckin int
Value:-152
Constants.FE_CMSFailedCancelChecko
ut
int
Value:-153
Property name Data Type
296
DOC
CHAPTER 5 OBJECT REFERENCE
5.33. Doc
Constants.FE_CMSFailedDelete int
Value:-154
Constants.FE_CMSFailedOpenFile int
Value:-155
Constants.FE_CMSFailedUploadObject int
Value:-156
Constants.FE_CMSFailedDownloadObj
ect
int
Value:-157
Constants.FE_CMSFailedGetItemFrom
path
int
Value:-158
Constants.FE_CMSFailedLogout int
Value:-159
Property name Data Type Description
BannerTextDisplay Bool Specifies whether banner text should
be displayed in a document. Here is
an example of usage:
F_ApiGetInt(FV_SessionId,
F_ObjHandleT
docId,FP_BannerTextDispla
y);F_ApiSetInt(FV_Session
Id, F_ObjHandleT
docId,FP_BannerTextDispla
y,True/False);
CurrentPage FMObject Denotes the current page [Body page,
Master page or Reference page] in
the document.
FirstBodyPageInDoc BodyPage Denotes the first body page in the
document.
FirstCharFmtInDoc CharFmt Indicates the first character tag in the
list of the document's character tags.
FirstColorInDoc Color Specifies the first color in the list of
document's colors.
Property name Data Type
297
DOC
CHAPTER 5 OBJECT REFERENCE
FirstCombinedFontDefnInDoc CombinedFo
ntDefn
Specifies the first combined font
definition in the list of the
document's combined font
definitions.
FirstCondFmtInDoc CondFmt Indicates the first condition tag in the
list of the document's condition tags.
FirstDITAConrefElementInDoc string Gets the first Conref element in the
document
FirstDITALinkElementInDoc string Gets the first Conref element in the
document
FirstDITATopicrefElementInDoc string Gets the first Topicref element in the
document
FirstDITATopicsetrefElementInDoc string Gets the first Topicref element in the
document
FirstDITAXrefElementInDoc string Gets the first cross reference element
in the document
FirstFlowInDoc Flow Denotes the first flow in the list of the
document's flows.
FirstFnInDoc Fn Specifies the first footnote in the list
of the document's footnotes.
FirstGraphicInDoc FMObject Indicates the first graphic object in
the list of the document's graphic
objects.
FirstMarkerInDoc Marker Denotes the first marker in the list of
the document's markers.
FirstMarkerTypeInDoc MarkerType Specifies the first marker type in the
list of the document's marker types.
FirstMasterPageInDoc MasterPage Denotes the first master page in the
document.
FirstPgfFmtInDoc PgfFmt Indicates the first paragraph tag in
the list of the document's paragraph
tags.
FirstPgfInDoc Pgf Specifies the first paragraph in the list
of the document's paragraphs.
Property name Data Type Description
298
DOC
CHAPTER 5 OBJECT REFERENCE
FirstRefPageInDoc RefPage Denotes the first reference page in
the document.
FirstRubiInDoc Rubi Specifies the first rubi composite in
the list of the document's rubi
composites.
FirstRulingFmtInDoc RulingFmt Indicates the first ruling format in the
list of the document's ruling formats.
FirstSelectedTiInDoc FMObject Specifies the first selected text inset
[(FO_TiApiClient, FO_TiText,
FO_TiTextTable, or FO_TiFlow ID)]in
the list of selected text insets in the
document.
FirstSelectedGraphicInDoc FMObject Denotes the first selected graphic
object [FO_Graphic ID] in the list of
selected graphic objects in the
document.
SelectedTbl Tbl Denotes the table [FO_Tbl ID]
containing the selected table cells.
FirstTblFmtInDoc TblFmt Denotes the first table format
[FO_TblFmt ID] in the list of the
document's table formats.
FirstTblInDoc Tbl Denotes the first table [FO_Tbl ID] in
the list of the document's tables.
FirstTiInDoc FMObject Denotes the first text inset
[FO_TiApiClient, FO_TiText,
FO_TiTextTable, or FO_TiFlow ID] in
the list of the document's text insets.
FirstVarFmtInDoc VarFmt Specifies the first variable format
[FO_VarFmt ID] in the list of the
document's variable formats.
FirstVarInDoc Var Indicates the first variable [FO_Var ID]
in the list of the document's
variables.
FirstXRefFmtInDoc XRefFmt Denotes the first cross-reference
format [FO_XRefFmtID] in the list of
the document's cross reference
formats.
Property name Data Type Description
299
DOC
CHAPTER 5 OBJECT REFERENCE
FirstXRefInDoc XRef Specifies the first cross-reference
[FO_XRef ID] in the list of the
document's cross-references.
HiddenPage HiddenPage Denotes a hidden page
[FO_HiddenPage ID] in the
document.
KeyCatalog BodyPage Indicates the last body page
[FO_BodyPage ID] in the document.
LastBodyPageInDoc BodyPage Indicates the last body page
[FO_BodyPage ID] in the document.
LastMasterPageInDoc MasterPage Indicates the last master page
[FO_MasterPage ID] in the document.
LastRefPageInDoc RefPage Specifies the last reference page
[FO_RefPage ID] in the document.
LeftMasterPage MasterPage Denotes the left master page
[FO_MasterPage ID] in the document.
MainFlowInDoc Flow Specifies the main flow [FO_Flow ID]
in the document.
MarkerTypeNames Strings Indicates the list of marker type
names.
NextOpenDocInSession Doc Denotes the next open document
[(FO_Doc ID] in the list of open
documents in the session.
RightMasterPage MasterPage Denotes the right master page
[FO_MasterPage ID] in the document.
AcrobatBookmarkDisplayTags int Set to 1 if Include Paragraph Tags in
Bookmark Text is on (the paragraph
tag is added before the paragraph
text in each bookmark); 0, otherwise.
Property name Data Type Description
300
DOC
CHAPTER 5 OBJECT REFERENCE
Direction int Set or get the direction of the
document. Possible values:
•Constants.FV_DIR_Inherit
- Inherit the direction of the
parent
•Constants.FV_DIR_LTR -
Left-to-right
•FV_DIR_RTL - Right-to-left
ResolvedDirection int Get the inherited direction of the
document. Possible values:
•Constants.FV_DIR_LTR -
Left-to-right
•FV_DIR_RTL - Right-to-left
AsianComposer bool Whether the document will use the
Asian Composer layout engine.
DocAcrobatColumnArticleThreads int Set to 1 if you want separate article
threads for each column; 0 if you
want separate article threads for each
text frame.
The DocPDFNoArticleThread
property must be set to False, if the
DocAcrobatColumnArticleThreads
property is set to True.
DocAcrobatDefaultsChanged int Set to 1 if the default heuristics for
determining the paragraph level are
disabled; 0 otherwise.
DocAcrobatElementList Strings Denotes the list of the element tags
and context labels to include in
bookmarks. The DocPDFElementList
property applies only to structured
FrameMaker documents.
DocAcrobatElements int Set to 1 if elements rather than
paragraphs are used for bookmarks;
set to 0 otherwise. The
DocPDFElements property applies
only to structured FrameMaker
documents.
Property name Data Type Description
301
DOC
CHAPTER 5 OBJECT REFERENCE
DocAcrobatNoArticleThreads int Set to 1 if you do not want article
threads in the resulting PDF; set to 0
otherwise.
GenerateAcrobatInfo int Set to 1 if Generate Adobe Acrobat
Data is on. To generate PDF data, you
must set the other document print
properties as follows:
• PrintToFile - True
• PrintThumbnails - False
• PrintSeps - False
• PrintBlankPages - True
• PrintLastSheetFirst - False
• PrintNumCopies - 1
• PrintOddPages - True
• PrintEvenPages - True
• PrintScale - 100%
PDFAllNamedDestinations int Set to 1 to create named destinations
for all paragraphs and elements in the
PDF file generated from this
document.
PDFBookmark bool Set to True if FrameMaker is to
generate bookmarks when saving as
PDF; set to False otherwise.
Property name Data Type Description
302
DOC
CHAPTER 5 OBJECT REFERENCE
PDFBookmarksOpenLevel int Denote the level of bookmarks to
have expanded when Acrobat opens
the generated PDF document. The
value can be any integer, or one of
the following defined values:
• Constants.FV_PDFBookmarksOpen-
DefaultLevel (-1)
• Constants.FV_PDFBookmarksOpe-
nAllLevels (-2)
• Constant.FV_PDFBookmarksOpen-
NoneLevel (-3)
If you specify an integer greater than
the number of levels in the
Bookmarks Settings,
Constants.FV_PDFBookmarks
OpenAllLevels (-1) takes
effect.
PDFConvertCMYKtoRGB int When 1, the PDFConvertCMYKtoRGB
setting corresponds with setting
Convert CMYK colors to RGB in the
Save As PDF dialog box.
PDFDestsMarked int Set to 1 if the document has
paragraphs or elements marked via
the MarkedForNamed
Destination property.
One of two things must happen in
order for the PDFDestsMarked
property to be True:
1) The document must be created
in version 6.0 or later; the docu-
ment must be opened in version
6.0 or later
2) The PDF FileSize Optimization
client must be run over it to
mark all paragraphs or elements
that are targets of hypertext
links.
Normally, your client should not set
this value.
Property name Data Type Description
303
DOC
CHAPTER 5 OBJECT REFERENCE
PDFDistillerAbsent int A value of 1 indicates that Acrobat
Distiller is not available. Any other
value indicates that Acrobat Distiller
is available.
PDFDocInfo Strings Contains a list of strings expressing
values to be set in the PDF Document
Info dictionary when you save the
book as PDF.
Each dictionary entry is expressed as
a pair of strings; the first string
expresses the field name, and the
second string expresses the field
value.
PDFEndPage string Indicates then last page of the
printing page range, in the
FrameMaker numbering style.
PDFJobOption string Denotes the name of the Distiller Job
Option. If the specified name does
not exist in the Distiller Job Options
list, then the first Distiller Job Option
in the list is used.
PDFJobOptionsAbsent int A value of 1 indicates that PDF Job
Options are not available.
PDFOpenPage string Denote the PDF page number, in the
FrameMaker numbering style, at
which Acrobat opens the generated
PDF document.
PDFPageHeight int Indicates the page height for the
generated PDF.
PDFPageWidth int Indicates the page width for the
generated PDF.
PDFPrintPageRange int Set to 1 to generate PDF for the
specified page range; if set to 0,
FrameMaker generates PDF for the
entire document or book.
Property name Data Type Description
304
DOC
CHAPTER 5 OBJECT REFERENCE
PDFRegistrationMarks int Specifies the registration marks for
the generated PDF. May be one of:
• Constants.FV_PDFRegistra-
tionMarksNone(0)
• Constants.FV_PDFRegistra-
tionMarksWestern (1)
• Constants.FV_PDFRegistra-
tionMarksTombo (2)
PDFSeparateFiles int Set to 1, if a separate PDF file should
be generated for each document in a
book. This property can be set for
single document, but is ignored in
that case.
PDFStartPage string Denotes the first page of the printing
page range, in the FrameMaker
numbering style.
PDFStructure int Set to 1 to generate tagged or
structured PDF.
PDFZoomFactor int When the PDFZoomType property
is set to Constants.FV_PDFZoomNone
(0), the PDFZoomFactor property
denotes the zoom percentage of the
PDF document (metric 25% to
1600%).
If the value of this property is
negative or zero,
Constants.FV_PDFZoomDefault (1)
takes effect.
Property name Data Type Description
305
DOC
CHAPTER 5 OBJECT REFERENCE
PDFZoomType int Indicates the PDF zoom setting with
which Acrobat opens the generated
PDF document. The value can be one
of:
• Constants.FV_PDFZoomDefault
(1)
• Constants.FV_PDFZoomPage (2)
• Constants.FV_PDFZoomWidth
(3)
• Constants.FV_PDFZoomHeight
(4)
• Constants.FV_PDFZoomNone
(0)
If a different value is specified,
Constants.FV_PDFZoomDefau
lt (1) takes effect.
ChapNumComputeMethod int Denotes the component document's
chapter numbering type. The
possible value is one of:
• Constants.FV_NUM_CONTINUE
(0x01): Continue the numbering
from the previous chapter.
• Constants.FV_NUM_RESTART
(0x02): Use the value specified
for the ChapterNumber prop-
erty.
• Constants.FV_NUM_SAME
(0x03): Use the same chapter
number as for the previous file.
• Constants.FV_NUM_READ_FROM_-
FILE (0x00): Use the numbering
properties from the document
associated with this book
component.
ChapterNumber int Use the value of the
ChapterNumberproperty as the
chapter number, if the
ChapNumComputeMethod
property is set to
Constants.FV_NUM_RESTART (0x02).
Property name Data Type Description
306
DOC
CHAPTER 5 OBJECT REFERENCE
ChapterNumStyle int The numbering style. The possible
value is one of:
• Constants.FV_NUMSTYLE_NU-
MERIC (0x00): Arabic.
• Constants.FV_NUMSTYLE_RO-
MAN_UC (0x01): Roman, upper-
case.
• Constants.FV_NUMSTYLE_RO-
MAN_LC (0x02): Roman,lower-
case.
• Constants.FV_NUMSTYLE_AL-
PHA_UC (0x03): Alphabetic,
uppercase.
• Constants.FV_NUMSTYLE_AL-
PHA_LC (0x04): Alphabetic,
lowercase.
• Constants.FV_NUM-
STYLE_KANJI (0x05): Kanji.
• Constants.FV_NUMSTYLE_ZEN-
KAKU (0x06): Zenkaku.
• Constants.FV_NUMSTYLE_ZENKA-
KU_UC (0x07): Zenkaku, upper-
case.
• Constants.FV_NUMSTYLE_ZENKA-
KU_LC (0x08): Zenkaku, lower-
case.
• Constants.FV_NUMSTYLE_KAN-
JI_KAZU (0x09): Kazu.
• Constants.FV_NUMSTYLE_DAIJI
(0x0a): Daiji.
• Constants.FV_NUMSTYLE_TEXT
(0x0b): Text.
ChapterNumText string If the ChapNumStyle property is set
to
Constants.FV_NUMSTYLE_TEX
T (0x0b), use the value of the
ChapterNumText property as the
chapter number.
Dictionary Strings List of words to accept when spell-
checking the document.
Property name Data Type Description
307
DOC
CHAPTER 5 OBJECT REFERENCE
DocIsModified int Set to 1 if the document has been
modified. While this property is
read-only, you can modify a
document without setting this
property to True by setting the
Untouchable property to True for the
document before your client modifies
it. Otherwise, set to 0.
DocIsViewOnly int Set to 1 if the document is View Only,
else set to 0.
DocOpenType int Denotes the type of document
opened. The possible values are:
• Constants.FV_DOC_TYPE_BI-
NARY (0x01): Frame binary
document
• Constants.FV_DOC_TYPE_TEXT
(0x02): ASCII text document
• Constants.FV_DOC_TYPE_MIF
(0x03): MIF document
• Constants.FV_DOC_TYPE_-
FILTER (0x04) : A filtered docu-
ment.
DocSaveType int Denotes the type of document saved.
The possible values are:
• Constants.FV_DOC_TYPE_BI-
NARY (0x01): Frame binary
document
• Constants.FV_DOC_TYPE_TEXT
(0x02): ASCII text document
• Constants.FV_DOC_TYPE_MIF
(0x03): MIF document
• Constants.FV_DOC_TYPE_-
FILTER (0x04) : A filtered docu-
ment.
DontUpdateTextInsets int Set to 1 if FrameMaker is not to
automatically update text insets
when it opens the document.
Property name Data Type Description
308
DOC
CHAPTER 5 OBJECT REFERENCE
DontUpdateXRefs int Set to 1 if FrameMaker is not to
automatically update
cross-references when it opens or
prints the document.
FormatOverride int Specifies whether there are format
overrides at the current insertion
point.
If the insertion point is in a text range
that has a character format applied to
it, the FormatOverride property is
True if (and only if) the text
formatting at the insertion point
overrides the character format.
If the insertion point is in a text range
that does not have a character format
applied to it, the FormatOverride
property is True if (and only if) the
paragraph containing the insertion
point has formatting that overrides
the Paragraph Catalog format.
IsOnScreen int Returns 1 if the document is visible
on the screen, otherwise returns 0.
LineNumDistance Metric Sets the line number display width,
that is, the space in which the line
numbers are displayed.
LineNumRestart int If set, restarts line number display on
each page.
LineNumShow int If set, enables the line number
display.
Name string Denotes the filename of the
document.
Property name Data Type Description
309
DOC
CHAPTER 5 OBJECT REFERENCE
PageNumComputeMethod int Denotes the component document's
page numbering type. The possible
value is one of:
• Constants.FV_NUM_CONTINUE
(0x01): Continue the numbering
from the previous file.
• Constants.FV_NUM_RESTART
(0x02): Restart numbering at
the value specified by the First-
PageNum property.
PgfNumComputeMethod int Denotes the document's paragraph
numbering type. The possible value is
one of:
• Constants.FV_NUM_CONTINUE
(0x01): Continue the numbering
from the previous file.
• Constants.FV_NUM_RESTART
(0x02): Restart the numbering
at 1.
SpecifiedKeyCatalog F_ObjHandl
eT
Key Catalog specified for using for the
document.
StatusLine string Indicates the string that appears in
the document status bar.
NOTE: This property always returns an
empty string when queried; it is
effectively write-only.
If you set the StatusLine property to a
string other than an empty string (""),
the string will remain in the status
bar until you reset it.
To reset the StatusLine property
and enable FrameMaker to
automatically update the status line
with normal status information, set it
to an empty string ("").
TextSelection TextRange Specifies the currently selected text
range or insertion point in the
document.
Property name Data Type Description
310
DOC
CHAPTER 5 OBJECT REFERENCE
Untouchable int Set to 0 by default. Setting this to 1
allows your client to modify a
document without setting the
DocIsModified property to True.
VolNumComputeMethod int Denotes the document's volume
numbering type. The value is one of:
• Constants.FV_NUM_CONTINUE
(0x01): Continue the numbering
from the previous volume.
• Constants.FV_NUM_RESTART
(0x02): Use the value specified
for the VolumeNumber prop-
erty.
• Constants.FV_NUM_SAME
(0x03): Use the same volume
number as for the previous file
VolumeNumber int Use the value of the
VolumeNumber property as the
volume number, if the
VolNumComputeMethod property
is set to
Constants.FV_NUM_RESTART
(0x02).
Property name Data Type Description
311
DOC
CHAPTER 5 OBJECT REFERENCE
VolumeNumStyle int Denotes the volume numbering style.
The value is one of:
• Constants.FV_NUMSTYLE_NU-
MERIC (0x00): Arabic
• Constants.FV_NUMSTYLE_RO-
MAN_UC (0x01): Roman
numerals, uppercase.
• Constants.FV_NUMSTYLE_RO-
MAN_LC (0x02): Roman
numerals,lowercase.
• Constants.FV_NUMSTYLE_AL-
PHA_UC (0x03): Alphabetic,
uppercase.
• Constants.FV_NUMSTYLE_AL-
PHA_LC (0x04): Alphabetic,
lowercase.
• Constants.FV_NUM-
STYLE_KANJI (0x05): Kanji
• Constants.FV_NUMSTYLE_ZEN-
KAKU (0x06): Zenkaku
• Constants.FV_NUMSTYLE_ZENKA-
KU_UC (0x07): Zenkaku, upper-
case.
• Constants.FV_NUMSTYLE_ZENKA-
KU_LC (0x08): Zenkaku, lower-
case.
• Constants.FV_NUMSTYLE_KAN-
JI_KAZU (0x09): Kazu
• Constants.FV_NUMSTYLE_DAIJI
(0x0a): Daiji
• Constants.FV_NUMSTYLE_TEXT
(0x0b): Text
VolumeNumText string Use the value of the
VolumeNumText property, if the
VolNumStyle property is set
toConstants.FV_NUMSTYLE_T
EXT (0x0b).
AutoChangeBars int Returns 1 if Automatic Change Bars
are enabled in the document.
Property name Data Type Description
312
DOC
CHAPTER 5 OBJECT REFERENCE
ChangeBarColor Color Indicates the spot color (FO_Color
ID).
ChangeBarDistance int Denotes the distance between
change bar and text column.
ChangeBarPosition int Denotes the position of the change
bars. The value is one of:
• Constants.FV_CB_COL_LEFT
(0x00): Left of Column
• Constants.FV_CB_COL_RIGHT
(0x01): Right of Column
• Constants.FV_C-
B_COL_NEAREST (0x02): Side
nearest to Page Edge
• Constants.FV_CB_COL_FUR-
THEST (0x03): Side farthest from
Page Edge
ChangeBarThickness int Denotes the width of the change
bars.
ShowAll int Set to 1 to display all document
conditions, else set to 0.
ShowCondIndicators int Set to 1 to display all condition
indicators (Format Overrides). Else,
set to 0.
EqnIntegralSizeLarge int Indicates the point size of integral
symbol in large equations (2 pt to 400
pt).
EqnIntegralSizeMed int Indicates the point size of integral
symbol in medium equations (2 pt to
400 pt).
EqnIntegralSizeSmall int Indicates the point size of integral
symbol in small equations (2 pt to
400 pt).
EqnLevel1SizeLarge int Indicates the point size of level 1
expressions in large equations (2 pt to
400 pt).
Property name Data Type Description
313
DOC
CHAPTER 5 OBJECT REFERENCE
EqnLevel1SizeMed int Indicates the point size of level 1
expressions in medium equations (2
pt to 400 pt).
EqnLevel1SizeSmall int Indicates the point size of level 1
expressions in small equations (2 pt
to 400 pt).
EqnLevel2SizeLarge int Indicates the point size of level 2
expressions in large equations (2 pt to
400 pt).
EqnLevel2SizeMed int Indicates the point size of level 2
expressions in medium equations (2
pt to 400 pt).
EqnLevel2SizeSmall int Indicates the point size of level 2
expressions in small equations (2 pt
to 400 pt).
EqnLevel3SizeLarge int Indicates the point size of level 3
expressions in large equations (2 pt to
400 pt).
EqnLevel3SizeMed int Indicates the point size of level 3
expressions in medium equations (2
pt to 400 pt).
EqnLevel3SizeSmall int Indicates the point size of level 3
expressions in small equations (2 pt
to 400 pt).
EqnSigmaSizeLarge int Indicates the point size of the sigma
symbol in large equations (2 pt to 400
pt).
EqnSigmaSizeMed int Indicates the point size of the sigma
symbol in medium equations (2 pt to
400 pt).
EqnSigmaSizeSmall int Indicates the point size of the sigma
symbol in small equations (2 pt to
400 pt).
Functions string Denotes the character format tag of
the equation font to apply to Math
Functions.
Property name Data Type Description
314
DOC
CHAPTER 5 OBJECT REFERENCE
Numbers string Denotes the character format tag of
the equation font to apply to Math
Numbers.
Strings string Denotes the character format tag of
the equation font to apply to Math
Strings.
Symbols string Denotes the character format tag of
the equation font to apply to Math
Symbols.
SymbolsList Strings List of math symbol fonts used in the
Equation Fonts dialog box.
Variables string List of math symbol fonts used in the
Equation Fonts dialog box.
HypertextDoValidate bool Set to 1 if the next hypertext string
sent to
theHypertextCommandText
property is to be validated.
HypertextCommandText string Denotes the hypertext command to
parse. Setting this value executes the
parser. If the
HypertextDoValidate property
is True, the command is parsed and
validated.
Property name Data Type Description
315
DOC
CHAPTER 5 OBJECT REFERENCE
HypertextParseErr int Contains a non-zero value if there is a
parser error.
This property is set to one of the
following values if there is a parser
error:
• Constants.FV_HypertextSyn-
taxOK (0) - No parse errors.
• Constants.FV_HypertextEmptyCom-
mand (1) - Hypertext string is
empty.
• Constants.FV_HypertextUnrecog-
nizedCommand (2) - Cannot
map the first keyword to an
existing HypertextParsedCmd-
Code value.
• Constants.FV_HypertextMissingAr-
guments (3) - One or more argu-
ments required for the
command is missing.
• Constants.FV_HypertextExtraArgu-
ments (4) - More than the
required number of arguments
for the command; extra argu-
ments were ignored.
• Constants.FV_HypertextBadSyntax-
PathSpec (10) - File reference
expected for this command, but
no valid filepath found.
• Constants.FV_HypertextUnan-
choredPartialPath (11) - File
reference is relative to the
current document, but the
current document has not been
saved; file location could not be
calculated.
• Constants.FV_HypertextHelp-
DirNotFound (20) - Default help
directory either does not exist
(help was not installed) or
cannot be found.
• Constants.FV_HypertextExpec-
tedANumberParam (30) -
Command expected a number
but got text; check the value of
the
HypertextParseBadPara
m parameter.
Property name Data Type Description
316
DOC
CHAPTER 5 OBJECT REFERENCE
HypertextValidateErr int Set to a non-zero value if the
HypertextDoValidate property
is set to True and there is a validation
error.
The HypertextValidateErr
property is set to one of the following
values if there is a validation error:
• Constants.FV_HypertextValid
(0) - No validation errors
• Constants.FV_HypertextUsesDe-
faultText (200) - Default text
was found as an argument; are
you sure the default text is what
you want?
• Constants.FV_HypertextFileNotReg-
ular (210) - The referenced file
could not be found, or is not a
regular file; for example, it could
be a directory name.
• Constants.FV_HypertextFileNot-
MakerDoc (211) - The refer-
enced file is not created by
FrameMaker.
• Constants.FV_HypertextCantOpe-
nDestFile (212) - Cannot open
the file; perhaps you do not
have permission, or the file is
locked.
• Constants.FV_HypertextDestina-
tionLinkNotFound (220) - The
referenced file is valid, but
cannot find the named link
within it.
• Constants.FV_HypertextPa-
geNameNotFound (230) - The
referenced file is valid, but the
specified page is not found.
• Constants.FV_HypertextUnrecog-
nizedObjectType (240) - The
referenced file is valid, but the
link is to an object with an
unrecognized object type.
• Constants.FV_HypertextObjectID-
NotFound (241) - The file is a
link to an object, but cannot find
the linked object.
• Constants.FV_HypertextBadMatrix-
Property name Data Type Description
317
DOC
CHAPTER 5 OBJECT REFERENCE
• Constants.FV_HypertextMatrixCom-
mandInvalid (251)- One of the
commands in the reference
page flow for a matrix command
has a parse or validation error.
• Constants.FV_HypertextFlowMissin-
gLines (252) - The reference
flow for a matrix or popup
command is missing one or
more lines.
• Constants.FV_HypertextNoNamed-
Flow (260) - Cannot find the
named reference flow for a
matrix or popup command.
• Constants.FV_HypertextRecursive-
Flow (261) - The reference flow
for a matrix or popup command
contains nested popup or
matrix commands that name a
parent reference flow.
• Constants.FV_HypertextMissing-
PopupMarker (270) - At least
one entry in the popup
command's reference flow has
no hypertext marker in it.
• Constants.FV_HypertextMissing-
PopupLabelItem (271) - One
entry in the popup command's
reference flow has no text in it.
• Constants.FV_HypertextEmpty-
LineInMiddleOfPopup (272) -
One entry in the popup
command's reference flow has
no text in it.
• Constants.FV_HypertextComman-
dIllegalWithinPopup (273) -
Invalid command in the popup
command's reference flow; for
example, matrix or newlink.
• Constants.FV_HypertextFcodeIn-
valid (280)- Invalid FCode in
the hypertext command.
Property name Data Type Description
318
DOC
CHAPTER 5 OBJECT REFERENCE
HypertextParseBadParam int Denotes the index into the string list
contained in the
HypertextParsedArgs property, in
case of a parser error.
HypertextParseErrMsg string Denotes the message that
FrameMaker generates for a parser
error.
Property name Data Type Description
319
DOC
CHAPTER 5 OBJECT REFERENCE
HypertextParsedCmdCode int Denotes the FrameMaker hypertext
command in the
HypertextCommandText property, as
determined by the parser.
The possible value for the
HypertextParsedCmdCode property
is one of:
• Constants.FV_CmdError (1)
-Parser is in an error state
• Constants.FV_CmdUnknown (2)
- Unknown command
• Constants.FV_CmdNoop (3) -
Command causes no event.
• Constants.FV_CmdAlert (8) -
alert command
• Constants.FV_CmdAlertTitle (9)
- alerttitle command
• Constants.FV_CmdExit (10) -
exit command
• Constants.FV_CmdGoToLink
(11) - gotolink command
• Constants.FV_CmdGoToLink-
FitWin (12) -
gotolinkfitwin command
• Constants.FV_CmdGoToNew
(13) - gotonew command
• Constants.FV_CmdGoToPage
(14) - gotopage command
• Constants.FV_CmdGoToOb-
jectId (15) - gotoObjectId
command
• Constants.FV_CmdGoToObjectId-
FitWin (16) -
gotoObjectIdfitwin
command
• Constants.FV_CmdMatrix (17) -
matrix command
• Constants.FV_CmdMessage
(18) - message command
• Constants.FV_CmdNewLink (19)
- newlink command
• Constants.FV_CmdNextPage
(20) - nextpage command
• Constants.FV_CmdPrevious-
Page (21) - previouspage
command
Property name Data Type Description
320
DOC
CHAPTER 5 OBJECT REFERENCE
• Constants.FV_CmdOpenLink
(22) - openlink command
• Constants.FV_CmdOpenLink-
FitWin (23) -
openlinkfitwin command
• Constants.FV_CmdOpenNew
(24) - opennew command
• Constants.FV_CmdOpenOb-
jectId (25) - openObjectId
command
• Constants.FV_CmdOpenObjectId-
FitWin (26) -
openObjectIdfitwin
command
• Constants.FV_CmdOpenPage
(27) - openpage command
• Constants.FV_CmdPopup (28) -
popup command
• Constants.FV_CmdPreviousLink
(29) - previouslink
command
• Constants.FV_CmdPreviousLink-
FitWin (30) -
previouslinkfitwin
command
• Constants.FV_CmdQuit (31) -
quit command
• Constants.FV_CmdQuitAll (32) -
quitall command
Property name Data Type Description
321
DOC
CHAPTER 5 OBJECT REFERENCE
HypertextParsedCmdDest int Denotes the destination type for link
commands in the
HypertextCommandText property, as
determined by the parser.
The possible value for the
HypertextParsedCmdDest
property is one of:
• Constants.FV_DestNowhere (0)
- No destination found
• Constants.FV_DestMark-
erNewLink (1) - Destination is a
newlink
• Constants.FV_DestFirstPage (2)
- Destination is the first page of
a file
• Constants.FV_DestLastPage (3)
- Destination is the last page of a
file
• Constants.FV_DestPageNum (4)
- Destination is a named page
(usually a page number)
• Constants.FV_DestFluidFlow (5)
- Destination is to a fluid flow
document
• Constants.FV_DestMarker (6) -
Destination is a marker
• Constants.FV_DestObjectId (7) -
Destination is an object ID
(usually for generated hypertext
commands)
• Constants.FV_DestXRef (8) -
Destination is a cross-reference
Property name Data Type Description
322
DOC
CHAPTER 5 OBJECT REFERENCE
HypertextParsedCmdDestObjType int Denotes the type of the object in the
target document, for links to objects.
The possible value is one of:
• Constants.FV_ObjectUnknown
(0) - Unknown or invalid object
• Constants.FV_ObjectMarker (1)
- Object is a marker
• Constants.FV_ObjectPgf (2) -
Object is a paragraph
• Constants.FV_ObjectXref (3) -
Object is a cross-reference
• Constants.FV_ObjectGraphic (4)
- Object is a graphic
• Constants.FV_ObjectElement
(5) - Object is an element
• Constants.FV_ObjectTextInset
(6) - Object is a text inset
• Constants.FV_ObjectDataLink
(7) - Object is subscribed data
HypertextParsedCmdDestObjID int Denotes the object in the target
document for links to objects.
HypertextParsedCmdMatrixRows int Denotes the number of rows in the
matrix, if the value of the
HypertextParsedCmdCode
property is set to
Constants.FV_CmdMatrix (17)
HypertextParsedCmdMatrixColumns int Denotes the number of columns in
the matrix, if the value of the
HypertextParsedCmdCode
property is set to
Constants.FV_CmdMatrix (17)
HypertextParsedLinkName string Indicates either the value of a
newlink command, or a keyword such
as FirstPage or LastPage, for links to
new targets.
HypertextParsedPageName string Denotes the pagenumber, for links to
pages.
Property name Data Type Description
323
DOC
CHAPTER 5 OBJECT REFERENCE
HypertextParsedFlowName string Denotes the name of the flow (on a
reference page) that contains the
popup or matrix list of commands, for
popup and matrix commands.
HypertextParsedClientName string Indicates the name of the API client
to receive the message, for message
commands.
HypertextParsedTitle string Indicates the specified title for the
alert box, if the value of the
HypertextParsedCmdCode
property is set to
Constants.FV_CmdAlertTitle (9)
HypertextParsedMessage string Denotes the specified message for
the hypertext command, if the value
of the
HypertextParsedCmdCode
command is set to
Constants.FV_CmdAlert (8),
Constants.FV_CmdAlertTitle (9) or
Constants.FV_CmdMessage (18).
HypertextParsedDIFileName string Denotes the absolute path to the
target file, expressed in platform
independent syntax, for links to
external files.
MenuBar Menu Denotes the identifier of the
document's menu bar (FO_Menu ID).
ViewOnlyMenuBar Menu Denotes the identifier of the
document's menu bar when the
document is locked (FO_Menu ID).
FnCustNumString string Specifies the characters for custom
document footnote numbers.
FnFirstNum int Indicates the first document footnote
number.
FnFmt string Indicates the footnote paragraph tag.
FnHeightPerCol int Denotes the maximum height
allowed for document footnotes. The
permissible range of values is 36
points to 32767 points.
Property name Data Type Description
324
DOC
CHAPTER 5 OBJECT REFERENCE
FnInstancePosition int Specifies the placement of the
footnote number in the footnote. The
value is one of:
• Constants.FV_FN_POS_SUPER
(0x00) - Superscript
• Constants.FV_FN_POS_BASE-
LINE (0x01) - Baseline
• Constants.FV_FN_POS_SUB
(0x02) - Subscript
FnInstancePrefix string Indicates the prefix to appear before
the document footnote number in
the footnote.
FnInstanceSuffix string Indicates the suffix to appear after
the document footnote number in
the footnote.
FnNumComputeMethod int The document's footnote numbering
type. The value is one of:
• Constants.FV_NUM_CONTINUE
(0x01) - Continue the
numbering from the previous
file.
• Constants.FV_NUM_RESTART
(0x02) - Restart numbering at
the value specified by the asso-
ciated FO_Doc object's
FnFirstNum property.
• Constants.FV_NUM_PERPAGE
(0x03) - Restart numbering on
each page.
Property name Data Type Description
325
DOC
CHAPTER 5 OBJECT REFERENCE
FnNumStyle int Indicates the document footnote
numbering style. The value is one of:
• Constants.FV_FN_NUM_NU-
MERIC (0x00) - Arabic
• Constants.FV_FN_NUM_RO-
MAN_UC (0x01) - Roman upper-
case
• Constants.FV_FN_NUM_RO-
MAN_LC (0x02) - Roman lower-
case
• Constants.FV_FN_NUM_AL-
PHA_UC (0x03) - Alphabetic
uppercase
• Constants.FV_FN_NUM_AL-
PHA_LC (0x04) - Alphabetic
lowercase
• Constants.FV_FN_NUM_KANJI
(0x06) - Kanji characters
• Constants.FV_FN_NUM_ZEN-
KAKU (0x07) - Zenkaku
• Constants.FV_FN_NUM_ZENKA-
KU_UC (0x08) - Zenkaku upper-
case
• Constants.FV_FN_NUM_ZENKA-
KU_LC (0x09) - Zenkaku lower-
case
• Constants.FV_FN_NUM_KAN-
JI_KAZU (0x0A) - Kazu
• Constants.FV_FN_NUM_DAIJI
(0x0B) - Daiji
• Constants.FV_FN_NUM_-
CUSTOM (0x05) - Custom
numbering
Property name Data Type Description
326
DOC
CHAPTER 5 OBJECT REFERENCE
FnRefPosition int Specifies the placement of the
footnote reference in the footnote.
The value is one of:
• Constants.FV_FN_POS_SUPER
(0x00) - Superscript
• Constants.FV_FN_POS_BASE-
LINE (0x01) - Baseline
• Constants.FV_FN_POS_SUB
(0x02) - Subscript
FnRefPrefix string Indicates the prefix to appear before
the number in the document text.
FnRefSuffix string Indicates the suffix to appear after
the number in the document text.
BottomMargin int Indicates the bottom page margin.
ColGap int Denotes the size of the gap between
text columns
DocIsDoubleSided int Set to 1 if the layout of the document
is a 2 sided page; 0 otherwise.
FirstPageNum int Indicates the page number of the first
page.
FirstPageVerso int Set to 1 for right first page; 0 for left
first page.
LeftMargin int Denotes the left page margin.
NumCols int Indicates the number of columns on
the page.
PageHeight int Specifies the height of the
document's pages.
NOTE: Setting this property,
automatically sets the page height for
all the body pages of the document.
Property name Data Type Description
327
DOC
CHAPTER 5 OBJECT REFERENCE
PageNumStyle int Denotes the page numbering style.
The value is one of:
• Constants.FV_PAGE_NUM_NU-
MERIC (0x01) - Arabic
• Constants.FV_PAGE_NUM_RO-
MAN_UC (0x01) - Roman upper-
case
• Constants.FV_PAGE_NUM_RO-
MAN_LC (0x02) - Roman lower-
case
• Constants.FV_PAGE_NUM_AL-
PHA_UC (0x03) - Alphabetic
uppercase
• Constants.FV_PAGE_NUM_AL-
PHA_LC (0x04) - Alphabetic
lowercase
• Constants.FV_PAGE_NUM_KANJI (0
x05) - Kanji characters
• Constants.FV_PAGE_NUM_ZEN-
KAKU (0x06) - Zenkaku
• Constants.FV_PAGE_NUM_ZENKA-
KU_UC (0x07) - Zenkaku upper-
case
• Constants.FV_PAGE_NUM_ZENKA-
KU_LC (0x08) - Zenkaku lower-
case
• Constants.FV_PAGE_NUM_KAN-
JI_KAZU (0x09) - Kazu
• Constants.FV_PAGE_NUM_-
DAIJI (0x0a) - Daiji
Property name Data Type Description
328
DOC
CHAPTER 5 OBJECT REFERENCE
PageRounding int Indicates how to round pages. The
value is one of:
• Constants.FV_PR_DEL_EMPTY
(0x01) - Delete Empty Pages
• Constants.FV_PR_KEEP-
_NUM_EVEN (0x02) - Make
Page Count Even
• Constants.FV_PR_KEEP-
_NUM_ODD (0x03) - Make Page
Count Odd
• FV_PR_DONT_CHANGE (0x04) -
Do Not Change Page Count
PageWidth int Specifies the width of the document's
pages.
NOTE: Setting this property,
automatically sets the page width for
all the body pages of the document.
Property name Data Type Description
329
DOC
CHAPTER 5 OBJECT REFERENCE
PointPageNumStyle int Denotes the point page numbering
style. The value is one of:
• Constants.FV_PAGE_NUM_NU-
MERIC (0x01) - Arabic
• Constants.FV_PAGE_NUM_RO-
MAN_UC (0x01) - Roman upper-
case
• Constants.FV_PAGE_NUM_RO-
MAN_LC (0x02) - Roman lower-
case
• Constants.FV_PAGE_NUM_AL-
PHA_UC (0x03) - Alphabetic
uppercase
• Constants.FV_PAGE_NUM_AL-
PHA_LC (0x04) - Alphabetic
lowercase
• Constants.FV_PAGE_NUM_KANJI (0
x05) - Kanji characters
• Constants.FV_PAGE_NUM_ZEN-
KAKU (0x06) - Zenkaku
• Constants.FV_PAGE_NUM_ZENKA-
KU_UC (0x07) - Zenkaku upper-
case
• Constants.FV_PAGE_NUM_ZENKA-
KU_LC (0x08) - Zenkaku lower-
case
• Constants.FV_PAGE_NUM_KAN-
JI_KAZU (0x09) - Kazu
• Constants.FV_PAGE_NUM_-
DAIJI (0x0a) - Daiji
RightMargin int Denotes the Right page margin.
SmartQuotes int Returns 1 if Smart Quotes is enabled;
returns 0 otherwise.
SmartSpaces int Returns 1 if Smart Spaces is enabled;
returns 0 otherwise.
TopMargin int Denotes the Top Page Margin.
Property name Data Type Description
330
DOC
CHAPTER 5 OBJECT REFERENCE
PrintBlankPages int Returns 1 if the PageRounding
property allows an empty page at end
of a document. Returns 0, otherwise.
PrintCollated int Returns 1 if Collate is enabled.
Returns 0, otherwise.
PrintCols int Indicates the number of columns to
print, if the PrintThumbnails
property is set to True.
PrintEmulsion int Specifies the direction of the print
emulsion. The value is one of:
• Constants.FV_EMUL_UP (0) -
Emulsion side up
• Constants.FV_EMUL_DOWN (1)
- Emulsion side down
PrintEndPage int Specifies the number of the last page
to print.
NOTE: The value of the DocFluidFlow
property must be 0, when you use the
PrintEndPage property. You cannot
print a range of pages when a
document is in fluid view.
PrintEndPageName int Denotes the page number string for
the last page to be printed. Use this
property when the pages are
numbered with a style other than
Constants.FV_PAGE_NUM_NUM
ERIC (0x01).
NOTE: The value of the DocFluidFlow
property must be 0, when you use the
PrintEndPageName property. You
cannot print a range of pages when a
document is in fluid view.
PrintEndPoint int Denotes the number of the last point
page to print.
Property name Data Type Description
331
DOC
CHAPTER 5 OBJECT REFERENCE
PrinterName string Specifies the name of the printer.
NOTE: Setting the PrinterName
property on Windows has no effect.
NOTE: You can set the printer to the
default printer by specifying the
PrinterName as null.
PrintEvenPages int Set to 1 if Print Even-Numbered Pages
is enabled. Set to 0, otherwise.
PrintFileName string Name of the file to which to print.
You can set the filename to the
default filename by specifying the
value of the PrintFileName
property as null.
PrintImaging int Specifies the type of print imaging.
The value is one of:
• Constants.FV_IMG_POSITIVE
(0)
• Constants.FV_IMG_NEGATIVE
(1)
PrintLastSheetFirst int Set to 1 to print the last sheet first.
Else, set to 0.
PrintLowRes int Set to 1 to print in low resolution.
Else, set to 0.
PrintManualFeed int Set to 1 if Manual feed is enabled.
Else, set to 0.
PrintNumCopies int Denotes the number of copies to
print.
PrintOddPages int Set to 1 if Print Odd-Numbered Pages
is enabled. Else, set to 0.
PrintPaperHeight int Specifies the height of the printing
paper.
PrintPaperWidth int Indicates the width of the printing
paper.
PrintRegistrationMarks int Set to 1 if Registration Marks is
enabled; Set to 0 otherwise.
Property name Data Type Description
332
DOC
CHAPTER 5 OBJECT REFERENCE
PrintRows int Indicates the number of rows to print
if the PrintThumbnails property is set
to True.
PrintScale int Denotes the Print scale factor
expressed as a percentage metric (0%
to 100%).For print scale percentages,
the value <<16 or 0x10000 specifies
100%.
PrintScope int Denotes the pages to print. The value
is one of:
• Constants.FV_PR_ALL (1) - Print
all pages
• Constants.FV_PR_RANGE (2) -
Print a range of pages
NOTE: The value of the DocFluidFlow
property must be set to 0 when you
set the PrintScope property. You
cannot print a range of pages when a
document is in the fluid view.
PrintSeps int Returns 1 if Print Separations
is enabled. Else, returns 0.
PrintStartPage int Denotes the number of the first page
to print.
NOTE: The value of the DocFluidFlow
property must be set to 0 when you
set the PrintStartPage property. You
cannot print a range of pages when a
document is in the fluid view.
PrintStartPageName int Indicates the page number string for
the first page to print.This property is
valid only when the pages are
numbered with a style other than
Constants.FV_PAGE_NUM_NUMERIC
(0x00)
NOTE: The value of the DocFluidFlow
property must be set to 0 when you
set the PrintStartPage property. You
cannot print a range of pages when a
document is in the fluid view.
Property name Data Type Description
333
DOC
CHAPTER 5 OBJECT REFERENCE
PrintStartPoint int Indicates the number of the first
point page to print.
PrintThumbnails int Returns 1 if Print Thumbnails is
enabled. Returns 0, otherwise.
PrintToFile int Returns 1 if Print Only to File is
enabled. Else, returns 0.
SkipBlankSeps int Returns 1 if Skip Blank Separations
(do not print blank color separations)
is enabled. Else, returns 0.
TrapwiseCompatibility bool Set to 1 if Trapwise Compatibility is
enabled. Else, set to 0.
NOTE: Setting the
TrapwiseCompatibility parameter to
True automatically sets the
PrintToFile parameter to True and the
PrintSeps parameter to False.
NarrowRubiSpaceForOther int Denotes the value for a composite
ruby object. The value is one of:
• Constants.FV_Wide (0)
• Constants.FV_Narrow (1)
• Constants.FV_Proportional (2)
RubiOverhang int Set to 1 if Rubi is allowed to
overhang, else set to 0.
RubiSize int Specifies the scaling factor for rubi
text expressed as percentage of the
current font size (metric 1% to
1000%).
NOTE: If the RubiSize property and the
RubiFixedSize property are both set,
the most recently set property value
is used.
RubiFixedSize int Specifies the fixed size for all rubi text
(metric 2 points to 400 points).
NOTE: If the RubiFixedSize property
and the RubiSize property are both
set, the most recently set property
value is used.
Property name Data Type Description
334
DOC
CHAPTER 5 OBJECT REFERENCE
WideRubiSpaceForOther int Denotes the value for a composite
ruby object. The value is one of:
• Constants.FV_Wide (0)
• Constants.FV_Narrow (1)
• Constants.FV_Proportional (2)
ElementSelection ElementRan
ge
Denotes the currently selected
element range in the document.
CustomElementList Strings Contains the list of tags to display
when the
ElementCatalogDisplay
property is set to
Constants.FV_ELCAT_CUSTOM
(0x04).
DefaultExclusions Strings Indicates the list of exclusions
inherited when a document is
included in a structured book.
DefaultInclusions Strings Indicates the list of inclusions
inherited when a document is
included in a structured book.
ElementBoundaryDisplay int Specifies the Element Boundary
Display options. The value is one
of:
• Constants.FV_ELEM_DISP_-
NONE (0) - Do not display any
element boundaries
• Constants.FV_ELEM_DISP_BRACKET
S (1) - Display the bracketed
boundaries
• Constants.FV_ELEM_DISP_TAGS (
2) - Display the element tags
ElementCatalog ElementCat
alogEntrie
s
Displays the list of elements in the
Element Catalog.
Property name Data Type Description
335
DOC
CHAPTER 5 OBJECT REFERENCE
ElementCatalogDisplay int Indicates the catalog display options.
The value is one of:
• Constants.FV_ELCAT_STRICT
(0x00)- Valid children for
working from start to finish
• Constants.FV_ELCAT_LOOSE
(0x01) - Valid children for
working in any order
• Constants.FV_ELCAT_CHIL-
DREN (0x02) - Children allowed
anywhere in the parent
• Constants.FV_ELCAT_ALL (0x03)
- All elements
• Constants.FV_ELCAT_CUSTOM
(0x04) - The list of tags specified
by the CustomElementList prop-
erty.
FirstElementDefInDoc ElementDef Denotes the first element definition
in the list of element definitions in
the document (FO_ElementDef ID).
FirstFmtChangeListInDoc FmtChangeL
ist
Specifies the ID of the first format
change list in the list of format
change lists in the
book.(FO_FmtChangeList ID).
MaxBottomMargin int Specifies the maximum bottom
margin allowed in the document.
MaxFirstIndent int Specifies the maximum first indent
allowed in the document.
MaxFontSize int Denotes the maximum font size
allowed in the document.
MaxLeading int Denotes the maximum leading
allowed in the document.
MaxLeftIndent int Specifies the maximum left indent
allowed in the document.
MaxLeftMargin int Specifies the maximum left margin
allowed in the document.
Property name Data Type Description
336
DOC
CHAPTER 5 OBJECT REFERENCE
MaxRightIndent int Specifies the maximum right indent
allowed in the document.
MaxRightMargin int Specifies the maximum right margin
allowed in the document.
MaxSpaceAbove int Denotes the maximum space above
paragraph allowed in the document.
MaxSpaceBelow int Denotes the maximum space below
paragraph allowed in the document.
MaxStretch int Denotes the maximum character
stretch (set width) expressed as a
percentage of normal stretch for the
font (metric –10% to 1000%).
MaxTabPosition int Specifies the maximum tab position
allowed in the document.
MaxTopMargin int Specifies the maximum top margin
allowed in the document.
MinBottomMargin int Specifies the minimum bottom
margin allowed in the document.
MinFirstIndent int Specifies the minimum first indent
allowed in the document.
MinFontSize int Denotes the minimum font size
allowed in the document.
MinLeading int Denotes the minimum leading
allowed in the document.
MinLeftIndent int Denotes the minimum left indent
allowed in the document.
MinLeftMargin int Denotes the minimum left margin
allowed in the document.
MinRightIndent int Denotes the minimum right indent
allowed in the document.
MinRightMargin int Denotes the minimum right margin
allowed in the document.
MinSpaceAbove int Denotes the minimum space above
the paragraph allowed in the
document.
Property name Data Type Description
337
DOC
CHAPTER 5 OBJECT REFERENCE
MinSpaceBelow int Denotes the minimum space below
the paragraph allowed in the
document.
MinStretch int Indicates the minimum character
stretch (set width) expressed as a
percentage of normal stretch for the
font (metric –10% to 1000%)
MinTabPosition int Indicates the minimum tab position
allowed in the document.
MinTopMargin int Indicates the minimum top margin
allowed in the document.
NewElemAttrDisplay int Specifies the attribute display
properties for new elements. The
value is one of:
• Constants.FV_ATTR_DISP_-
NONE (1) - Do not display attri-
butes
• Constants.FV_AT-
TR_DISP_REQSPEC (2) - Display
required and specified attri-
butes
• Constants.FV_ATTR_DISP_ALL
(3) - Display all attributes
NewElemAttrEditing int Specifies when the Edit Attributes
dialog box appears for new elements.
The value is one of:
• Constants.FV_ATTR_EDIT_-
NONE (0)
• Constants.FV_ATTR_EDIT_RE-
QUIRED (1)
• Constants.FV_ATTR_EDIT_AL-
WAYS (2)
SeparateInclusions int Returns 1 if inclusions are listed
separately in the Element Catalog.
Else, returns 0.
Property name Data Type Description
338
DOC
CHAPTER 5 OBJECT REFERENCE
StructuredApplication string The name of the structure application
that is associated with the document.
If the document has no associated
structure application, the
GetString() method returns an
empty string.
UseInitialStructure int Returns 1 if FrameMaker inserts the
initial structure for new elements.
Else, returns 0.
XmlDocType string Contains the DOCTYPE parameter.
from the source XML.
XmlEncoding string Contains the encoding parameter of
the XML Declaration for the source
XML document.
The string is empty if no encoding is
specified.
If the XmlEncoding property is set,
the XML Declaration contains the
encoding parameter with the set
value on Save As XML operation.
XmlFileEncoding string Specifies the encoding that is
detected for the source XML book. If
no encoding is specified for the
source XML, the value of the
XmlEncoding property will be an
empty string. In that case, if this
string is set, it determines the
encoding to use when saving as XML.
If the XmlEncoding property has a
value, the value of
theXmlFileEncoding property
may be null.
XmlPublicId string Indicates the DOCTYPE public
identifier for the source XML
document.
Property name Data Type Description
339
DOC
CHAPTER 5 OBJECT REFERENCE
XmlStandAlone int An integer that specifies the XML
standalone parameter for the XML
document that is the source of the
current document. The value is one
of:
• Constants.FV_XML_STAND-
ALONE_YES (1)
• Constants.FV_XML_STAND-
ALONE_NO (2)
• Constants.FV_XML_STAND-
ALONE_NODEC (3)
• Constants.FV_XML_STANDALONE_-
NONE (4)
The standalone parameter is declared
in the XML Declaration.
For a file with no XML Declaration,
the value is
Constants.FV_XML_STANDALONE_N
ODEC (3).
For an XML Declaration with no
standalone parameter, this value is
Constants.FV_XML_STANDALONE_N
ONE (4).
XmlStyleSheet string Specifies the XML stylesheet
processing instruction to write out to
XML when saving the document as
XML. The ESTK does not verify that
you use correct syntax in this
string.The value you set should not
include the PI delimiters,<? and ?>.
For example, the string you supply for
my.css may be:
"type=\"text\\css\"
href=\"my.css\""
Only use this string to set a specific
stylesheet specification.
NOTE: The GetString() method always
returns null for this property. To get
the list of stylesheet specifications
associated with a document, use the
XmlStyleSheetList property.
Property name Data Type Description
340
DOC
CHAPTER 5 OBJECT REFERENCE
XmlStyleSheetList Strings Contains a list of stylesheet
processing instructions for the
current document.A document can
have more than one stylesheet
specification associated with it. The
ESTK does not verify that you use the
correct syntax in these strings. The
value you set should not include the
PI delimiters,<? and ?>. For
example, the string you supply for
my.css may be:
"type=\"text\\css\"
href=\"my.css\""
Setting a list to the XmlStyleSheetList
property completely overwrites the
preceding list.
XmlSystemId string Specifies the DOCTYPE system
identifier for the source XML
document.
XmlUseBOM int Indicates whether a byte order mark
was detected when opening the
source XML. The value is one of:
• Constants.FV_XML_USE-
BOM_YES (1)
• Constants.FV_XML_USE-
BOM_NO (2)
If this value is set to
Constants.FV_XML_USEBOM_YES (1),
FrameMaker writes a byte order
mark in the resulting XML, when
saving as XML.
XmlVersion string Indicates the XML Version that was
specified in the XML Declaration
when the file was opened.
If no XML version was specified, the
GetString() method returns an empty
string. If this string contains an invalid
XML declaration, a parsing error
occurs when the document is saved
as XML.
Property name Data Type Description
341
DOC
CHAPTER 5 OBJECT REFERENCE
XmlWellFormed int Indicates whether the source XML
qualified as well formed. The value is
one of:
• Constants.FV_XML_WELL-
FORMED_YES (1)
• Constants.FV_XML_WELL-
FORMED_NO (2)
TblFnCellPosition int Denotes the placement of footnote
number in footnote text. The value is
one of:
• Constants.FV_FN_POS_SUPER
(0x00) - Superscript
• Constants.FV_FN_POS_BASE-
LINE (0x01) - Baseline
• Constants.FV_FN_POS_SUB
(0x02) - Subscript
TblFnCellPrefix string Specifies the prefix to appear before
the table footnote number in table
cell.
TblFnCellSuffix string Specifies the suffix to appear after
the table footnote number in table
cell.
TblFnCustNumString string Specifies the characters for custom
table footnote numbers.
TblFnFmt string Represents the paragraph tag of the
table footnote.
Property name Data Type Description
342
DOC
CHAPTER 5 OBJECT REFERENCE
TblFnNumStyle int Denotes the footnote numbering
style for tables in the document. The
value is one of:
• Constants.FV_FN_NUM_NU-
MERIC (0x00) - Arabic
• Constants.FV_FN_NUM_RO-
MAN_UC (0x01) - Roman upper-
case
• Constants.FV_FN_NUM_RO-
MAN_LC (0x02) - Roman lower-
case
• Constants.FV_FN_NUM_AL-
PHA_UC (0x03) - Alphabetic
uppercase
• Constants.FV_FN_NUM_AL-
PHA_LC (0x04) - Alphabetic
lowercase
• Constants.FV_FN_NUM_KANJI
(0x06) - Kanji characters
• Constants.FV_FN_NUM_ZEN-
KAKU (0x07) - Zenkaku
• Constants.FV_FN_NUM_ZENKA-
KU_UC (0x08) - Zenkaku upper-
case
• Constants.FV_FN_NUM_ZENKA-
KU_LC (0x09) - Zenkaku lower-
case
• Constants.FV_FN_NUM_KAN-
JI_KAZU (0x0A) - Kazu
• Constants.FV_FN_NUM_DAIJI
(0x0B) - Daiji
• Constants.FV_FN_NUM_-
CUSTOM (0x05) - Custom
numbering.
Property name Data Type Description
343
DOC
CHAPTER 5 OBJECT REFERENCE
TblFnPosition int Denotes the placement of the
footnote number in the text. The
value is one of:
• Constants.FV_FN_POS_SUPER
(0x00) - Superscript
• Constants.FV_FN_POS_BASE-
LINE (0x01) - Baseline
• Constants.FV_FN_POS_SUB
(0x02) - Subscript
TblFnPrefix string Indicates the prefix to appear before
the number in the table footnote.
TblFnSuffix string Indicates the suffix to appear after
the number in the table footnote.
Capitalization int Indicates the type of capitalization.
The value is one of:
• Constants.FV_CAPITAL_-
CASE_NORM (0)
• Constants.FV_CAPITAL_-
CASE_SMALL (1)
• Constants.FV_CAPITAL_-
CASE_LOWER (2)
• Constants.FV_CAPITAL_-
CASE_UPPER (3)
ChangeBar int Returns 1 if Changebars are enabled.
Else, returns 0.
CharTag string Indicates the name of the character
format tag.
Color Color Denotes the Spot color (FO_Color ID).
CondFmtIsShown int Returns 1 if the document conditions
are shown. Else, returns 0.
CombinedFontFamily CombinedFo
ntDefn
Contains the Combined font
definition (FO_CombinedFontDefn)
FontEncodingName string Specifies the font encoding.
Property name Data Type Description
344
DOC
CHAPTER 5 OBJECT REFERENCE
FontAngle int Denotes the font angle (specifies an
index into the array of font angles
provided by the session property,
FontAngleNames).
FontFamily int Denotes the font family (specifies an
index into the array of font families
provided by the session property,
FontFamilyNames).
FontPlatformName string Indicates the name that uniquely
identifies a font on a specific
platform.
FontPostScriptName string Indicates the name given to a font
when it is sent to a PostScript printer.
FontSize int Specifies the font size (2 point to 400
point).
FontVariation int Denotes the font variation (specifies
an index into the array of font
variations provided by the session
property FontVariationNames).
FontWeight int Denotes the font weight (specifies an
index into the array of font weights
provided by the session property
FontWeightNames).
InCond Objects Indicates the condition tags that
apply to the text (an array of
FO_CondFmt IDs).
KernX int Specifies the horizontal kern value for
manual kerning expressed as a
percentage of an em (metric – 100%
to 1000%). A positive value moves a
character right and a negative value
moves a character left.
KernY int Specifies the vertical kern value for
manual kerning expressed as a
percentage of an em (metric – 100%
to 1000%). A positive value moves
characters up and a negative value
moves characters down.
Property name Data Type Description
345
DOC
CHAPTER 5 OBJECT REFERENCE
Overline int Returns 1 if Overline style is
enabled, else returns 0.
PairKern int Returns 1 if Pair Kern is enabled,
else returns 0.
Position int Denotes the text position relative to
the baseline of text. The value is one
of:
• Constants.FV_POS_NORM (0) -
Normal
• Constants.FV_POS_SUPER (1) -
Superscript
• Constants.FV_POS_SUB (2) -
Subscript
SepOverride Color Specifies the custom color separation
override (FO_Color ID).
Stretch int Denotes the character stretch (set
width) expressed as a percentage of
normal stretch for the font (metric –
10% to 1000%).
Strikethrough int Returns 1 if Strikethrough style is
enabled. Else, returns 0.
StyleOverrides int Specifies the style condition
indicators for conditional text. The
value is one of:
• Constants.FV_CN_NO_OVER-
RIDE (0)
• Constants.FV_CN_OVERLINE (1)
• Constants.FV_CN_STRIKE-
THROUGH (2)
• Constants.FV_CN_SINGLE_UNDER-
LINE (3)
• Constants.FV_CN_DOUBLE_UNDER-
LINE (4)
Property name Data Type Description
346
DOC
CHAPTER 5 OBJECT REFERENCE
Underlining int Denotes the style of underlining. The
value is one of:
• Constants.FV_CB_NO_UNDER-
LINE (0)
•Constants.FV_CB_SINGLE_UNDER-
LINE (1)
• Constants.FV_CB_DOUBLE_UNDER-
LINE (2)
• Constants.FV_CB_NUMER-
IC_UNDERLINE (3)
UseSepOverride int Returns 1 if the value of the
SepOverride property overrides
the default color separation. Else,
returns 0.
LineBreakAfter string Indicates the characters at which it is
permissible to break lines.
SmallCapsSize int Indicates the scaling factor for small
caps expressed as a percentage of
current font size (metric 1% to
1000%).
SmallCapsStretch int Denotes the character stretch (set
width) for small caps expressed as a
percentage of normal stretch for the
font (metric –10% to 1000%).
SubScriptShift int Denotes the baseline offset of
subscripts expressed as a percentage
of current font size (metric 1% to
1000%).
SubScriptSize int Indicates the scaling factor for
subscripts expressed as a percentage
of current font size (metric 1% to
1000%).
SubScriptStretch int Indicates the character stretch (set
width) for subscripts expressed as a
percentage of normal stretch for the
font (metric –10% to 1000%).
Property name Data Type Description
347
DOC
CHAPTER 5 OBJECT REFERENCE
SuperScriptShift int Denotes the baseline offset of
superscripts expressed as percentage
of current font size (metric 1% to
1000%).
SuperScriptSize int Specifies the scaling factor for
superscripts expressed as percentage
of the current font size (metric 1% to
1000%)
SuperScriptStretch int Specifies the character stretch (set
width) for superscripts expressed as a
percentage of normal stretch for the
font (metric –10% to 1000%).
IsIconified int Returns 1 if the document window is
iconified. Else, returns 0.
IsInFront int Set to 1 if the document window is in
front of other windows in the
FrameMaker product session. Else,
set to 0.
Label string Denotes the title in the document
window title bar.
ScreenHeight int Denotes the height of the document
window in pixels.
ScreenWidth int Denotes the width of the document
window in pixels.
ScreenX int Indicates the offset of the document
window in pixels from the left side of
the screen (or the left of the
FrameMaker application window).
If you set a value that results in the
document window being off the
screen, that value is ignored and the
old value is retained.
Property name Data Type Description
348
DOC
CHAPTER 5 OBJECT REFERENCE
ScreenY int Indicates the offset of the document
window in pixels from the top of the
screen (or the top of the FrameMaker
application window).
If you set a value that results in the
document window being off the
screen, that value is ignored and the
old value is retained.
SnapAngle int Specifies the angle of rotation for
Snap Rotate.
SnapGridUnits int Denotes the units for Snap Grid
spacing. The permissible range of
values is from 0 to 32768 points.
SpotColorView int Denotes the spot color separation
view. The values range from 0 to 6.0
specifies View 1, 1 specifies View 2,
and so on.
ViewBorders int Returns 1 if Borders is enabled, else
returns 0.
ViewDisplayUnits int Denotes the MetricT equivalent of
one unit in the current Display Units.
For example, if Display Units is points,
this parameter returns 65536.
ViewFontSizeUnits int Denotes the MetricT equivalent of
one unit in the current Font Size Unit.
Font size units can be either Points or
Q. If Points, this returns 65536. If Q,
this returns 47098.
ViewGrid int Returns 1 if View Grid is enabled.
Else, returns 0.
ViewGridUnits int Denotes the units for Grid Lines.
ViewNoGraphics int Returns 1 if Graphics is not enabled.
Else, set to 0.
Property name Data Type Description
349
DOC
CHAPTER 5 OBJECT REFERENCE
ViewPageScrolling int Denotes the Page scrolling technique.
The value is one of:
• Constants.FV_SCROLL_VARI-
ABLE (0)
• Constants.FV_SCROLL_HORI-
ZONTAL (1)
• Constants.FV_SCROLL_VER-
TICAL (2)
• Constants.FV_SCROLL_FACING
(3)
ViewRulers int Returns 1 if Rulers is enabled. Else,
returns 0.
ViewRulerUnits int Denotes the units to display rulers.
ViewTextSymbols int Returns 1 if Text Symbols is enabled.
Else, returns 0.
Zoom int Specifies the zoom percentage of
document (metric 25% to 1600%).
DocFluidFlow Flow Specifies the flow to set to fluid view.
To turn this off, set the value of this
property to 0.
ViewOnlyDeadCodes UInts Indicates the F-codes that cannot be
executed in the document.
ViewOnlySelect int Specifies whether user can select text
or graphics in the document. The
value is one of:
• Constants.FV_VOS_US-
ER_ONLY (1) - the user can
select text when pressing modi-
fier keys, and link targets
(cross-reference sources and
newliniks) do not highlight.
• Constants.FV_VOS_NONE (2) -
the user cannot select text, and
links targets do not highlight.
• Constants.FV_VOS_YES(3) - the
user can select text (using modi-
fier keys) and link targets are
highlighted.
Property name Data Type Description
350
DOC
CHAPTER 5 OBJECT REFERENCE
ViewOnlyWinBorders int Returns 1 if the document has normal
document borders; returns 0 if the
document scroll bars and border
buttons are suppressed.
ViewOnlyWinMenubar int Returns 1 if the document has a
document window menu bar. Else,
returns 0.
ViewOnlyWinPalette int Returns 1 if the document is a
palette. Else, returns 0.
ViewOnlyWinPopup int Returns 1 if the document window
pop-up menu is available. Else,
returns 0.
ViewOnlyXRef int Specifies the behavior of
cross-references in the document.
The value is one of:
• Constants.FV_VOX_NOT_AC-
TIVE(0) - Cross references are
not active.
• Constants.FV_VOX_GOTO_BE-
HAVIOR(1) - Internal
cross-references are active.
• Constants.FV_VOX_OPEN_BE-
HAVIOR(2) - External
cross-references are active.
• Constants.FV_VOX_ALERT(3) -
Alert appears when cross-refer-
ence is clicked.
PDFGenerateForReview int This flag is used to generate a PDF for
review workflow that is getting
review comments in PDF and
importing them back to FrameMaker
document. It helps in importing back
the comments correctly. When this
flag is turned ON, the behavior is
same as if the "Generate for review
only" checkbox is ON in the PDF
setup dialog.
Property name Data Type Description
351
DOC
CHAPTER 5 OBJECT REFERENCE
PDFViewPDF int Set to 1 to open the PDF after
creating it with the Save aS PDF
command.
StructuredApplicationForOpen string Specifies the application that has
been used to open the document.
SecNumComputeMethod int Denotes the type of numbering
applied on a particular section of a
document. The value is one of:
• Constants.FV_NUM_CONTINUE
(0x01)
• Constants.FV_NUM_RESTART
(0x02)
• Constants.FV_NUM_SAME
(0x03)
Property name Data Type Description
352
DOC
CHAPTER 5 OBJECT REFERENCE
SectionNumStyle int Denotes the section numbering style.
The value is one of:
• Constants.FV_PAGE_NUM_NU-
MERIC(0x00) - Arabic
• Constants.FV_PAGE_NUM_RO-
MAN_UC(0x01) - Roman upper-
case
• Constants.FV_PAGE_NUM_RO-
MAN_LC(0x02) - Roman lower-
case
• Constants.FV_PAGE_NUM_AL-
PHA_UC(0x03) - Alphabetic
uppercase
• Constants.FV_PAGE_NUM_AL-
PHA_LC(0x04) - Alphabetic
lowercase
• Constants.FV_PAGE_NUM_KANJI(0x
05) - Kanji characters
• Constants.FV_PAGE_NUM_ZEN-
KAKU(0x06) - Zenkaku
• Constants.FV_PAGE_NUM_ZENKA-
KU_UC(0x07) - Zenkaku upper-
case
• Constants.FV_PAGE_NUM_ZENKA-
KU_LC(0x08) - Zenkaku lower-
case
• Constants.FV_PAGE_NUM_KAN-
JI_KAZU(0x09) - Kazu
• Constants.FV_PAGE_NUM_-
DAIJI(0x0a) - Daiji
SectionNumber int Denotes the section number in the
document.
SectionNumText string Indicates the text to use for the
SectionNumber parameter.
Property name Data Type Description
353
DOC
CHAPTER 5 OBJECT REFERENCE
SubsecNumComputeMethod int Denotes the type of numbering
applied on a particular subsection of
a document. The value is one of:
• Constants.FV_NUM_CONTINUE
(0x01)
• Constants.FV_NUM_RESTART
(0x02)
• Constants.FV_NUM_SAME
(0x03)
SubsectionNumStyle int Denotes the subsection numbering
style. The value is one of:
• Constants.FV_PAGE_NUM_NU-
MERIC(0x00) - Arabic
• Constants.FV_PAGE_NUM_RO-
MAN_UC(0x01) - Roman upper-
case
• Constants.FV_PAGE_NUM_RO-
MAN_LC(0x02) - Roman lower-
case
• Constants.FV_PAGE_NUM_AL-
PHA_UC(0x03) - Alphabetic
uppercase
• Constants.FV_PAGE_NUM_AL-
PHA_LC(0x04) - Alphabetic
lowercase
• Constants.FV_PAGE_NUM_KANJI(0x
05) - Kanji characters
• Constants.FV_PAGE_NUM_ZEN-
KAKU(0x06) - Zenkaku
• Constants.FV_PAGE_NUM_ZENKA-
KU_UC(0x07) - Zenkaku upper-
case
• Constants.FV_PAGE_NUM_ZENKA-
KU_LC(0x08) - Zenkaku lower-
case
• Constants.FV_PAGE_NUM_KAN-
JI_KAZU(0x09) - Kazu
• Constants.FV_PAGE_NUM_-
DAIJI(0x0a) - Daiji
Property name Data Type Description
354
DOC
CHAPTER 5 OBJECT REFERENCE
SubsectionNumber int Denotes the subsection number in
the document
SubsectionNumText string Indicates the text to use for the
SubsectionNumber parameter.
TrackChangesOn bool Set to True if Track Changes are on in
the document. Else, set to False.
PreviewState int Sets/retrieves the state of Track Text
Edits of the document. The value is
one of:
• Constants.FV_PRE-
VIEW_OFF_TRACK_CHANGE (0)
- Displays text edits using the
defined styles.
• Constants.FV_PREVIEW_ON_ORIG-
INAL (1)- Preview of the docu-
ment as if no text edits were
done.
• Constants.FV_PREVIEW_ON_-
FINAL (2) - Preview of the docu-
ment as if all the text edits were
incorporated.
TrackChangesAddedColor Color Sets/retrieves the color in which
tracked additions are displayed.
TrackChangesDeletedColor Color Sets/retrieves the color in which
tracked deletions are displayed.
ReviewerNameList Strings Retrieves the list of reviewers of a
document.
FirstAttrCondExprInDoc AttrCondEx
pr
Denotes the first Attribute
Conditional Expression in the list of
attribute conditional expressions in
the document (FO_AttrCondExpr).
BooleanConditionExpression string Denotes the actual conditional
expression used in the document.
Property name Data Type Description
355
DOC
CHAPTER 5 OBJECT REFERENCE
Doc methods
AddNewBuildExpr, AddText, CenterOnText, Clear, ClearAllChangebars, Close, Compare, Copy, Cut,
DeleteBuildExpr, DeleteText, DeleteUnusedCharFmt, DeleteUnusedFmts, DeleteUnusedPgfFmt, Dele-
teUnusedTblFmt, DemoteElement, ElementLocToTextLoc, Find, GetActiveBuildExpr, GetBuildExpr,
GetBuildExprCatalog, GetNamedAttrCondExpr, GetNamedCharFmt, GetNamedColor, GetNamedCom-
binedFontDefn, GetNamedCondFmt, GetNamedElementDef, GetNamedFmtChangeList, GetNamed-
MarkerType, GetNamedMasterPage, GetNamedObject, GetNamedPgfFmt, GetNamedRefPage,
GetNamedRulingFmt, GetNamedTblFmt, GetNamedUnanchoredFrame, GetNamedVarFmt, GetNam-
edXRefFmt, GetProps, GetTextForRange, GetTextForRange2, GetTextPropVal, GetTextProps, GetTex-
tVal, GetUniqueObject, HypertextCommand, Import, MergeIntoFirst, MergeIntoLast,
NewAnchoredAFrame, NewAnchoredFn, NewAnchoredFormattedObject, NewAnchoredFormattedTbl,
NewAnchoredFormattedVar, NewAnchoredFormattedXRef, NewAnchoredMarker, NewAnchoredOb-
ject, NewAnchoredTbl, NewAnchoredTiApiClient, NewArc, NewEllipse, NewFlow, NewGraphicObject,
NewGroup, NewInset, NewInlineComponentOfType, NewLine, NewMath,NewMathML, NewNamedAt-
trCondExpr, NewNamedCharFmt, NewNamedColor, NewNamedCombinedFontDefn, NewNamed-
CondFmt, NewNamedElementDef, NewNamedFmtChangeList, NewNamedMarkerType,
NewNamedMasterPage, NewNamedObject, NewNamedPgfFmt, NewNamedRefPage, NewNamedRul-
BooleanConditionState int Set to 1 to indicate that the
conditional expression defined by the
BooleanConditionExpressio
n parameter is applied to the
document.
Set to 0 to indicate that the condition
is not applied to the document.
BooleanConditionExpressionTag string Indicates the tag name of the
expression applied in the document.
ShowElementDescriptiveNames bool Set to True to show element
descriptive names in the element
catalog, as specified in element
definition.
UseInitialStructureOfAutoInsertedEle
ments
bool If set to True, auto-insertion rules will
be processed recursively. For
example: If an element is inserted
automatically, and if auto-insertion
rules exist for this element in the
element definition , then those rules
are also processed.
UserString string A string to which clients can store
private data.
Property name Data Type Description
356
ELEMENT
CHAPTER 5 OBJECT REFERENCE
ingFmt, NewNamedTblFmt, NewNamedVarFmt, NewNamedXRefFmt, NewPolygon, NewPolyline,
NewRectangle, NewRoundRect, NewSeriesBodyPage, NewSeriesObject, NewSeriesPgf, NewTable,
NewTextFrame, NewTextLine, NewUnanchoredFrame, ObjectValid, Paste, PromoteElement, QuickSe-
lect, Redisplay, Reformat, Rehyphenate, ResetEqnSettings, ResetReferenceFrames, RestartPgfNum-
bering, Save, ScrollToText, SetActiveBuildExpr, SetElementRange, SetProps, SetTextPropVal,
SetTextProps, SetTextVal, SilentPrintDoc, SimpleImportElementDefs, SimpleImportFormats, Simple-
Save, SplitElement, TextLocToElementLoc, TrackChangesAcceptAll, TrackChangesRejectAll, UnWrapEle-
ment, UpdateVariables, UpdateXRef, UpdateXRefs.
5.34. Element
Property name Data Type Description
AttrDisplay int Specifies element’s attribute display
properties. The value is one of:
• Constants.FV_ATTR_DISP_-
NONE (1) - Do not display attri-
butes
• Constants.FV_AT-
TR_DISP_REQSPEC (2) - Display
required and specified attri-
butes
• Constants.FV_ATTR_DISP_ALL
(3) - Display all attributes
Attributes Attributes The element’s attributes.
ContextLabel string The context label (if any) that is
applied to the element.
ElementIsCollapsed int Returns 1 if the element is collapsed
in Structure View. Returns 0
otherwise.
ElementIsTopicRef bool Determines if the element is a topic
reference.
ElementIsTopicHead bool Determines if the element is a topic
heading.
ElementIsTopicGroup bool Determines if the element is a topic
group.
NextElementDFS Element Denotes the pointer to the next
Element component in the heirarchy.
357
ELEMENT
CHAPTER 5 OBJECT REFERENCE
PrevElementDFS Element Denotes the pointer to the prevoius
Element component in the heirarchy.
ElementType int The type of element. The value is one
of:
• Constants.FV_FO_CONTAINER
(1)
• Constants.FV_FO_SYS_VAR (2)
• Constants.FV_FO_XREF (3)
• Constants.FV_FO_MARKER (4)
• Constants.FV_FO_FOOTNOTE
(5)
• Constants.FV_FO_GRAPHIC (6)
• Constants.FV_FO_EQN (7)
• Constants.FV_FO_TBL (8)
• Constants.FV_FO_TBL_TITLE (9)
• Constants.FV_FO_TBL_-
HEADING (10)
• Constants.FV_FO_TBL_BODY
(11)
• Constants.FV_FO_TBL_-
FOOTING (12)
• Constants.FV_FO_TBL_ROW
(13)
• Constants.FV_FO_TBL_CELL
(14)
• Constants.FV_FO_RUBIGROUP
(15)
• Constants.FV_FO_RUBI (16)
MatchingFirstPgfClauses Objects IDs of the first paragraph clauses
(FO_FmtRuleClause IDs) in the
element’s definition that apply to the
element.
FormatOverride int Returns 1 if the element has a format
override. Else, returns 0.
ElementMarkedForNamedDestinatio
n
int Used for generatig PDF. If 1, this
element will have a corresponding
Named Destination in the
generated PDF.
Property name Data Type Description
358
ELEMENT
CHAPTER 5 OBJECT REFERENCE
MatchingLastPgfClauses Objects IDs of the last paragraph clauses
(FO_FmtRuleClause IDs) in the
element’s definition that apply to the
element.
MatchingObjectClauses Objects IDs of the object clauses
(FO_FmtRuleClause IDs) in the
element’s definition that apply to the
element.
MatchingPrefixClauses Objects IDs of the prefix clauses
(FO_FmtRuleClause IDs) in the
element’s definition that apply to the
element.
MatchingSuffixClauses Objects IDs of the suffix clauses
(FO_FmtRuleClause IDs) in the
element’s definition that apply to the
element.
MatchingTextClauses Objects IDs of the text clauses
(FO_FmtRuleClause IDs) in the
element’s definition that apply to the
element.
TextRange TextRange Denotes the Text range that the
element encompasses (see the
explanation below).
TopicRefAbsoluteFilePath string Denotes the absolute file path for the
topic reference
Unique int Unique ID of the element.
UserString string A string to which clients can store
private data.
BookComponent BookCompon
ent
Component file in book
(FO_BookComponent ID).
ElementDef ElementDef Element’s element definition
(FO_ElementDef ID).
FirstChildElement Element Denote the element’s first child
element (FO_Element ID) if the
element is a container, .
Property name Data Type Description
359
ELEMENT
CHAPTER 5 OBJECT REFERENCE
LastChildElement Element Denotes the element’s last child
element (FO_Element ID) if the
element is a container.
NextSiblingElement Element Element’s next sibling element
(FO_Element ID).
NextDITAConrefElementInDoc string The next Conref element in the
document
NextDITAXrefElementInDoc string The next XRef element in the
document
NextDITALinkElementInDoc string The next Link element in the
document
NextDITATopicrefElementInDoc string The next Topicref element in the
document
NextDITATopicsetrefElementInDoc string The next Topicsetref element in the
document
Property name Data Type Description
360
ELEMENT
CHAPTER 5 OBJECT REFERENCE
Object FMObject ID of the object that an element
contains. The type of object the ID
specifies depends on the element
definition as follows:
• Constants.FV_FO_SYS_VAR (2):
FO_Var
• Constants.FV_FO_XREF (3):
FO_XRef
• Constants.FV_FO_MARKER (4):
FO_Marker
• Constants.FV_FO_FOOTNOTE
(5): FO_Fn
• Constants.FV_FO_GRAPHIC (6):
FO_AFrame (containing the
graphic)
• Constants.FV_FO_EQN (7):
FO_AFrame (containing the
equation)
• Constants.FV_FO_TBL (8):
FO_Tbl
• Constants.FV_FO_TBL_TITLE
(9): FO_Tbl
• Constants.FV_FO_TBL_-
HEADING (10): FO_Tbl
• Constants.FV_FO_TBL_BODY
(11): FO_Tbl
• Constants.FV_FO_TBL_-
FOOTING (12): FO_Tbl
• Constants.FV_FO_TBL_ROW
(13): FO_Row
• Constants.FV_FO_TBL_CELL
(14): FO_Cell
• Constants.FV_FO_RUBIGROUP
(15): FO_Rubi
• Constants.FV_FO_RUBI (16):
FO_Rubi
ParentElement Element Element’s parent element
(FO_Element ID).
Property name Data Type Description
361
ELEMENT
CHAPTER 5 OBJECT REFERENCE
PrevSiblingElement Element Element’s previous sibling element
(FO_Element ID).
Namespace Strings Prefix/path pairs defining
namespaces for the element. This list
must contain an even number of
strings. For example:
prefix1, path1prefix2,
path2
NamespaceScope Element The ID of element which declares the
namespace that is used to define the
current element.
NumNamespaces int The number of namespaces declared
in the current element. This property
is Readonly.
AllowAsSpecialCase int 1 if the element is treated as a special
case.
AttributeValueInvalid int 1 if the element contains an attribute
value that is invalid.
BookComponentMissing int 1 if a component file is missing from a
book.
ElementIsUndefined int 1 if the element is undefined.
ErrorInBookComponent int 1 if there is a validation error for a
component in a book.
ContentIsLooselyValid int 1 if the content is loosely valid (it has
some missing elements).
ContentIsStrictlyValid int 1 if the content of the element is
strictly valid.
ContentMustBeEmpty int 1 if the element cannot have any
content.
ContentNeededAtBegin int 1 if content is needed at the
beginning of the element.
ContentNeededAtEnd int 1 if content is needed at end of the
element.ContentNeededAtEnd
is obsolete, but is supported for
backward compatibility.
Property name Data Type Description
362
ELEMENT
CHAPTER 5 OBJECT REFERENCE
ElementIsExcludedInContext int 1 if the element is excluded.
ElementIsInvalidInParent int 1 if the element cannot occur
anywhere in its current parent.
ElementIsInvalidInPosition int 1 if the element is invalid in its
current position.
HoleBeforeElement int 1 if there are one or more missing
elements before the element within
the same parent.
InvalidHighestLevel int 1 if the element cannot be the
highest-level element in the flow.
NextInvalidElement Element Next invalid element in the document
(FO_Element ID).
TextIsInvalidInElement int 1 if the element contains only text
and the element definition disallows
it.
TextIsInvalidInElement is
obsolete and is no longer supported.
Property name Data Type Description
363
ELEMENT
CHAPTER 5 OBJECT REFERENCE
ValidationFlags int Bit flags specifying the element’s
validity.
To determine all the ways in which an
element is invalid without querying
all the validation properties, query
the ValidationFalgs property.
Each bit flag in the returned value
represents the value of the validation
property with the corresponding
name.
For example, if the
ElementTypeMismatch property
is True, the
Constants.FV_ELEM_TYPE_MI
SMATCH (0x0002) flag is set.
The various bit flags are as follows:
• Constants.FV_ELEM_UNDE-
FINED (0x0001)
• Constants.FV_ELEM_TYPE_MIS-
MATCH (0x0002)
• Constants.FV_ELEM_EX-
CLUDED (0x0004)
• Constants.FV_ELEM_IN-
VALID_IN_PARENT (0x0008)
• Constants.FV_ELEM_IN-
VALID_AT_POSITION (0x0010)
• Constants.FV_ELEM_HAS_TEXT_IN-
VALID (0x0020)
• Constants.FV_ELEM_CON-
TENT_MUST_BE_EMPTY
(0x0040)
• Constants.FV_ELEM_MISSING_-
CONTENT_BEFORE (0x0080)
• Constants.FV_ELEM_MISSING_-
CONTENT_AT_BEG (0x0100)
• Constants.FV_ELEM_MISSING_-
CONTENT_AT_END (0x0200)
• Constants.FV_ELEM_NOT_VALID_A
S_ROOT (0x0400)
• Constants.FV_ELEM_BOOK_COM-
P_MISSING (0x0800)
• Constants.FV_ELEM_BOOK_COM-
P_INVALID (0x1000)
Property name Data Type Description
364
ELEMENTCATALOGENTRIES
CHAPTER 5 OBJECT REFERENCE
Element methods
Delete, GetAttributes, GetProps, GetText, ObjectValid, SetProps.
5.35. ElementCatalogEntries
An Array of ElementCatalogEntry objects with integer indexing and a length property.
ElementCatalogEntries methods
concat, pop, push.
• Constants.FV_ELEM_ATTRVAL_RE-
QUIRED (0x2000)
• Constants.FV_ELEM_ATTRVAL_IN-
VALID (0x4000)
• Constants.FV_ELEM_CON-
TENT_STRICTLY_VALID
(0x10000)
• Constants.FV_ELEM_CONTENT_-
LOOSELY_VALID (0x20000)
Direction int Set or get the direction of the
document. Possible values:
•Constants.FV_DIR_Inherit
- Inherit the direction of the
parent
•Constants.FV_DIR_LTR -
Left-to-right
•FV_DIR_RTL - Right-to-left
ResolvedDirection int Get the inherited direction of the
document. Possible values:
•Constants.FV_DIR_LTR -
Left-to-right
•FV_DIR_RTL - Right-to-left
Property name Data Type Description
length number The length of the array
Property name Data Type Description
365
ELEMENTCATALOGENTRY
CHAPTER 5 OBJECT REFERENCE
5.36. ElementCatalogEntry
ElementCatalogEntry methods
ElementCatalogEntry.
5.37. ElementDef
Property name Data Type Description
obj ElementDef Denotes the ID of the element
definition.
flags uint The type of validation returned. The
value is one of the following:
• Constants.FV_STRICTLY_VALID
(0x01) - Catalog entry is strictly
valid.
• Constants.FV_LOOSELY_VALID
(0x02) - Catalog entry is loosely
valid.
• Constants.FV_ALTERNATIVE
(0x04) - Catalog entry is an alter-
native.
• Constants.FV_INCLUSION
(0x08) - Catalog entry is valid
because it is an inclusion.
NOTE: If none of the flags are set, then
the element is invalid at the current
position.
Property name Data Type Description
AttributeDefs AttributeD
efs
The element definition’s attribute
definitions.
BannerText string Property of element definition
object, FO_ElementDef. Users can
set, change or query the banner text
associated with an element definition
object.
Comment string Text string of the comment.
366
ELEMENTDEF
CHAPTER 5 OBJECT REFERENCE
InitStructurePattern string The initial structure pattern; for table
elements, a comma delimited string
that specifies the necessary child
elements to automatically insert.
ElementDefType int Type of formatter object represented
by the element with element
definition.Constants.FV_FO_CONTAI
NER (1) identifies a container
element. Other values identify object
(non-container) elements.
The value is one of:
• Constants.FV_FO_UNSPECIFIED
(0)
• Constants.FV_FO_CONTAINER
(1)
• Constants.FV_FO_SYS_VAR (2)
• Constants.FV_FO_XREF (3)
• Constants.FV_FO_MARKER (4)
• Constants.FV_FO_FOOTNOTE
(5)
• Constants.FV_FO_GRAPHIC (6)
• Constants.FV_FO_EQN (7)
• Constants.FV_FO_TBL (8)
• Constants.FV_FO_TBL_TITLE (9)
• Constants.FV_FO_TBL_-
HEADING (10)
• Constants.FV_FO_TBL_BODY
(11)
• Constants.FV_FO_TBL_-
FOOTING (12)
• Constants.FV_FO_TBL_ROW
(13)
• Constants.FV_FO_TBL_CELL
(14)
ElementInCatalog int 1 if the element is in the Element
Catalog.
ElementPgfFormat string The name of the paragraph format
applied to the element.
Property name Data Type Description
367
ELEMENTDEF
CHAPTER 5 OBJECT REFERENCE
Exclusions Strings List of excluded elements.
FirstPgfRules Objects The IDs of the first paragraph format
rules (FO_FmtRule IDs).
NOTE: To set the format rules for an
element definition, use
NewFmtRuleObject().
GeneralRule string Text of the element’s general rule.
GeneralRuleErrorOffsets Ints Contains the error offsets (two
positions are specified only if the
content rule is ambiguous).
Inclusions Strings List of included elements.
LastPgfRules Objects The IDs of the last paragraph format
rules (FO_FmtRule IDs).
Name string Name of the element definition.
NextElementDefInDoc ElementDef Next element definition in the
document’s list of element
definitions (FO_ElementDef ID).
ObjectFmtRules Objects The IDs of the object format rules
(FO_FmtRule IDs).
PrefixRules Objects The IDs of the prefix format rules
(FO_FmtRule IDs).
SuffixRules Objects The IDs of the suffix format rules
(FO_FmtRule IDs).
TextFmtRules Objects The IDs of the text format rules
(FO_FmtRule IDs).
ValidHighestLevel int 1 if the element can be used as the
highest-level element for a flow.
ElementDataType int Retrieves/sets the data type of
Element. The possible values are one
of:
• Constants.FV_DT_UNSPECI-
FIED(0)
• Constants.FV_DT_INTEGER(1)
• Constants.FV_DT_FLOAT(2)
Property name Data Type Description
368
ELEMENTLOC
CHAPTER 5 OBJECT REFERENCE
ElementDef methods
Delete, ElementDefIsText, GetAttributeDefs, GetProps, NewElement, NewElementInHierarchy,
NewFirstPgfRules, NewLastPgfRules, NewObjectFmtRules, NewPrefixRules, NewSuffixRules, NewText-
FmtRules, ObjectValid, SetProps, WrapElement.
5.38. ElementLoc
AllowedDataRange Defines the permissible range of
values for the values defined in the
ElementDataType property.
DescriptiveTag string A small description about the
element. If the user specifies this in
the EDD, then the element
description can be viewed in the
Element Catalog of the structured
document.
ElementDescription string Reserved for future use.
AlsoInsert Strings The list of the tags of child elements
that are automatically inserted when
an element is initially added.
AlsoInserts TypedVal The list of list of the tags of child
elements that are automatically
inserted when an element is initially
added.
For example: Setting the
AlsoInsertsproperty of element
definition of A to [[a1, a11],[a2, a21]],
will automatically insert all child
elements of A [a1, a2, a11 and a21]
when A is inserted.
Property name Data Type Description
parent Element ID of the parent element.
child Element ID of the child element.
offset int Offset within the parent or child
element.
Property name Data Type Description
369
ELEMENTRANGE
CHAPTER 5 OBJECT REFERENCE
ElementLoc methods
ElementLoc.
5.39. ElementRange
ElementRange methods
ElementRange.
5.40. Ellipse
Property name Data Type Description
beg ElementLoc Beginning of the element range.
end ElementLoc End of the element range.
Property name Data Type Description
RectangleIsSmoothed int 1 if smoothing is enabled. This
property is always 1 for Ellipse
objects.
Angle int Angle of rotation of the ellipse.
ArrowBaseAngle int Arrowhead base angle in degrees.
ArrowLength int Denotes the arrowhead length
(always rounded down to the nearest
1/256 point).
ArrowScaleFactor int Specifies the factor by which
arrowhead is scaled as line width
changes (always rounded down to
nearest 1/16 point). It is not used if
the ArrowScaleHead property is set
to False.
ArrowScaleHead int Set to 1 if arrowhead is scaled as the
line width changes. Set to 0,
otherwise.
ArrowTipAngle int Arrowhead tip angle in degrees.
370
ELLIPSE
CHAPTER 5 OBJECT REFERENCE
ArrowType int Arrowhead style. The value is one of
the following:
• Constants.FV_ARROW_STICK
(0x1)
• Constants.FV_AR-
ROW_HOLLOW (0x2)
• Constants.FV_ARROW_FILLED
(0x3)
BorderWidth int Denotes the border width. The
permissible range is from 0.015
points to 360 points.
Color Color The spot color.
Dash Metrics The dash style. The Dash property
specifies a dash pattern that is
repeated for the length of an object’s
border.
The pattern is stored in a MetricsT
structure. The 0th element of the
MetricsT.MetricsT_val array
stores the length of the first dash; the
1st element stores the following
space; the 2nd element stores the
next dash; and so on for an even
number of elements.
Fill int The fill pattern (numbers between 0
and 15). The ESTK provides constants
for the following fill patterns:
• Constants.FV_FILL_BLACK (0)
• Constants.FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
FrameParent FMObject Denotes the frame containing the
graphic object (AFrame or
UnAnchoredFrame).
GraphicCantBeSelected int 1 if the graphic object cannot be
selected; 0 otherwise.
GraphicIsSelected int 1 if the graphic object is selected; 0,
otherwise.
Property name Data Type Description
371
ELLIPSE
CHAPTER 5 OBJECT REFERENCE
GroupParent Group Group that the object is in (FO_Group
ID). Anchored and unanchored
frames do not have this property.
HeadArrow int 1 if the line has an arrow head;
otherwise, 0.
Height int Denotes the height of the object. The
permissible range is from 0.125
points to 3600 points.
HotspotCmdStr StringT The command string for a hotspot.
Thismust be a valid hypertext
command string.
HotspotTitle StringT The tooltip text for the hotspot in the
outputs that support it (for example
HTML). This property is 0ptional.
IsHotspot Bool Whether the object is a hotspot or
not. If this property is turned off, the
object is no longer a hotspot even if
command string is non-empty.
LineCap int Type of line end. The value is one of:
• Constants.FV_CAP_BUTT (0x00)
• Constants.FV_CAP_ROUND
(0x01)
• Constants.FV_CAP_SQUARE
(0x02)
LocX int Distance from the left side of the
parent frame (–216 inches to 216
inches).
NOTE: For anchored frames, the
distance is automatically calculated
from the left side of the page frame.
You cannot manually set this property
for anchored frames.
Property name Data Type Description
372
ELLIPSE
CHAPTER 5 OBJECT REFERENCE
LocY int Distance from the top of the parent
frame (–216 inches to 216 inches).
NOTE: For anchored frames, the
distance is automatically calculated
from the topof the page frame. You
cannot manually set this property for
anchored frames.
NextGraphicInDoc FMObject Next graphic object in the document.
NextGraphicInFrame FMObject Next graphic object in the frame.
NextGraphicInGroup FMObject Next graphic object in the group.
NextSelectedGraphicInDoc FMObject Next selected graphic object in
document.
ObjectAttributes Strings A list of strings, each string expressing
an attribute that is specified for an
anchored frame in the Object
Properties > Object Attributes dialog
box.Each string is in the form of
<tag>string_text</tag>. You
can use the backslash to escape
characters such as \n, \r, or \t for
newline, carraige return, and tab,
respectively. For a backslash
character in the string text, type \\.
Overprint int Specifies the overprint settings for
the objec. The value is one of:
• Constants.FV_KNOCKOUT
(0x00)
• Constants.FV_OVERPRINT
(0x01)
• Constants.FV_FROMCOLOR
(0x02)
Pen int The fill pattern (numbers between 0
and 15). The ESTK provides constants
for the following fill patterns:
• Constants.FV_FILL_BLACK (0)
• Constants.FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
Property name Data Type Description
373
FCODES
CHAPTER 5 OBJECT REFERENCE
Ellipse methods
Delete, GetProps, ObjectValid, SetProps.
5.41. FCodes
PrevGraphicInFrame FMObject Previous graphic object in the frame.
PrevGraphicInGroup FMObject Previous graphic object in the group.
Runaround int Specifies whether text can flow
around the object and, if so, whether
the text follows the contour of the
object or a box shape surrounding
the object.
The value is one of:
• Constants.FV_TR_NONE (0x01)
• Constants.FV_TR_CONTOUR
(0x02)
• Constants.FV_TR_BBOX (0x03)
RunaroundGap int Denotes the width of the runaround
gap if the object is a runaround
object.
TailArrow int 1 if arrowhead is enabled at the
beginning of the line. 0, otherwise.
TintPercent int Denotes the tint percentage.
Unique int The graphic object’s UID.
Width int Denotes the width of the object. The
permissible range is from 0.125
points to 3600 points.
Property name Data Type
FCodes.NULLINPUT NULLINPUT
Value-1
FCodes.KBD_INPUT KBD_INPUT
Value1
Property name Data Type Description
374
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.START_DIALOG START_DIALOG
Value0xC100
FCodes.END_DIALOG END_DIALOG
Value0xC200
FCodes.START_WINDOW START_WINDOW
Value0xC400
FCodes.END_WINDOW END_WINDOW
Value0xC500
FCodes.LEAVE_DOC LEAVE_DOC
Value0xC600
FCodes.SERVER_CANCEL SERVER_CANCEL
Value0xC001
FCodes.SERVER_QUERY SERVER_QUERY
Value0xC002
FCodes.MENU_BARSTART MENU_BARSTART
Value0xC301
FCodes.MENU_WAITBIT MENU_WAITBIT
Value0x0010
FCodes.MENU_DOWNWAIT MENU_DOWNWAIT
Value0xC312
FCodes.MENU_RIGHTWAIT MENU_RIGHTWAIT
Value0xC313
FCodes.MENU_DOWN MENU_DOWN
Value0xC304
FCodes.MENU_RIGHT MENU_RIGHT
Value0xC305
FCodes.MENU_DONE MENU_DONE
Value0xC30F
FCodes.KBD_GBL_START KBD_GBL_START
Value0x100
FCodes.CSR_HOME CSR_HOME
Value0x100
FCodes.CSR_UP CSR_UP
Value0x101
Property name Data Type
375
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.CSR_DOWN CSR_DOWN
Value0x102
FCodes.CSR_RIGHT CSR_RIGHT
Value0x103
FCodes.CSR_LEFT CSR_LEFT
Value0x104
FCodes.CSR_BOL CSR_BOL
Value0x105
FCodes.CSR_EOL CSR_EOL
Value0x106
FCodes.CSR_BOW CSR_BOW
Value0x107
FCodes.CSR_EOW CSR_EOW
Value0x108
FCodes.CSR_BOS CSR_BOS
Value0x109
FCodes.CSR_EOS CSR_EOS
Value0x10A
FCodes.CSR_BOP CSR_BOP
Value0x10B
FCodes.CSR_EOP CSR_EOP
Value0x10C
FCodes.CSR_TOTR CSR_TOTR
Value0x10D
FCodes.CSR_BOTR CSR_BOTR
Value0x10E
FCodes.CSR_TOP CSR_TOP
Value0x10F
FCodes.CSR_BOT CSR_BOT
Value0x110
FCodes.DEL_CHARBWD DEL_CHARBWD
Value0x112
FCodes.DEL_CHARFWD DEL_CHARFWD
Value0x113
Property name Data Type
376
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.DEL_BOW DEL_BOW
Value0x114
FCodes.DEL_EOW DEL_EOW
Value0x115
FCodes.DEL_EOL DEL_EOL
Value0x116
FCodes.DEL_EOS DEL_EOS
Value0x117
FCodes.DEL_SEL DEL_SEL
Value0x118
FCodes.DEL_BOL DEL_BOL
Value0x119
FCodes.KBD_KERNUP KBD_KERNUP
Value0x11A
FCodes.KBD_KERNDOWN KBD_KERNDOWN
Value0x11B
FCodes.KBD_KERNLEFT KBD_KERNLEFT
Value0x11C
FCodes.KBD_KERNRIGHT KBD_KERNRIGHT
Value0x11D
FCodes.KBD_KERNHOME KBD_KERNHOME
Value0x11E
FCodes.KBD_KERNUP6 KBD_KERNUP6
Value0x121
FCodes.KBD_KERNDOWN6 KBD_KERNDOWN6
Value0x122
FCodes.KBD_KERNLEFT6 KBD_KERNLEFT6
Value0x123
FCodes.KBD_KERNRIGHT6 KBD_KERNRIGHT6
Value0x124
FCodes.KBD_OBJUP KBD_OBJUP
Value0x125
FCodes.KBD_OBJDOWN KBD_OBJDOWN
Value0x126
Property name Data Type
377
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_OBJLEFT KBD_OBJLEFT
Value0x127
FCodes.KBD_OBJRIGHT KBD_OBJRIGHT
Value0x128
FCodes.CSR_NEXT_BOW CSR_NEXT_BOW
Value0x140
FCodes.CSR_NEXT_BOS CSR_NEXT_BOS
Value0x141
FCodes.CSR_NEXT_BOP CSR_NEXT_BOP
Value0x142
FCodes.CSR_FIRST_COL CSR_FIRST_COL
Value0x143
FCodes.CSR_NEXT_COL CSR_NEXT_COL
Value0x144
FCodes.CSR_NEXT_ELEMENT CSR_NEXT_ELEMENT
Value0x145
FCodes.CSR_PREV_ELEMENT CSR_PREV_ELEMENT
Value0x146
FCodes.CSR_BOE CSR_BOE
Value0x149
FCodes.CSR_EOE CSR_EOE
Value0x14A
FCodes.CSR_BEFORE_ELEMENT CSR_BEFORE_ELEMENT
Value0x14B
FCodes.CSR_INTO_CHILD CSR_INTO_CHILD
Value0x14D
FCodes.CSR_PREV_EOS CSR_PREV_EOS
Value0x937
FCodes.CSR_PREV_EOW CSR_PREV_EOW
Value0x938
FCodes.DEL_WORD_START DEL_WORD_START
Value0x160
FCodes.DEL_WORD_END DEL_WORD_END
Value0x161
Property name Data Type
378
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.DEL_NEXT_SS DEL_NEXT_SS
Value0x162
FCodes.DEL_BOS DEL_BOS
Value0x163
FCodes.KBD_NUMLOCK KBD_NUMLOCK
Value0x170
FCodes.KBD_GBL_END KBD_GBL_END
Value0x1FF
FCodes.KBD_BACKTAB KBD_BACKTAB
Value0x220
FCodes.KBD_SHFTSPACE KBD_SHFTSPACE
Value0x221
FCodes.KBD_FIRSTTAB KBD_FIRSTTAB
Value0x222
FCodes.KBD_TABLE_TAB KBD_TABLE_TAB
Value0x223
FCodes.KBD_TAB KBD_TAB
Value0x219
FCodes.KBD_XCHARS KBD_XCHARS
Value0x224
FCodes.KBD_SOFTHYPHEN KBD_SOFTHYPHEN
Value0x225
FCodes.KBD_DONTHYPHEN KBD_DONTHYPHEN
Value0x226
FCodes.KBD_HARDHYPHEN KBD_HARDHYPHEN
Value0x227
FCodes.KBD_HARDSPACE KBD_HARDSPACE
Value0x228
FCodes.KBD_HARDRETURN KBD_HARDRETURN
Value0x229
FCodes.KBD_NUMSPACE KBD_NUMSPACE
Value0x22A
FCodes.KBD_THINSPACE KBD_THINSPACE
Value0x22B
Property name Data Type
379
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_EMSPACE KBD_EMSPACE
Value0x22C
FCodes.KBD_ENSPACE KBD_ENSPACE
Value0x22D
FCodes.KBD_OPENLINE KBD_OPENLINE
Value0x22E
FCodes.KBD_RETURN KBD_RETURN
Value0x22F
FCodes.KBD_FPREV KBD_FPREV
Value0x230
FCodes.KBD_FNEXT KBD_FNEXT
Value0x231
FCodes.KBD_RONCE KBD_RONCE
Value0x232
FCodes.KBD_RGLOBAL KBD_RGLOBAL
Value0x233
FCodes.KBD_RANDF KBD_RANDF
Value0x234
FCodes.KBD_SETSEARCH KBD_SETSEARCH
Value0x235
FCodes.HIGH_CHAR HIGH_CHAR
Value0x240
FCodes.HIGH_WORD HIGH_WORD
Value0x241
FCodes.HIGH_LINE HIGH_LINE
Value0x242
FCodes.HIGH_SENT HIGH_SENT
Value0x243
FCodes.HIGH_PGF HIGH_PGF
Value0x244
FCodes.HIGH_SHL HIGH_SHL
Value0x245
FCodes.HIGH_SHR HIGH_SHR
Value0x246
Property name Data Type
380
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.HIGH_CLEAR HIGH_CLEAR
Value0x247
FCodes.HIGH_FLOW HIGH_FLOW
Value0x248
FCodes.HIGH_ELEMENT HIGH_ELEMENT
Value0x249
FCodes.KBD_ABORT KBD_ABORT
Value0x250
FCodes.KBD_CAPTURE KBD_CAPTURE
Value0x251
FCodes.KBD_ECAPTURE KBD_ECAPTURE
Value0x256
FCodes.KBD_RECORD KBD_RECORD
Value0x252
FCodes.KBD_GETTRIGGER KBD_GETTRIGGER
Value0x253
FCodes.KBD_ABORT_DLGS KBD_ABORT_DLGS
Value0x254
FCodes.KBD_WAIT_DLGS KBD_WAIT_DLGS
Value0x255
FCodes.TXT_BOLD TXT_BOLD
Value0x260
FCodes.TXT_ITALIC TXT_ITALIC
Value0x261
FCodes.TXT_UNDERLINE TXT_UNDERLINE
Value0x262
FCodes.TXT_PLAIN TXT_PLAIN
Value0x263
FCodes.TXT_SUPER TXT_SUPER
Value0x264
FCodes.TXT_SUB TXT_SUB
Value0x265
FCodes.TXT_NORMAL TXT_NORMAL
Value0x266
Property name Data Type
381
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.TXT_INCSIZE TXT_INCSIZE
Value0x267
FCodes.TXT_DECSIZE TXT_DECSIZE
Value0x268
FCodes.TXT_SELINCSIZE TXT_SELINCSIZE
Value0x11F
FCodes.TXT_SELDECSIZE TXT_SELDECSIZE
Value0x120
FCodes.TXT_SQUEEZE TXT_SQUEEZE
Value0x269
FCodes.TXT_SPREAD TXT_SPREAD
Value0x26A
FCodes.TXT_NOSTRETCH TXT_NOSTRETCH
Value0x130
FCodes.TXT_LESSSTRETCH TXT_LESSSTRETCH
Value0x131
FCodes.TXT_MORESTRETCH TXT_MORESTRETCH
Value0x132
FCodes.TXT_BAM TXT_BAM
Value0x26B
FCodes.TXT_STRIKEOUT TXT_STRIKEOUT
Value0x26C
FCodes.TXT_DEFAULT TXT_DEFAULT
Value0x26D
FCodes.TXT_OVERLINE TXT_OVERLINE
Value0x26E
FCodes.TXT_CHANGEBAR TXT_CHANGEBAR
Value0x26F
FCodes.TXT_KERN TXT_KERN
Value0x270
FCodes.TXT_OUTLINE TXT_OUTLINE
Value0x271
FCodes.TXT_SHADOW TXT_SHADOW
Value0x272
Property name Data Type
382
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.TXT_MINICAPS TXT_MINICAPS
Value0x273
FCodes.TXT_INITCAPS TXT_INITCAPS
Value0x274
FCodes.TXT_UPPERCASE TXT_UPPERCASE
Value0x275
FCodes.TXT_LOWERCASE TXT_LOWERCASE
Value0x276
FCodes.TXT_NORMALCASE TXT_NORMALCASE
Value0x277
FCodes.TXT_DBLUNDERLINE TXT_DBLUNDERLINE
Value0x278
FCodes.TXT_NUMUNDERLINE TXT_NUMUNDERLINE
Value0x279
FCodes.TXT_TSUME TXT_TSUME
Value0x2A5
FCodes.TXT_SELBOLD TXT_SELBOLD
Value0x27A
FCodes.TXT_SELITALIC TXT_SELITALIC
Value0x27B
FCodes.TXT_SELUNDERLINE TXT_SELUNDERLINE
Value0x27C
FCodes.TXT_SELPLAIN TXT_SELPLAIN
Value0x27D
FCodes.TXT_7 TXT_7
Value0xC00
FCodes.TXT_9 TXT_9
Value0xC01
FCodes.TXT_10 TXT_10
Value0xC02
FCodes.TXT_12 TXT_12
Value0xC03
FCodes.TXT_14 TXT_14
Value0xC04
Property name Data Type
383
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.TXT_18 TXT_18
Value0xC05
FCodes.TXT_24 TXT_24
Value0xC06
FCodes.TXT_USIZE TXT_USIZE
Value0xC07
FCodes.TXT_OTHERSIZE TXT_OTHERSIZE
Value0xC08
FCodes.TXT_FAMILY_AND_VARIATION TXT_FAMILY_AND_VARIATION
Value0xC09
FCodes.TXT_FAMILY_AND_VARIATION
_PLATFORM
TXT_FAMILY_AND_VARIATION_PLATFORM
Value0xC0A
FCodes.PGF_APPLY_TAG PGF_APPLY_TAG
Value0xC10
FCodes.CHAR_APPLY_TAG CHAR_APPLY_TAG
Value0xC11
FCodes.MENU_EXPOSE_WIN MENU_EXPOSE_WIN
Value0xC12
FCodes.MRU_SELECT_FILE MRU_SELECT_FILE
Value0xC13
FCodes.MENU_IMPORT_FILE MENU_IMPORT_FILE
Value0xC14
FCodes.KBD_EXPORT_GRAPHIC KBD_EXPORT_GRAPHIC
Value0xC15
FCodes.KBD_EXPORT_DOCUMENT KBD_EXPORT_DOCUMENT
Value0xC16
FCodes.TXT_FONT TXT_FONT
Value0xC17
FCodes.PGF_APPLY_CAT_TO_SEL PGF_APPLY_CAT_TO_SEL
Value0xF3D
FCodes.CHAR_APPLY_CAT_TO_SEL CHAR_APPLY_CAT_TO_SEL
Value0xF3E
FCodes.PGF_HYPHENON PGF_HYPHENON
Value0x27E
Property name Data Type
384
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.PGF_HYPHENOFF PGF_HYPHENOFF
Value0x27F
FCodes.PGF_INCLINE PGF_INCLINE
Value0x280
FCodes.PGF_DECLINE PGF_DECLINE
Value0x281
FCodes.PGF_CENTER PGF_CENTER
Value0x282
FCodes.PGF_LEFT PGF_LEFT
Value0x283
FCodes.PGF_RIGHT PGF_RIGHT
Value0x284
FCodes.PGF_FULL PGF_FULL
Value0x285
FCodes.PGF_BAM PGF_BAM
Value0x286
FCodes.PGF_LINEFIX PGF_LINEFIX
Value0x287
FCodes.PGF_LINEFLOAT PGF_LINEFLOAT
Value0x288
FCodes.PGF_UNIFY PGF_UNIFY
Value0x289
FCodes.PGF_PAGETOP PGF_PAGETOP
Value0x28A
FCodes.PGF_COLTOP PGF_COLTOP
Value0x28B
FCodes.PGF_LEFTTOP PGF_LEFTTOP
Value0x28C
FCodes.PGF_RIGHTTOP PGF_RIGHTTOP
Value0x28D
FCodes.PGF_ANYPLACE PGF_ANYPLACE
Value0x28E
FCodes.KBD_ALIGN_TOP KBD_ALIGN_TOP
Value0x290
Property name Data Type
385
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_ALIGN_MIDDLE KBD_ALIGN_MIDDLE
Value0x291
FCodes.KBD_ALIGN_BOTTOM KBD_ALIGN_BOTTOM
Value0x292
FCodes.KBD_OBALIGN_TOP KBD_OBALIGN_TOP
Value0x129
FCodes.KBD_OBALIGN_MIDDLE KBD_OBALIGN_MIDDLE
Value0x12A
FCodes.KBD_OBALIGN_BOTTOM KBD_OBALIGN_BOTTOM
Value0x12B
FCodes.KBD_OBALIGN_CENTER KBD_OBALIGN_CENTER
Value0x12C
FCodes.KBD_OBALIGN_LEFT KBD_OBALIGN_LEFT
Value0x12D
FCodes.KBD_OBALIGN_RIGHT KBD_OBALIGN_RIGHT
Value0x12E
FCodes.PGF_SINGLE_SPACE PGF_SINGLE_SPACE
Value0x293
FCodes.PGF_ONEANDAHALF_SPACE PGF_ONEANDAHALF_SPACE
Value0x294
FCodes.PGF_DOUBLE_SPACE PGF_DOUBLE_SPACE
Value0x295
FCodes.PGF_SPACE_BETWEEN PGF_SPACE_BETWEEN
Value0x296
FCodes.PGF_LINE_SPACE PGF_LINE_SPACE
Value0x297
FCodes.PGF_UPDATE_ALL PGF_UPDATE_ALL
Value0x298
FCodes.PGF_NEW_FORMAT PGF_NEW_FORMAT
Value0x299
FCodes.KBD_HELP_INDEX KBD_HELP_INDEX
Value0x2A0
FCodes.KBD_HELP_KEYS KBD_HELP_KEYS
Value0x2A1
Property name Data Type
386
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_HELP_SAMPLES KBD_HELP_SAMPLES
Value0x2A2
FCodes.KBD_HELP_OVERVIEW KBD_HELP_OVERVIEW
Value0x2A3
FCodes.KBD_HELP_ONLINEMANUALS KBD_HELP_ONLINEMANUALS
Value0x2A4
FCodes.KBD_HELP_WEBWORKS KBD_HELP_WEBWORKS
Value0x2A6
FCodes.KBD_CUSTOMNEW KBD_CUSTOMNEW
Value0x2FF
FCodes.KBD_NEW KBD_NEW
Value0x300
FCodes.KBD_NEWBOOK KBD_NEWBOOK
Value0x308
FCodes.KBD_OPEN KBD_OPEN
Value0x301
FCodes.KBD_HEROIC_OPEN KBD_HEROIC_OPEN
Value0x306
FCodes.KBD_SILENT_OPEN KBD_SILENT_OPEN
Value0x307
FCodes.KBD_HELP KBD_HELP
Value0x302
FCodes.KBD_INFO KBD_INFO
Value0x303
FCodes.KBD_CSHELPMODE KBD_CSHELPMODE
Value0x304
FCodes.KBD_ABOUTPRODUCT KBD_ABOUTPRODUCT
Value0x305
FCodes.KBD_BOOKADDFILE KBD_BOOKADDFILE
Value0x30A
FCodes.KBD_BOOKEDITDEFINE KBD_BOOKEDITDEFINE
Value0x30B
FCodes.KBD_BOOKRENAMEFILE KBD_BOOKRENAMEFILE
Value0x30C
Property name Data Type
387
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_BOOKDISPLAYFILENAME KBD_BOOKDISPLAYFILENAME
Value0x30D
FCodes.KBD_BOOKDISPLAYTEXT KBD_BOOKDISPLAYTEXT
Value0x30E
FCodes.KBD_BOOKCOMP_EXCLUDE KBD_BOOKCOMP_EXCLUDE
Value0x4E0
FCodes.KBD_BOOKADDFOLDER KBD_BOOKADDFOLDER
Value0x601
FCodes.KBD_BOOKCOMP_FILENAME KBD_BOOKCOMP_FILENAME
Value0x607
FCodes.KBD_BOOKCOMP_TEXT KBD_BOOKCOMP_TEXT
Value0x608
FCodes.KBD_BOOKADDGROUP KBD_BOOKADDGROUP
Value0x609
FCodes.KBD_MOVE_UP KBD_MOVE_UP
Value0x70A
FCodes.KBD_MOVE_DOWN KBD_MOVE_DOWN
Value0x70B
FCodes.KBD_MOVE_LEFT KBD_MOVE_LEFT
Value0x70C
FCodes.KBD_MOVE_RIGHT KBD_MOVE_RIGHT
Value0x70D
FCodes.KBD_OPEN_COMPONENTS KBD_OPEN_COMPONENTS
Value0x3EA
FCodes.KBD_CLOSE_COMPONENTS KBD_CLOSE_COMPONENTS
Value0x3EB
FCodes.KBD_PRINT_COMPONENTS KBD_PRINT_COMPONENTS
Value0x3EC
FCodes.KBD_SAVE_COMPONENTS KBD_SAVE_COMPONENTS
Value0x3ED
FCodes.KBD_COMPONENT_PROPERTI
ES
KBD_COMPONENT_PROPERTIES
Value0x3EE
FCodes.KBD_DELETE_FILE KBD_DELETE_FILE
Value0x30F
Property name Data Type
388
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_COLLAPSE_ALL KBD_COLLAPSE_ALL
Value0x3FA
FCodes.KBD_EXPAND_ALL KBD_EXPAND_ALL
Value0x3FB
FCodes.SWITCH_TO_RESOURCEMANA
GER
SWITCH_TO_RESOURCEMANAGER
Value0x9EA
FCodes.SWITCH_TO_DOCUMENTVIEW SWITCH_TO_DOCUMENTVIEW
Value0x9EB
FCodes.KBD_SAVE KBD_SAVE
Value0x310
FCodes.KBD_SAVEAS KBD_SAVEAS
Value0x311
FCodes.KBD_SAVEASPDFREVIEW KBD_SAVEASPDFREVIEW
Value0x95A
FCodes.KBD_SAVEASPDFREVIEW2 KBD_SAVEASPDFREVIEW2
Value0x95B
FCodes.KBD_SAVEASPDFUBIQ KBD_SAVEASPDFUBIQ
Value0x95E
FCodes.KBD_SAVEASPDFSHARE KBD_SAVEASPDFSHARE
Value0x95F
FCodes.KBD_SAVEASPDF KBD_SAVEASPDF
Value0x950
FCodes.KBD_SAVEASXML KBD_SAVEASXML
Value0x951
FCodes.KBD_MANCOND KBD_MANCOND
Value0x952
FCodes.KBD_CONDINDICATOR KBD_CONDINDICATOR
Value0x953
FCodes.KBD_ATTRCOND KBD_ATTRCOND
Value0x954
FCodes.KBD_PREVIEWFBA KBD_PREVIEWFBA
Value0xB16
FCodes.AMT_REGISRATION AMT_REGISRATION
Value0x965
Property name Data Type
389
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.AMT_DEACTIVATION AMT_DEACTIVATION
Value0x967
FCodes.AMT_UPDATES AMT_UPDATES
Value0x968
FCodes.KBD_REVERT KBD_REVERT
Value0x312
FCodes.KBD_DOCINFO KBD_DOCINFO
Value0x3DA
FCodes.KBD_SETPOSTER KBD_SETPOSTER
Value0x3DB
FCodes.KBD_REMOVEPOSTER KBD_REMOVEPOSTER
Value0x3DE
FCodes.KBD_PRINT KBD_PRINT
Value0x313
FCodes.KBD_IMPORT KBD_IMPORT
Value0x314
FCodes.KBD_GENERATE KBD_GENERATE
Value0x3E1
FCodes.KBD_USEFMTFROM KBD_USEFMTFROM
Value0x316
FCodes.KBD_KBMACRO KBD_KBMACRO
Value0x317
FCodes.KBD_SESSION KBD_SESSION
Value0x318
FCodes.KBD_PAGESETUP KBD_PAGESETUP
Value0x319
FCodes.KBD_OPENALL KBD_OPENALL
Value0x31A
FCodes.KBD_QUITALL KBD_QUITALL
Value0x31B
FCodes.KBD_SAVEALL KBD_SAVEALL
Value0x31C
FCodes.KBD_REPEATNEW KBD_REPEATNEW
Value0x31D
Property name Data Type
390
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_PODLOCATION KBD_PODLOCATION
Value0x31E
FCodes.KBD_COMPARE KBD_COMPARE
Value0x31F
FCodes.KBD_UNDO KBD_UNDO
Value0x320
FCodes.KBD_REDO KBD_REDO
Value0x935
FCodes.KBD_HIST KBD_HIST
Value0x936
FCodes.KBD_REPEAT KBD_REPEAT
Value0x939
FCodes.KBD_CUT KBD_CUT
Value0x321
FCodes.KBD_COPY KBD_COPY
Value0x322
FCodes.KBD_PASTE KBD_PASTE
Value0x323
FCodes.KBD_CLEAR KBD_CLEAR
Value0x324
FCodes.KBD_COPYFONT KBD_COPYFONT
Value0x325
FCodes.KBD_COPYPGF KBD_COPYPGF
Value0x326
FCodes.KBD_SELECTALL KBD_SELECTALL
Value0x327
FCodes.KBD_STUFF KBD_STUFF
Value0x328
FCodes.KBD_SEARCH KBD_SEARCH
Value0x329
FCodes.KBD_SPELLING KBD_SPELLING
Value0x32A
FCodes.KBD_CAPITAL KBD_CAPITAL
Value0x32B
Property name Data Type
391
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_YANK KBD_YANK
Value0x32C
FCodes.KBD_SELECT_GENERATED_FIL
ES
KBD_SELECT_GENERATED_FILES
Value0x32D
FCodes.KBD_SELECT_NON_GENERATE
D_FILES
KBD_SELECT_NON_GENERATED_FILES
Value0x32E
FCodes.KBD_SELECT_FM_FILES KBD_SELECT_FM_FILES
Value0x315
FCodes.KBD_SELECT_PRINTABLE_FILE
S
KBD_SELECT_PRINTABLE_FILES
Value0x9E2
FCodes.KBD_SELECT_EXCLUDED_FILE KBD_SELECT_EXCLUDED_FILE
Value0x9D1
FCodes.KBD_SELECT_NONEXCLUDED_
FILE
KBD_SELECT_NONEXCLUDED_FILE
Value0x9D2
FCodes.KBD_SELECT_CHAPTER_COMP
ONENTS
KBD_SELECT_CHAPTER_COMPONENTS
Value0x9D3
FCodes.KBD_SELECT_SECTION_COMP
ONENTS
KBD_SELECT_SECTION_COMPONENTS
Value0x9D4
FCodes.KBD_SELECT_SUBSECTION_CO
MPONENTS
KBD_SELECT_SUBSECTION_COMPONENTS
Value0x9D5
FCodes.KBD_ALLCAP KBD_ALLCAP
Value0x33A
FCodes.KBD_ALLLOWER KBD_ALLLOWER
Value0x33B
FCodes.KBD_INITCAP KBD_INITCAP
Value0x33C
FCodes.KBD_ALLCAPH KBD_ALLCAPH
Value0x369
FCodes.KBD_ALLLOWERH KBD_ALLLOWERH
Value0x36A
FCodes.KBD_INITCAPH KBD_INITCAPH
Value0x36B
FCodes.KBD_THESAURUS KBD_THESAURUS
Value0x3D0
Property name Data Type
392
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_THESAURUS_REPLACE KBD_THESAURUS_REPLACE
Value0x3D3
FCodes.KBD_CREATE_PUBLISHER KBD_CREATE_PUBLISHER
Value0x3D5
FCodes.KBD_SUBSCRIBE_TO KBD_SUBSCRIBE_TO
Value0x3D6
FCodes.KBD_LINK_BOUNDARIES KBD_LINK_BOUNDARIES
Value0x3D7
FCodes.KBD_FONTDESIGN KBD_FONTDESIGN
Value0x330
FCodes.KBD_PGFDESIGN KBD_PGFDESIGN
Value0x331
FCodes.KBD_RUBIPROPS KBD_RUBIPROPS
Value0x3DD
FCodes.KBD_COLLAYOUT KBD_COLLAYOUT
Value0x348
FCodes.KBD_LINELAYOUT KBD_LINELAYOUT
Value0x332
FCodes.KBD_PAGESIZE KBD_PAGESIZE
Value0x349
FCodes.KBD_PAGINATION KBD_PAGINATION
Value0xA40
FCodes.KBD_PAGEBACK KBD_PAGEBACK
Value0x34A
FCodes.KBD_NEWMASTER KBD_NEWMASTER
Value0xA0A
FCodes.KBD_REORDERMASTER KBD_REORDERMASTER
Value0xA0B
FCodes.KBD_PAGEUPDATE KBD_PAGEUPDATE
Value0xA00
FCodes.KBD_CUST_TEXT_FRAME KBD_CUST_TEXT_FRAME
Value0xA01
FCodes.KBD_CONNECT_TEXT_FRAME KBD_CONNECT_TEXT_FRAME
Value0x35B
Property name Data Type
393
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_CUTHEAD KBD_CUTHEAD
Value0x35C
FCodes.KBD_CURTAIL KBD_CURTAIL
Value0x35D
FCodes.KBD_CUTBOTH KBD_CUTBOTH
Value0xA04
FCodes.KBD_SPLIT KBD_SPLIT
Value0x35A
FCodes.KBD_SPLITR KBD_SPLITR
Value0xA02
FCodes.KBD_SPLITL KBD_SPLITL
Value0xA03
FCodes.KBD_ROTPAGE_PLUS KBD_ROTPAGE_PLUS
Value0x34E
FCodes.KBD_ROTPAGE_MINUS KBD_ROTPAGE_MINUS
Value0x34F
FCodes.KBD_ROTPAGE_NORM KBD_ROTPAGE_NORM
Value0xA05
FCodes.KBD_NUMBERING KBD_NUMBERING
Value0x333
FCodes.KBD_CBARPRO KBD_CBARPRO
Value0x334
FCodes.KBD_FOOTNOTEPRO KBD_FOOTNOTEPRO
Value0x335
FCodes.KBD_TEXT_OPTIONS KBD_TEXT_OPTIONS
Value0x337
FCodes.KBD_COMBINED_FONTS KBD_COMBINED_FONTS
Value0x338
FCodes.KBD_ACROBAT_SETUP KBD_ACROBAT_SETUP
Value0x36C
FCodes.KBD_LINENUMPRO KBD_LINENUMPRO
Value0x673
FCodes.KBD_LINENUMTOGGLE KBD_LINENUMTOGGLE
Value0x674
Property name Data Type
394
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_FIRSTPAGE KBD_FIRSTPAGE
Value0x340
FCodes.KBD_LASTPAGE KBD_LASTPAGE
Value0x341
FCodes.KBD_BODYPAGE KBD_BODYPAGE
Value0x342
FCodes.KBD_MASTERPAGE KBD_MASTERPAGE
Value0x343
FCodes.KBD_REFPAGE KBD_REFPAGE
Value0x344
FCodes.KBD_GOTOPAGE KBD_GOTOPAGE
Value0x345
FCodes.KBD_ADDPAGE KBD_ADDPAGE
Value0x346
FCodes.KBD_DELETEPAGE KBD_DELETEPAGE
Value0x347
FCodes.KBD_FREEZE KBD_FREEZE
Value0x34B
FCodes.KBD_TEXTCOLPRO KBD_TEXTCOLPRO
Value0x339
FCodes.KBD_PREVPAGE KBD_PREVPAGE
Value0x34C
FCodes.KBD_NEXTPAGE KBD_NEXTPAGE
Value0x34D
FCodes.KBD_GOTOPAGEN KBD_GOTOPAGEN
Value0x96E
FCodes.KBD_GOTOIP KBD_GOTOIP
Value0x96F
FCodes.KBD_STRWIN_LEFTANCHOR KBD_STRWIN_LEFTANCHOR
Value0x3DF
FCodes.KBD_PAGEBREAK KBD_PAGEBREAK
Value0x32F
FCodes.KBD_ANCHOR KBD_ANCHOR
Value0x350
Property name Data Type
395
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_FOOTNOTE KBD_FOOTNOTE
Value0x351
FCodes.KBD_REFERENCE KBD_REFERENCE
Value0x352
FCodes.KBD_VARIABLE KBD_VARIABLE
Value0x353
FCodes.KBD_INSET KBD_INSET
Value0x354
FCodes.KBD_HYPERTEXT KBD_HYPERTEXT
Value0x359
FCodes.KBD_MARKERS KBD_MARKERS
Value0x355
FCodes.KBD_EQUATION KBD_EQUATION
Value0x336
FCodes.KBD_CONDTEXT KBD_CONDTEXT
Value0x357
FCodes.KBD_NEWMARKER KBD_NEWMARKER
Value0x356
FCodes.KBD_EDITMARKERTYPE KBD_EDITMARKERTYPE
Value0x409
FCodes.KBD_DELMARKERTYPE KBD_DELMARKERTYPE
Value0x358
FCodes.KBD_RENAMEMARKERTYPE KBD_RENAMEMARKERTYPE
Value0x35F
FCodes.KBD_ADDMARKERTYPE KBD_ADDMARKERTYPE
Value0x41D
FCodes.KBD_DELETEMARKER KBD_DELETEMARKER
Value0x969
FCodes.KBD_MARKERSPOD KBD_MARKERSPOD
Value0x96A
FCodes.KBD_XREFSPOD KBD_XREFSPOD
Value0x96B
FCodes.KBD_FONTPOD KBD_FONTPOD
Value0x966
Property name Data Type
396
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_FONTREPLACEPOD KBD_FONTREPLACEPOD
Value0x95C
FCodes.KBD_HOTSPOTSPOD KBD_HOTSPOTSPOD
Value0x4FF
FCodes.KBD_NEWAFRAME KBD_NEWAFRAME
Value0x96D
FCodes.KBD_NEWHYPERTEXT KBD_NEWHYPERTEXT
Value0x35E
FCodes.KBD_VALIDATE_HYPERTEXT KBD_VALIDATE_HYPERTEXT
Value0xF13
FCodes.MENU_HYPERTEXT MENU_HYPERTEXT
Value0xC18
FCodes.KBD_HYPRTXT_SHTCUT KBD_HYPRTXT_SHTCUT
Value0x41E
FCodes.WEB_GOTOADOBE WEB_GOTOADOBE
Value0xC19
FCodes.KBD_FMPIP KBD_FMPIP
Value0x806
FCodes.WEB_PREFERENCES WEB_PREFERENCES
Value0xC1A
FCodes.WEB_TOPISSUES WEB_TOPISSUES
Value0xC1B
FCodes.WEB_ADOBEHELP WEB_ADOBEHELP
Value0xC22
FCodes.WEB_CORPORATENEWS WEB_CORPORATENEWS
Value0xC1D
FCodes.WEB_REGISTRATION WEB_REGISTRATION
Value0xC1E
FCodes.WEB_FRAME_BOOKMARKS WEB_FRAME_BOOKMARKS
Value0xC1F
FCodes.WEB_ADOBE_BOOKMARKS WEB_ADOBE_BOOKMARKS
Value0xC21
FCodes.KBD_DUMPHYPERTEXT KBD_DUMPHYPERTEXT
Value0xC20
Property name Data Type
397
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_VARCURPG KBD_VARCURPG
Value0xA06
FCodes.KBD_VARPGCOUNT KBD_VARPGCOUNT
Value0xA07
FCodes.KBD_VARCURDATE KBD_VARCURDATE
Value0xA08
FCodes.KBD_VAROTHER KBD_VAROTHER
Value0xA09
FCodes.KBD_EDITVARIABLE KBD_EDITVARIABLE
Value0xA0C
FCodes.KBD_FINDNEXT KBD_FINDNEXT
Value0x955
FCodes.KBD_FINDPREV KBD_FINDPREV
Value0x956
FCodes.KBD_TRACKCHANGE KBD_TRACKCHANGE
Value0x957
FCodes.KBD_TRACKCHANGEDISABLE KBD_TRACKCHANGEDISABLE
Value0x95D
FCodes.KBD_ACCEPTCHANGE KBD_ACCEPTCHANGE
Value0x958
FCodes.KBD_REJECTCHANGE KBD_REJECTCHANGE
Value0x959
FCodes.KBD_ACCEPTCHANGEANDNEX
T
KBD_ACCEPTCHANGEANDNEXT
Value0x99B
FCodes.KBD_REJECTCHANGEANDNEXT KBD_REJECTCHANGEANDNEXT
Value0x99C
FCodes.KBD_ACCEPTALLCHANGE KBD_ACCEPTALLCHANGE
Value0x960
FCodes.KBD_REJECTALLCHANGE KBD_REJECTALLCHANGE
Value0x961
FCodes.KBD_PREVIEW_ACCEPTALL KBD_PREVIEW_ACCEPTALL
Value0x962
FCodes.KBD_PREVIEW_REJECTALL KBD_PREVIEW_REJECTALL
Value0x963
Property name Data Type
398
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_PREVIEW_OFF KBD_PREVIEW_OFF
Value0x964
FCodes.KBD_CONFIGURE_TC_COLOR KBD_CONFIGURE_TC_COLOR
Value0x990
FCodes.KBD_TC_USER_NAME KBD_TC_USER_NAME
Value0x991
FCodes.KBD_TC_SEARCH_DOC KBD_TC_SEARCH_DOC
Value0x133
FCodes.KBD_TC_SEARCH_BOOK KBD_TC_SEARCH_BOOK
Value0x134
FCodes.KBD_TC_SEARCH_DITAMAP KBD_TC_SEARCH_DITAMAP
Value0x135
FCodes.KBD_TC_SEARCH_SEL KBD_TC_SEARCH_SEL
Value0x136
FCodes.KBD_TOC KBD_TOC
Value0x2B0
FCodes.KBD_LIST_FIGURE KBD_LIST_FIGURE
Value0x2B1
FCodes.KBD_LIST_TABLE KBD_LIST_TABLE
Value0x2B2
FCodes.KBD_LIST_PGF KBD_LIST_PGF
Value0x2B3
FCodes.KBD_LIST_PGF_ALPHA KBD_LIST_PGF_ALPHA
Value0x2B4
FCodes.KBD_LIST_MARKER KBD_LIST_MARKER
Value0x2B5
FCodes.KBD_LIST_MARKER_ALPHA KBD_LIST_MARKER_ALPHA
Value0x2B6
FCodes.KBD_LIST_REFERENCES KBD_LIST_REFERENCES
Value0x2B7
FCodes.KBD_INDEX_STANDARD KBD_INDEX_STANDARD
Value0x2C0
FCodes.KBD_INDEX_AUTHOR KBD_INDEX_AUTHOR
Value0x2C1
Property name Data Type
399
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_INDEX_SUBJECT KBD_INDEX_SUBJECT
Value0x2C2
FCodes.KBD_INDEX_MARKER KBD_INDEX_MARKER
Value0x2C3
FCodes.KBD_INDEX_REFERENCES KBD_INDEX_REFERENCES
Value0x2C4
FCodes.KBD_OPTIONS KBD_OPTIONS
Value0x360
FCodes.KBD_BORDERS KBD_BORDERS
Value0x361
FCodes.KBD_SYMBOLS KBD_SYMBOLS
Value0x362
FCodes.KBD_RULERS KBD_RULERS
Value0x363
FCodes.KBD_GRID KBD_GRID
Value0x364
FCodes.KBD_SEPARATIONS KBD_SEPARATIONS
Value0x365
FCodes.KBD_COLOR KBD_COLOR
Value0x39F
FCodes.KBD_CONDVISIBILITY KBD_CONDVISIBILITY
Value0x367
FCodes.KBD_CONDTOGGLEOVERR KBD_CONDTOGGLEOVERR
Value0x368
FCodes.KBD_HOTSPOTINDICATORS KBD_HOTSPOTINDICATORS
Value0x508
FCodes.KBD_TOGGLEDRAW KBD_TOGGLEDRAW
Value0x366
FCodes.KBD_VIEWSEP1 KBD_VIEWSEP1
Value0x36D
FCodes.KBD_VIEWSEP2 KBD_VIEWSEP2
Value0x36E
FCodes.KBD_VIEWSEP3 KBD_VIEWSEP3
Value0x36F
Property name Data Type
400
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_VIEWSEP4 KBD_VIEWSEP4
Value0x37D
FCodes.KBD_VIEWSEP5 KBD_VIEWSEP5
Value0x37E
FCodes.KBD_VIEWSEP6 KBD_VIEWSEP6
Value0x39E
FCodes.KBD_MENUCOMPLETE KBD_MENUCOMPLETE
Value0x33D
FCodes.KBD_MENUQUICK KBD_MENUQUICK
Value0x33E
FCodes.KBD_MENUCUSTOM KBD_MENUCUSTOM
Value0x33F
FCodes.KBD_MENUMODIFY KBD_MENUMODIFY
Value0x3D9
FCodes.KBD_MENURESET KBD_MENURESET
Value0x3D8
FCodes.KBD_SHOW_BORDERS KBD_SHOW_BORDERS
Value0x3F1
FCodes.KBD_SHOW_HOTSPOTINDICAT
ORS
KBD_SHOW_HOTSPOTINDICATORS
Value0x509
FCodes.KBD_SHOW_SYMBOLS KBD_SHOW_SYMBOLS
Value0x3F2
FCodes.KBD_SHOW_RULERS KBD_SHOW_RULERS
Value0x3F3
FCodes.KBD_SHOW_GRID KBD_SHOW_GRID
Value0x3F4
FCodes.KBD_SHOW_LINK_BOUNDARI
ES
KBD_SHOW_LINK_BOUNDARIES
Value0x3F5
FCodes.KBD_SHOW_ELEM_BORDER KBD_SHOW_ELEM_BORDER
Value0x3F6
FCodes.KBD_SHOW_ELEM_TAGS KBD_SHOW_ELEM_TAGS
Value0x3F7
FCodes.KBD_SHOW_GRAPHICS KBD_SHOW_GRAPHICS
Value0x3F8
Property name Data Type
401
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_SHOW_COND_IND KBD_SHOW_COND_IND
Value0x3F9
FCodes.KBD_HIDE_BORDERS KBD_HIDE_BORDERS
Value0x4F1
FCodes.KBD_HIDE_HOTSPOTINDICATO
RS
KBD_HIDE_HOTSPOTINDICATORS
Value0x50A
FCodes.KBD_HIDE_SYMBOLS KBD_HIDE_SYMBOLS
Value0x4F2
FCodes.KBD_HIDE_RULERS KBD_HIDE_RULERS
Value0x4F3
FCodes.KBD_HIDE_GRID KBD_HIDE_GRID
Value0x4F4
FCodes.KBD_HIDE_LINK_BOUNDARIES KBD_HIDE_LINK_BOUNDARIES
Value0x4F5
FCodes.KBD_HIDE_ELEM_BORDER KBD_HIDE_ELEM_BORDER
Value0x4F6
FCodes.KBD_HIDE_GRAPHICS KBD_HIDE_GRAPHICS
Value0x4F8
FCodes.KBD_HIDE_COND_IND KBD_HIDE_COND_IND
Value0x4F9
FCodes.KBD_INSETPOD KBD_INSETPOD
Value0x994
FCodes.KBD_SEARCHREFS KBD_SEARCHREFS
Value0xB17
FCodes.KBD_FLIPUD KBD_FLIPUD
Value0x370
FCodes.KBD_FLIPLR KBD_FLIPLR
Value0x371
FCodes.KBD_ROTATE_CCW KBD_ROTATE_CCW
Value0x372
FCodes.KBD_ROT_PLUS KBD_ROT_PLUS
Value0x372
FCodes.KBD_ROTATE_CCW_SMALL KBD_ROTATE_CCW_SMALL
Value0x38A
Property name Data Type
402
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_SCALE KBD_SCALE
Value0x373
FCodes.KBD_SMOOTH KBD_SMOOTH
Value0x374
FCodes.KBD_UNSMOOTH KBD_UNSMOOTH
Value0x375
FCodes.KBD_RESHAPE KBD_RESHAPE
Value0x376
FCodes.KBD_JOINCURVES KBD_JOINCURVES
Value0x377
FCodes.KBD_SETSIDES KBD_SETSIDES
Value0x378
FCodes.KBD_CONSTRAIN KBD_CONSTRAIN
Value0x379
FCodes.KBD_SNAP KBD_SNAP
Value0x37A
FCodes.KBD_GRAVITY KBD_GRAVITY
Value0x37B
FCodes.KBD_KEEPTOOL KBD_KEEPTOOL
Value0x37C
FCodes.KBD_OVERPRINT KBD_OVERPRINT
Value0x3D2
FCodes.KBD_OVERPRINT_NONE KBD_OVERPRINT_NONE
Value0x3D4
FCodes.KBD_RUN_OFF KBD_RUN_OFF
Value0x670
FCodes.KBD_RUN_CONTOUR KBD_RUN_CONTOUR
Value0x668
FCodes.KBD_RUN_BBOX KBD_RUN_BBOX
Value0x669
FCodes.KBD_RUN_GAP KBD_RUN_GAP
Value0x671
FCodes.KBD_RUN_PROPS KBD_RUN_PROPS
Value0x667
Property name Data Type
403
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_SETRUN_PROPS KBD_SETRUN_PROPS
Value0x96C
FCodes.KBD_FRONT KBD_FRONT
Value0x380
FCodes.KBD_BACK KBD_BACK
Value0x381
FCodes.KBD_GROUP KBD_GROUP
Value0x382
FCodes.KBD_UNGROUP KBD_UNGROUP
Value0x383
FCodes.KBD_ALIGN KBD_ALIGN
Value0x384
FCodes.KBD_DISTRIBUTE KBD_DISTRIBUTE
Value0x385
FCodes.KBD_ROTATE_CW KBD_ROTATE_CW
Value0x386
FCodes.KBD_ROT_MINUS KBD_ROT_MINUS
Value0x386
FCodes.KBD_ROTATE_CW_SMALL KBD_ROTATE_CW_SMALL
Value0x389
FCodes.KBD_OBJPROPS KBD_OBJPROPS
Value0x387
FCodes.KBD_PICKOBJPROPS KBD_PICKOBJPROPS
Value0x388
FCodes.KBD_MUTATE KBD_MUTATE
Value0x37F
FCodes.KBD_ROTATE KBD_ROTATE
Value0x38B
FCodes.KBD_ROTATE_AGAIN KBD_ROTATE_AGAIN
Value0x38C
FCodes.KBD_ROTATE_NATURAL KBD_ROTATE_NATURAL
Value0x38D
FCodes.KBD_REROTATE KBD_REROTATE
Value0x38E
Property name Data Type
404
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_ROTATE_RESET0 KBD_ROTATE_RESET0
Value0x38F
FCodes.KBD_SETALIGN_PROPS KBD_SETALIGN_PROPS
Value0x992
FCodes.KBD_SETDISTRIBUTE_PROPS KBD_SETDISTRIBUTE_PROPS
Value0x993
FCodes.KBD_CLOSEWIN KBD_CLOSEWIN
Value0x390
FCodes.KBD_OPENWIN KBD_OPENWIN
Value0x391
FCodes.KBD_CLOPWIN KBD_CLOPWIN
Value0x392
FCodes.KBD_MOVEWIN KBD_MOVEWIN
Value0x393
FCodes.KBD_EXPOSEWIN KBD_EXPOSEWIN
Value0x395
FCodes.KBD_HIDEWIN KBD_HIDEWIN
Value0x396
FCodes.KBD_HISHWIN KBD_HISHWIN
Value0x397
FCodes.KBD_REFRESHWIN KBD_REFRESHWIN
Value0x398
FCodes.KBD_QUITWIN KBD_QUITWIN
Value0x399
FCodes.KBD_RESIZELOCK KBD_RESIZELOCK
Value0x39A
FCodes.KBD_RESIZEUNLOCK KBD_RESIZEUNLOCK
Value0x39B
FCodes.KBD_QUIETCLOSEWIN KBD_QUIETCLOSEWIN
Value0x39C
FCodes.KBD_POPUP_MENU KBD_POPUP_MENU
Value0x39D
FCodes.KBD_LINETOOL KBD_LINETOOL
Value0x3A0
Property name Data Type
405
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_RECTTOOL KBD_RECTTOOL
Value0x3A1
FCodes.KBD_POLYGTOOL KBD_POLYGTOOL
Value0x3A2
FCodes.KBD_POLYLTOOL KBD_POLYLTOOL
Value0x3A3
FCodes.KBD_ARCTOOL KBD_ARCTOOL
Value0x3A4
FCodes.KBD_ROUNDRECT KBD_ROUNDRECT
Value0x3A5
FCodes.KBD_OVALTOOL KBD_OVALTOOL
Value0x3A6
FCodes.KBD_TEXTLTOOL KBD_TEXTLTOOL
Value0x3A7
FCodes.KBD_TEXTRTOOL KBD_TEXTRTOOL
Value0x3A8
FCodes.KBD_FREETOOL KBD_FREETOOL
Value0x3A9
FCodes.KBD_FRAMETOOL KBD_FRAMETOOL
Value0x3AA
FCodes.KBD_LASTTOOL KBD_LASTTOOL
Value0x3AB
FCodes.KBD_WIDTH0 KBD_WIDTH0
Value0x3AC
FCodes.KBD_WIDTH1 KBD_WIDTH1
Value0x3AD
FCodes.KBD_INCWIDTH KBD_INCWIDTH
Value0x3AE
FCodes.KBD_DECWIDTH KBD_DECWIDTH
Value0x3AF
FCodes.KBD_PEN0 KBD_PEN0
Value0x3B0
FCodes.KBD_PEN1 KBD_PEN1
Value0x3B1
Property name Data Type
406
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_INCPEN KBD_INCPEN
Value0x3B2
FCodes.KBD_DECPEN KBD_DECPEN
Value0x3B3
FCodes.KBD_FILL0 KBD_FILL0
Value0x3B4
FCodes.KBD_FILL1 KBD_FILL1
Value0x3B5
FCodes.KBD_INCFILL KBD_INCFILL
Value0x3B6
FCodes.KBD_DECFILL KBD_DECFILL
Value0x3B7
FCodes.KBD_SETFILL KBD_SETFILL
Value0x3B8
FCodes.KBD_SETPEN KBD_SETPEN
Value0x3B9
FCodes.KBD_SETWIDTH KBD_SETWIDTH
Value0x3BA
FCodes.KBD_SETCAP KBD_SETCAP
Value0x3BB
FCodes.KBD_SETSEP KBD_SETSEP
Value0x3BC
FCodes.KBD_SETSEP_KEEP KBD_SETSEP_KEEP
Value0x3BE
FCodes.KBD_SETSEP_ALL KBD_SETSEP_ALL
Value0x3BF
FCodes.KBD_SETSEP_RESET_TINT_OV
ERPRINT
KBD_SETSEP_RESET_TINT_OVERPRINT
Value0x3D1
FCodes.KBD_SETFILL_0 KBD_SETFILL_0
Value0x430
FCodes.KBD_SETFILL_1 KBD_SETFILL_1
Value0x431
FCodes.KBD_SETFILL_2 KBD_SETFILL_2
Value0x432
Property name Data Type
407
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_SETFILL_3 KBD_SETFILL_3
Value0x433
FCodes.KBD_SETFILL_4 KBD_SETFILL_4
Value0x434
FCodes.KBD_SETFILL_5 KBD_SETFILL_5
Value0x435
FCodes.KBD_SETFILL_6 KBD_SETFILL_6
Value0x436
FCodes.KBD_SETFILL_7 KBD_SETFILL_7
Value0x437
FCodes.KBD_SETFILL_8 KBD_SETFILL_8
Value0x438
FCodes.KBD_SETFILL_9 KBD_SETFILL_9
Value0x439
FCodes.KBD_SETFILL_A KBD_SETFILL_A
Value0x43A
FCodes.KBD_SETFILL_B KBD_SETFILL_B
Value0x43B
FCodes.KBD_SETFILL_C KBD_SETFILL_C
Value0x43C
FCodes.KBD_SETFILL_D KBD_SETFILL_D
Value0x43D
FCodes.KBD_SETFILL_E KBD_SETFILL_E
Value0x43E
FCodes.KBD_SETFILL_F KBD_SETFILL_F
Value0x43F
FCodes.KBD_SETPEN_0 KBD_SETPEN_0
Value0x440
FCodes.KBD_SETPEN_1 KBD_SETPEN_1
Value0x441
FCodes.KBD_SETPEN_2 KBD_SETPEN_2
Value0x442
FCodes.KBD_SETPEN_3 KBD_SETPEN_3
Value0x443
Property name Data Type
408
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_SETPEN_4 KBD_SETPEN_4
Value0x444
FCodes.KBD_SETPEN_5 KBD_SETPEN_5
Value0x445
FCodes.KBD_SETPEN_6 KBD_SETPEN_6
Value0x446
FCodes.KBD_SETPEN_7 KBD_SETPEN_7
Value0x447
FCodes.KBD_SETPEN_8 KBD_SETPEN_8
Value0x448
FCodes.KBD_SETPEN_9 KBD_SETPEN_9
Value0x449
FCodes.KBD_SETPEN_A KBD_SETPEN_A
Value0x44A
FCodes.KBD_SETPEN_B KBD_SETPEN_B
Value0x44B
FCodes.KBD_SETPEN_C KBD_SETPEN_C
Value0x44C
FCodes.KBD_SETPEN_D KBD_SETPEN_D
Value0x44D
FCodes.KBD_SETPEN_E KBD_SETPEN_E
Value0x44E
FCodes.KBD_SETPEN_F KBD_SETPEN_F
Value0x44F
FCodes.KBD_SETWIDTH_0 KBD_SETWIDTH_0
Value0x450
FCodes.KBD_SETWIDTH_1 KBD_SETWIDTH_1
Value0x451
FCodes.KBD_SETWIDTH_2 KBD_SETWIDTH_2
Value0x452
FCodes.KBD_SETWIDTH_3 KBD_SETWIDTH_3
Value0x453
FCodes.KBD_SETWIDTH_SLIDE KBD_SETWIDTH_SLIDE
Value0x45E
Property name Data Type
409
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_SETWIDTH_OPTION KBD_SETWIDTH_OPTION
Value0x45F
FCodes.KBD_SETCAP_0 KBD_SETCAP_0
Value0x460
FCodes.KBD_SETCAP_1 KBD_SETCAP_1
Value0x461
FCodes.KBD_SETCAP_2 KBD_SETCAP_2
Value0x462
FCodes.KBD_SETCAP_3 KBD_SETCAP_3
Value0x463
FCodes.KBD_SETCAP_OPTION KBD_SETCAP_OPTION
Value0x46F
FCodes.KBD_SETDASH_0 KBD_SETDASH_0
Value0x470
FCodes.KBD_SETDASH_1 KBD_SETDASH_1
Value0x471
FCodes.KBD_SETDASH_2 KBD_SETDASH_2
Value0x472
FCodes.KBD_SETDASH_3 KBD_SETDASH_3
Value0x473
FCodes.KBD_SETDASH_4 KBD_SETDASH_4
Value0x474
FCodes.KBD_SETDASH_5 KBD_SETDASH_5
Value0x475
FCodes.KBD_SETDASH_6 KBD_SETDASH_6
Value0x476
FCodes.KBD_SETDASH_7 KBD_SETDASH_7
Value0x477
FCodes.KBD_SETDASH_8 KBD_SETDASH_8
Value0x478
FCodes.KBD_SETDASH_OPTION KBD_SETDASH_OPTION
Value0x47F
FCodes.KBD_SNAP_0 KBD_SNAP_0
Value0x480
Property name Data Type
410
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_SNAP_1 KBD_SNAP_1
Value0x481
FCodes.KBD_GRAVITY_0 KBD_GRAVITY_0
Value0x482
FCodes.KBD_GRAVITY_1 KBD_GRAVITY_1
Value0x483
FCodes.KBD_SETKNOCKOUT KBD_SETKNOCKOUT
Value0x48A
FCodes.KBD_SETOVERPRINT KBD_SETOVERPRINT
Value0x48B
FCodes.KBD_SETFROMCOLOR KBD_SETFROMCOLOR
Value0x48C
FCodes.KBD_SETTINT KBD_SETTINT
Value0x48D
FCodes.KBD_SETSOLID KBD_SETSOLID
Value0x402
FCodes.KBD_SETDASH KBD_SETDASH
Value0x403
FCodes.KBD_DASH0 KBD_DASH0
Value0x404
FCodes.KBD_DASH1 KBD_DASH1
Value0x405
FCodes.KBD_INCDASH KBD_INCDASH
Value0x406
FCodes.KBD_DECDASH KBD_DECDASH
Value0x407
FCodes.KBD_DASHOPTION KBD_DASHOPTION
Value0x408
FCodes.KBD_CHECKSEL KBD_CHECKSEL
Value0x3C0
FCodes.KBD_CHECKDOC KBD_CHECKDOC
Value0x3C1
FCodes.KBD_CORRECT KBD_CORRECT
Value0x3C2
Property name Data Type
411
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_ADDUSRDICT KBD_ADDUSRDICT
Value0x3C3
FCodes.KBD_ADDDOCDICT KBD_ADDDOCDICT
Value0x3C4
FCodes.KBD_ADDAUTOCORR KBD_ADDAUTOCORR
Value0x3C5
FCodes.KBD_DELUSRDICT KBD_DELUSRDICT
Value0x3C6
FCodes.KBD_DELDOCDICT KBD_DELDOCDICT
Value0x3C7
FCodes.KBD_CLEARAUTO KBD_CLEARAUTO
Value0x3C8
FCodes.KBD_CHANGEDICT KBD_CHANGEDICT
Value0x3C9
FCodes.KBD_SPELLRESET KBD_SPELLRESET
Value0x3CA
FCodes.KBD_CHECKPAGE KBD_CHECKPAGE
Value0x3CB
FCodes.KBD_SPOPTIONS KBD_SPOPTIONS
Value0x3CC
FCodes.KBD_HYPHENATE KBD_HYPHENATE
Value0x3CD
FCodes.KBD_CHECKBATCH KBD_CHECKBATCH
Value0x3CE
FCodes.KBD_REFORMATDOC KBD_REFORMATDOC
Value0x3CF
FCodes.KBD_ASC_CORRECT KBD_ASC_CORRECT
Value0x995
FCodes.KBD_ASC_ADDUSRDICT KBD_ASC_ADDUSRDICT
Value0x996
FCodes.KBD_ASC_ADDDOCDICT KBD_ASC_ADDDOCDICT
Value0x997
FCodes.KBD_ASC_ENABLE_AUTO_SPE
LL_CHECK
KBD_ASC_ENABLE_AUTO_SPELL_CHECK
Value0x999
Property name Data Type
412
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.TEXT_INSET_PROPS TEXT_INSET_PROPS
Value0x3E0
FCodes.UPDATE_INSETS UPDATE_INSETS
Value0x3E1
FCodes.SUPPRESS_INSETS SUPPRESS_INSETS
Value0x3E2
FCodes.KBD_CREATE_MULTIMEDIA_LI
NK
KBD_CREATE_MULTIMEDIA_LINK
Value0x3E3
FCodes.KBD_CREATE_MULTIMEDIA_LI
NK_TBL
KBD_CREATE_MULTIMEDIA_LINK_TBL
Value0x3E4
FCodes.KBD_MENUBARFOCUS KBD_MENUBARFOCUS
Value0x3F0
FCodes.KBD_SINGLE_QUOTE KBD_SINGLE_QUOTE
Value0x400
FCodes.KBD_DOUBLE_QUOTE KBD_DOUBLE_QUOTE
Value0x401
FCodes.HIGH_CHAR_PREV HIGH_CHAR_PREV
Value0x410
FCodes.HIGH_WORD_PREV HIGH_WORD_PREV
Value0x411
FCodes.HIGH_LINE_PREV HIGH_LINE_PREV
Value0x412
FCodes.HIGH_SENT_PREV HIGH_SENT_PREV
Value0x413
FCodes.HIGH_PGF_PREV HIGH_PGF_PREV
Value0x414
FCodes.HIGH_LINE_UP HIGH_LINE_UP
Value0x415
FCodes.HIGH_LINE_DOWN HIGH_LINE_DOWN
Value0x416
FCodes.HIGH_COL_TOP HIGH_COL_TOP
Value0x417
FCodes.HIGH_COL_BOT HIGH_COL_BOT
Value0x418
Property name Data Type
413
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.HIGH_FLOW_BEG HIGH_FLOW_BEG
Value0x419
FCodes.HIGH_FLOW_END HIGH_FLOW_END
Value0x41A
FCodes.HIGH_LINE_BEG HIGH_LINE_BEG
Value0x41B
FCodes.HIGH_LINE_END HIGH_LINE_END
Value0x41C
FCodes.HIGH_ELEMENT_PREV HIGH_ELEMENT_PREV
Value0x420
FCodes.HIGH_ELEMENT_NEXT HIGH_ELEMENT_NEXT
Value0x421
FCodes.HIGH_SIBLINGS HIGH_SIBLINGS
Value0x422
FCodes.HIGH_PARENT HIGH_PARENT
Value0x423
FCodes.KBD_DFN_WEB_obsolete KBD_DFN_WEB_obsolete
Value0x500
FCodes.KBD_DFN_LIB_obsolete KBD_DFN_LIB_obsolete
Value0x501
FCodes.KBD_PASTE_RTF KBD_PASTE_RTF
Value0x502
FCodes.KBD_PAGELAYOUT KBD_PAGELAYOUT
Value0x503
FCodes.KBD_COPYRIGHT KBD_COPYRIGHT
Value0x504
FCodes.KBD_RESTOREFONT KBD_RESTOREFONT
Value0x505
FCodes.KBD_SYMFONT KBD_SYMFONT
Value0x506
FCodes.HIGH_CHAR_NEXT HIGH_CHAR_NEXT
Value0x510
FCodes.HIGH_WORD_NEXT HIGH_WORD_NEXT
Value0x511
Property name Data Type
414
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.HIGH_LINE_NEXT HIGH_LINE_NEXT
Value0x512
FCodes.HIGH_SENT_NEXT HIGH_SENT_NEXT
Value0x513
FCodes.HIGH_PGF_NEXT HIGH_PGF_NEXT
Value0x514
FCodes.HIGH_SAMECB HIGH_SAMECB
Value0x515
FCodes.HIGH_SAMECOND HIGH_SAMECOND
Value0x516
FCodes.HIGH_HYPERTEXT HIGH_HYPERTEXT
Value0x517
FCodes.SEARCH_CB SEARCH_CB
Value0x518
FCodes.SEARCH_CBTAG SEARCH_CBTAG
Value0x519
FCodes.SEARCH_COND SEARCH_COND
Value0x51A
FCodes.SEARCH_CBOVERRIDE SEARCH_CBOVERRIDE
Value0x51B
FCodes.OBJ_SEL_FIRST OBJ_SEL_FIRST
Value0x600
FCodes.OBJ_SEL_NEXT OBJ_SEL_NEXT
Value0x601
FCodes.OBJ_SEL_EXTEND_NEXT OBJ_SEL_EXTEND_NEXT
Value0x602
FCodes.OBJ_SEL_PREV OBJ_SEL_PREV
Value0x603
FCodes.OBJ_SEL_NEXT_WRAP OBJ_SEL_NEXT_WRAP
Value0x604
FCodes.OBJ_SEL_PREV_WRAP OBJ_SEL_PREV_WRAP
Value0x605
FCodes.OBJ_SEL_LAST OBJ_SEL_LAST
Value0x606
Property name Data Type
415
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.FOCUS_INPUT_DOC FOCUS_INPUT_DOC
Value0x620
FCodes.FOCUS_INPUT_SEARCH FOCUS_INPUT_SEARCH
Value0x621
FCodes.FOCUS_INPUT_MARKER FOCUS_INPUT_MARKER
Value0x622
FCodes.FOCUS_INPUT_SPELL FOCUS_INPUT_SPELL
Value0x623
FCodes.FOCUS_INPUT_HYPERTEXT FOCUS_INPUT_HYPERTEXT
Value0x624
FCodes.FOCUS_INPUT_PGFFMT FOCUS_INPUT_PGFFMT
Value0x626
FCodes.FOCUS_INPUT_FONTFMT FOCUS_INPUT_FONTFMT
Value0x627
FCodes.FOCUS_INPUT_COND FOCUS_INPUT_COND
Value0x629
FCodes.FOCUS_INPUT_CELLFMT FOCUS_INPUT_CELLFMT
Value0x62A
FCodes.FOCUS_INPUT_CUSTRS FOCUS_INPUT_CUSTRS
Value0x62B
FCodes.FOCUS_INPUT_TBLFMT FOCUS_INPUT_TBLFMT
Value0x62C
FCodes.FOCUS_INPUT_STRWIN FOCUS_INPUT_STRWIN
Value0x62D
FCodes.FOCUS_INPUT_VALIDATION FOCUS_INPUT_VALIDATION
Value0x62E
FCodes.FOCUS_INPUT_ATTREDITOR FOCUS_INPUT_ATTREDITOR
Value0x62F
FCodes.FOCUS_INPUT_ELEM_CTX FOCUS_INPUT_ELEM_CTX
Value0xA32
FCodes.KBD_CLOSE_SEARCH KBD_CLOSE_SEARCH
Value0x681
FCodes.KBD_CLOSE_MARKER KBD_CLOSE_MARKER
Value0x682
Property name Data Type
416
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_CLOSE_SPELL KBD_CLOSE_SPELL
Value0x683
FCodes.KBD_CLOSE_PGFFMT KBD_CLOSE_PGFFMT
Value0x684
FCodes.KBD_CLOSE_FONTFMT KBD_CLOSE_FONTFMT
Value0x685
FCodes.KBD_CLOSE_COND KBD_CLOSE_COND
Value0x686
FCodes.KBD_CLOSE_CUSTRS KBD_CLOSE_CUSTRS
Value0x687
FCodes.KBD_CLOSE_TBLFMT KBD_CLOSE_TBLFMT
Value0x688
FCodes.KBD_CLOSE_STRWIN KBD_CLOSE_STRWIN
Value0x689
FCodes.KBD_CLOSE_VALIDATION KBD_CLOSE_VALIDATION
Value0x68A
FCodes.KBD_CLOSE_ATTREDITOR KBD_CLOSE_ATTREDITOR
Value0x68B
FCodes.KBD_CLOSE_ELEM_CTX KBD_CLOSE_ELEM_CTX
Value0x68C
FCodes.KBD_CLOSE_HYPERTEXT KBD_CLOSE_HYPERTEXT
Value0x68D
FCodes.KBD_PAUSE_1x00 KBD_PAUSE_1x00
Value0x630
FCodes.KBD_PAUSE_0x10 KBD_PAUSE_0x10
Value0x631
FCodes.KBD_PAUSE_0x01 KBD_PAUSE_0x01
Value0x632
FCodes.KBD_SLOW_0x00 KBD_SLOW_0x00
Value0x633
FCodes.KBD_SLOW_1x00 KBD_SLOW_1x00
Value0x634
FCodes.KBD_SLOW_0x10 KBD_SLOW_0x10
Value0x635
Property name Data Type
417
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_SLOW_0x01 KBD_SLOW_0x01
Value0x636
FCodes.KBD_SET_TEXTFRAME_GRID KBD_SET_TEXTFRAME_GRID
Value0x666
FCodes.KBD_PURIFY_NEW_LEAKS KBD_PURIFY_NEW_LEAKS
Value0x650
FCodes.KBD_PURIFY_ALL_LEAKS KBD_PURIFY_ALL_LEAKS
Value0x651
FCodes.KBD_PURIFY_CLEAR_LEAKS KBD_PURIFY_CLEAR_LEAKS
Value0x652
FCodes.KBD_COUNT_SBLOCKS KBD_COUNT_SBLOCKS
Value0x653
FCodes.KBD_API KBD_API
Value0xDF0
FCodes.KBD_API_SHORTCUT KBD_API_SHORTCUT
Value0xDF1
FCodes.TYPEIN TYPEIN
Value0xDF2
FCodes.INLINE_TYPEIN INLINE_TYPEIN
Value0xDF3
FCodes.KBD_VIEW_API KBD_VIEW_API
Value0xDF4
FCodes.KBD_VIEW_API_SHORTCUT KBD_VIEW_API_SHORTCUT
Value0xDF5
FCodes.KBD_VIEW_SWITCH KBD_VIEW_SWITCH
Value0xDF6
FCodes.KBD_BACKSTACK KBD_BACKSTACK
Value0xEF0
FCodes.KBD_UPSTACK KBD_UPSTACK
Value0xEF1
FCodes.KBD_VIEWER KBD_VIEWER
Value0xF00
FCodes.TOGGLE_FLUID_VIEW TOGGLE_FLUID_VIEW
Value0x500
Property name Data Type
418
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_DSEXIT KBD_DSEXIT
Value0xF01
FCodes.KBD_MEMFAIL KBD_MEMFAIL
Value0xF02
FCodes.KBD_SAVEMETA KBD_SAVEMETA
Value0xF03
FCodes.KBD_MEM_STATS KBD_MEM_STATS
Value0xF04
FCodes.KBD_CACHE_STATS KBD_CACHE_STATS
Value0xF05
FCodes.KBD_NEWVAR KBD_NEWVAR
Value0xF06
FCodes.KBD_UPDATEREF KBD_UPDATEREF
Value0xF07
FCodes.KBD_DEREFREF KBD_DEREFREF
Value0xF08
FCodes.KBD_HEATREF KBD_HEATREF
Value0xF09
FCodes.KBD_DOC_REPORT KBD_DOC_REPORT
Value0xF10
FCodes.KBD_FULLRULERS KBD_FULLRULERS
Value0x3BD
FCodes.KBD_ALLSELECT KBD_ALLSELECT
Value0xF20
FCodes.KBD_OBJSELECT KBD_OBJSELECT
Value0xF21
FCodes.KBD_TOOLWIN KBD_TOOLWIN
Value0xF22
FCodes.KBD_PGFWIN KBD_PGFWIN
Value0xF23
FCodes.KBD_FONTWIN KBD_FONTWIN
Value0xF24
FCodes.KBD_RESIZEBOX KBD_RESIZEBOX
Value0xF25
Property name Data Type
419
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_MATHWIN KBD_MATHWIN
Value0xF26
FCodes.KBD_RESIZEBOXM KBD_RESIZEBOXM
Value0xF27
FCodes.KBD_ELEMENTWIN KBD_ELEMENTWIN
Value0xF28
FCodes.KBD_SMALLTOOLWIN KBD_SMALLTOOLWIN
Value0xF29
FCodes.KBD_OBJSELECT_NOPREF KBD_OBJSELECT_NOPREF
Value0xF2A
FCodes.KBD_HOTSPOT KBD_HOTSPOT
Value0x4FD
FCodes.KBD_EDITHOTSPOT KBD_EDITHOTSPOT
Value0x4FE
FCodes.KBD_DELINKHOTSPOT KBD_DELINKHOTSPOT
Value0x507
FCodes.KBD_ZOOMIN KBD_ZOOMIN
Value0xF30
FCodes.KBD_ZOOMOUT KBD_ZOOMOUT
Value0xF31
FCodes.KBD_ZOOM_FIT_PAGE KBD_ZOOM_FIT_PAGE
Value0xF32
FCodes.KBD_ZOOM_FIT_WINDOW KBD_ZOOM_FIT_WINDOW
Value0xF33
FCodes.KBD_ZOOM KBD_ZOOM
Value0xF34
FCodes.KBD_ZOOM100 KBD_ZOOM100
Value0xF35
FCodes.KBD_ZOOM_SET KBD_ZOOM_SET
Value0xF3C
FCodes.KBD_ZOOM_FIT_TEXTFRAME KBD_ZOOM_FIT_TEXTFRAME
Value0xF3F
FCodes.KBD_ZOOM_AUTOFIT_AFTER_
ZOOM
KBD_ZOOM_AUTOFIT_AFTER_ZOOM
Value0xF1A
Property name Data Type
420
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_TAGSTATUS KBD_TAGSTATUS
Value0xF36
FCodes.KBD_PAGESTATUS KBD_PAGESTATUS
Value0xF37
FCodes.KBD_HSCROLL KBD_HSCROLL
Value0xF38
FCodes.KBD_VSCROLL KBD_VSCROLL
Value0xF39
FCodes.KBD_RENAMEPAGE KBD_RENAMEPAGE
Value0xF3A
FCodes.KBD_RENAMEFRAME KBD_RENAMEFRAME
Value0xF3B
FCodes.KBD_FONTQUICK KBD_FONTQUICK
Value0xF40
FCodes.KBD_PGFQUICK KBD_PGFQUICK
Value0xF41
FCodes.KBD_VARQUICK KBD_VARQUICK
Value0xF42
FCodes.KBD_CELLFMTQUICK KBD_CELLFMTQUICK
Value0xF43
FCodes.KBD_CONDINQUICK KBD_CONDINQUICK
Value0xF44
FCodes.KBD_CONDNOTINQUICK KBD_CONDNOTINQUICK
Value0xF45
FCodes.KBD_UNCOND KBD_UNCOND
Value0xF46
FCodes.KBD_CONDVISONLYQUICK KBD_CONDVISONLYQUICK
Value0xF47
FCodes.KBD_INSERTQUICK KBD_INSERTQUICK
Value0xF48
FCodes.KBD_WRAPQUICK KBD_WRAPQUICK
Value0xF49
FCodes.KBD_CHANGEQUICK KBD_CHANGEQUICK
Value0xF4C
Property name Data Type
421
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_ATTREDITQUICK KBD_ATTREDITQUICK
Value0xF4D
FCodes.PGF_DESIGN_CAT PGF_DESIGN_CAT
Value0xF4E
FCodes.CHAR_DESIGN_CAT CHAR_DESIGN_CAT
Value0xF4F
FCodes.TBL_DESIGN_CAT TBL_DESIGN_CAT
Value0xF5F
FCodes.KBD_NOCHANGEDB KBD_NOCHANGEDB
Value0xF4A
FCodes.KBD_RESETDB KBD_RESETDB
Value0xF4B
FCodes.KBD_SMEQN KBD_SMEQN
Value0xF50
FCodes.KBD_MEDEQN KBD_MEDEQN
Value0xF51
FCodes.KBD_LGEQN KBD_LGEQN
Value0xF52
FCodes.KBD_PUTINLINE KBD_PUTINLINE
Value0xF53
FCodes.KBD_ANTIPUTINLINE KBD_ANTIPUTINLINE
Value0xF54
FCodes.KBD_EVACUATE KBD_EVACUATE
Value0xF60
FCodes.KBD_VERIFYCONTEXT KBD_VERIFYCONTEXT
Value0xF61
FCodes.KBD_SAVEASDBRE KBD_SAVEASDBRE
Value0xF70
FCodes.KBD_TEST_MODAL KBD_TEST_MODAL
Value0xF71
FCodes.KBD_TEST_MODELESS KBD_TEST_MODELESS
Value0xF72
FCodes.KBD_STUFF_ITEM KBD_STUFF_ITEM
Value0xF73
Property name Data Type
422
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_SAVESAS KBD_SAVESAS
Value0xF74
FCodes.KBD_TEST_PRINTDBRE KBD_TEST_PRINTDBRE
Value0xF75
FCodes.KBD_SAVEFMX KBD_SAVEFMX
Value0xF76
FCodes.KBD_SAVEDBRE KBD_SAVEDBRE
Value0xF77
FCodes.KBD_CAPTURE_LIVE_DIALOG KBD_CAPTURE_LIVE_DIALOG
Value0xF78
FCodes.KBD_RM_MODE KBD_RM_MODE
Value0xF79
FCodes.KBD_DRE_MODE_X KBD_DRE_MODE_X
Value0xF7A
FCodes.KBD_DRE_MODE_W KBD_DRE_MODE_W
Value0xF7B
FCodes.KBD_DRE_MODE_M KBD_DRE_MODE_M
Value0xF7C
FCodes.KBD_TABLE_INS KBD_TABLE_INS
Value0xF80
FCodes.KBD_TABLE_FORMAT KBD_TABLE_FORMAT
Value0xF81
FCodes.KBD_TABLE_CELLFMT KBD_TABLE_CELLFMT
Value0xF84
FCodes.KBD_TABLE_ROWFMT KBD_TABLE_ROWFMT
Value0xF85
FCodes.KBD_TABLE_CUSTRS KBD_TABLE_CUSTRS
Value0xF86
FCodes.KBD_TABLE_ADDRC KBD_TABLE_ADDRC
Value0xF87
FCodes.KBD_TABLE_RESIZECOL KBD_TABLE_RESIZECOL
Value0xF88
FCodes.KBD_TABLE_STRADDLE KBD_TABLE_STRADDLE
Value0xF89
Property name Data Type
423
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_TABLE_CONVERT KBD_TABLE_CONVERT
Value0xF8A
FCodes.KBD_TABLE_DEBUG KBD_TABLE_DEBUG
Value0xF8B
FCodes.KBD_TABLE_RULES KBD_TABLE_RULES
Value0xF8C
FCodes.KBD_TABLE_EXIT_IP KBD_TABLE_EXIT_IP
Value0xFC0
FCodes.KBD_TBL_DLG_UNIFY_TF KBD_TBL_DLG_UNIFY_TF
Value0xF90
FCodes.KBD_TBL_DLG_UNIFY_CF KBD_TBL_DLG_UNIFY_CF
Value0xF91
FCodes.KBD_TBL_DLG_ADD_ABOVE KBD_TBL_DLG_ADD_ABOVE
Value0xF92
FCodes.KBD_TBL_DLG_ADD_BELOW KBD_TBL_DLG_ADD_BELOW
Value0xF93
FCodes.KBD_TBL_DLG_ADD_LEFT KBD_TBL_DLG_ADD_LEFT
Value0xF94
FCodes.KBD_TBL_DLG_ADD_RIGHT KBD_TBL_DLG_ADD_RIGHT
Value0xF95
FCodes.KBD_TBL_DLG_CLEAR_EMPTY KBD_TBL_DLG_CLEAR_EMPTY
Value0xF96
FCodes.KBD_TBL_DLG_CLEAR_X KBD_TBL_DLG_CLEAR_X
Value0xF97
FCodes.KBD_TBL_DLG_PASTE_REPL KBD_TBL_DLG_PASTE_REPL
Value0xF98
FCodes.KBD_TBL_DLG_PASTE_BEFORE KBD_TBL_DLG_PASTE_BEFORE
Value0xF99
FCodes.KBD_TBL_DLG_PASTE_AFTER KBD_TBL_DLG_PASTE_AFTER
Value0xF9A
FCodes.KBD_TABLEWIN KBD_TABLEWIN
Value0xFBB
FCodes.TBL_APPLY_CAT_TO_SEL TBL_APPLY_CAT_TO_SEL
Value0xFBC
Property name Data Type
424
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_CLOSE_TABLE_CATALOG KBD_CLOSE_TABLE_CATALOG
Value0xFBD
FCodes.TBL_APPLY_TAG TBL_APPLY_TAG
Value0xFBE
FCodes.KBD_COPYCELLFMT KBD_COPYCELLFMT
Value0xF9B
FCodes.KBD_COPYCOLW KBD_COPYCOLW
Value0xF9C
FCodes.KBD_COPYCOND KBD_COPYCOND
Value0xF9D
FCodes.KBD_USEELTDEFSFROM KBD_USEELTDEFSFROM
Value0xF9E
FCodes.KBD_COPYATTRS KBD_COPYATTRS
Value0xF9F
FCodes.KBD_ATOMIZE_INSET KBD_ATOMIZE_INSET
Value0xFAA
FCodes.KBD_SWAP_RED_BLUE KBD_SWAP_RED_BLUE
Value0xFAB
FCodes.KBD_REWRAP_INLINE_MATH KBD_REWRAP_INLINE_MATH
Value0xFAC
FCodes.KBD_MODE_ROTATE_TOOL KBD_MODE_ROTATE_TOOL
Value0xFAD
FCodes.KBD_XYZZY KBD_XYZZY
Value0xFED
FCodes.KBD_XYZZZ KBD_XYZZZ
Value0xEE0
FCodes.KBD_XYZZQ KBD_XYZZQ
Value0xEE1
FCodes.KBD_ACTIVATE_IN_PDF_BYDE
FAULT
KBD_ACTIVATE_IN_PDF_BYDEFAULT
Value0x4FA
FCodes.KBD_OPEN_IN_POPUP_WIN_I
N_PDF
KBD_OPEN_IN_POPUP_WIN_IN_PDF
Value0x4FB
FCodes.KBD_GRAPHIC_SET_NAME KBD_GRAPHIC_SET_NAME
Value0x4FC
Property name Data Type
425
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.CMD_OPEN_DITAMAP_COMP
ONENT
CMD_OPEN_DITAMAP_COMPONENT
Value0xF14
FCodes.PGF_DESIGNKIT_APPLY PGF_DESIGNKIT_APPLY
Value0xAAA
FCodes.CHAR_DESIGNKIT_APPLY CHAR_DESIGNKIT_APPLY
Value0xAAB
FCodes.TBL_DESIGNKIT_APPLY TBL_DESIGNKIT_APPLY
Value0xAAC
FCodes.PGF_DESIGNKIT_UPDATEALL PGF_DESIGNKIT_UPDATEALL
Value0xAAD
FCodes.CHAR_DESIGNKIT_UPDATEALL CHAR_DESIGNKIT_UPDATEALL
Value0xAAE
FCodes.TBL_DESIGNKIT_UPDATEALL TBL_DESIGNKIT_UPDATEALL
Value0xAAF
FCodes.PGF_DESIGNKIT_NEWFORMAT PGF_DESIGNKIT_NEWFORMAT
Value0xB00
FCodes.CHAR_DESIGNKIT_NEWFORM
AT
CHAR_DESIGNKIT_NEWFORMAT
Value0xB01
FCodes.TBL_DESIGNKIT_NEWFORMAT TBL_DESIGNKIT_NEWFORMAT
Value0xB02
FCodes.PGF_DESIGNKIT_UPDATEOPTI
ONS
PGF_DESIGNKIT_UPDATEOPTIONS
Value0xB03
FCodes.CHAR_DESIGNKIT_UPDATEOPT
IONS
CHAR_DESIGNKIT_UPDATEOPTIONS
Value0xB04
FCodes.TBL_DESIGNKIT_UPDATEOPTI
ONS
TBL_DESIGNKIT_UPDATEOPTIONS
Value0xB05
FCodes.KBD_PGFFMT_DELETE KBD_PGFFMT_DELETE
Value0xB06
FCodes.KBD_CHARFMT_DELETE KBD_CHARFMT_DELETE
Value0xB07
FCodes.KBD_TBLFMT_DELETE KBD_TBLFMT_DELETE
Value0xB08
FCodes.KBD_STYLEFMT_DELETE_UNU
SED
KBD_STYLEFMT_DELETE_UNUSED
Value0xB10
Property name Data Type
426
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_PGFFMT_DELETE_UNUSE
D
KBD_PGFFMT_DELETE_UNUSED
Value0xB13
FCodes.KBD_CHARFMT_DELETE_UNU
SED
KBD_CHARFMT_DELETE_UNUSED
Value0xB14
FCodes.KBD_TBLFMT_DELETE_UNUSE
D
KBD_TBLFMT_DELETE_UNUSED
Value0xB15
FCodes.PGF_DESIGNKIT_RESET PGF_DESIGNKIT_RESET
Value0xABA
FCodes.CHAR_DESIGNKIT_RESET CHAR_DESIGNKIT_RESET
Value0xABB
FCodes.TBL_DESIGNKIT_RESET TBL_DESIGNKIT_RESET
Value0xABC
FCodes.KBD_STYLEFMT_DELETE KBD_STYLEFMT_DELETE
Value0xBB0
FCodes.KBD_STYLE_CATALOG KBD_STYLE_CATALOG
Value0xBB1
FCodes.KBD_STYLE_DESIGNER KBD_STYLE_DESIGNER
Value0xBB2
FCodes.CONDTEXT_KIT_APPLY CONDTEXT_KIT_APPLY
Value0xB09
FCodes.ALT_TXT_INSET ALT_TXT_INSET
Value0xB11
FCodes.ALT_GFX_INSET ALT_GFX_INSET
Value0xB12
FCodes.KBD_TBLSEL_CELL KBD_TBLSEL_CELL
Value0xFA0
FCodes.KBD_TBLSEL_ROW KBD_TBLSEL_ROW
Value0xFA1
FCodes.KBD_TBLSEL_COL KBD_TBLSEL_COL
Value0xFA2
FCodes.KBD_TBLSEL_TABLE KBD_TBLSEL_TABLE
Value0xFA3
FCodes.KBD_TBLSEL_CELLTEXT KBD_TBLSEL_CELLTEXT
Value0xFA4
Property name Data Type
427
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_TBLSEL_COLBODY KBD_TBLSEL_COLBODY
Value0xFA5
FCodes.KBD_TBLIP_TOPLEFT KBD_TBLIP_TOPLEFT
Value0xFB0
FCodes.KBD_TBLIP_RIGHT KBD_TBLIP_RIGHT
Value0xFB1
FCodes.KBD_TBLIP_LEFT KBD_TBLIP_LEFT
Value0xFB2
FCodes.KBD_TBLIP_ABOVE KBD_TBLIP_ABOVE
Value0xFB3
FCodes.KBD_TBLIP_BELOW KBD_TBLIP_BELOW
Value0xFB4
FCodes.KBD_TBLIP_LEFTMOST KBD_TBLIP_LEFTMOST
Value0xFB5
FCodes.KBD_TBLIP_RIGHTMOST KBD_TBLIP_RIGHTMOST
Value0xFB6
FCodes.KBD_TBLIP_NEXT KBD_TBLIP_NEXT
Value0xFB7
FCodes.KBD_TBLIP_PREV KBD_TBLIP_PREV
Value0xFB8
FCodes.KBD_TBLIP_TOP KBD_TBLIP_TOP
Value0xFB9
FCodes.KBD_TBLIP_BOTTOM KBD_TBLIP_BOTTOM
Value0xFBA
FCodes.PGF_KBD_SIDEBODY PGF_KBD_SIDEBODY
Value0xFC9
FCodes.PGF_KBD_SIDEHEAD_FIRST_B
ASELINE
PGF_KBD_SIDEHEAD_FIRST_BASELINE
Value0xFCA
FCodes.PGF_KBD_SIDEHEAD_LAST_BA
SELINE
PGF_KBD_SIDEHEAD_LAST_BASELINE
Value0xFCB
FCodes.PGF_KBD_SIDEHEAD_TOP PGF_KBD_SIDEHEAD_TOP
Value0xFCC
FCodes.PGF_KBD_RUN_IN PGF_KBD_RUN_IN
Value0xFCD
Property name Data Type
428
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.PGF_KBD_FULLSTRADDLE PGF_KBD_FULLSTRADDLE
Value0xFCE
FCodes.PGF_KBD_BODYSTRADDLE PGF_KBD_BODYSTRADDLE
Value0xFCF
FCodes.KBD_TBL_DLG_SHRINKWRAP KBD_TBL_DLG_SHRINKWRAP
Value0xFD0
FCodes.ELEM_INS_CAT_AT_SEL ELEM_INS_CAT_AT_SEL
Value0xA10
FCodes.ELEM_WRAP_CAT_AT_SEL ELEM_WRAP_CAT_AT_SEL
Value0xA11
FCodes.ELEM_CHANGE_CAT_AT_SEL ELEM_CHANGE_CAT_AT_SEL
Value0xA12
FCodes.ELEM_INSERT_CUSTOM_1 ELEM_INSERT_CUSTOM_1
Value0xA21
FCodes.ELEM_INSERT_CUSTOM_2 ELEM_INSERT_CUSTOM_2
Value0xA22
FCodes.ELEM_INSERT_CUSTOM_3 ELEM_INSERT_CUSTOM_3
Value0xA23
FCodes.ELEM_INSERT_CUSTOM_4 ELEM_INSERT_CUSTOM_4
Value0xA24
FCodes.ELEM_INSERT_CUSTOM_5 ELEM_INSERT_CUSTOM_5
Value0xA25
FCodes.ELEM_INSERT_CUSTOM_6 ELEM_INSERT_CUSTOM_6
Value0xA26
FCodes.ELEM_INSERT_CUSTOM_7 ELEM_INSERT_CUSTOM_7
Value0xA27
FCodes.ELEM_INSERT_CUSTOM_8 ELEM_INSERT_CUSTOM_8
Value0xA28
FCodes.ELEM_INSERT_CUSTOM_9 ELEM_INSERT_CUSTOM_9
Value0xA29
FCodes.ELEM_INSERT_CUSTOM_10 ELEM_INSERT_CUSTOM_10
Value0xA2A
FCodes.KBD_STRIP_FLOWSTRUCTURE KBD_STRIP_FLOWSTRUCTURE
Value0xA30
Property name Data Type
429
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_SHOW_ELEM_CTX KBD_SHOW_ELEM_CTX
Value0xA31
FCodes.KBD_NORMALIZE_TAGS KBD_NORMALIZE_TAGS
Value0xA33
FCodes.KBD_STRWIN KBD_STRWIN
Value0xFD1
FCodes.KBD_ELEM_BORDER KBD_ELEM_BORDER
Value0xFD2
FCodes.KBD_ELEM_MERGE_1ST KBD_ELEM_MERGE_1ST
Value0xFD3
FCodes.KBD_ELEM_MERGE_LAST KBD_ELEM_MERGE_LAST
Value0xFD4
FCodes.KBD_ELEM_SPLIT KBD_ELEM_SPLIT
Value0xFD5
FCodes.KBD_ELEM_UNWRAP KBD_ELEM_UNWRAP
Value0xFD6
FCodes.KBD_ELEM_CAT_OPTS KBD_ELEM_CAT_OPTS
Value0xFD7
FCodes.KBD_SETELCATSTRICT KBD_SETELCATSTRICT
Value0xFD8
FCodes.KBD_SETELCATLOOSE KBD_SETELCATLOOSE
Value0xFD9
FCodes.KBD_SETELCATCHILD KBD_SETELCATCHILD
Value0xFDA
FCodes.KBD_SETELCATALL KBD_SETELCATALL
Value0xFDB
FCodes.KBD_SETELCATFREQ KBD_SETELCATFREQ
Value0xFF7
FCodes.ELEM_BAM ELEM_BAM
Value0xFDC
FCodes.KBD_ELEM_TAGS KBD_ELEM_TAGS
Value0xFDD
FCodes.KBD_BANNER_TEXT KBD_BANNER_TEXT
Value0x137
Property name Data Type
430
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_ELEM_PROMOTE KBD_ELEM_PROMOTE
Value0xFDE
FCodes.KBD_ELEM_DEMOTE KBD_ELEM_DEMOTE
Value0xFDF
FCodes.KBD_VALIDATION KBD_VALIDATION
Value0xFE0
FCodes.KBD_VAL_ELEM KBD_VAL_ELEM
Value0xFE1
FCodes.KBD_VAL_FLOW KBD_VAL_FLOW
Value0xFE2
FCodes.KBD_VAL_DOC KBD_VAL_DOC
Value0xFE3
FCodes.KBD_VAL_IGNORE KBD_VAL_IGNORE
Value0xFE4
FCodes.KBD_VAL_START KBD_VAL_START
Value0xFE5
FCodes.KBD_VAL_ALLOW KBD_VAL_ALLOW
Value0xFE6
FCodes.KBD_VAL_CLEAR KBD_VAL_CLEAR
Value0xFE7
FCodes.SW_CSR_UP SW_CSR_UP
Value0xFE8
FCodes.SW_CSR_DOWN SW_CSR_DOWN
Value0xFE9
FCodes.SW_CSR_RIGHT SW_CSR_RIGHT
Value0xFEA
FCodes.SW_CSR_LEFT SW_CSR_LEFT
Value0xFEB
FCodes.KBD_INLINE_ATTREDTR KBD_INLINE_ATTREDTR
Value0x29B
FCodes.KBD_ATTRIBUTE_EDIT KBD_ATTRIBUTE_EDIT
Value0xFEC
FCodes.KBD_ATTR_CONFIG_FILE_MAK
ER
KBD_ATTR_CONFIG_FILE_MAKER
Value0xFFA
Property name Data Type
431
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_ATTR_DISP_OPTS KBD_ATTR_DISP_OPTS
Value0xFEE
FCodes.KBD_FB_EDIT_PREFS KBD_FB_EDIT_PREFS
Value0xFEF
FCodes.KBD_REMOVE_STRUCT KBD_REMOVE_STRUCT
Value0xFF0
FCodes.KBD_TOGGLE_INCLUSION KBD_TOGGLE_INCLUSION
Value0xFF1
FCodes.KBD_TOGGLE_COLLAPSE KBD_TOGGLE_COLLAPSE
Value0xFF2
FCodes.KBD_TOGGLE_COLLAPSE_ALL KBD_TOGGLE_COLLAPSE_ALL
Value0xFF3
FCodes.KBD_TOGGLE_COLLAPSE_CHIL
DREN
KBD_TOGGLE_COLLAPSE_CHILDREN
Value0xA0D
FCodes.KBD_ELEM_TRANSPOSE_PREV KBD_ELEM_TRANSPOSE_PREV
Value0xFF4
FCodes.KBD_ELEM_TRANSPOSE_NEXT KBD_ELEM_TRANSPOSE_NEXT
Value0xFF5
FCodes.KBD_VAL_IGNORE_ATTR KBD_VAL_IGNORE_ATTR
Value0xFF6
FCodes.KBD_NAMESPACES KBD_NAMESPACES
Value0xFF8
FCodes.KBD_TOGGLE_STRUCT_AND_
DOCWIN
KBD_TOGGLE_STRUCT_AND_DOCWIN
Value0xFF9
FCodes.FM_SEPARATOR FM_SEPARATOR
Value0xF12
FCodes.FM_TERMINATE FM_TERMINATE
Value0xFFF
FCodes.FM_RPT_CMDS_BY_TAG FM_RPT_CMDS_BY_TAG
Value0xD00
FCodes.FM_RPT_CMDS_BY_SHORTCU
T
FM_RPT_CMDS_BY_SHORTCUT
Value0xD01
FCodes.KBD_PASTESPECIAL KBD_PASTESPECIAL
Value0xD10
Property name Data Type
432
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_CLOSE_TOP_PALETTE KBD_CLOSE_TOP_PALETTE
Value0xD20
FCodes.KBD_CLOSE_PARAGRAPH_CAT
ALOG
KBD_CLOSE_PARAGRAPH_CATALOG
Value0xD21
FCodes.KBD_CLOSE_CHARACTER_CAT
ALOG
KBD_CLOSE_CHARACTER_CATALOG
Value0xD22
FCodes.KBD_CLOSE_TOOLS_PALETTE KBD_CLOSE_TOOLS_PALETTE
Value0xD23
FCodes.KBD_CLOSE_EQUATIONS_PALE
TTE
KBD_CLOSE_EQUATIONS_PALETTE
Value0xD24
FCodes.KBD_CLOSE_ELEMENT_CATAL
OG
KBD_CLOSE_ELEMENT_CATALOG
Value0xD26
FCodes.KBD_CLOSE_PARAGRAPH_DES
IGNER
KBD_CLOSE_PARAGRAPH_DESIGNER
Value0xD28
FCodes.KBD_CLOSE_CHARACTER_DESI
GNER
KBD_CLOSE_CHARACTER_DESIGNER
Value0xD29
FCodes.KBD_CLOSE_TABLE_DESIGNER KBD_CLOSE_TABLE_DESIGNER
Value0xD2A
FCodes.KBD_WINDOWFULL_UP KBD_WINDOWFULL_UP
Value0xD40
FCodes.KBD_WINDOWFULL_DOWN KBD_WINDOWFULL_DOWN
Value0xD41
FCodes.KBD_VIEWER_MAKE_DOCUM
ENT
KBD_VIEWER_MAKE_DOCUMENT
Value0xD50
FCodes.KBD_VIEWER_MAKE_PALETTE KBD_VIEWER_MAKE_PALETTE
Value0xD51
FCodes.KBD_VIEWER_MAKE_MODELE
SSDIALOG
KBD_VIEWER_MAKE_MODELESSDIALOG
Value0xD52
FCodes.KBD_Item1stLogical KBD_Item1stLogical
Value0xD60
FCodes.KBD_ItemNextLogical KBD_ItemNextLogical
Value0xD61
FCodes.KBD_ItemPrevLogical KBD_ItemPrevLogical
Value0xD62
Property name Data Type
433
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_ItemNextPhysical KBD_ItemNextPhysical
Value0xD63
FCodes.KBD_ItemPrevPhysical KBD_ItemPrevPhysical
Value0xD64
FCodes.KBD_ItemLeft KBD_ItemLeft
Value0xD65
FCodes.KBD_ItemRight KBD_ItemRight
Value0xD66
FCodes.KBD_ItemUp KBD_ItemUp
Value0xD67
FCodes.KBD_ItemDown KBD_ItemDown
Value0xD68
FCodes.KBD_ItemSelect KBD_ItemSelect
Value0xD69
FCodes.KBD_ItemFirstFocus KBD_ItemFirstFocus
Value0xD6A
FCodes.INIT_DIALOG INIT_DIALOG
Value0xD80
FCodes.KBD_RENAMEORPLAIN KBD_RENAMEORPLAIN
Value0x900
FCodes.KBD_WIN_CASCADE KBD_WIN_CASCADE
Value0x903
FCodes.KBD_WIN_TILE KBD_WIN_TILE
Value0x904
FCodes.KBD_TAB_LEFT KBD_TAB_LEFT
Value0x906
FCodes.KBD_TAB_CENTER KBD_TAB_CENTER
Value0x907
FCodes.KBD_TAB_RIGHT KBD_TAB_RIGHT
Value0x908
FCodes.KBD_TAB_DECIMAL KBD_TAB_DECIMAL
Value0x909
FCodes.KBD_PRINTSETUP KBD_PRINTSETUP
Value0x90A
Property name Data Type
434
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_MINIMIZE KBD_MINIMIZE
Value0x90F
FCodes.KBD_MAXIMIZE KBD_MAXIMIZE
Value0x910
FCodes.KBD_RESTORE KBD_RESTORE
Value0x911
FCodes.KBD_EDITLINKS KBD_EDITLINKS
Value0x912
FCodes.KBD_INSERTOBJECT KBD_INSERTOBJECT
Value0x913
FCodes.KBD_CONTEXTMENU KBD_CONTEXTMENU
Value0x914
FCodes.KBD_EMBEDDED00 KBD_EMBEDDED00
Value0x920
FCodes.KBD_EMBEDDED01 KBD_EMBEDDED01
Value0x921
FCodes.KBD_EMBEDDED02 KBD_EMBEDDED02
Value0x922
FCodes.KBD_EMBEDDED03 KBD_EMBEDDED03
Value0x923
FCodes.KBD_EMBEDDED04 KBD_EMBEDDED04
Value0x924
FCodes.KBD_EMBEDDED05 KBD_EMBEDDED05
Value0x925
FCodes.KBD_EMBEDDED06 KBD_EMBEDDED06
Value0x926
FCodes.KBD_EMBEDDED07 KBD_EMBEDDED07
Value0x927
FCodes.KBD_EMBEDDED08 KBD_EMBEDDED08
Value0x928
FCodes.KBD_EMBEDDED09 KBD_EMBEDDED09
Value0x92A
FCodes.KBD_EMBEDDED10 KBD_EMBEDDED10
Value0x92B
Property name Data Type
435
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_EMBEDDED11 KBD_EMBEDDED11
Value0x92C
FCodes.KBD_EMBEDDED12 KBD_EMBEDDED12
Value0x92D
FCodes.KBD_EMBEDDED13 KBD_EMBEDDED13
Value0x92E
FCodes.KBD_EMBEDDED14 KBD_EMBEDDED14
Value0x92F
FCodes.KBD_EMBEDDED15 KBD_EMBEDDED15
Value0x930
FCodes.KBD_EMBEDDED16 KBD_EMBEDDED16
Value0x931
FCodes.KBD_EMBEDDED17 KBD_EMBEDDED17
Value0x932
FCodes.KBD_EMBEDDED18 KBD_EMBEDDED18
Value0x933
FCodes.KBD_EMBEDDED19 KBD_EMBEDDED19
Value0x934
FCodes.KBD_EMBEDDEDMAX KBD_EMBEDDEDMAX
Value0x94F
FCodes.KBD_GOTOLINEN KBD_GOTOLINEN
Value0x970
FCodes.KBD_SHOWNEXT KBD_SHOWNEXT
Value0x971
FCodes.KBD_SHOWPREV KBD_SHOWPREV
Value0x972
FCodes.KBD_SCREENMODE_TOGGLE KBD_SCREENMODE_TOGGLE
Value0x978
FCodes.KBD_SCREENMODE_STANDAR
D
KBD_SCREENMODE_STANDARD
Value0x979
FCodes.KBD_SCREENMODE_FULLSCRE
EN_UI
KBD_SCREENMODE_FULLSCREEN_UI
Value0x97A
FCodes.KBD_SCREENMODE_FULLSCRE
EN
KBD_SCREENMODE_FULLSCREEN
Value0x97B
Property name Data Type
436
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.KBD_UI_PREFERENCE KBD_UI_PREFERENCE
Value0x980
FCodes.KBD_UIALERTSTRINGS_PREF KBD_UIALERTSTRINGS_PREF
Value0x981
FCodes.KBD_TOOLBAR_SHOWALL KBD_TOOLBAR_SHOWALL
Value0x989
FCodes.KBD_TOOLBAR_HIDEALL KBD_TOOLBAR_HIDEALL
Value0x98A
FCodes.KBD_TOOLBAR_BASE KBD_TOOLBAR_BASE
Value0x98F
FCodes.KBD_BROWSE_URL KBD_BROWSE_URL
Value0x9A0
FCodes.KBD_MATH_BASE KBD_MATH_BASE
Value0x1000
FCodes.TEXTSEL_QUICK_COPY TEXTSEL_QUICK_COPY
Value0x0001
FCodes.TEXTSEL_EXTEND TEXTSEL_EXTEND
Value0x0002
FCodes.TEXTSEL_EXTEND_WORD TEXTSEL_EXTEND_WORD
Value0x0004
FCodes.TEXTSEL_EXTEND_LINE TEXTSEL_EXTEND_LINE
Value0x0008
FCodes.TEXTSEL_EXTEND_PGF TEXTSEL_EXTEND_PGF
Value0x0010
FCodes.TEXTSEL_WORD TEXTSEL_WORD
Value0x0020
FCodes.TEXTSEL_LINE TEXTSEL_LINE
Value0x0040
FCodes.TEXTSEL_PGF TEXTSEL_PGF
Value0x0080
FCodes.TEXTSEL_SELECT_ONLY TEXTSEL_SELECT_ONLY
Value0x0100
FCodes.TEXTSEL_EXTEND_SENT TEXTSEL_EXTEND_SENT
Value0x0200
Property name Data Type
437
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.TEXTSEL_SENT TEXTSEL_SENT
Value0x0400
FCodes.TEXTSEL_EXTEND_ELEMENT TEXTSEL_EXTEND_ELEMENT
Value0x0800
FCodes.TEXTSEL_ELEMENT TEXTSEL_ELEMENT
Value0x1000
FCodes.TEXTSEL_DRAGGING TEXTSEL_DRAGGING
Value0x2000
FCodes.EXTEND_SEL EXTEND_SEL
Value(0x0002|0x0004|0x0008|0x0010|0x0800)
FCodes.MIF_SAVE_TEXT MIF_SAVE_TEXT
Value0x000001
FCodes.MIF_SAVE_TAGS MIF_SAVE_TAGS
Value0x000002
FCodes.MIF_SAVE_FMTS MIF_SAVE_FMTS
Value0x000004
FCodes.MIF_SAVE_FONTS MIF_SAVE_FONTS
Value0x000008
FCodes.MIF_SAVE_MKRS MIF_SAVE_MKRS
Value0x000010
FCodes.MIF_SAVE_AFMS MIF_SAVE_AFMS
Value0x000020
FCodes.MIF_SAVE_LAYT MIF_SAVE_LAYT
Value0x000040
FCodes.MIF_SAVE_MPAGE MIF_SAVE_MPAGE
Value0x000080
FCodes.MIF_SAVE_FCAT MIF_SAVE_FCAT
Value0x000100
FCodes.MIF_SAVE_PCAT MIF_SAVE_PCAT
Value0x000200
FCodes.MIF_SAVE_CCAT MIF_SAVE_CCAT
Value0x000400
FCodes.MIF_SAVE_TMPLT MIF_SAVE_TMPLT
Value0x000800
Property name Data Type
438
FCODES
CHAPTER 5 OBJECT REFERENCE
FCodes.MIF_SAVE_DICT MIF_SAVE_DICT
Value0x001000
FCodes.MIF_SAVE_VARS MIF_SAVE_VARS
Value0x002000
FCodes.MIF_SAVE_TABLECATS MIF_SAVE_TABLECATS
Value0x004000
FCodes.MIF_SAVE_TABLES MIF_SAVE_TABLES
Value0x008000
FCodes.MIF_SAVE_ECAT MIF_SAVE_ECAT
Value0x010000
FCodes.MIF_SAVE_ELEMENTS MIF_SAVE_ELEMENTS
Value0x020000
FCodes.MIF_SAVE_COLORCAT MIF_SAVE_COLORCAT
Value0x040000
FCodes.MIF_SAVE_VIEWSET MIF_SAVE_VIEWSET
Value0x080000
FCodes.MIF_SAVE_DATALINKS MIF_SAVE_DATALINKS
Value0x100000
FCodes.MIF_SAVE_FPLCAT MIF_SAVE_FPLCAT
Value0x200000
FCodes.MIF_SAVE_TEXTINSETS MIF_SAVE_TEXTINSETS
Value0x400000
FCodes.MIF_SAVE_RUBIS MIF_SAVE_RUBIS
Value0x800000
FCodes.MIF_SAVE_BANNERTEXT MIF_SAVE_BANNERTEXT
Value0x1000000
FCodes.KBD_OPEN_REPOSITORY KBD_OPEN_REPOSITORY
Value0x801
FCodes.KBD_CMS_CONNECTION_MG
R
KBD_CMS_CONNECTION_MGR
Value0x802
FCodes.KBD_NEW_XML KBD_NEW_XML
Value0x803
FCodes.KBD_CMS_UPLOAD_DOC_OR_
BOOK
KBD_CMS_UPLOAD_DOC_OR_BOOK
Value0x805
Property name Data Type
439
FILTERARGS
CHAPTER 5 OBJECT REFERENCE
5.42. FilterArgs
FilterArgs methods
FilterArgs.
5.43. Flow
FCodes.KBD_REFRESH_DITAMAP_RM
VIEW
KBD_REFRESH_DITAMAP_RMVIEW
Value0x807
FCodes.STYLE_APPLY_CAT_TO_SEL STYLE_APPLY_CAT_TO_SEL
Value0x808
FCodes.KBD_SHOW_ELEM_CTX_AV KBD_SHOW_ELEM_CTX_AV
Value0x809
FCodes.FOCUS_INPUT_ELEM_CTX_AV FOCUS_INPUT_ELEM_CTX_AV
Value0x810
FCodes.KBD_CLOSE_ELEM_CTX_AV KBD_CLOSE_ELEM_CTX_AV
Value0x811
Property name Data Type Description
infile string The file to filter.
outfile string The filter output file.
clname string The registered name of the filter
informat string The registered incoming format.
outformat string The registered output format
binname string The name of the filter client file.
args Strings Currently NULL.
Property name Data Type Description
FlowIsAutoConnect int 1 if Autoconnect is enabled; 0
otherwise.
Property name Data Type
440
FLOW
CHAPTER 5 OBJECT REFERENCE
FlowIsFeathered int 1 if Feather is enabled; 0 otherwise
FlowIsPostScript int 1 if flow is PostScript code; 0
otherwise
FlowIsSynchronized int 1 if Baseline
Synchronization is enabled; 0
otherwise.
FirstTextFrameInFlow TextFrame First text frame in flow
(FO_TextFrame ID).
LastTextFrameInFlow TextFrame Last text frame in flow
(FO_TextFrame ID).
MaxInterlinePadding int Maximum interline spacing.
MaxInterPgfPadding int Maximum interparagraph spacing.
MinHang int Maximum character height for
synchronization of first line in
column. If characters exceed this
height, FrameMaker does not
synchronize the first line.
Name string Name of flow tag.
NextFlowInDoc Flow Next flow in document (FO_Flow ID).
SideHeadRoomInFlow int 1 if Leave Room for
Sideheads in Flow is enabled; 0
otherwise.
Spacing int Line spacing for synchronized
baselines.
HighestLevelElement Element Highest-level element in flow
(FO_Element ID)
Direction int Set or get the direction of the
document. Possible values:
•Constants.FV_DIR_Inherit
- Inherit the direction of the
parent
•Constants.FV_DIR_LTR -
Left-to-right
•FV_DIR_RTL - Right-to-left
Property name Data Type Description
441
FMTCHANGELIST
CHAPTER 5 OBJECT REFERENCE
Flow methods
Delete, GetProps, GetText, ObjectValid, SetProps.
5.44. FmtChangeList
ResolvedDirection int Get the inherited direction of the
document. Possible values:
•Constants.FV_DIR_LTR -
Left-to-right
•FV_DIR_RTL - Right-to-left
UserString string A string to which clients can store
private data.
Property name Data Type Description
FmtChangeListInCatalog int 1 if the format change list is in the
Format Change List Catalog. 0 if it is in
an element definition, as part of the
text format rules.
Name string The name of the format change list if
it is in the Format Change List
Catalog.
NextFmtChangeListInDoc FmtChangeL
ist
The next format change list in the
document (FO_FmtChangeList ID).
PgfCatalogReference string A paragraph format tag if the format
change list specifies one. If this
property is set, you cannot change
any of the other format change list
properties, except Name.
AdjHyphens int Number of allowable adjacent
hyphens
BottomSeparator string Name of frame to put below
paragraph.
Property name Data Type Description
442
FMTCHANGELIST
CHAPTER 5 OBJECT REFERENCE
BottomSepAtIndent int 1 if the position of the frame
specified by BottomSeparator is
at the current left indent;0
otherwise.
Hyphenate int 1 if Automatic Hyphenation is
enabled;0, otherwise.
HyphMinPrefix int Minimum number of letters that
must precede the hyphen.
HyphMinSuffix int Minimum number of letters that
must follow a hyphen.
HyphMinWord int Minimum length of a hyphenated
word.
LetterSpace int 1 if Word Spacing is enabled.
MaxSpace int Maximum word spacing (percentage
of an em space in current font).
MinSpace int Minimum word spacing (percentage
of an em space in current font).
OptSpace int Optimum word spacing.
TopSeparator string Name of frame to put above
paragraph.
TopSepAtIndent int 1 if the position of the frame
specified by TopSeparator is at the
current left indent; 0 otherwise.
MinJRomSpace int Minimum Asian-Roman space.
OptJRomSpace int Optimum Asian-Roman space.
MaxJRomSpace int Maximum Asian-Roman space.
MinJLetSpace int Minimum Asian letter space.
OptJLetSpace int Optimum Asian letter space.
MaxJLetSpace int Maximum Asian letter space.
Property name Data Type Description
443
FMTCHANGELIST
CHAPTER 5 OBJECT REFERENCE
YakumonoType int Denotes the The Yakumono rules to
handle punctuation characters. The
value can be one of:
• Constants.FV_FLOATING_YAKU-
MONO (0x00)
• Constants.FV_MONOSPACE_YAKU-
MONO (0x01)
• Constants.FV_FIXED_YAKU-
MONO (0x02)
AutoNumChar string Character format for the automatic
numbering string specified by
AutoNumString; “ “if the default
character format is used.
AutoNumString string Autonumber format string (for
example, <n>.<n+>)
NumAtEnd int 1 if the numbering position is at the
End of the Paragraph; 0 if it is at the
Beginning of the Paragraph.
PgfIsAutoNum int 1 if autonumbering is enabled; 0
otherwise.
FirstIndent int The paragraph’s first-line left margin,
measured from the left side of the
current text column (0 cm to 100 cm
).
FirstIndentChange int Amount by which to increase or
decrease the first-line left margin.
FirstIndentIsRelative int 1 if the first indent is relative to the
left indent.
FirstIndentRelPos int Position relative to left indent if
FirstIndentIsRelative is
True.
Leading int Denotes the space below each line in
the paragraph.
LeadingChange int Amount by which to increase or
decrease the leading.
Property name Data Type Description
444
FMTCHANGELIST
CHAPTER 5 OBJECT REFERENCE
LeftIndent int The paragraph’s left margin,
measured from the left side of the
current text column (0 cm to 100 cm).
LeftIndentChange int Amount by which to increase or
decrease the left margin.
LineSpacingFixed int 1 if the line spacing is fixed.
MoveTabs int Amount by which to move all tab
positions in the paragraph.
NumTabs int The number of tabs in the paragraph.
To clear all the tabs in the paragraph,
set NumTabs to 0.
PgfAlignment int Horizontal alignment of the
paragraph. The value is one of:
• Constants.FV_PGF_LEFT (0x01)
• Constants.FV_PGF_RIGHT
(0x02)
• Constants.FV_PGF_CENTER
(0x03)
• Constants.FV_PGF_JUSTIFIED
(0x04)
RightIndent int The paragraph’s right margin,
measured from the right side of the
current text column.
RightIndentChange int Amount by which to increase or
decrease the right margin.
SpaceAbove int Indicates the space above the
paragraph.
SpaceAboveChange int Amount by which to increase or
decrease the space above.
SpaceBelow int Indicates the space below the
paragraph.
SpaceBelowChange int Amount by which to increase or
decrease the space below.
Tabs Tabs An array of tab descriptions that
specify the positions and types of tab
stops in the paragraph.
Property name Data Type Description
445
FMTCHANGELIST
CHAPTER 5 OBJECT REFERENCE
Capitalization int Type of capitalization to use. The
value is one of:
• Constants.FV_CAPITAL_-
CASE_NORM ()
• Constants.FV_CAPITAL_-
CASE_SMALL ()
• Constants.FV_CAPITAL_-
CASE_LOWER ()
• Constants.FV_CAPITAL_-
CASE_UPPER ()
ChangeBar int 1 if Change Bars are on;0 otherwise.
Color Color The spot color (FO_Color ID).
CombinedFontFamily CombinedFo
ntDefn
The combined font definition
(FO_CombinedFontDefn)
FontAngle int Denotes the font angle (specifies an
index into the array of font angles
provided by the session property
FontAngleNames).
FontFamily int Denotes the font family (specifies an
index into the array of font families
provided by the session property
FontFamilyNames).
Property name Data Type Description
446
FMTCHANGELIST
CHAPTER 5 OBJECT REFERENCE
Language int The hyphenation and spell-checking
language to use. The value is one of:
• Constants.FV_LANG_BRA-
ZILIAN (0x0B)
• Constants.FV_LANG_BRITISH
(0x02)
• Constants.FV_LANG_CANADIAN_-
FRENCH (0x06)
• Constants.FV_LANG_CATALAN
(0x08)
• Constants.FV_LANG_DANISH
(0x0C)
• Constants.FV_LANG_DUTCH
(0x0D)
• Constants.FV_LANG_ENGLISH
(0x01)
• Constants.FV_LANG_FINNISH
(0x10)
• Constants.FV_LANG_FRENCH
(0x05)
• Constants.FV_LANG_GERMAN
(0x03)
• Constants.FV_LANG_ITALIAN
(0x09)
• Constants.FV_LANG_NOLAN-
GUAGE (0x00)
• Constants.FV_LANG_NORWE-
GIAN (0x0E)
• Constants.FV_LANG_NYNORSK
(0x0F)
• Constants.FV_LANG_PORTU-
GUESE (0x0A)
• Constants.FV_LANG_SPANISH
(0x07)
• Constants.FV_LANG_SWEDISH
(0x11)
• Constants.FV_LANG_SWISS_-
GERMAN (0x04)
• Constants.FV_LANG_JAPANESE
(0x12)
• Constants.FV_LANG_TRADITION-
AL_CHINESE (0x13)
• Constants.FV_LANG_SIMPLI-
FIED_CHINESE (0x14)
•
Constants FV LANG KOREAN
Property name Data Type Description
447
FMTCHANGELIST
CHAPTER 5 OBJECT REFERENCE
FontSize int The font size (2 pt to 400 pt).
FontSizeChange int Amount by which to increase or
decrease the font size.
FontVariation int Font variation (specifies an index into
the array of font variations provided
by the session property
FontVariationNames).
FontWeight int Font weight (specifies an index into
the array of font weights provided by
the session property
FontWeightNames).
KernX int Horizontal kern value for manual
kerning expressed as a percentage of
an em (metric – 100% to 1000%).b A
positive value moves a character right
and a negative value moves a
character left.
KernY int Vertical kern value for manual
kerning expressed as a percentage of
an em (metric – 100% to 1000%). A
positive value moves characters up
and a negative value moves
characters down.
Overline int 1 if Overline is enabled. 0,
otherwise.
PairKern int 1 if Pair Kern is enabled. 0,
otherwise.
Position int Specifies position relative to baseline
of text. The value is one of:
• Constants.FV_POS_NORM (0):
Normal
• Constants.FV_POS_SUPER (1):
Superscript
• Constants.FV_POS_SUB (2):
Subscript
Property name Data Type Description
448
FMTCHANGELIST
CHAPTER 5 OBJECT REFERENCE
Stretch int Character stretch (set width)
expressed as a percentage of normal
stretch for the font (metric –10% to
1000%).
StretchChange int Amount expressed as a percentage
(metric – 10% to 1000%) by which to
increase or decrease the character
stretch.
Strikethrough int 1 if Strikethrough is enabled. 0,
otherwise.
Underlining int Type of underlining. The value is one
of:
• Constants.FV_CB_NO_UNDER-
LINE (0)
•Constants.FV_CB_SINGLE_UNDER-
LINE (1)
• Constants.FV_CB_DOUBLE_UNDER-
LINE (2)
• Constants.FV_CB_NUMER-
IC_UNDERLINE (3)
BlockLines int The number of Widow/Orphan lines.
KeepWithNext int 1 if Keep With Next
Paragraph is enabled. 0 otherwise.
KeepWithPrev int 1 if Keep With Previous
Paragraph is enabled. 0 otherwise.
Property name Data Type Description
449
FMTCHANGELIST
CHAPTER 5 OBJECT REFERENCE
Placement int Denotes the Paragraph placement.
The value is one of:
• Constants.FV_PGF_SIDEBODY
(0)
• Constants.FV_PGF_SIDE-
HEAD_TOP (1)
• Constants.FV_PGF_SIDEHEAD_-
FIRST_BASELINE (2)
• Constants.FV_PGF_SIDE-
HEAD_LAST_BASELINE (3)
• Constants.FV_PGF_RUN_IN (4)
• Constants.FV_PGF_STRADDLE
(5)
• Constants.FV_PGF_STRAD-
DLE_NORMAL_ONLY (6)
RunInSeparator string Denotes the string for Run-In Head
Default Punctuation.
Start int Denotes the Vertical placement of a
paragraph. The value is one of:
• Constants.FV_PGF_ANYWHERE
()
• Constants.FV_PG-
F_TOP_OF_COL ()
• Constants.FV_PG-
F_TOP_OF_PAGE ()
• Constants.FV_PG-
F_TOP_OF_LEFT_PAGE ()
• Constants.FV_PG-
F_TOP_OF_RIGHT_PAGE ()
CellBottomMargin int Amount added to default bottom
margin of table cell.
CellBottomMarginChange int Amount by which to increase or
decrease the cell bottom margin.
CellBottomMarginFixed int 1 if the cell bottom margin is fixed. 0
otherwise.
CellLeftMargin int Amount added to default left margin
of table cell.
Property name Data Type Description
450
FMTCHANGELIST
CHAPTER 5 OBJECT REFERENCE
CellLeftMarginChange int Amount by which to increase or
decrease the cell left margin.
CellLeftMarginFixed int 1 if the cell left margin is fixed. 0
otherwise.
CellRightMargin int Amount added to default right
margin of table cell.
CellRightMarginFixed int 1 if the cell right margin is fixed. 0,
otherwise.
CellTopMargin int Amount added to default top margin
of table cell.
CellTopMarginChange int Amount by which to increase or
decrease the cell top margin.
CellTopMarginFixed int 1 if the cell top margin is fixed. 0,
otherwise.
CellVAlignment int Denotes the vertical alignment of a
paragraph when it is the first one in a
cell. The value is one of:
• Constants.FV_PG-
F_V_ALIGN_TOP (0)
• Constants.FV_PG-
F_V_ALIGN_MIDDLE (1)
• Constants.FV_PG-
F_V_ALIGN_BOTTOM (2)
BkColor Color Denotes the text background color. If
this property is applied on a
paragraph format, it denotes the
background color of the whole
paragraph; if it is applied on a
character format, it denotes the
background color of the text over
which the character format is
applied.
PgfBoxColor Color Denotes the background color of the
paragraph box that encloses the
paragraph text.
Property name Data Type Description
451
FMTRULE
CHAPTER 5 OBJECT REFERENCE
FmtChangeList methods
Delete, GetProps, ObjectValid, SetProps.
5.45. FmtRule
Direction int Set or get the direction of the
document. Possible values:
•Constants.FV_DIR_Inherit
- Inherit the direction of the
parent
•Constants.FV_DIR_LTR -
Left-to-right
•FV_DIR_RTL - Right-to-left
ResolvedDirection int Get the inherited direction of the
document. Possible values:
•Constants.FV_DIR_LTR -
Left-to-right
•FV_DIR_RTL - Right-to-left
Property name Data Type Description
CountElements Strings The list of element tags to count
among the element’s ancestors, if the
format rule is a level rule. The tags
are specified by the Count
ancestors named element of the
format rule.
ElementDef ElementDef Denotes the ID of the element
definition that contains the format
rule (FO_ElementDef ID), if the
format rule is not nested.
FmtRuleClause FmtRuleCla
use
Denotes the ID of the rule clause that
contains the format rule
(FO_ElementDef ID), if the format
rule is nested.
Property name Data Type Description
452
FMTRULECLAUSE
CHAPTER 5 OBJECT REFERENCE
FmtRule methods
Delete, GetProps, NewFmtRuleClauses, ObjectValid, SetProps.
5.46. FmtRuleClause
FmtRuleClauses Objects IDs of the format rule’s format rule
clause objects (FO_FmtRuleClause
IDs).
FmtRuleType int The format rule’s type. The value is
one of:
• Constants.FV_CONTEXT_RULE
(0)
• Constants.FV_LEVEL_RULE (1)
StopCountingAt string Denotes the the tag of the element at
which to stop counting elements, if
the the format rule is a level rule.
The tag is specified by the Stop
counting at first
ancestor named element.
Property name Data Type Description
ContextLabel string The context label for generated files.
The label cannot contain white-space
characters or any of these special
characters:( ) & | , * + ? <
> % [ ] = ! ;: { } "
When a user displays the Set Up
dialog box to set up a generated file,
the label appears next to elements to
which the rule clause applies.
ElemPrefixSuffix string The text of the prefix or suffix.
ElemPrefixSuffix specifies NULL if
there is no prefix or suffix.
Property name Data Type Description
453
FMTRULECLAUSE
CHAPTER 5 OBJECT REFERENCE
FmtChangeList FmtChangeL
ist
If the format rule clause specifies a
format change list
(RuleClauseType specifies
Constants.FV_RC_CHANGELIS
T ()), FmtChangeList specifies
the ID of the format change list
(FO_FmtChangeList ID).To change the
FmtChangeList property, use the
NewFmtRuleObject() property.
FmtChangeListTag string Denotes the change list’s tag, if If the
format rule clause specifies a change
list (RuleClauseType specifies
Constants.FV_RC_CHANGELIS
T_TAG (3)).
FmtRule FmtRule The ID of the format rule containing
the format rule clause (FO_FmtRule
ID).
FormatTag string The format tag if the format rule
clause specifies one
(RuleClauseTypespecifies
Constants.FV_RC_TAG (0)). If
IsTextRange is True,
FormatTag specifies a character
format tag; otherwise it specifies a
paragraph tag, table tag, marker
type, cross-reference format, or
equation size.
IsTextRange int 1 if the container element is
formatted as a text range instead of a
paragraph;0. otherwise.
RuleClauseType int The type of rule clause. The value is
one of:
• Constants.FV_RC_TAG (0)
• Constants.FV_RC_SUB_FM-
TRUL (1)
• Constants.FV_RC_CHANGELIST
(2)
• Constants.FV_RC_CHANGE-
LIST_TAG (3)
Property name Data Type Description
454
FN
CHAPTER 5 OBJECT REFERENCE
FmtRuleClause methods
Delete, GetProps, NewFmtChangeList, NewSubFmtRule, ObjectValid, SetProps.
5.47. Fn
Specification string The format clause’s context or level
specification.
SpecificationForCSS Strings A list of CSS specifications that match
the Specification for the
current clause.For example, assume
an element has a specification of F <
(G | H).This property returns the
following strings:
G > F > Eand
H > F > E.
SubFmtRule FmtRule Denotes the the format rule’s ID
(FO_FmtRule ID), if the format rule
clause contains a nested format rule
(if RuleClauseTypespecifies
Constants.FV_RC_SUB_FMTRU
LE (1)),
Property name Data Type Description
ContentHeight int The distance between the top of the
footnote and the baseline of the last
line in the footnote.
Element Element Specifies the the ID of the element
containing the footnote, if the
footnote is in a FrameMaker
document.
FirstPgf Pgf First paragraph in the footnote
(FO_Pgf ID).
FnNum int Footnote number.
InTextFrame TextFrame Text frame containing the footnote
(FO_TextFrame ID).
Property name Data Type Description
455
FONT
CHAPTER 5 OBJECT REFERENCE
Fn methods
Delete, GetProps, GetText, ObjectValid, SetProps.
5.48. Font
InTextObj SubCol Sub column that contains the
footnote (FO_SubCol).
LastPgf Pgf Last paragraph in the footnote
(FO_Pgf ID).
NextFnInDoc Fn Next footnote (FO_Fn ID) in the
document.
NextFn Fn Next footnote in the text frame
(FO_Fn ID).
Overflowed int 1 if the text in the footnote
overflows; 0, otherwise.
PrevFn Fn Previous footnote in the text frame
(FO_Fn ID).
TextLoc TextLoc Text location of the footnote symbol.
Unique int Footnote’s unique ID.
FnAnchorString string This is the display string for a
footnote anchor (generally a number
string). This is a read-only property of
a footnote and cannot be set by the
user.
UserString string A string to which clients can store
private data.
Property name Data Type Description
family uint Index of the font family.
variation uint Index of the font variation.
weight uint Index of the font weight.
angle uint Index of the font angle.
Property name Data Type Description
456
FONTS
CHAPTER 5 OBJECT REFERENCE
Font methods
Font.
5.49. Fonts
An Array of Font objects with integer indexing and a length property.
Fonts methods
concat, pop, push.
5.50. Group
Property name Data Type Description
length number The length of the array
Property name Data Type Description
FirstGraphicInGroup FMObject First object in the group.
LastGraphicInGroup FMObject Last object in the group.
Angle int Angle of the object’s rotation.
ArrowBaseAngle int Arrowhead base angle in degrees.
ArrowLength int Denotes the arrowhead length
(always rounded down to the nearest
1/256 point).
ArrowScaleFactor int Specifies the factor by which
arrowhead is scaled as line width
changes (always rounded down to
nearest 1/16 point). It is not used if
the ArrowScaleHead property is set
to False.
ArrowScaleHead int Set to 1 if arrowhead is scaled as the
line width changes. Set to 0,
otherwise.
ArrowTipAngle int Arrowhead tip angle in degrees.
457
GROUP
CHAPTER 5 OBJECT REFERENCE
ArrowType int Arrowhead style. The value is one of:
• Constants.FV_ARROW_STICK
(0x1)
• Constants.FV_AR-
ROW_HOLLOW (0x2)
• Constants.FV_ARROW_FILLED
(0x3)
BorderWidth int Denotes the border width (0.015
points to 360 points).
Color Color The spot color (FO_Color ID).
Dash Metrics Specifies a dash pattern that is
repeated for the length of an object’s
border. The pattern is stored in a
MetricsT structure. The 0th
element of the
MetricsT.MetricsT_val array
stores the length of the first dash; the
1st element stores the following
space; the 2nd element stores the
next dash; and so on for an even
number of elements.
Fill int The fill pattern (numbers between 0
and 15). The ESTK provides constants
for the following fill patterns:
• Constants.FV_FILL_BLACK (0)
• Constants.FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR(15)
FrameParent FMObject Frame containing the graphic object
(FO_AFrame or
FO_UnanchoredFrame ID).
GraphicCantBeSelected int 1 if the graphic object cannot be
selected; 0, otherwise.
GraphicIsSelected int 1 if the graphic object is selected; 0,
otherwise.
Property name Data Type Description
458
GROUP
CHAPTER 5 OBJECT REFERENCE
GroupParent Group Group that the object is in (FO_Group
ID).
NOTE: Anchored and unanchored
frames do not have this property.
HeadArrow int 1 if the line has an arrowhead; 0,
otherwise.
Height int Height of the object (0.125 points to
3600 points).
HotspotCmdStr StringT The command string for a hotspot.
Thismust be a valid hypertext
command string.
HotspotTitle StringT The tooltip text for the hotspot in the
outputs that support it (for example
HTML). This property is 0ptional.
IsHotspot Bool Whether the object is a hotspot or
not. If this property is turned off, the
object is no longer a hotspot even if
command string is non-empty.
LineCap int Type of line end. The value is one of:
• Constants.FV_CAP_BUTT (0x00)
• Constants.FV_CAP_ROUND
(0x01)
• Constants.FV_CAP_SQUARE
(0x02)
LocX int Distance from the left side of the
parent frame (–216 inches to 216
inches).If the graphic object is an
anchored frame, the distance is
calculated from the left side of the
page frame. You cannot set LocX for
anchored frames.
LocY int Distance from the top of the parent
frame (–216 inches to 216 inches).If
the graphic object is an anchored
frame, the distance is calculated from
the top of the page frame. You cannot
set LocY for anchored frames.
NextGraphicInDoc FMObject Next graphic object in the document.
Property name Data Type Description
459
GROUP
CHAPTER 5 OBJECT REFERENCE
NextGraphicInFrame FMObject Next graphic object in the frame.
NextGraphicInGroup FMObject Next graphic object in the group.
NextSelectedGraphicInDoc FMObject Next selected graphic object in
document.
ObjectAttributes Strings A list of strings, each string expressing
an attribute that is specified for an
anchored frame in the Object
Properties > Object
Attributes dialog box.Each string
is in the form of
<tag>string_text</tag>. You
can use the backslash to escape
characters such as \n, \r, or \t for
newline, carraige return, and tab,
respectively.
For a backslash character in the string
text, type \\.
Overprint int Specifies the overprint settings for
the object. The value is one of:
• Constants.FV_KNOCKOUT
(0x00)
• Constants.FV_OVERPRINT
(0x01)
• Constants.FV_FROMCOLOR
(0x02)
Pen int The pen pattern (numbers between 0
and 7). The ESTK provides constants
for the following values:
• Constants.FV_FILL_BLACK (0)
• Constants.FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
PrevGraphicInFrame FMObject Previous graphic object in the frame.
PrevGraphicInGroup FMObject Previous graphic object in the group
Property name Data Type Description
460
HIDDENPAGE
CHAPTER 5 OBJECT REFERENCE
Group methods
Delete, GetProps, ObjectValid, SetProps.
5.51. HiddenPage
HiddenPage methods
ApplyPageLayout, GetProps, ObjectValid, SetProps.
Runaround int Specifies whether text can flow
around the object and, if so, whether
the text follows the contour of the
object or a box shape surrounding
the object. The value is one of:
• Constants.FV_TR_NONE (0x01)
• Constants.FV_TR_CONTOUR
(0x02)
• Constants.FV_TR_BBOX (0x03)
RunaroundGap int Denotes the the width of the
runaround gapfor a runaround
object.
TailArrow int 1 if arrowhead is present at the
beginning of the line. 0, otherwise.
TintPercent int The tint percentage.
Unique int Unique ID of the object.
Width int Width of the object (0.125 points to
3600 points).
Property name Data Type Description
Name string Name of the hidden page.
PageFrame Unanchored
Frame
Denotes the page frame
(FO_UnanchoredFrame ID)
PageHeight int Height of the hidden page.
PageWidth int Width of the hidden page.
Property name Data Type Description
461
GRAPHICSFMT
CHAPTER 5 OBJECT REFERENCE
5.52. GraphicsFmt
Property name Data Type Description
UseColumnsAreBalanced int 1 if terminal and underfilled columns
in the flow are balanced.
UseSideHeadPlacement int Placement of side heads relative to
columns in the text frame:
FV_SH_LEFT
FV_SH_RIGHT
FV_SH_INSIDE
FV_SH_OUTSIDE
UseRadius MetricT Radius of corner; 0 for a square
corner
UseFlowIsAutoConnect Int 1 if Autoconnect is enabled.
UseFlowIsPostScript int 1 if flow is PostScript code.
UseBorderWidth MetricT Border width (0.015 pt to 360 pt).
UseFill int The fill pattern (numbers between 0
and 15). The FDK provides constants
for several fill patterns:
FV_FILL_BLACK
FV_FILL_WHITE
FV_FILL_CLEAR
UsePen int The pen pattern (numbers between 0
and 15). The FDK provides constants
for several pen patterns:
FV_FILL_BLACK
FV_FILL_WHITE
FV_FILL_CLEAR
UseRunaroundGap MetricT If the object is a runaround object,
the width of the runaround gap.
UseTintPercent MetricT The tint percentage
UseOverprint int Specifies the overprint settings for
the object:
FV_OVERPRINT
FV_KNOCKOUT
FV_FROMCOLOR
UseAngle MetricT Angle of the object’s rotation.
462
INLINECOMPONENT
CHAPTER 5 OBJECT REFERENCE
5.53. InlineComponent
A component that can be placed inline within a Frammaker document. Currently FrameMaker supports
the mini-TOC inline component.
InlineComponent methods
Delete, GetProps, ObjectValid, SetProps.
UseLocX MetricT Distance from the left side of the
parent frame.
UseLocY MetricT Distance from the top side of the
parent frame
UseWidth MetricT Width of object
UseHeight MetricT Height of object.
UseRunaround MetricT If the object is a runaround object,
the width of the runaround gap.
Property name Data Type Description
InlineComponentType int Denotes the type of inline
component. (FV_MiniTOC).
ExtractTags Strings Paragraph tags to include for the
inline component
InsertLinks int Flag that specifies if hyperlinks need
to be created in the inline
component.
TextRange TextRange The text range that the inline
component encompasses.
Unique int The inline component's unique ID
NextInlineComponentInDoc InlineComp
onent
The next instance of an inline
component in the document.
Currently only the mini-TOC inline
component can exist in a document.
Property name Data Type Description
463
INSET METHODS
CHAPTER 5 OBJECT REFERENCE
5.54. Inset methods
Delete, DeletePropByName, GetIntByName, GetMetricByName, GetProps, GetUBytesByName, Object-
Valid, SetIntByName, SetMetricByName, SetProps, SetUBytesByName.
5.55. IdValuePair
IdValuePair methods
5.56. IdValuePairs
An Array ofobjects with integer indexing and a length property.
5.57. Inset
Property name Data Type Description
ID int Specifies the unique identifier for the
value pair.
value string or
int
Specifies the value for the value pair.
Property name Data Type Description
length number The length of the array
Property name Data Type Description
InsetDpi int Specifies the scaling information for
bitmap file (corresponds to the value
specified in the Image File
Scaling Options dialog box
when the graphics file is imported).
464
INSET
CHAPTER 5 OBJECT REFERENCE
ImportHint string Record identifying the filter used to
import the graphic. FrameMaker uses
this record to find the filter to use
when updating the inset.
NOTE: The ImportHint property
does not apply to graphics imported
by copy. FrameMaker uses the facet
name stored with the graphic to
identify the filter that filtered a
graphic imported by copy.
InsetEditor string Name of the application to call to edit
inset or imported object.
InsetGfxActiveInPdf BoolString If this property is set, on publishing a
document to PDF, the inset object
that has facets FLV, U3D, or SWF will
be activated as soon as the page
containing the graphic object is
visible. In PDF the graphic objects are
called annotation.
InsetGfxName String Assigns a name to a graphic object. It
will work only in case of inset objects
that have an FLV, U3D or SWF facet.
The name of the graphic should not
contain any special characters or
spaces.
InsetGfxPlayWindowInPdf Bool If this property is set, on publishing a
document to PDF, the inset object
that has facets FLV, U3D, or SWF will
be activated in a new window in a
PDF file. In PDF, the graphic objects
are called annotation.
InsetFile string Platform-specific pathname if the
inset is an external inset, or a null
string (" ") if it is internal.The
pathname can be document-relative.
InsetIsFixedSize int 1 if scaling of bitmap file is inhibited.
0, otherwise.
InsetIsFlippedSideways int 1 if inset is flipped about the vertical
axis. 0, otherwise.
Property name Data Type Description
465
INSET
CHAPTER 5 OBJECT REFERENCE
InsetJavaScriptAttached Bool Denotes whether or not Javascript is
attached with the graphic object that
has a U3D facet.
InsetJavaScriptFile String Attaches the given Javascript file to
the graphic object that has a U3D
facet. If the value of the file path is
null, the Javascript attached to the
inset is removed.
InsetMonikerFilePath String Provides the file path of the moniker
of an inset object that has an OLE2
facet.
InsetSaveFacetToFile Strings Saves the given facet of an inset to a
given file. This is set-only property
and no get operations are
possible.The input to the method
contain the property name and list of
strings. In the list of strings the, first
strings is the facet name and the
second string is the filename where
the facet is to be saved.
InsetU3dAnimationList Strings Provides the list of "animations"
defined in the U3D facet of an inset
object.
InsetU3dPartList Strings Provides the list of "parts" defined in
the U3D facet of an inset object.
InsetU3dViewList Strings Retrieves the list of "views" defined in
the U3D facet of an inset object.
InsetUpdater string Not currently implemented.
PageNum int The page number of the PDF file to
display in the inset, when importing a
PDF file.
NOTE: PDF page numbering begins
with 0.
Property name Data Type Description
466
INSET
CHAPTER 5 OBJECT REFERENCE
InsetPosterFile string Sets thespecified file as a poster on
the Inset. This property is not
supported for all the inset objects but
supported only for multimedia
objects and u3d object.
The property takes the poster file
path as the value.
InsetGfxActiveInPdf string If this property is set, on publishing a
document to PDF ,the inset object
(which has facets FLV, U3d, or swf)
will be activated as soon as the page
containing the graphic object is
visible. In PDF the graphic objects are
called annotation.
InsetJavaScriptFile string Attaches the given Javascript file to
the graphic object that has a U3d
facet. If the value of the file path is
null, the Javascript attached to the
inset is removed.
InsetU3dAnimationList string A read-only property. Provides the list
of "animations" defined on the U3d
facet of a inset object.
InsetU3dPartList string Provides the list of "parts" defined in
the U3d facet of a inset object.
InsetU3dViewList string A read-only property. Retrieves the
list of "views" defined in the U3d
facet of a inset object.
Angle int Angle of the object’s rotation.
ArrowBaseAngle int Arrowhead base angle in degrees.
ArrowLength int Denotes the arrowhead length
(always rounded down to the nearest
1/256 point).
ArrowScaleFactor int Specifies the factor by which
arrowhead is scaled as line width
changes (always rounded down to
nearest 1/16 point). It is not used if
the ArrowScaleHead property is set
to False.
Property name Data Type Description
467
INSET
CHAPTER 5 OBJECT REFERENCE
ArrowScaleHead int Set to 1 if arrowhead is scaled as the
line width changes. Set to 0,
otherwise.
ArrowTipAngle int Arrowhead tip angle in degrees.
ArrowType int Arrowhead style. The value is one of:
• Constants.FV_ARROW_STICK
(0x1)
• Constants.FV_AR-
ROW_HOLLOW (0x2)
• Constants.FV_ARROW_FILLED
(0x3)
BorderWidth int Denotes the border width (0.015
points to 360 points).
Color Color The spot color (FO_Color ID)
Dash Metrics Specifies a dash pattern that is
repeated for the length of an object’s
border. The pattern is stored in a
MetricsT structure. The 0th
element of the
MetricsT.MetricsT_val array
stores the length of the first dash; the
1st element stores the following
space; the 2nd element stores the
next dash; and so on for an even
number of elements
Fill int The fill pattern (numbers between 0
and 15). The ESTK provides constants
for the following fill patterns:
• Constants.FV_FILL_BLACK (0)
• Constants.FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR(15)
FrameParent FMObject Frame containing the graphic object
(FO_AFrame or
FO_UnanchoredFrame ID).
GraphicCantBeSelected int 1 if the graphic object cannot be
selected; 0, otherwise.
Property name Data Type Description
468
INSET
CHAPTER 5 OBJECT REFERENCE
GraphicIsSelected int 1 if the graphic object is selected; 0,
otherwise.
GroupParent Group Group that the object is in (FO_Group
ID).
NOTE: Anchored and unanchored
frames do not have this property.
HeadArrow int 1 if the line has an arrowhead; 0,
otherwise.
Height int Height of the object (0.125 points to
3600 points).
HotspotCmdStr StringT The command string for a hotspot.
Thismust be a valid hypertext
command string.
HotspotTitle StringT The tooltip text for the hotspot in the
outputs that support it (for example
HTML). This property is 0ptional.
IsHotspot Bool Whether the object is a hotspot or
not. If this property is turned off, the
object is no longer a hotspot even if
command string is non-empty.
LineCap int Type of line end. The value is one of:
• Constants.FV_CAP_BUTT (0x00)
• Constants.FV_CAP_ROUND
(0x01)
• Constants.FV_CAP_SQUARE
(0x02)
LocX int Distance from the left side of the
parent frame (–216 inches to 216
inches).If the graphic object is an
anchored frame, the distance is
calculated from the left side of the
page frame. You cannot set LocX for
anchored frames.
Property name Data Type Description
469
INSET
CHAPTER 5 OBJECT REFERENCE
LocY int Distance from the top of the parent
frame (–216 inches to 216 inches).If
the graphic object is an anchored
frame, the distance is calculated from
the top of the page frame. You cannot
set LocY for anchored frames.
NextGraphicInDoc FMObject Next graphic object in the document.
NextGraphicInFrame FMObject Next graphic object in the frame.
NextGraphicInGroup FMObject Next graphic object in the group.
NextSelectedGraphicInDoc FMObject Next selected graphic object in
document.
ObjectAttributes Strings A list of strings, each string expressing
an attribute that is specified for an
anchored frame in the Object
Properties > Object
Attributes dialog box.Each string
is in the form of
<tag>string_text</tag>. You
can use the backslash to escape
characters such as \n, \r, or \t for
newline, carraige return, and tab,
respectively.
For a backslash character in the string
text, type \\.
Overprint int Specifies the overprint settings for
the object. The value is one of:
• Constants.FV_KNOCKOUT
(0x00)
• Constants.FV_OVERPRINT
(0x01)
• Constants.FV_FROMCOLOR
(0x02)
Pen int The pen pattern (numbers between 0
and 7). The ESTK provides constants
for the following values:
• Constants.FV_FILL_BLACK (0)
• Constants.FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
Property name Data Type Description
470
INTS
CHAPTER 5 OBJECT REFERENCE
Inset methods
Delete, DeletePropByName, GetIntByName, GetMetricByName, GetProps, GetUBytesByName, Object-
Valid, SetIntByName, SetMetricByName, SetProps, SetUBytesByName.
5.58. Ints
An Array of objects with integer indexing and a length property.
Ints methods
concat, pop, push.
PrevGraphicInFrame FMObject Previous graphic object in the frame.
PrevGraphicInGroup FMObject Previous graphic object in the group
Runaround int Specifies whether text can flow
around the object and, if so, whether
the text follows the contour of the
object or a box shape surrounding
the object. The value is one of:
• Constants.FV_TR_NONE (0x01)
• Constants.FV_TR_CONTOUR
(0x02)
• Constants.FV_TR_BBOX (0x03)
RunaroundGap int Denotes the the width of the
runaround gapfor a runaround
object.
TailArrow int 1 if arrowhead is present at the
beginning of the line. 0, otherwise.
TintPercent int The tint percentage.
Unique int Unique ID of the object.
Width int Width of the object (0.125 points to
3600 points).
Property name Data Type Description
length number The length of the array
Property name Data Type Description
471
KEYCATALOG
CHAPTER 5 OBJECT REFERENCE
5.59. KeyCatalog
5.60. Line
Property name Data Type Description
Name string Name of the KeyCatalog
IsDefault bool If True, the Key Catalog is the default
one for the current workflow.
If False, Key Catalog is not the default
one for the current workflow.
IsStale bool If True, the Key Catalog is maked as
stale and needs to be re-loaded
before using.
If False, the Key Catalog is not stale
and can be used.
NextKeyCatalogInSession F_ObjHandl
eT
Next Key Catalog in the session.
NotLoaded bool If True, the Key Catalog is not loaded
and cannot be used.
If False, the Key Catalog is loaded and
can be used.
Source string Complete path of the file conatining
the Key Catalog.
SourceType FV_KeySrcT
ypeNone
FV_KeySrcTypeDitamap
Type of the file conatining the Key
Catalog.
KeyCount int Number of keys in the Key Catalog
including duplicate definitons.
KeyCatalogClientName string Name of the client owning the key
catalog.
Property name Data Type Description
NumPoints int Specifies the number of vertices. The
default is 2 (the line’s start point and
end point).
472
LINE
CHAPTER 5 OBJECT REFERENCE
Points Points Array of x-y coordinate pairs that
specify the line’s vertices. The default
coordinate pairs are for the line’s
start point and end point.
Angle int Angle of the line’s rotation.
ArrowBaseAngle int Arrowhead base angle in degrees.
ArrowLength int Denotes the arrowhead length
(always rounded down to the nearest
1/256 point).
ArrowScaleFactor int Specifies the factor by which
arrowhead is scaled as line width
changes (always rounded down to
nearest 1/16 point). It is not used if
the ArrowScaleHead property is set
to False.
ArrowScaleHead int Set to 1 if arrowhead is scaled as the
line width changes. Set to 0,
otherwise.
ArrowTipAngle int Arrowhead tip angle in degrees.
ArrowType int Arrowhead style. The value is one of:
• Constants.FV_ARROW_STICK
(0x1)
• Constants.FV_AR-
ROW_HOLLOW (0x2)
• Constants.FV_ARROW_FILLED
(0x3)
BorderWidth int Denotes the border width (0.015
points to 360 points).
Color Color The spot color (FO_Color ID)
Property name Data Type Description
473
LINE
CHAPTER 5 OBJECT REFERENCE
Dash Metrics Specifies a dash pattern that is
repeated for the length of an object’s
border. The pattern is stored in a
MetricsT structure. The 0th
element of the
MetricsT.MetricsT_val array
stores the length of the first dash; the
1st element stores the following
space; the 2nd element stores the
next dash; and so on for an even
number of elements
Fill int The fill pattern (numbers between 0
and 15). The ESTK provides constants
for the following fill patterns:
• Constants.FV_FILL_BLACK (0)
• Constants.FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR(15)
FrameParent FMObject Frame containing the graphic object
(FO_AFrame or
FO_UnanchoredFrame ID).
GraphicCantBeSelected int 1 if the graphic object cannot be
selected; 0, otherwise.
GraphicIsSelected int 1 if the graphic object is selected; 0,
otherwise.
GroupParent Group Group that the line is in (FO_Group
ID).
HeadArrow int 1 if the line has an arrowhead; 0,
otherwise.
Height int Height of the object (0.125 points to
3600 points).
HotspotCmdStr StringT The command string for a hotspot.
Thismust be a valid hypertext
command string.
HotspotTitle StringT The tooltip text for the hotspot in the
outputs that support it (for example
HTML). This property is 0ptional.
Property name Data Type Description
474
LINE
CHAPTER 5 OBJECT REFERENCE
IsHotspot Bool Whether the object is a hotspot or
not. If this property is turned off, the
object is no longer a hotspot even if
command string is non-empty.
LineCap int Type of line end. The value is one of:
• Constants.FV_CAP_BUTT (0x00)
• Constants.FV_CAP_ROUND
(0x01)
• Constants.FV_CAP_SQUARE
(0x02)
LocX int Distance from the left side of the
parent frame (–216 inches to 216
inches).If the graphic object is an
anchored frame, the distance is
calculated from the left side of the
page frame. You cannot set LocX for
anchored frames.
LocY int Distance from the top of the parent
frame (–216 inches to 216 inches).If
the graphic object is an anchored
frame, the distance is calculated from
the top of the page frame. You cannot
set LocY for anchored frames.
NextGraphicInDoc FMObject Next graphic object in the document.
NextGraphicInFrame FMObject Next graphic object in the frame.
NextGraphicInGroup FMObject Next graphic object in the group.
NextSelectedGraphicInDoc FMObject Next selected graphic object in
document.
Property name Data Type Description
475
LINE
CHAPTER 5 OBJECT REFERENCE
ObjectAttributes Strings A list of strings, each string expressing
an attribute that is specified for an
anchored frame in the Object
Properties > Object
Attributes dialog box.Each string
is in the form of
<tag>string_text</tag>. You
can use the backslash to escape
characters such as \n, \r, or \t for
newline, carraige return, and tab,
respectively.
For a backslash character in the string
text, type \\.
Overprint int Specifies the overprint settings for
the object. The value is one of:
• Constants.FV_KNOCKOUT
(0x00)
• Constants.FV_OVERPRINT
(0x01)
• Constants.FV_FROMCOLOR
(0x02)
Pen int The pen pattern (numbers between 0
and 7). The ESTK provides constants
for the following values:
• Constants.FV_FILL_BLACK (0)
• Constants.FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
PrevGraphicInFrame FMObject Previous graphic object in the frame.
PrevGraphicInGroup FMObject Previous graphic object in the group
Runaround int Specifies whether text can flow
around the object and, if so, whether
the text follows the contour of the
object or a box shape surrounding
the object. The value is one of:
• Constants.FV_TR_NONE (0x01)
• Constants.FV_TR_CONTOUR
(0x02)
• Constants.FV_TR_BBOX (0x03)
Property name Data Type Description
476
MARKER
CHAPTER 5 OBJECT REFERENCE
Line methods
Delete, GetProps, ObjectValid, SetProps.
5.61. Marker
RunaroundGap int Denotes the the width of the
runaround gapfor a runaround
object.
TailArrow int 1 if arrowhead is present at the
beginning of the line. 0, otherwise.
TintPercent int The tint percentage.
Unique int Unique ID of the object.
Width int Width of the object (0.125 points to
3600 points).
Property name Data Type Description
Element Element Denotes the the element containing
the marker, if the marker is a
structured marker in a FrameMaker
document,.
MarkerText string The marker’s text string.
MarkerTypeId MarkerType The ID of the current marker’s type
(FO_MarkerType).
NextMarkerInDoc Marker Denotes the next marker (FO_Marker
ID).
OldTypeNum int A number to map markers from
documents earlier than version 5.5 to
this marker type.
TextLoc TextLoc Text location of the marker’s symbol.
Unique int The marker’s unique ID.
UserString string A string to which clients can store
private data.
Property name Data Type Description
477
MARKERTYPE
CHAPTER 5 OBJECT REFERENCE
Marker methods
Delete, GetProps, ObjectValid, SetProps.
5.62. MarkerType
MarkerType methods
Delete, GetProps, ObjectValid, SetProps.
5.63. MasterPage
Property name Data Type Description
NextMarkerTypeInDoc MarkerType Denotes the next marker type
(FO_MarkerType ID).
Name string The name of this marker type, as it
appears in the user interface.
InvariantName string An internal name for the marker
type. By default, this is the same as
Name. However, this can differ from
Name if the user interface is in
another language.
Public bool True if the marker type should appear
in the user interface. The default is
True.
Transient bool True if markers of this type shoud not
be saved to files. The default is False.
Required bool True if the marker type is required by
FrameMaker. The default is False.
Property name Data Type Description
Name string Name of master page (for example,
Right or Left).
PageFrame Unanchored
Frame
Page frame (FO_UnanchoredFrame
ID).
PageHeight int Height of the page.
478
MATH
CHAPTER 5 OBJECT REFERENCE
MasterPage methods
ApplyPageLayout, Delete, GetProps, ObjectValid, SetProps.
5.64. Math
PageNext MasterPage Next master page (FO_MasterPage
ID) in the document.
PageNum int Page number.
PagePrev MasterPage Previous master page
(FO_MasterPage ID) in the document.
PageWidth int Width of the page.
Property name Data Type Description
BasePointX int Horizontal placement of text line
base point relative to the left side of
the frame.
BasePointY int Vertical placement of text line base
point relative to top of the frame.
MathFullForm string String representing the mathematical
expression.
MathSize int The equation size. The value is one of
:
• Constants.FV_MATH_MEDIUM
(0)
• Constants.FV_MATH_SMALL (1)
• Constants.FV_MATH_LARGE (2)
Property name Data Type Description
479
MATH
CHAPTER 5 OBJECT REFERENCE
TextLineType int Type of text line. The value is one of:
• Constants.FV_TEXTLINE_LEFT
(0)
• Constants.FV_TEXTLINE_RIGHT
(1)
• Constants.FV_TEXT-
LINE_CENTER (2)
• Constants.FV_TEXTLINE_MATH
(3)
Angle int Specifies the angle of the object's
rotation.
ArrowBaseAngle int Indicates the arrowhead base angle in
degrees.
ArrowLength int Denotes the arrowhead length
(always rounded down to the nearest
1/256 point).
ArrowScaleHead int Set to 1 if the arrowhead is scaled as
the line width changes. Set to 0,
otherwise.
ArrowScaleFactor int Specifies the factor by which
arrowhead is scaled as line width
changes (always rounded down to
nearest 1/16 point). It is not used if
the ArrowScaleHead property is set
to False.
ArrowTipAngle int Specifies the arrowhead tip angle in
degrees.
ArrowType int Denotes the Arrowhead style.
Possible values are:
• Constants.FV_ARROW_STICK
(0x01)
• Constants.FV_AR-
ROW_HOLLOW (0x02)
• Constants.FV_ARROW_FILLED
(0x03)
Property name Data Type Description
480
MATH
CHAPTER 5 OBJECT REFERENCE
BorderWidth int Specifies the border width in points.
The permissible range is 0.015 point
to 360 point.
Color Color Indicates the spot color.
Dash Metrics Specifies a dash pattern that is
repeated for the length of an object's
border. The pattern is stored in a
Metrics object. The 0th element of
the MetricsT.MetricsT_val
array stores the length of the first
dash; the 1st element stores the
following space; the 2nd element
stores the next dash; and so on for an
even number of elements.
Fill int Denotes the fill pattern. The patterns
are denoted by numbers between 0
and 15.
The following constants are provided
for the fill patterns 0, 7 and 15:
• Constants.FV_FILL_BLACK (0)
• Constants.FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
FrameParent FMObject Specifies the frame containing the
graphic object.
GraphicCantBeSelected int Set to 1 if the graphic object cannot
be selected. Else, set to 0.
GraphicIsSelected int Set to 1 if the graphic object is
selected, else set to 0.
GroupParent Group Indicates the group to which the
object belongs. Anchored and
unanchored frames do not have this
property.
HeadArrow int Set to 1 if line has an arrowhead, set
to 0 otherwise.
Height int Specifies the height of the object in
points. The permissible range is from
0.125 pt to 3600 pt.
Property name Data Type Description
481
MATH
CHAPTER 5 OBJECT REFERENCE
HotspotCmdStr StringT The command string for a hotspot.
Thismust be a valid hypertext
command string.
HotspotTitle StringT The tooltip text for the hotspot in the
outputs that support it (for example
HTML). This property is 0ptional.
IsHotspot Bool Whether the object is a hotspot or
not. If this property is turned off, the
object is no longer a hotspot even if
command string is non-empty.
LineCap int Indicates the type of line end. The
possible values are:
• Constants.FV_CAP_BUTT (0x00)
• Constants.FV_CAP_ROUND
(0x01)
• Constants.FV_CAP_SQUARE
(0x02)
LocX int Specifies the distance of the object
from the left side of the parent, in
inches. The permissible range is from
–216 inches to 216 inches.
If the graphic object is an anchored
frame, the distance is automatically
calculated from the left side of the
page frame. You cannot set the LocX
property for anchored frames.
LocY int Specifies the distance of the object
from the top of the parent frame, in
inches. The permissible range is from
–216 inches to 216 inches.
If the graphic object is an anchored
frame, the distance is automatically
calculated from the top of the page
frame. You CANNOT set the LocY
property for anchored frames.
NextGraphicInDoc FMObject Indicates the next graphic object in
the document.
NextGraphicInFrame FMObject Denotes the next graphic object in
the frame.
Property name Data Type Description
482
MATH
CHAPTER 5 OBJECT REFERENCE
NextGraphicInGroup FMObject Indicates the next graphic object in
the group.
NextSelectedGraphicInDoc FMObject Specifies the next selected graphic
object in the document.
ObjectAttributes Strings Contains a list of strings, each string
expressing an attribute that is
specified for an anchored frame in
the Object Properties > Object
Attributes dialog box. Each string is in
the form of string_text .You can use
the backslash to escape characters
such as \n, \r, or \t for newline,
carriage return, and tab, respectively.
For a backslash character in the string
text, type \\.
Overprint int Specifies the overprint settings for
the object. The possible values are:
• Constants.FV_KNOCKOUT
(0x00)
• Constants.FV_OVERPRINT
(0x01)
• Constants.FV_FROMCOLOR
(0x02)
Pen int Indicates the pen pattern, denoted by
numbers between 0 and 7.
Constants are provided for some of
the fill patterns:
• Constants.FV_FILL_BLACK (0)
• Constants.FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
PrevGraphicInFrame FMObject Specifies the previous graphic object
in the frame.
PrevGraphicInGroup FMObject Indicate the previous graphic object
in the group.
Property name Data Type Description
483
MATHML
CHAPTER 5 OBJECT REFERENCE
Math methods
Delete, GetProps, ObjectValid, SetProps.
5.65. MathML
Runaround int Specifies whether text can flow
around the object and, if so, whether
the text follows the contour of the
object or a box shape surrounding
the object. Possible values are:
• Constants.FV_TR_NONE (0x01)
• Constants.FV_TR_CONTOUR
(0x02)
• Constants.FV_TR_BBOX (0x03)
RunaroundGap int Denotes the width of the runaround
gap, if the object is a runaround
object.
TailArrow int Set to 1 if the arrowhead is enabled
at the beginning of the line. Set to 0,
otherwise.
TintPercent int Specifies the tint percentage.
Unique int Denotes the internal identifier of the
graphic object.
Width int Specifies the width of the object in
points. The permissible range is 0.125
point to 3600 point.
Property name Data Type Description
MathMLDpi int Specifies the display Dpi for the
MathML object.
MathMLIsFixedSize int 1 if scaling of bitmap file is inhibited.
0, otherwise.
MathMLIsInverted int 1 if image is flipped about the
horizontal axis. 0, otherwise.
Property name Data Type Description
484
MATHML
CHAPTER 5 OBJECT REFERENCE
MathMLIsFlippedSideways int 1 if image is flipped about the vertical
axis. 0, otherwise.
MathMLData strings Specifies the XML data of the
MathML object as a string array.
MathMLComposeDpi int Specifies the compose Dpi for the
MathML object
MathMLFontSize int Specifies the font size for the
MathML object
MathMLXmlData string Specifies the XML data of the
MathML object as a string.
Angle int Specifies the angle of the object's
rotation.
ArrowBaseAngle int Indicates the arrowhead base angle in
degrees.
ArrowLength int Denotes the arrowhead length
(always rounded down to the nearest
1/256 point).
ArrowScaleHead int Set to 1 if the arrowhead is scaled as
the line width changes. Set to 0,
otherwise.
ArrowScaleFactor int Specifies the factor by which
arrowhead is scaled as line width
changes (always rounded down to
nearest 1/16 point). It is not used if
the ArrowScaleHead property is set
to False.
ArrowTipAngle int Specifies the arrowhead tip angle in
degrees.
ArrowType int Denotes the Arrowhead style.
Possible values are:
• Constants.FV_ARROW_STICK
(0x01)
• Constants.FV_AR-
ROW_HOLLOW (0x02)
• Constants.FV_ARROW_FILLED
(0x03)
Property name Data Type Description
485
MATHML
CHAPTER 5 OBJECT REFERENCE
BorderWidth int Specifies the border width in points.
The permissible range is 0.015 point
to 360 point.
Color Color Indicates the spot color.
Dash Metrics Specifies a dash pattern that is
repeated for the length of an object's
border. The pattern is stored in a
Metrics object. The 0th element of
the MetricsT.MetricsT_val
array stores the length of the first
dash; the 1st element stores the
following space; the 2nd element
stores the next dash; and so on for an
even number of elements.
Fill int Denotes the fill pattern. The patterns
are denoted by numbers between 0
and 15.
The following constants are provided
for the fill patterns 0, 7 and 15:
• Constants.FV_FILL_BLACK (0)
• Constants.FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
FrameParent FMObject Specifies the frame containing the
graphic object.
GraphicCantBeSelected int Set to 1 if the graphic object cannot
be selected. Else, set to 0.
GraphicIsSelected int Set to 1 if the graphic object is
selected, else set to 0.
GroupParent Group Indicates the group to which the
object belongs. Anchored and
unanchored frames do not have this
property.
HeadArrow int Set to 1 if line has an arrowhead, set
to 0 otherwise.
Height int Specifies the height of the object in
points. The permissible range is from
0.125 pt to 3600 pt.
Property name Data Type Description
486
MATHML
CHAPTER 5 OBJECT REFERENCE
HotspotCmdStr StringT The command string for a hotspot.
Thismust be a valid hypertext
command string.
HotspotTitle StringT The tooltip text for the hotspot in the
outputs that support it (for example
HTML). This property is 0ptional.
IsHotspot Bool Whether the object is a hotspot or
not. If this property is turned off, the
object is no longer a hotspot even if
command string is non-empty.
LineCap int Indicates the type of line end. The
possible values are:
• Constants.FV_CAP_BUTT (0x00)
• Constants.FV_CAP_ROUND
(0x01)
• Constants.FV_CAP_SQUARE
(0x02)
LocX int Specifies the distance of the object
from the left side of the parent, in
inches. The permissible range is from
–216 inches to 216 inches.
If the graphic object is an anchored
frame, the distance is automatically
calculated from the left side of the
page frame. You cannot set the LocX
property for anchored frames.
LocY int Specifies the distance of the object
from the top of the parent frame, in
inches. The permissible range is from
–216 inches to 216 inches.
If the graphic object is an anchored
frame, the distance is automatically
calculated from the top of the page
frame. You CANNOT set the LocY
property for anchored frames.
NextGraphicInDoc FMObject Indicates the next graphic object in
the document.
NextGraphicInFrame FMObject Denotes the next graphic object in
the frame.
Property name Data Type Description
487
MATHML
CHAPTER 5 OBJECT REFERENCE
NextGraphicInGroup FMObject Indicates the next graphic object in
the group.
NextSelectedGraphicInDoc FMObject Specifies the next selected graphic
object in the document.
ObjectAttributes Strings Contains a list of strings, each string
expressing an attribute that is
specified for an anchored frame in
the Object Properties > Object
Attributes dialog box. Each string is in
the form of string_text .You can use
the backslash to escape characters
such as \n, \r, or \t for newline,
carriage return, and tab, respectively.
For a backslash character in the string
text, type \\.
Overprint int Specifies the overprint settings for
the object. The possible values are:
• Constants.FV_KNOCKOUT
(0x00)
• Constants.FV_OVERPRINT
(0x01)
• Constants.FV_FROMCOLOR
(0x02)
Pen int Indicates the pen pattern, denoted by
numbers between 0 and 7.
Constants are provided for some of
the fill patterns:
• Constants.FV_FILL_BLACK (0)
• Constants.FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
PrevGraphicInFrame FMObject Specifies the previous graphic object
in the frame.
PrevGraphicInGroup FMObject Indicate the previous graphic object
in the group.
Property name Data Type Description
488
MENU
CHAPTER 5 OBJECT REFERENCE
MathML methods
Delete, GetProps, SetProps, ObjectValid.
5.66. Menu
Runaround int Specifies whether text can flow
around the object and, if so, whether
the text follows the contour of the
object or a box shape surrounding
the object. Possible values are:
• Constants.FV_TR_NONE (0x01)
• Constants.FV_TR_CONTOUR
(0x02)
• Constants.FV_TR_BBOX (0x03)
RunaroundGap int Denotes the width of the runaround
gap, if the object is a runaround
object.
TailArrow int Set to 1 if the arrowhead is enabled
at the beginning of the line. Set to 0,
otherwise.
TintPercent int Specifies the tint percentage.
Unique int Denotes the internal identifier of the
graphic object.
Width int Specifies the width of the object in
points. The permissible range is 0.125
point to 3600 point.
Property name Data Type Description
FirstMenuItemInMenu FMObject The first menu item in the menu.
Property name Data Type Description
489
MENU
CHAPTER 5 OBJECT REFERENCE
Menu methods
AddCommandToMenu, AddMenuToMenu, DefineAndAddCommand, DefineAndAddMenu, Delete,
Delete, GetProps, MenuItemInMenu, ObjectValid, SetProps.
MenuType int Type of menu. The value is one of:
• Constants.FV_MENU_MENUBAR (1)
- Amenu bar defined by the
FrameMaker product.
• Constants.FV_MENU_POPUP
(2) - A pop-up menu.
• Constants.FV_MENU_DEFAULT
(4) - A pull-down or pull-right
menu.
Label string The label the user sees on a menu.
The label for menu item separators is
read-only; it is always ---.
MenuItemIsEnabled int 1 if the menu item is enabled. 0, if it
is disabled.
Name string The command, menu, or menu item
separator name.
The names for the default,
predefined separators are
!Separator, !Separator1,
!Separator2, !Separator3,
!Separator4,
and!Separator5.
NextMenuItemInMenu FMObject The next menu item, menu, or
separator in the menu.
NextMenuItemInSession FMObject The next menu item, menu, or
separator in the list of menu items,
menus, and separators in the session.
PrevMenuItemInMenu FMObject The previous menu item, menu, or
separator in the list of menu items,
menus, and separators in the session.
Property name Data Type Description
490
MENUITEMSEPARATOR
CHAPTER 5 OBJECT REFERENCE
5.67. MenuItemSeparator
MenuItemSeparator methods
Delete, GetProps, ObjectValid, SetProps.
5.68. Metrics
An Array ofobjects with integer indexing and a length property.
Metrics methods
concat, pop, push.
Property name Data Type Description
Label string The label for menu item separators is
read-only; it is always ---.
MenuItemIsEnabled int 1 if the menu item separator is
enabled. 0, if it is disabled.
Name string The menu item separator name.
The names for the default,
predefined separators are
!Separator, !Separator1,
!Separator2, !Separator3,
!Separator4,
and!Separator5.
NextMenuItemInMenu FMObject The next menu item separator in the
menu.
NextMenuItemInSession FMObject The next menu item separator in the
list of menu items, menus, and
separators in the session.
PrevMenuItemInMenu FMObject The previous menu item separator in
the list of menu items, menus, and
separators in the session.
Property name Data Type Description
length number The length of the array
491
PGF
CHAPTER 5 OBJECT REFERENCE
5.69. Pgf
Property name Data Type Description
MinJRomSpace int Minimum Asian-Roman space.
OptJRomSpace int Optimum Asian-Roman space.
MaxJRomSpace int Maximum Asian-Roman space.
MinJLetSpace int Minimum Asian letter space.
OptJLetSpace int Optimum Asian letter space.
MaxJLetSpace int Maximum Asian letter space.
YakumonoType int The Yakumono rules to handle
punctuation characters. The value is
one of:
• Constants.FV_FLOATING_YAKU-
MONO (0x00)
• Constants.FV_MONOSPACE_YAKU-
MONO (0x01)
• Constants.FV_FIXED_YAKU-
MONO (0x02)
AutoNumChar string Character format for the automatic
numbering string specified by
AutoNumString; "" if the default
character format is used
AutoNumString string Autonumber format string (for
example, <n>.<n+>)
NumAtEnd int 1 if numbering position is End of
Paragraph; 0 if it is Beginning of
Paragraph.
PgfIsAutoNum int 1 if autonumbering is enabled.
PgfNumber string The formatted string representation
of the paragraph number; for
example, 1.2 for a paragraph whose
AutoNumString property is set to
<n>.<n+>
492
PGF
CHAPTER 5 OBJECT REFERENCE
Capitalization int Type of capitalization to use. The
value is one of:
• Constants.FV_CAPITAL_-
CASE_NORM (0)
• Constants.FV_CAPITAL_-
CASE_SMALL (1)
• Constants.FV_CAPITAL_-
CASE_LOWER (2)
• Constants.FV_CAPITAL_-
CASE_UPPER (3)
ChangeBar int 1 if Change Bars are on.
Color Color Spot color (FO_Color ID).
CombinedFontFamily CombinedFo
ntDefn
Combined font definition
(FO_CombinedFontDefn).
FontAngle int Font angle (specifies an index into the
array of font angles provided by the
session property
FontAngleNames).
FontEncodingName string The font’s encoding.
FontFamily int Font family (specifies an index into
the array of font families provided by
the session property
FontFamilyNames).
FontPlatformName string Name that uniquely identifies a font
on a specific platform.
FontPostScriptName string Name given to a font when it is sent
to a PostScript printer.
FontSize int Font size (2 pt to 400 pt).
FontVariation int Font variation (specifies an index into
the array of font variations provided
by the session
propertyFontVariationNames).
FontWeight int Font weight (specifies an index into
the array of font weights provided by
the session property
FontWeightNames).
Property name Data Type Description
493
PGF
CHAPTER 5 OBJECT REFERENCE
KernX int Horizontal kern value for manual
kerning expressed as a percentage of
an em (metric –100% to 1000%). A
positive value moves a character right
and a negative value moves a
character left.
KernY int Vertical kern value for manual
kerning expressed as a percentage of
an em (metric –100% to 1000%). A
positive value moves characters up
and a negative value moves
characters down.
Overline int 1 if Overline is enabled.
PairKern int 1 if Pair Kern is enabled.
Position int Specifies position relative to baseline
of text. The value is one of:
• Constants.FV_POS_NORM (0):
Normal
• Constants.FV_POS_SUPER (1):
Superscript
• Constants.FV_POS_SUB (2):
Subscript
Stretch int Character stretch (set width)
expressed as a percentage of normal
stretch for the font (metric –10% to
1000%).
Strikethrough int 1 if Strikethrough is enabled.
Underlining int Type of underlining. The value is one
of:
• Constants.FV_CB_NO_UNDER-
LINE (0)
•Constants.FV_CB_SINGLE_UNDER-
LINE (1)
• Constants.FV_CB_DOUBLE_UNDER-
LINE (2)
• Constants.FV_CB_NUMER-
IC_UNDERLINE (3)
Property name Data Type Description
494
PGF
CHAPTER 5 OBJECT REFERENCE
CellBottomMargin int Amount added to default bottom
margin of table cell.
CellLeftMargin int Amount added to default left margin
of table cell.
CellMarginsFixed int Specifies which cell margins are fixed.
The following values can be ORed
into it:
• Constants.FV_PGF_FIXED_L_-
MARGIN (0x01): the left margin
is fixed.
• Constants.FV_PGF_FIXED_B_-
MARGIN (0x02): the bottom
margin is fixed.
• Constants.FV_PGF_FIXED_R_-
MARGIN (0x04): the right
margin is fixed.
• Constants.FV_PGF_FIXED_T_-
MARGIN (0x08): the top margin
is fixed.
If the margin for a cell is fixed, the
margin property specifies the
absolute value of the cell margin. For
example, if
Constants.FV_PGF_FIXED_B_
MARGIN (0x02) is set,
CellBottomMargin specifies the
absolute value of the cell’s bottom
margin, overriding the cell margin
specified by the table format.
If
Constants.FV_PGF_FIXED_B_
MARGIN (0x02) is not set,
CellBottomMargin is added to
the margin specified by the table
format.
CellRightMargin int Amount added to default right
margin of table cell.
CellTopMargin int Amount added to default top margin
of table cell.
Property name Data Type Description
495
PGF
CHAPTER 5 OBJECT REFERENCE
CellVAlignment int Vertical alignment of a paragraph
when it is the first one in a cell. The
value is one of:
• Constants.FV_PG-
F_V_ALIGN_TOP (0)
• Constants.FV_PG-
F_V_ALIGN_MIDDLE (1)
• Constants.FV_PG-
F_V_ALIGN_BOTTOM (2)
Locked int 1 if the paragraph is part of a text
inset that retains formatting
information from the source
document. The paragraph is not
affected by global formatting
performed on the document.
FormatOverride int 1 if the paragraph contains a
paragraph format override.
AdjHyphens int Number of allowable adjacent
hyphens.
Hyphenate int 1 if Automatic Hyphenation is
enabled.
HyphMinPrefix int Minimum number of letters that
must precede hyphen.
HyphMinSuffix int Minimum number of letters that
must follow a hyphen.
HyphMinWord int Minimum length of a hyphenated
word.
Property name Data Type Description
496
PGF
CHAPTER 5 OBJECT REFERENCE
Language int Hyphenation and spell-checking
language to use. The value is one of:
• Constants.FV_LANG_NOLAN-
GUAGE (0x00)
• Constants.FV_LANG_ENGLISH
(0x01)
• Constants.FV_LANG_BRITISH
(0x02)
• Constants.FV_LANG_GERMAN
(0x03)
• Constants.FV_LANG_SWISS_-
GERMAN (0x04)
• Constants.FV_LANG_FRENCH
(0x05)
• Constants.FV_LANG_CANADIAN_-
FRENCH (0x06)
• Constants.FV_LANG_SPANISH
(0x07)
• Constants.FV_LANG_CATALAN
(0x08)
• Constants.FV_LANG_ITALIAN
(0x09)
• Constants.FV_LANG_FINNISH
(0x10)
• Constants.FV_LANG_SWEDISH
(0x11)
• Constants.FV_LANG_JAPANESE
(0x12)
• Constants.FV_LANG_TRADITION-
AL_CHINESE (0x13)
• Constants.FV_LANG_SIMPLI-
FIED_CHINESE (0x14)
• Constants.FV_LANG_KOREAN
(0x15)
• Constants.FV_LANG_PORTU-
GUESE (0x0A)
• Constants.FV_LANG_BRA-
ZILIAN (0x0B)
• Constants.FV_LANG_DANISH
(0x0C)
• Constants.FV_LANG_DUTCH
(0x0D)
• Constants.FV_LANG_NORWE-
GIAN (0x0E)
•
Constants FV LANG NYNORSK
Property name Data Type Description
497
PGF
CHAPTER 5 OBJECT REFERENCE
PgfSpellChecked int 1 if paragraph has been spell-checked
Unique int The paragraph’s user ID.
FirstIndent int First-line left margin, measured from
left side of current text column (0 cm
to 100 cm).
LeftIndent int Left margin, measured from left side
of current text column (0 cm to 100
cm).
RightIndent int Right margin, measured from right
side of current text column.
Leading int Space below each line in a paragraph.
LineSpacing int Space between lines in a paragraph
measured from baseline to baseline.
The value is one of:
• Constants.FV_PGF_FIXED
(0x00): default font size
• Constants.FV_PGF_PROPOR-
TIONAL (0x01): largest font in
line
• Constants.FV_PGF_FLOATING
(0x02): largest ascender in line
BlockLines int The number of Widow/Orphan lines.
KeepWithNext int 1 if Keep With Next Paragraph is
enabled.
KeepWithPrev int 1 if Keep With Previous Paragraph is
enabled.
PgfAlignment int Horizontal alignment of paragraph.
The value is one of:
• Constants.FV_PGF_LEFT (0x01)
• Constants.FV_PGF_RIGHT
(0x02)
• Constants.FV_PGF_CENTER
(0x03)
• Constants.FV_PGF_JUSTIFIED
(0x04)
Property name Data Type Description
498
PGF
CHAPTER 5 OBJECT REFERENCE
Placement int Paragraph placement. The value is
one of:
• Constants.FV_PGF_SIDEBODY
(0)
• Constants.FV_PGF_SIDE-
HEAD_TOP (1)
• Constants.FV_PGF_SIDEHEAD_-
FIRST_BASELINE (2)
• Constants.FV_PGF_SIDE-
HEAD_LAST_BASELINE (3)
• Constants.FV_PGF_RUN_IN (4)
• Constants.FV_PGF_STRADDLE
(5)
• Constants.FV_PGF_STRAD-
DLE_NORMAL_ONLY (6)
RunInSeparator string String for Run-In Head Default
Punctuation.
SpaceAbove int Space above paragraph.
SpaceBelow int Space below paragraph.
Start int Vertical placement of paragraph. The
value is one of:
• Constants.FV_PGF_ANYWHERE
(0x00)
• Constants.FV_PG-
F_TOP_OF_COL (0x01)
• Constants.FV_PG-
F_TOP_OF_PAGE (0x02)
• Constants.FV_PG-
F_TOP_OF_LEFT_PAGE (0x03)
• Constants.FV_PG-
F_TOP_OF_RIGHT_PAGE (0x04)
InTextFrame TextFrame Text frame containing the paragraph
(FO_TextFrame ID).
InTextObj FMObject Subcolumn, footnote, or table cell
the paragraph begins in (FO_SubCol,
FO_Fn, or FO_Cell ID).
Property name Data Type Description
499
PGF
CHAPTER 5 OBJECT REFERENCE
NextPgfInDoc Pgf Next paragraph in the document
(FO_Pgf ID).
NextPgfInFlow Pgf Next paragraph in the flow (FO_Pgf
ID).
PrevPgfInFlow Pgf Previous paragraph in the flow
(FO_Pgf ID).
BottomSeparator string Name of frame to put below
paragraph.
TopSeparator string Name of frame to put above
paragraph.
NumTabs int Number of tabs in the paragraph..
Tabs Tabs Array of tab descriptions that specify
the positions and types of tab stops.
Name string Name of paragraph format.
NextTag string Tag for new next paragraph.
UseNextTag int 1 if Next Paragraph Tag is enabled.
LetterSpace int 1 if Word Spacing is enabled.
MaxSpace int Maximum word spacing (percentage
of an em space in current font).
MinSpace int Minimum word spacing (percentage
of an em space in current font).
OptSpace int Optimum word spacing.
BkColor Color Denotes the text background color. If
this property is applied on a
paragraph format, it denotes the
background color of the whole
paragraph; if it is applied on a
character format, it denotes the
background color of the text over
which the character format is
applied.
PgfBoxColor Color Denotes the background color of the
paragraph box that encloses the
paragraph text.
Property name Data Type Description
500
PGFFMT
CHAPTER 5 OBJECT REFERENCE
Pgf methods
Delete, GetProps, GetText, ObjectValid, SetProps.
5.70. PgfFmt
Direction int Set or get the direction of the
document. Possible values:
•Constants.FV_DIR_Inherit
- Inherit the direction of the
parent
•Constants.FV_DIR_LTR -
Left-to-right
•FV_DIR_RTL - Right-to-left
ResolvedDirection int Get the inherited direction of the
document. Possible values:
•Constants.FV_DIR_LTR -
Left-to-right
•FV_DIR_RTL - Right-to-left
AsianComposer bool Whether the document will use the
Asian Composer layout engine.
UserString string A string to which clients can store
private data.
Property name Data Type Description
AcrobatLevel int Retained in Version 6.0 or later for
backward compatibility. Use
PDFStructureLevel instead.
PgfMarkedForNamedDestination int If 1, this paragraph will have a
corresponding Named Destination in
the generated PDF.
Property name Data Type Description
501
PGFFMT
CHAPTER 5 OBJECT REFERENCE
PDFStructureLevel int The PDF structure level of paragraphs
with the current format. This
property is used when the
PDFStructure property is True for
the document, and FrameMaker
generates PDF data.The value for this
property can be between 0 and 100,
where greater values are deeper in
the hierarchy. If PDFStructureLevel is
0, FrameMaker does not include
paragraphs of this format in the PDF
structure.
MinJRomSpace int Minimum Asian-Roman space.
OptJRomSpace int Optimum Asian-Roman space.
MaxJRomSpace int Maximum Asian-Roman space.
MinJLetSpace int Minimum Asian letter space.
OptJLetSpace int Optimum Asian letter space.
MaxJLetSpace int Maximum Asian letter space.
YakumonoType int The Yakumono rules to handle
punctuation characters. The value is
one of:
• Constants.FV_FLOATING_YAKU-
MONO (0x00)
• Constants.FV_MONOSPACE_YAKU-
MONO (0x01)
• Constants.FV_FIXED_YAKU-
MONO (0x02)
AutoNumChar string Character format for the automatic
numbering string specified by
AutoNumString; "" if the default
character format is used
AutoNumString string Autonumber format string (for
example, <n>.<n+>)
NumAtEnd int 1 if numbering position is End of
Paragraph; 0 if it is Beginning of
Paragraph.
Property name Data Type Description
502
PGFFMT
CHAPTER 5 OBJECT REFERENCE
PgfIsAutoNum int 1 if autonumbering is enabled.
Capitalization int Type of capitalization to use. The
value is one of:
• Constants.FV_CAPITAL_-
CASE_NORM (0)
• Constants.FV_CAPITAL_-
CASE_SMALL (1)
• Constants.FV_CAPITAL_-
CASE_LOWER (2)
• Constants.FV_CAPITAL_-
CASE_UPPER (3)
ChangeBar int 1 if Change Bars are on.
Color Color Spot color (FO_Color ID).
CombinedFontFamily CombinedFo
ntDefn
Combined font definition
(FO_CombinedFontDefn).
FontAngle int Font angle (specifies an index into the
array of font angles provided by the
session property
FontAngleNames).
FontEncodingName string The font’s encoding.
FontFamily int Font family (specifies an index into
the array of font families provided by
the session property
FontFamilyNames).
FontPlatformName string Name that uniquely identifies a font
on a specific platform.
FontPostScriptName string Name given to a font when it is sent
to a PostScript printer.
FontSize int Font size (2 pt to 400 pt).
FontVariation int Font variation (specifies an index into
the array of font variations provided
by the session
propertyFontVariationNames).
Property name Data Type Description
503
PGFFMT
CHAPTER 5 OBJECT REFERENCE
FontWeight int Font weight (specifies an index into
the array of font weights provided by
the session property
FontWeightNames).
KernX int Horizontal kern value for manual
kerning expressed as a percentage of
an em (metric –100% to 1000%). A
positive value moves a character right
and a negative value moves a
character left.
KernY int Vertical kern value for manual
kerning expressed as a percentage of
an em (metric –100% to 1000%). A
positive value moves characters up
and a negative value moves
characters down.
Overline int 1 if Overline is enabled.
PairKern int 1 if Pair Kern is enabled.
Position int Specifies position relative to baseline
of text. The value is one of:
• Constants.FV_POS_NORM (0):
Normal
• Constants.FV_POS_SUPER (1):
Superscript
• Constants.FV_POS_SUB (2):
Subscript
Stretch int Character stretch (set width)
expressed as a percentage of normal
stretch for the font (metric –10% to
1000%).
Strikethrough int 1 if Strikethrough is enabled.
Property name Data Type Description
504
PGFFMT
CHAPTER 5 OBJECT REFERENCE
Underlining int Type of underlining. The value is one
of:
• Constants.FV_CB_NO_UNDER-
LINE (0)
•Constants.FV_CB_SINGLE_UNDER-
LINE (1)
• Constants.FV_CB_DOUBLE_UNDER-
LINE (2)
• Constants.FV_CB_NUMER-
IC_UNDERLINE (3)
AdjHyphens int Number of allowable adjacent
hyphens
Hyphenate int 1 if Automatic Hyphenation is
enabled.
HyphMinPrefix int Minimum number of letters that
must precede hyphen.
HyphMinSuffix int Minimum number of letters that
must follow a hyphen.
HyphMinWord int Minimum length of a hyphenated
word.
Property name Data Type Description
505
PGFFMT
CHAPTER 5 OBJECT REFERENCE
Language int Hyphenation and spell-checking
language to use. The value is one of:
• Constants.FV_LANG_NOLAN-
GUAGE (0x00)
• Constants.FV_LANG_ENGLISH
(0x01)
• Constants.FV_LANG_BRITISH
(0x02)
• Constants.FV_LANG_GERMAN
(0x03)
• Constants.FV_LANG_SWISS_-
GERMAN (0x04)
• Constants.FV_LANG_FRENCH
(0x05)
• Constants.FV_LANG_CANADIAN_-
FRENCH (0x06)
• Constants.FV_LANG_SPANISH
(0x07)
• Constants.FV_LANG_CATALAN
(0x08)
• Constants.FV_LANG_ITALIAN
(0x09)
• Constants.FV_LANG_FINNISH
(0x10)
• Constants.FV_LANG_SWEDISH
(0x11)
• Constants.FV_LANG_JAPANESE
(0x12)
• Constants.FV_LANG_TRADITION-
AL_CHINESE (0x13)
• Constants.FV_LANG_SIMPLI-
FIED_CHINESE (0x14)
• Constants.FV_LANG_KOREAN
(0x15)
• Constants.FV_LANG_PORTU-
GUESE (0x0A)
• Constants.FV_LANG_BRA-
ZILIAN (0x0B)
• Constants.FV_LANG_DANISH
(0x0C)
• Constants.FV_LANG_DUTCH
(0x0D)
• Constants.FV_LANG_NORWE-
GIAN (0x0E)
•
Constants FV LANG NYNORSK
Property name Data Type Description
506
PGFFMT
CHAPTER 5 OBJECT REFERENCE
FirstIndent int First-line left margin, measured from
left side of current text column (0 cm
to 100 cm).
LeftIndent int Left margin, measured from left side
of current text column (0 cm to 100
cm).
RightIndent int Right margin, measured from right
side of current text column.
Leading int Space below each line in a paragraph.
LineSpacing int Space between lines in a paragraph
measured from baseline to baseline.
The value is one of:
• Constants.FV_PGF_FIXED
(0x00): default font size
• Constants.FV_PGF_PROPOR-
TIONAL (0x01): largest font in
line
• Constants.FV_PGF_FLOATING
(0x02): largest ascender in line
NextPgfInDoc Pgf Next paragraph in the document
(FO_Pgf ID).
BlockLines int The number of Widow/Orphan lines.
KeepWithNext int 1 if Keep With Next Paragraph is
enabled.
KeepWithPrev int 1 if Keep With Previous Paragraph is
enabled.
PgfAlignment int Horizontal alignment of paragraph.
The value is one of:
• Constants.FV_PGF_LEFT (0x01)
• Constants.FV_PGF_RIGHT
(0x02)
• Constants.FV_PGF_CENTER
(0x03)
• Constants.FV_PGF_JUSTIFIED
(0x04)
Property name Data Type Description
507
PGFFMT
CHAPTER 5 OBJECT REFERENCE
Placement int Paragraph placement. The value is
one of:
• Constants.FV_PGF_SIDEBODY
(0)
• Constants.FV_PGF_SIDE-
HEAD_TOP (1)
• Constants.FV_PGF_SIDEHEAD_-
FIRST_BASELINE (2)
• Constants.FV_PGF_SIDE-
HEAD_LAST_BASELINE (3)
• Constants.FV_PGF_RUN_IN (4)
• Constants.FV_PGF_STRADDLE
(5)
• Constants.FV_PGF_STRAD-
DLE_NORMAL_ONLY (6)
RunInSeparator string String for Run-In Head Default
Punctuation.
SpaceAbove int Space above paragraph.
SpaceBelow int Space below paragraph.
Start int Vertical placement of paragraph. The
value is one of:
• Constants.FV_PGF_ANYWHERE
(0x00)
• Constants.FV_PG-
F_TOP_OF_COL (0x01)
• Constants.FV_PG-
F_TOP_OF_PAGE (0x02)
• Constants.FV_PG-
F_TOP_OF_LEFT_PAGE (0x03)
• Constants.FV_PG-
F_TOP_OF_RIGHT_PAGE (0x04)
BottomSeparator string Name of frame to put below
paragraph.
TopSeparator string Name of frame to put above
paragraph.
Property name Data Type Description
508
PGFFMT
CHAPTER 5 OBJECT REFERENCE
BkColor Color Denotes the text background color. If
this property is applied on a
paragraph format, it denotes the
background color of the whole
paragraph; if it is applied on a
character format, it denotes the
background color of the text over
which the character format is
applied.
PgfBoxColor Color Denotes the background color of the
paragraph box that encloses the
paragraph text.
UseBkColor bool The UseBkColor is a Boolean flag
which indicates whether the
BkColor property is set or not. A
value of 1 indicates the text has some
background color. A value of 0
indicates a transparent background.
NOTE: When the UseBkColor
property is set to 0, the BkColor
value is not used.
CellBottomMargin int Amount added to default bottom
margin of table cell.
CellLeftMargin int Amount added to default left margin
of table cell.
Property name Data Type Description
509
PGFFMT
CHAPTER 5 OBJECT REFERENCE
CellMarginsFixed int Specifies which cell margins are fixed.
The following values can be ORed
into it:
• Constants.FV_PGF_FIXED_L_-
MARGIN (0x01): the left margin
is fixed.
• Constants.FV_PGF_FIXED_B_-
MARGIN (0x02): the bottom
margin is fixed.
• Constants.FV_PGF_FIXED_R_-
MARGIN (0x04): the right
margin is fixed.
• Constants.FV_PGF_FIXED_T_-
MARGIN (0x08): the top margin
is fixed.
If the margin for a cell is fixed, the
margin property specifies the
absolute value of the cell margin. For
example, if
Constants.FV_PGF_FIXED_B_
MARGIN (0x02) is set,
CellBottomMargin specifies the
absolute value of the cell’s bottom
margin, overriding the cell margin
specified by the table format.
If
Constants.FV_PGF_FIXED_B_
MARGIN (0x02) is not set,
CellBottomMargin is added to
the margin specified by the table
format.
CellRightMargin int Amount added to default right
margin of table cell.
CellTopMargin int Amount added to default top margin
of table cell.
Property name Data Type Description
510
PGFFMT
CHAPTER 5 OBJECT REFERENCE
CellVAlignment int Vertical alignment of a paragraph
when it is the first one in a cell. The
value is one of:
• Constants.FV_PG-
F_V_ALIGN_TOP (0)
• Constants.FV_PG-
F_V_ALIGN_MIDDLE (1)
• Constants.FV_PG-
F_V_ALIGN_BOTTOM (2)
NumTabs int Number of tabs in the paragraph..
Tabs Tabs Array of tab descriptions that specify
the positions and types of tab stops.
Name string Name of paragraph format.
NextTag string Tag for new next paragraph.
UseNextTag int 1 if Next Paragraph Tag is enabled.
LetterSpace int 1 if Word Spacing is enabled.
MaxSpace int Maximum word spacing (percentage
of an em space in current font).
MinSpace int Minimum word spacing (percentage
of an em space in current font).
OptSpace int Optimum word spacing.
Direction int Set or get the direction of the
document. Possible values:
•Constants.FV_DIR_Inherit
- Inherit the direction of the
parent
•Constants.FV_DIR_LTR -
Left-to-right
•FV_DIR_RTL - Right-to-left
ResolvedDirection int Get the inherited direction of the
document. Possible values:
•Constants.FV_DIR_LTR -
Left-to-right
•FV_DIR_RTL - Right-to-left
Property name Data Type Description
511
POINT
CHAPTER 5 OBJECT REFERENCE
PgfFmt methods
Delete, GetProps, ObjectValid, SetProps.
5.71. Point
Point methods
Point.
5.72. Points
An Array of Point objects with integer indexing and a length property.
Points methods
concat, pop, push.
5.73. Polygon
AsianComposer bool Whether the document will use the
Asian Composer layout engine.
Property name Data Type Description
xint X coordinate
yint Y cooridnate
Property name Data Type Description
length number The length of the array
Property name Data Type Description
NumPoints int Number of polygon vertices.
Property name Data Type Description
512
POLYGON
CHAPTER 5 OBJECT REFERENCE
Points Points Array of x-y coordinate pairs that
specify the polygon’s vertices.
PolyIsBezier int 1 if polygon is smoothed.
Angle int Indicates the angle of rotation of the
graphic object.
ArrowBaseAngle int Denotes the arrowhead base angle in
degrees.
ArrowLength int Denotes the arrowhead length
(always rounded down to the nearest
1/256 point).
ArrowScaleFactor int Indicates the factor by which the
arrowhead is scaled as line width
changes (always rounded down to
nearest 1/16 point). It is not used if
the ArrowScaleHead property is
False.
ArrowScaleHead int Set to 1 if arrowhead is scaled as the
line width changes. Set to 0,
otherwise.
ArrowTipAngle int Denotes the arrowhead tip angle in
degrees.
ArrowType int Denotes the style of the arrowhead.
Possible values are:
• Constants.FV_ARROW_STICK
(0x1)
• Constants.FV_AR-
ROW_HOLLOW (0x2)
• Constants.FV_ARROW_FILLED
(0x3)
BorderWidth int Indicates the border width specified
in points. The permissible range is
0.015 pt to 360 points.
Color Color Denotes the spot color.
Property name Data Type Description
513
POLYGON
CHAPTER 5 OBJECT REFERENCE
Dash Metrics Specifies a dash pattern that is
repeated for the length of an object's
border. The pattern is stored in a
MetricsT structure. The 0th element
of the MetricsT.MetricsT_val array
stores the length of the first dash; the
1st element stores the following
space; the 2nd element stores the
next dash; and so on for an even
number of elements.
Fill int Denotes the fill pattern (numbers
between 0 and 15).
Constants are provided for fill
patterns 0, 7 and 15, as follows:
• Constants.FV_FILL_BLACK (0)
• Constants.FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
FrameParent FMObject Denotes the frame containing the
graphic object.
GraphicCantBeSelected int Set to 1 if the graphic object cannot
be selected. Set to 0, otherwise.
GraphicIsSelected int Set to 1, if the graphic object is
selected. Else, set to 0.
GroupParent Group Specifies the group to which the
object belongs.
Note: Anchored frames do NOT have
this property.
HeadArrow int Set to 1 if the line has an arrow head.
Set to 0, otherwise.
Height int Denotes the height of the object
denoted in points. The permissible
range is from 0.125 points to 3600
points.
HotspotCmdStr StringT The command string for a hotspot.
Thismust be a valid hypertext
command string.
Property name Data Type Description
514
POLYGON
CHAPTER 5 OBJECT REFERENCE
HotspotTitle StringT The tooltip text for the hotspot in the
outputs that support it (for example
HTML). This property is 0ptional.
IsHotspot Bool Whether the object is a hotspot or
not. If this property is turned off, the
object is no longer a hotspot even if
command string is non-empty.
LineCap int Specifies the type of the end of the
line. The possible values are:
• Constants.FV_CAP_BUTT (0x00)
• Constants.FV_CAP_ROUND
(0x01)
• Constants.FV_CAP_SQUARE
(0x02)
LocX int Specifies the distance of the object
from the left side of the parent frame
(in inches). The permissible range is –
216 inches to 216 inches.
If the graphic object is an anchored
frame, the distance is automatically
calculated from the left side of the
page frame. You cannot set this value
manually for anchored frames.
LocY int Distance of the object from the top of
the parent frame (in inches) The
permissible range is –216 inches to
216 inches.
If the graphic object is an anchored
frame, the distance is automatically
calculated from the top of the page
frame. You cannot set this value
manually for anchored frames.
NextGraphicInDoc FMObject Denotes the next graphic object in
the document.
NextGraphicInFrame FMObject Denotes the next graphic object in
the frame.
NextGraphicInGroup FMObject Denotes the next graphic object in
the group.
Property name Data Type Description
515
POLYGON
CHAPTER 5 OBJECT REFERENCE
NextSelectedGraphicInDoc FMObject Denotes the next selected graphic
object in the document.
ObjectAttributes Strings A list of strings. Each string expresses
an attribute that is specified for an
anchored frame in the Object
Properties > Object Attributes dialog
box. Each string is in the form of
string_text.You can use the backslash
to escape characters such as \n, \r, or
\t for newline, carriage return, and
tab, respectively. For a backslash
character in the string text, type \\.
Overprint int Specifies the overprint settings for
the object. The possible values are:
• Constants.FV_KNOCKOUT
(0x00)
• Constants.FV_OVERPRINT
(0x01)
• Constants.FV_FROMCOLOR
(0x02)
Pen int Specifies the pen pattern (numbers
between 0 and 7).
Constants are provided for pen
patterns 0, 7 and 15, as follows:
• Constants.FV_FILL_BLACK (0)
• Constants. FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
PrevGraphicInFrame FMObject Denotes the previous graphic object
in the frame.
PrevGraphicInGroup FMObject Denotes the previous graphic object
in the group.
Property name Data Type Description
516
POLYLINE
CHAPTER 5 OBJECT REFERENCE
Polygon methods
Delete, GetProps, ObjectValid, SetProps.
5.74. Polyline
Runaround int Specifies whether text can flow
around the object and, if so, whether
the text follows the contour of the
object or a box shape surrounding
the object. The possible values are:
• Constants.FV_TR_NONE (0x01)
• Constants.FV_TR_CONTOUR
(0x02)
• Constants.FV_TR_BBOX (0x03)
RunaroundGap int Denotes the width of the runaround
gap, if the object is a runaround
object.
TailArrow int Set to 1 if the arrowhead is enabled
at the begining of the line; Set to 0
otherwise.
TintPercent int Specifies the tint percentage.
Unique int Indicates the graphic object's internal
unique number.
Width int Denotes the width of the object. The
permissible range is from 0.125
points to 3600 points.
Property name Data Type Description
NumPoints int Number of polygon vertices.
Points Points Array of x-y coordinate pairs that
specify the polygon’s vertices.
PolyIsBezier int 1 if polygon is smoothed.
Angle int Indicates the angle of rotation of the
graphic object.
Property name Data Type Description
517
POLYLINE
CHAPTER 5 OBJECT REFERENCE
ArrowBaseAngle int Denotes the arrowhead base angle in
degrees.
ArrowLength int Denotes the arrowhead length
(always rounded down to the nearest
1/256 point).
ArrowScaleFactor int Indicates the factor by which the
arrowhead is scaled as line width
changes (always rounded down to
nearest 1/16 point). It is not used if
the ArrowScaleHead property is
False.
ArrowScaleHead int Set to 1 if arrowhead is scaled as the
line width changes. Set to 0,
otherwise.
ArrowTipAngle int Denotes the arrowhead tip angle in
degrees.
ArrowType int Denotes the style of the arrowhead.
Possible values are:
• Constants.FV_ARROW_STICK
(0x1)
• Constants.FV_AR-
ROW_HOLLOW (0x2)
• Constants.FV_ARROW_FILLED
(0x3)
BorderWidth int Indicates the border width specified
in points. The permissible range is
0.015 pt to 360 points.
Color Color Denotes the spot color.
Dash Metrics Specifies a dash pattern that is
repeated for the length of an object's
border. The pattern is stored in a
MetricsT structure. The 0th element
of the MetricsT.MetricsT_val array
stores the length of the first dash; the
1st element stores the following
space; the 2nd element stores the
next dash; and so on for an even
number of elements.
Property name Data Type Description
518
POLYLINE
CHAPTER 5 OBJECT REFERENCE
Fill int Denotes the fill pattern (numbers
between 0 and 15).
Constants are provided for fill
patterns 0, 7 and 15, as follows:
• Constants.FV_FILL_BLACK (0)
• Constants.FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
FrameParent FMObject Denotes the frame containing the
graphic object.
GraphicCantBeSelected int Set to 1 if the graphic object cannot
be selected. Set to 0, otherwise.
GraphicIsSelected int Set to 1, if the graphic object is
selected. Else, set to 0.
GroupParent Group Specifies the group to which the
object belongs.
Note: Anchored frames do NOT have
this property.
HeadArrow int Set to 1 if the line has an arrow head.
Set to 0, otherwise.
Height int Denotes the height of the object
denoted in points. The permissible
range is from 0.125 points to 3600
points.
HotspotCmdStr StringT The command string for a hotspot.
Thismust be a valid hypertext
command string.
HotspotTitle StringT The tooltip text for the hotspot in the
outputs that support it (for example
HTML). This property is 0ptional.
IsHotspot Bool Whether the object is a hotspot or
not. If this property is turned off, the
object is no longer a hotspot even if
command string is non-empty.
Property name Data Type Description
519
POLYLINE
CHAPTER 5 OBJECT REFERENCE
LineCap int Specifies the type of the end of the
line. The possible values are:
• Constants.FV_CAP_BUTT (0x00)
• Constants.FV_CAP_ROUND
(0x01)
• Constants.FV_CAP_SQUARE
(0x02)
LocX int Specifies the distance of the object
from the left side of the parent frame
(in inches). The permissible range is –
216 inches to 216 inches.
If the graphic object is an anchored
frame, the distance is automatically
calculated from the left side of the
page frame. You cannot set this value
manually for anchored frames.
LocY int Distance of the object from the top of
the parent frame (in inches) The
permissible range is –216 inches to
216 inches.
If the graphic object is an anchored
frame, the distance is automatically
calculated from the top of the page
frame. You cannot set this value
manually for anchored frames.
NextGraphicInDoc FMObject Denotes the next graphic object in
the document.
NextGraphicInFrame FMObject Denotes the next graphic object in
the frame.
NextGraphicInGroup FMObject Denotes the next graphic object in
the group.
NextSelectedGraphicInDoc FMObject Denotes the next selected graphic
object in the document.
Property name Data Type Description
520
POLYLINE
CHAPTER 5 OBJECT REFERENCE
ObjectAttributes Strings A list of strings. Each string expresses
an attribute that is specified for an
anchored frame in the Object
Properties > Object Attributes dialog
box. Each string is in the form of
string_text.You can use the backslash
to escape characters such as \n, \r, or
\t for newline, carriage return, and
tab, respectively. For a backslash
character in the string text, type \\.
Overprint int Specifies the overprint settings for
the object. The possible values are:
• Constants.FV_KNOCKOUT
(0x00)
• Constants.FV_OVERPRINT
(0x01)
• Constants.FV_FROMCOLOR
(0x02)
Pen int Specifies the pen pattern (numbers
between 0 and 7).
Constants are provided for pen
patterns 0, 7 and 15, as follows:
• Constants.FV_FILL_BLACK (0)
• Constants. FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
PrevGraphicInFrame FMObject Denotes the previous graphic object
in the frame.
PrevGraphicInGroup FMObject Denotes the previous graphic object
in the group.
Runaround int Specifies whether text can flow
around the object and, if so, whether
the text follows the contour of the
object or a box shape surrounding
the object. The possible values are:
• Constants.FV_TR_NONE (0x01)
• Constants.FV_TR_CONTOUR
(0x02)
• Constants.FV_TR_BBOX (0x03)
Property name Data Type Description
521
PROPIDENT
CHAPTER 5 OBJECT REFERENCE
Polyline methods
Delete, GetProps, ObjectValid, SetProps.
5.75. PropIdent
PropIdent methods
PropIdent.
5.76. PropVal
RunaroundGap int Denotes the width of the runaround
gap, if the object is a runaround
object.
TailArrow int Set to 1 if the arrowhead is enabled
at the begining of the line; Set to 0
otherwise.
TintPercent int Specifies the tint percentage.
Unique int Indicates the graphic object's internal
unique number.
Width int Denotes the width of the object. The
permissible range is from 0.125
points to 3600 points.
Property name Data Type Description
num int The property number.
name string The property name.
Property name Data Type Description
propIdent PropIdent The property identifier.
propVal TypedVal The property value.
Property name Data Type Description
522
PROPVALS
CHAPTER 5 OBJECT REFERENCE
PropVal methods
PropVal.
5.77. PropVals
An Array of PropVal objects with integer indexing and a length property.
PropVals methods
concat, pop, push.
5.78. Rectangle
Property name Data Type Description
length number The length of the array
Property name Data Type Description
RectangleIsSmoothed int 1 if smoothing is enabled. This
property is always 1 for Ellipse
objects.
Angle int Indicates the angle of rotation of the
graphic object.
ArrowBaseAngle int Denotes the arrowhead base angle in
degrees.
ArrowLength int Denotes the arrowhead length
(always rounded down to the nearest
1/256 point).
ArrowScaleFactor int Indicates the factor by which the
arrowhead is scaled as line width
changes (always rounded down to
nearest 1/16 point). It is not used if
the ArrowScaleHead property is
False.
ArrowScaleHead int Set to 1 if arrowhead is scaled as the
line width changes. Set to 0,
otherwise.
523
RECTANGLE
CHAPTER 5 OBJECT REFERENCE
ArrowTipAngle int Denotes the arrowhead tip angle in
degrees.
ArrowType int Denotes the style of the arrowhead.
Possible values are:
• Constants.FV_ARROW_STICK
(0x1)
• Constants.FV_AR-
ROW_HOLLOW (0x2)
• Constants.FV_ARROW_FILLED
(0x3)
BorderWidth int Indicates the border width specified
in points. The permissible range is
0.015 pt to 360 points.
Color Color Denotes the spot color.
Dash Metrics Specifies a dash pattern that is
repeated for the length of an object's
border. The pattern is stored in a
MetricsT structure. The 0th element
of the MetricsT.MetricsT_val array
stores the length of the first dash; the
1st element stores the following
space; the 2nd element stores the
next dash; and so on for an even
number of elements.
Fill int Denotes the fill pattern (numbers
between 0 and 15).
Constants are provided for fill
patterns 0, 7 and 15, as follows:
• Constants.FV_FILL_BLACK (0)
• Constants.FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
FrameParent FMObject Denotes the frame containing the
graphic object.
GraphicCantBeSelected int Set to 1 if the graphic object cannot
be selected. Set to 0, otherwise.
GraphicIsSelected int Set to 1, if the graphic object is
selected. Else, set to 0.
Property name Data Type Description
524
RECTANGLE
CHAPTER 5 OBJECT REFERENCE
GroupParent Group Specifies the group to which the
object belongs.
Note: Anchored frames do NOT have
this property.
HeadArrow int Set to 1 if the line has an arrow head.
Set to 0, otherwise.
Height int Denotes the height of the object
denoted in points. The permissible
range is from 0.125 points to 3600
points.
HotspotCmdStr StringT The command string for a hotspot.
Thismust be a valid hypertext
command string.
HotspotTitle StringT The tooltip text for the hotspot in the
outputs that support it (for example
HTML). This property is 0ptional.
IsHotspot Bool Whether the object is a hotspot or
not. If this property is turned off, the
object is no longer a hotspot even if
command string is non-empty.
LineCap int Specifies the type of the end of the
line. The possible values are:
• Constants.FV_CAP_BUTT (0x00)
• Constants.FV_CAP_ROUND
(0x01)
• Constants.FV_CAP_SQUARE
(0x02)
LocX int Specifies the distance of the object
from the left side of the parent frame
(in inches). The permissible range is –
216 inches to 216 inches.
If the graphic object is an anchored
frame, the distance is automatically
calculated from the left side of the
page frame. You cannot set this value
manually for anchored frames.
Property name Data Type Description
525
RECTANGLE
CHAPTER 5 OBJECT REFERENCE
LocY int Distance of the object from the top of
the parent frame (in inches) The
permissible range is –216 inches to
216 inches.
If the graphic object is an anchored
frame, the distance is automatically
calculated from the top of the page
frame. You cannot set this value
manually for anchored frames.
NextGraphicInDoc FMObject Denotes the next graphic object in
the document.
NextGraphicInFrame FMObject Denotes the next graphic object in
the frame.
NextGraphicInGroup FMObject Denotes the next graphic object in
the group.
NextSelectedGraphicInDoc FMObject Denotes the next selected graphic
object in the document.
ObjectAttributes Strings A list of strings. Each string expresses
an attribute that is specified for an
anchored frame in the Object
Properties > Object Attributes dialog
box. Each string is in the form of
string_text.You can use the backslash
to escape characters such as \n, \r, or
\t for newline, carriage return, and
tab, respectively. For a backslash
character in the string text, type \\.
Overprint int Specifies the overprint settings for
the object. The possible values are:
• Constants.FV_KNOCKOUT
(0x00)
• Constants.FV_OVERPRINT
(0x01)
• Constants.FV_FROMCOLOR
(0x02)
Property name Data Type Description
526
RECTANGLE
CHAPTER 5 OBJECT REFERENCE
Rectangle methods
Delete, GetProps, ObjectValid, SetProps.
Pen int Specifies the pen pattern (numbers
between 0 and 7).
Constants are provided for pen
patterns 0, 7 and 15, as follows:
• Constants.FV_FILL_BLACK (0)
• Constants. FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
PrevGraphicInFrame FMObject Denotes the previous graphic object
in the frame.
PrevGraphicInGroup FMObject Denotes the previous graphic object
in the group.
Runaround int Specifies whether text can flow
around the object and, if so, whether
the text follows the contour of the
object or a box shape surrounding
the object. The possible values are:
• Constants.FV_TR_NONE (0x01)
• Constants.FV_TR_CONTOUR
(0x02)
• Constants.FV_TR_BBOX (0x03)
RunaroundGap int Denotes the width of the runaround
gap, if the object is a runaround
object.
TailArrow int Set to 1 if the arrowhead is enabled
at the begining of the line; Set to 0
otherwise.
TintPercent int Specifies the tint percentage.
Unique int Indicates the graphic object's internal
unique number.
Width int Denotes the width of the object. The
permissible range is from 0.125
points to 3600 points.
Property name Data Type Description
527
REFPAGE
CHAPTER 5 OBJECT REFERENCE
5.79. RefPage
RefPage methods
ApplyPageLayout, Delete, GetProps, ObjectValid, SetProps.
5.80. RoundRect
Property name Data Type Description
Name string Name of the reference page.
PageFrame Unanchored
Frame
Page frame (FO_UnanchoredFrame
ID)
PageHeight int Height of the page.
PageNext RefPage Next reference page (FO_RefPage ID)
in the document.
PageNum int Page number.
PagePrev RefPage Previous reference page (FO_RefPage
ID) in the document.
PageWidth int Width of the page.
Property name Data Type Description
Radius int Radius of corner; 0 for a square
corner.
Angle int Indicates the angle of rotation of the
graphic object.
ArrowBaseAngle int Denotes the arrowhead base angle in
degrees.
ArrowLength int Denotes the arrowhead length
(always rounded down to the nearest
1/256 point).
528
ROUNDRECT
CHAPTER 5 OBJECT REFERENCE
ArrowScaleFactor int Indicates the factor by which the
arrowhead is scaled as line width
changes (always rounded down to
nearest 1/16 point). It is not used if
the ArrowScaleHead property is
False.
ArrowScaleHead int Set to 1 if arrowhead is scaled as the
line width changes. Set to 0,
otherwise.
ArrowTipAngle int Denotes the arrowhead tip angle in
degrees.
ArrowType int Denotes the style of the arrowhead.
Possible values are:
• Constants.FV_ARROW_STICK
(0x1)
• Constants.FV_AR-
ROW_HOLLOW (0x2)
• Constants.FV_ARROW_FILLED
(0x3)
BorderWidth int Indicates the border width specified
in points. The permissible range is
0.015 pt to 360 points.
Color Color Denotes the spot color.
Dash Metrics Specifies a dash pattern that is
repeated for the length of an object's
border. The pattern is stored in a
MetricsT structure. The 0th element
of the MetricsT.MetricsT_val array
stores the length of the first dash; the
1st element stores the following
space; the 2nd element stores the
next dash; and so on for an even
number of elements.
Property name Data Type Description
529
ROUNDRECT
CHAPTER 5 OBJECT REFERENCE
Fill int Denotes the fill pattern (numbers
between 0 and 15).
Constants are provided for fill
patterns 0, 7 and 15, as follows:
• Constants.FV_FILL_BLACK (0)
• Constants.FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
FrameParent FMObject Denotes the frame containing the
graphic object.
GraphicCantBeSelected int Set to 1 if the graphic object cannot
be selected. Set to 0, otherwise.
GraphicIsSelected int Set to 1, if the graphic object is
selected. Else, set to 0.
GroupParent Group Specifies the group to which the
object belongs.
Note: Anchored frames do NOT have
this property.
HeadArrow int Set to 1 if the line has an arrow head.
Set to 0, otherwise.
Height int Denotes the height of the object
denoted in points. The permissible
range is from 0.125 points to 3600
points.
HotspotCmdStr StringT The command string for a hotspot.
Thismust be a valid hypertext
command string.
HotspotTitle StringT The tooltip text for the hotspot in the
outputs that support it (for example
HTML). This property is 0ptional.
IsHotspot Bool Whether the object is a hotspot or
not. If this property is turned off, the
object is no longer a hotspot even if
command string is non-empty.
Property name Data Type Description
530
ROUNDRECT
CHAPTER 5 OBJECT REFERENCE
LineCap int Specifies the type of the end of the
line. The possible values are:
• Constants.FV_CAP_BUTT (0x00)
• Constants.FV_CAP_ROUND
(0x01)
• Constants.FV_CAP_SQUARE
(0x02)
LocX int Specifies the distance of the object
from the left side of the parent frame
(in inches). The permissible range is –
216 inches to 216 inches.
If the graphic object is an anchored
frame, the distance is automatically
calculated from the left side of the
page frame. You cannot set this value
manually for anchored frames.
LocY int Distance of the object from the top of
the parent frame (in inches) The
permissible range is –216 inches to
216 inches.
If the graphic object is an anchored
frame, the distance is automatically
calculated from the top of the page
frame. You cannot set this value
manually for anchored frames.
NextGraphicInDoc FMObject Denotes the next graphic object in
the document.
NextGraphicInFrame FMObject Denotes the next graphic object in
the frame.
NextGraphicInGroup FMObject Denotes the next graphic object in
the group.
NextSelectedGraphicInDoc FMObject Denotes the next selected graphic
object in the document.
Property name Data Type Description
531
ROUNDRECT
CHAPTER 5 OBJECT REFERENCE
ObjectAttributes Strings A list of strings. Each string expresses
an attribute that is specified for an
anchored frame in the Object
Properties > Object Attributes dialog
box. Each string is in the form of
string_text.You can use the backslash
to escape characters such as \n, \r, or
\t for newline, carriage return, and
tab, respectively. For a backslash
character in the string text, type \\.
Overprint int Specifies the overprint settings for
the object. The possible values are:
• Constants.FV_KNOCKOUT
(0x00)
• Constants.FV_OVERPRINT
(0x01)
• Constants.FV_FROMCOLOR
(0x02)
Pen int Specifies the pen pattern (numbers
between 0 and 7).
Constants are provided for pen
patterns 0, 7 and 15, as follows:
• Constants.FV_FILL_BLACK (0)
• Constants. FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
PrevGraphicInFrame FMObject Denotes the previous graphic object
in the frame.
PrevGraphicInGroup FMObject Denotes the previous graphic object
in the group.
Runaround int Specifies whether text can flow
around the object and, if so, whether
the text follows the contour of the
object or a box shape surrounding
the object. The possible values are:
• Constants.FV_TR_NONE (0x01)
• Constants.FV_TR_CONTOUR
(0x02)
• Constants.FV_TR_BBOX (0x03)
Property name Data Type Description
532
ROW
CHAPTER 5 OBJECT REFERENCE
RoundRect methods
Delete, GetProps, ObjectValid, SetProps.
5.81. Row
RunaroundGap int Denotes the width of the runaround
gap, if the object is a runaround
object.
TailArrow int Set to 1 if the arrowhead is enabled
at the begining of the line; Set to 0
otherwise.
TintPercent int Specifies the tint percentage.
Unique int Indicates the graphic object's internal
unique number.
Width int Denotes the width of the object. The
permissible range is from 0.125
points to 3600 points.
Property name Data Type Description
CondFmtIsShown int 1 if the condition is shown.
Element Element The ID of the element containing the
row in a FrameMaker document.
FirstCellInRow Cell First cell in row (FO_Cell ID).
Height int Height of the row.
InCond Objects Condition tags for row (array of
FO_CondFmt IDs).
LocX int Offset from the left side of the text
frame containing the row.
LocY int Offset from the top of the page frame
containing the row.
NextRowInTbl Row Next row (FO_Row ID) in the table.
Property name Data Type Description
533
ROW
CHAPTER 5 OBJECT REFERENCE
PrevRowInTbl Row Previous row (FO_Row ID) in the
table.
RowIsShown int 1 if the conditional row is shown.
RowKeepWithNext int 1 if Keep With Next Row is enabled.
RowKeepWithPrev int 1 if Keep With Previous Row is
enabled.
RowMaxHeight int Maximum row height.
RowMinHeight int Minimum row height.
RowStart int Denotes the row placement. The
value is one of:
• Constants.FV_ROW_ANY-
WHERE (0)
• Constants.FV_ROW_TOP_OF_COL (
1)
• Constants.FV_ROW_TOP_OF_PAGE
(2)
• Constants.FV_ROW_TOP_OF_LEFT_
PAGE (3)
• Constants.FV_ROW_TOP_OF_RIGHT
_PAGE (4)
RowTbl Tbl Table containing the row (FO_Tbl ID).
RowType int Type of row. The value is one of:
• Constants.FV_ROW_HEADING
(0)
• Constants.FV_ROW_BODY (1)
• Constants.FV_ROW_FOOTING
(2)
SepOverride Color Color separation format override
(FO_Color ID).
Property name Data Type Description
534
RUBI
CHAPTER 5 OBJECT REFERENCE
Row methods
AddRows, Delete, GetProps, ObjectValid, SetProps.
5.82. Rubi
StyleOverrides int Style condition indicators for
conditional text:
• Constants.FV_CS_NO_OVER-
RIDE (0x00)
• Constants.FV_CS_OVERLINE
(0x01)
• Constants.FV_CS_STRIKE-
THROUGH (0x02)
• Constants.FV_CS_SINGLE_UNDER-
LINE (0x04)
• Constants.FV_CS_DOUBLE_UNDER-
LINE (0x08)
All style condition indicators are
represented as hatched lines for the
table rows.
UseSepOverride int 1 if the SepOverride property
overrides default from the table.
Width int Width of the row.
Property name Data Type Description
Element Element The object handle of the associated
FO_Element for the rubi group
element, if the rubi group is in a
structured document.
OyamojiTextRange TextRange The text range that the oyamoji text
encompasses.
NextRubiInDoc Rubi The next instance of a rubi composite
(FO_Rubi ID) in the document..
Property name Data Type Description
535
RULINGFMT
CHAPTER 5 OBJECT REFERENCE
Rubi methods
Delete, GetProps, GetText2, ObjectValid, SetProps.
5.83. RulingFmt
RubiElement Element The object handle of the associated
FO_Element for the rubi element, if
the rubi group is in a structured
document.
RubiTextRange TextRange The text range that the rubi text
encompasses.
Unique int The rubi composite’s unique ID.
Property name Data Type Description
Name string Ruling format name.
NextRulingFmtInDoc RulingFmt Next ruling format in document
(FO_RulingFmt ID).
Pen int Specifies the pen pattern (numbers
between 0 and 7).
Constants are provided for pen
patterns 0, 7 and 15, as follows:
• Constants.FV_FILL_BLACK (0)
• Constants. FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
RulingGap int Gap between double ruling lines
(0.015 pt to 360 pt).
RulingLines int Number of ruling lines (0 to 2 lines).
RulingPenWidth int Ruling line thickness (0.015 pt to 360
pt).
RulingSep Color Spot color of ruling format (FO_Color
ID).
Property name Data Type Description
536
STRINGS
CHAPTER 5 OBJECT REFERENCE
RulingFmt methods
Delete, GetProps, ObjectValid, SetProps.
5.84. Strings
An Array of objects with integer indexing and a length property.
Strings methods
concat, pop, push.
5.85. SubCol
Property name Data Type Description
length number The length of the array
Property name Data Type Description
ContentHeight int The distance between the top of the
column and the baseline of the last
line in the column.
FirstAFrame AFrame First anchored frame in the column
(FO_AFrame ID).
FirstCell Cell First table cell in the column (FO_Cell
ID).
FirstFn Fn First footnote in the column (FO_Fn
ID).
FirstPgf Pgf First paragraph in the column (FO_Pgf
ID).
FrameParent TextFrame ID of text frame that contains the
column (FO_TextFrame ID).
Height int Column Height.
LastAFrame AFrame Last anchored frame in the column
(FO_AFrame ID).
LastCell Cell Last table cell in the column (FO_Cell
ID).
537
TAB
CHAPTER 5 OBJECT REFERENCE
SubCol methods
Delete, GetProps, GetText, ObjectValid, SetProps.
5.86. Tab
LastFn Fn Last footnote in the column (FO_Fn
ID).
LastPgf Pgf Last paragraph in the column (FO_Pgf
ID).
LocX int Offset from left side of the text frame
that contains the column.
LocY int Offset from top of text frame that
contains the column.
NextSubCol SubCol Next column in the flow.
Overflowed int 1 if the text frame containing the
column has Autoconnect turned off
and text overflows the column.
ParentTextFrame TextFrame ID of text frame that contains the
column (FO_TextFrame ID).
PrevSubCol SubCol Previous column in the flow.
Unique int Text column’s unique ID.
UserString string A string to which clients can store
private data.
Width int Column width.
Property name Data Type Description
xint Offset from the left margin.
Property name Data Type Description
538
TABS
CHAPTER 5 OBJECT REFERENCE
Tab methods
Tab.
5.87. Tabs
An Array of Tab objects with integer indexing and a length property.
type uint Type of tab. The value is one of:
• Constants.FV_TAB_LEFT (0x1) -
Left tab.
• Constants.FV_TAB_CENTER
(0x2) - Center tab.
• Constants.FV_TAB_RIGHT (0x3)
- Right tab.
• Constants.FV_TAB_DECIMAL
(0x4) - Decimal tab.
• Constants.FV_TAB_RELA-
TIVE_LEFT (0x5) - Relative left
tab (allowed only for format
change lists).
• Constants.FV_TAB_RELA-
TIVE_CENTER (0x6) - Relative
center tab (allowed only for
format change lists).
• Constants.FV_TAB_RELA-
TIVE_RIGHT (0x7) - Relative
right tab (allowed only for
format change lists).
• Constants.FV_TAB_RELATIVE_DEC-
IMAL (0x8) - Relative decimal
tab (allowed only for format
change lists).
leader string String that appears before the tab.
decimal uint Character to align the tab around (For
example “,”).
Property name Data Type Description
539
TBL
CHAPTER 5 OBJECT REFERENCE
Tabs methods
concat, pop, push.
5.88. Tbl
Property name Data Type Description
length number The length of the array
Property name Data Type Description
ContentHeight int The height of the table title.
Locked int 1 if the table is part of a text inset
that retains formatting information
from the source document. The table
is not affected by global formatting
performed on the document.
OrphanRows int Number of orphan rows.
Overflowed int 1 if the table has cells that are not
shown because they extend beyond
the text frame boundaries.
TblAlignment int Horizontal placement of table. The
value is one of:
• Constants.FV_ALIGN_TBL_LEFT
(0)
• Constants.FV_ALIGN_T-
BL_CENTER (1)
• Constants.FV_ALIGN_T-
BL_RIGHT (2)
TblCellBottomMargin int Default bottom cell margin for the
table.
TblCellLeftMargin int Default left cell margin for the table.
TblCellRightMargin int Default right cell margin for the table.
TblCellTopMargin int Default top cell margin for the table.
TblLeftIndent int Left indent for the table.
540
TBL
CHAPTER 5 OBJECT REFERENCE
TblInLockedTi bool 1 if the table is in a locket text inset.
You should not use the ESTK to delete
table elements when the table is in a
locket text inset.
TblPlacement int Vertical placement of table on page.
The value is one of:
• Constants.FV_TBL_ANYWHERE
(0)
• Constants.FV_T-
BL_TOP_OF_COL (1)
• Constants.FV_T-
BL_TOP_OF_PAGE (2)
• Constants.FV_T-
BL_TOP_OF_LEFT_PAGE (3)
• Constants.FV_T-
BL_TOP_OF_RIGHT_PAGE (4)
• Constants.FV_TBL_FLOAT (5)
TblRightIndent int Right indent for the table.
TblSpaceAbove int Vertical space above the table.
TblSpaceBelow int Vertical space below the table.
TextLoc TextLoc The text location of the table’s
anchor.
Unique int The table’s unique ID.
FirstRowInTbl Row First row in the table (FO_Row ID).
LastRowInTbl Row Last row in the table (FO_Row ID).
NextTblInDoc Tbl Next table (FO_Tbl ID) in the
document.
TblCatalogEntry int 1 if the table’s format is in the Table
Catalog.
TblColWidths Metrics List of column widths.
Property name Data Type Description
541
TBL
CHAPTER 5 OBJECT REFERENCE
TblNumbering int Direction of autonumbering for the
table. The value is one of:
• Constants.FV_T-
BL_NUM_BY_ROW (0)
• Constants.FV_T-
BL_NUM_BY_COL (1)
TblNumCols int Number of colums in the table.
TblNumRows int Number of rows in the table.
TblTag string Name of the table format.
TblWidth int Horizontal width of the table.
TblBodyRowRuling RulingFmt Ruling applied to body rows specified
by TblBodyRowRulingPeriod
(FO_RulingFmt ID).
TblBodyRowRulingPeriod int The periodicity of the ruling specified
byTblBodyRowRuling.For
example, if
TblBodyRowRulingPeriodis set
to 3, the ruling specified by
TblBodyRowRulingis applied to
every third row.
TblBottomRuling int Ruling applied to the bottom of the
table (FO_RulingFmt ID).
TblColRuling RulingFmt Ruling applied to table columns
specified by
TblColRulingPeriod
(FO_RulingFmt ID).
TblColRulingPeriod int The periodicity of the ruling specified
by TblColRuling.
For example, if
TblColRulingPeriod is set to 2,
the ruling specified by
TblColRuling is applied to every
other column.
TblHFRowRuling RulingFmt Ruling for table heading and footing
rows (FO_RulingFmt ID).
TblHFSeparatorRuling RulingFmt Separator ruling for table heading
and footing rows (FO_RulingFmt ID).
Property name Data Type Description
542
TBL
CHAPTER 5 OBJECT REFERENCE
TblLastBodyRuling int 1 if Draw Bottom Ruling on Last
Sheet Only is enabled (FO_RulingFmt
ID).
TblLeftRuling RulingFmt Ruling for the left side of the table
(FO_RulingFmt ID).
TblOtherBodyRowRuling RulingFmt Ruling for body rows that are not
specified by
TblBodyRowRulingPeriod
(FO_RulingFmt ID).
TblOtherColRuling RulingFmt Ruling for columns that are not
specified by
TblColRulingPeriod
(FO_RulingFmt ID).
TblRightRuling RulingFmt Ruling for the right side of the table
(FO_RulingFmt ID).
TblTopRuling RulingFmt Ruling for the top of the table
(FO_RulingFmt ID).
BottomRowSelection Row Bottom body row in selection, if table
is selected (FO_Row ID).
LeftColNum int Number of the leftmost selected
column, if a table is selected
(columns are numbered from left to
right, starting with 0).
RightColNum int Number of rightmost selected
column, if a table is selected
(columns are numbered from left to
right, starting with 0).
TblTitleSelected int 1 if table title is selected.
TopRowSelection Row Top row in selection, if table is
selected (FO_Row ID).
TblBodyFirstColor Color First spot color for table body
(FO_Color ID).
TblBodyFirstFill int First fill pattern for table body.
Property name Data Type Description
543
TBL
CHAPTER 5 OBJECT REFERENCE
TblBodyFirstPeriod int Number of columns or body rows to
which the first fill pattern (specified
by TblBodyFirstFill) is
applied.
TblBodyNextColor Color Exception color for columns or body
rows (FO_Color ID).
TblBodyNextFill int Exception fill pattern for table body.
TblBodyNextPeriod int Number of columns or body rows to
which the exception fill pattern
(specified by TblBodyNextFill)
is applied.
TblBodyShadeBy int 1 if Shade By is set to Columns; 0 if
Shade By is set to Rows.
TblHFColor Color Color for table heading and footing.
TblHFFill int Fill pattern for table heading and
footing (integer percentage).
Element Element Denotes the element associated with
the table.
TblBodyElement Element Specifies the element containing the
table’s body rows.
TblElement Element Specifies the element containing the
table.
TblFooterElement Element Denotes the element containing the
table’s footer rows.
TblHeaderElement Element Denotes the element containing the
table’s header rows.
TblTitleElement Element Indicates the element containing the
table title.
FirstPgf Pgf The first paragraph in the title, if the
table has a title.
Property name Data Type Description
544
TBL
CHAPTER 5 OBJECT REFERENCE
HighestLevelElement Element Specifies the title’s highest-level
element if the table is in a structured
document and has a title.
NOTE: HighestLevelElement is
obsolete but is supported for
backward compatibility.
LastPgf Pgf The last paragraph in the title, if the
table has a title.
TblTitleGap int Gap between the title and top or
bottom row of the table.
TblTitlePosition int The placement of the table title. The
value is one of:
• Constants.FV_TBL_NO_TITLE (0)
- Table has no title
• Constants.FV_TBL_TI-
TLE_ABOVE (1) - The title
appears above the table
• Constants.FV_TBL_TITLE_-
BELOW (2) - The title appears
below the table
Direction int Set or get the direction of the
document. Possible values:
•Constants.FV_DIR_Inherit
- Inherit the direction of the
parent
•Constants.FV_DIR_LTR -
Left-to-right
•FV_DIR_RTL - Right-to-left
ResolvedDirection int Get the inherited direction of the
document. Possible values:
•Constants.FV_DIR_LTR -
Left-to-right
•FV_DIR_RTL - Right-to-left
UserString string A string to which clients can store
private data.
Property name Data Type Description
545
TBLFMT
CHAPTER 5 OBJECT REFERENCE
Tbl methods
AddCols, Delete, DeleteCols, DeleteRows, GetTableColumnByColNum, GetProps, MakeTblSelection,
ObjectValid, SetProps.
5.89. TblFmt
Property name Data Type Description
OrphanRows int Number of orphan rows.
TblAlignment int Horizontal placement of table. The
value is one of:
• Constants.FV_ALIGN_TBL_LEFT
(0)
• Constants.FV_ALIGN_T-
BL_CENTER (1)
• Constants.FV_ALIGN_T-
BL_RIGHT (2)
TblCellBottomMargin int Bottom margin of table cell.
TblCellLeftMargin int Left margin of the table cell.
TblCellRightMargin int Right margin of the table cell.
TblCellTopMargin int Top margin of the table cell.
TblLeftIndent int Left indent of the table cell.
TblPlacement int Vertical placement of table on page.
The value is one of:
• Constants.FV_TBL_ANYWHERE
(0)
• Constants.FV_T-
BL_TOP_OF_COL (1)
• Constants.FV_T-
BL_TOP_OF_PAGE (2)
• Constants.FV_T-
BL_TOP_OF_LEFT_PAGE (3)
• Constants.FV_T-
BL_TOP_OF_RIGHT_PAGE (4)
• Constants.FV_TBL_FLOAT (5)
TblRightIndent int Right indent of the table.
546
TBLFMT
CHAPTER 5 OBJECT REFERENCE
TblSpaceAbove int Vertical space above the table.
TblSpaceBelow int Vertical space below the table.
TblTitleGap int Gap between title and top or bottom
row.
TblTitlePosition int The placement of the table title. The
value is one of:
• Constants.FV_TBL_NO_TITLE (0)
- Table has no title
• Constants.FV_TBL_TI-
TLE_ABOVE (1) - The title
appears above the table
• Constants.FV_TBL_TITLE_-
BELOW (2) - The title appears
below the table
TblCatalogEntry int 1 if format is in the Table Catalog.
Name string Name of the paragraph format of the
table title.
NextTblFmtInDoc TblFmt Next table format in the document
(FO_TblFmt ID).
TblNumbering int Direction of autonumbering for the
table. The value is one of:
• Constants.FV_T-
BL_NUM_BY_ROW (0)
• Constants.FV_T-
BL_NUM_BY_COL (1)
TblTag string Name of the table format
TblInitNumBodyRows int Number of body rows for new table
TblInitNumCols int Number of columns for new table
TblInitNumFRows int Number of footing rows for new table
TblInitNumHRows int Number of heading rows for new
table
TblBodyRowRuling RulingFmt Ruling for body rows that are not
specified by
TblBodyRowRulingPeriod
(FO_RulingFmt ID).
Property name Data Type Description
547
TBLFMT
CHAPTER 5 OBJECT REFERENCE
TblBodyRowRulingPeriod int The periodicity of the ruling specified
by TblOtherBodyRowRuling.
For example, if
TblBodyRowRulingPeriod is
set to 3, the ruling specified by
TblOtherBodyRowRuling is
applied to every third row.
TblBottomRuling RulingFmt Ruling for the bottom of the table
(FO_RulingFmt ID).
TblColRuling RulingFmt Ruling for columns that are not
specified by
TblColRulingPeriod
(FO_RulingFmt ID).
TblColRulingPeriod int The periodicity of the ruling specified
by TblOtherColRuling. For
example, if
TblColRulingPeriod is set to 2,
the ruling specified by
TblOtherColRuling is applied
to every other column.
TblHFRowRuling RulingFmt Ruling for the heading and footing
rows (FO_RulingFmt ID).
TblHFSeparatorRuling RulingFmt Separator ruling for the table heading
and footing rows
(FO_RulingFmtID).
TblLastBodyRuling int 1 if Draw Bottom Ruling on Last Sheet
Only is enabled (FO_RulingFmt
ID).
TblLeftRuling RulingFmt Ruling for the left side of the table
(FO_RulingFmt ID).
TblOtherBodyRowRuling RulingFmt Ruling applied to body rows specified
by TblBodyRowRulingPeriod
(FO_RulingFmt ID).
TblOtherColRuling RulingFmt Ruling applied to table columns
specified by
TblColRulingPeriod
(FO_RulingFmt ID).
Property name Data Type Description
548
TBLFMT
CHAPTER 5 OBJECT REFERENCE
TblRightRuling RulingFmt Ruling for the right side of the table
(FO_RulingFmt ID).
TblTopRuling RulingFmt Ruling for the top of the table
(FO_RulingFmt ID).
TblBodyFirstColor Color First spot color for table body
(FO_Color ID)
TblBodyFirstFill int First fill pattern for table body
TblBodyFirstPeriod int Number of columns or body rows to
which the first fill pattern (specified
by TblBodyFirstFill) is applied
TblBodyNextColor Color Exception color for columns or body
rows (FO_Color ID)
TblBodyNextFill int Exception fill pattern for table body
TblBodyNextPeriod int Number of columns or body rows to
which the exception fill pattern
(specified by TblBodyNextFill)
is applied
TblBodyShadeBy int 1if Shade By is set to Columns; 0 if
Shade By is set to Rows
TblHFColor Color Color for table heading and footing
TblHFFill int Fill pattern for table heading and
footing (integer percentage)
Direction int Set or get the direction of the
document. Possible values:
•Constants.FV_DIR_Inherit
- Inherit the direction of the
parent
•Constants.FV_DIR_LTR -
Left-to-right
•FV_DIR_RTL - Right-to-left
ResolvedDirection int Get the inherited direction of the
document. Possible values:
•Constants.FV_DIR_LTR -
Left-to-right
•FV_DIR_RTL - Right-to-left
Property name Data Type Description
549
TEXTFRAME
CHAPTER 5 OBJECT REFERENCE
TblFmt methods
Delete, GetProps, ObjectValid, SetProps.
5.90. TextFrame
UserString string A string to which clients can store
private data.
Property name Data Type Description
ColGapWidth int Gap between columns (0 to 50
inches).
ColumnsAreBalanced int 1 if terminal and underfilled columns
in the flow are balanced.
FirstAFrame AFrame First anchored frame in the text
frame (FO_AFrame ID).
FirstCell Cell First table cell in the text frame
(FO_Cell ID).
FirstFn Fn First footnote in the text frame
(FO_Fn ID).
FirstPgf Pgf First paragraph in the text frame
(FO_Pgf ID).
FirstSubCol SubCol First column in the text frame
(FO_SubCol ID).
Flow Flow Flow containing the text frame
(FO_Flow ID).
GraphicIsButton int 1 if the text frame is a hypertext
button.
LastAFrame AFrame Last anchored frame in the text frame
(FO_AFrame ID).
LastCell Cell Last table cell in the text frame
(FO_Cell ID).
LastFn Fn Last footnote in the text frame
(FO_Fn ID).
Property name Data Type Description
550
TEXTFRAME
CHAPTER 5 OBJECT REFERENCE
LastPgf Pgf Last paragraph in the text frame
(FO_Pgf ID).
LastSubCol SubCol Last column in the text frame
(FO_SubCol ID).
NextTextFrameInFlow TextFrame Next text frame in the flow
(FO_TextFrame ID).
NumColumns int The number of columns in the
underlying column grid (1–10).
PrevTextFrameInFlow TextFrame Previous text frame in the flow
(FO_TextFrame ID).
SideHeadGap int Gap between side head area and
body text area (0 to 50 inches).
SideHeadPlacement int Placement of side heads relative to
columns in the text frame:
• Constants.FV_SH_LEFT (0x00)
• Constants.FV_SH_RIGHT (0x01)
• Constants.FV_SH_INSIDE (0x02)
• Constants.FV_SH_OUTSIDE
(0x03)
SideHeadWidth int Width of side head area for the text
frame (0 to 50 inches).
Angle int Indicates the angle of rotation of the
graphic object.
ArrowBaseAngle int Denotes the arrowhead base angle in
degrees.
ArrowLength int Denotes the arrowhead length
(always rounded down to the nearest
1/256 point).
ArrowScaleFactor int Indicates the factor by which the
arrowhead is scaled as line width
changes (always rounded down to
nearest 1/16 point). It is not used if
the ArrowScaleHead property is
False.
Property name Data Type Description
551
TEXTFRAME
CHAPTER 5 OBJECT REFERENCE
ArrowScaleHead int Set to 1 if arrowhead is scaled as the
line width changes. Set to 0,
otherwise.
ArrowTipAngle int Denotes the arrowhead tip angle in
degrees.
ArrowType int Denotes the style of the arrowhead.
Possible values are:
• Constants.FV_ARROW_STICK
(0x1)
• Constants.FV_AR-
ROW_HOLLOW (0x2)
• Constants.FV_ARROW_FILLED
(0x3)
BorderWidth int Indicates the border width specified
in points. The permissible range is
0.015 pt to 360 points.
Color Color Denotes the spot color.
Dash Metrics Specifies a dash pattern that is
repeated for the length of an object's
border. The pattern is stored in a
MetricsT structure. The 0th element
of the MetricsT.MetricsT_val array
stores the length of the first dash; the
1st element stores the following
space; the 2nd element stores the
next dash; and so on for an even
number of elements.
Fill int Denotes the fill pattern (numbers
between 0 and 15).
Constants are provided for fill
patterns 0, 7 and 15, as follows:
• Constants.FV_FILL_BLACK (0)
• Constants.FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
FrameParent FMObject Denotes the frame containing the
graphic object.
Property name Data Type Description
552
TEXTFRAME
CHAPTER 5 OBJECT REFERENCE
GraphicCantBeSelected int Set to 1 if the graphic object cannot
be selected. Set to 0, otherwise.
GraphicIsSelected int Set to 1, if the graphic object is
selected. Else, set to 0.
GroupParent Group Specifies the group to which the
object belongs.
Note: Anchored frames do NOT have
this property.
HeadArrow int Set to 1 if the line has an arrow head.
Set to 0, otherwise.
Height int Denotes the height of the object
denoted in points. The permissible
range is from 0.125 points to 3600
points.
HotspotCmdStr StringT The command string for a hotspot.
Thismust be a valid hypertext
command string.
HotspotTitle StringT The tooltip text for the hotspot in the
outputs that support it (for example
HTML). This property is 0ptional.
IsHotspot Bool Whether the object is a hotspot or
not. If this property is turned off, the
object is no longer a hotspot even if
command string is non-empty.
LineCap int Specifies the type of the end of the
line. The possible values are:
• Constants.FV_CAP_BUTT (0x00)
• Constants.FV_CAP_ROUND
(0x01)
• Constants.FV_CAP_SQUARE
(0x02)
Property name Data Type Description
553
TEXTFRAME
CHAPTER 5 OBJECT REFERENCE
LocX int Specifies the distance of the object
from the left side of the parent frame
(in inches). The permissible range is –
216 inches to 216 inches.
If the graphic object is an anchored
frame, the distance is automatically
calculated from the left side of the
page frame. You cannot set this value
manually for anchored frames.
LocY int Distance of the object from the top of
the parent frame (in inches) The
permissible range is –216 inches to
216 inches.
If the graphic object is an anchored
frame, the distance is automatically
calculated from the top of the page
frame. You cannot set this value
manually for anchored frames.
NextGraphicInDoc FMObject Denotes the next graphic object in
the document.
NextGraphicInFrame FMObject Denotes the next graphic object in
the frame.
NextGraphicInGroup FMObject Denotes the next graphic object in
the group.
NextSelectedGraphicInDoc FMObject Denotes the next selected graphic
object in the document.
ObjectAttributes Strings A list of strings. Each string expresses
an attribute that is specified for an
anchored frame in the Object
Properties > Object Attributes dialog
box. Each string is in the form of
string_text.You can use the backslash
to escape characters such as \n, \r, or
\t for newline, carriage return, and
tab, respectively. For a backslash
character in the string text, type \\.
Property name Data Type Description
554
TEXTFRAME
CHAPTER 5 OBJECT REFERENCE
Overprint int Specifies the overprint settings for
the object. The possible values are:
• Constants.FV_KNOCKOUT
(0x00)
• Constants.FV_OVERPRINT
(0x01)
• Constants.FV_FROMCOLOR
(0x02)
Pen int Specifies the pen pattern (numbers
between 0 and 7).
Constants are provided for pen
patterns 0, 7 and 15, as follows:
• Constants.FV_FILL_BLACK (0)
• Constants. FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
PrevGraphicInFrame FMObject Denotes the previous graphic object
in the frame.
PrevGraphicInGroup FMObject Denotes the previous graphic object
in the group.
Runaround int Specifies whether text can flow
around the object and, if so, whether
the text follows the contour of the
object or a box shape surrounding
the object. The possible values are:
• Constants.FV_TR_NONE (0x01)
• Constants.FV_TR_CONTOUR
(0x02)
• Constants.FV_TR_BBOX (0x03)
RunaroundGap int Denotes the width of the runaround
gap, if the object is a runaround
object.
TailArrow int Set to 1 if the arrowhead is enabled
at the begining of the line; Set to 0
otherwise.
TintPercent int Specifies the tint percentage.
Unique int Indicates the graphic object's internal
unique number.
Property name Data Type Description
555
TEXTITEM
CHAPTER 5 OBJECT REFERENCE
TextFrame methods
Delete, GetProps, GetText, ObjectValid, SetProps.
5.91. TextItem
The type of Text Item is one of the following:
Width int Denotes the width of the object. The
permissible range is from 0.125
points to 3600 points.
Property name Data Type Description
offset int Offset from the beginning of the
paragraph or the text line.
dataType int Type of the text item.
sdata string Denotes the text item if the text item
is a string.
idata number ID of the object if the text item is an
object,.
obj any Denotes the text item if the text item
is an object.
Text Item Type Text Item Represents Text Item Data
FTI_TextObjId The object to which the offsets of
all the text items are relative.
FO_Pgf, FO_Cell, FO_TextLine,
FO_TiApiClient, FO_TiFlow,
FO_TiText, or FO_TiTextTable
FTI_String A string of characters with the
same condition and character
format.
A character string
FTI_LineBegin The beginning of a line. -
Property name Data Type Description
556
TEXTITEM
CHAPTER 5 OBJECT REFERENCE
FTI_LineEnd The end of a line and the line end
type.
If the line end is a normal line end,
the value is 0;
if it is a forced line end, the
FTI_HardLineEnd flag is set;
if it is a hyphen line end, the
FTI_HyphenLineEnd flag is set
FTI_PgfBegin The beginning of a paragraph. FO_Pgf
FTI_PgfEnd The end of a paragraph. FO_Pgf
FTI_FlowBegin The beginning of a flow. FO_Flow
FTI_FlowEnd The end of a flow. FO_Flow
FTI_PageBegin The beginning of a page. FO_Page
FTI_PageEnd The end of a page. FO_Page
FTI_SubColBegin The beginning of a column. FO_SubCol
FTI_SubColEnd The end of a column. FO_SubCol
FTI_FrameAnchor An anchored frame. FO_AFrame
FTI_FnAnchor A footnote. FO_Fn
FTI_TblAnchor A table. FO_Tbl
FTI_MarkerAnchor A marker. FO_Marker
FTI_XRefBegin The beginning of a cross-reference. FO_XRef
FTI_XRefEnd The end of a cross-reference. FO_XRef
FTI_TextFrameBeg
in
The beginning of a text frame. FO_TextFrame
FTI_TextFrameEnd The end of a text frame. FO_TextFrame
FTI_VarBegin The beginning of a variable. FO_Var
FTI_VarEnd The end of a variable. FO_Var
FTI_ElementBegin The beginning of a container
structural element.
FO_Element
FTI_ElementEnd The end of a container structural
element.
FO_Element
FTI_ElemPrefixBeg
in
The beginning of an element’s
prefix.
FO_Element
Text Item Type Text Item Represents Text Item Data
557
TEXTITEM
CHAPTER 5 OBJECT REFERENCE
The following table lists the flags for FTI_CharPropsChange. These flags indicate which properties
have changed.
FTI_ElemPrefixEnd The end of an element’s prefix. FO_Element
FTI_ElemSuffixBeg
in
The beginning of an element’s
suffix.
FO_Element
FTI_ElemSuffixEnd The end of an element’s suffix. FO_Element
FTI_CharPropsCha
nge
A change in the text properties. Flags indicating which properties
have changed (see the following
table).
FTI_RubiComposit
eBegin
The beginning of a rubi composite
(and the beginning of oyamoji
text).
FO_Rubi
FTI_RubiComposit
eEnd
The end of a rubi composite. FO_Rubi
FTI_RubiTextBegin The beginning of rubi text (and the
end of oyamoji text).
FO_Rubi
FTI_RubiTextEnd The end of rubi text. FO_Rubi
Flags Meaning
FTF_ALL OR of all the flags
FTF_ANGLE The font angle has changed.
FTF_CAPITALIZATION The capitalization has changed.
FTF_CHANGEBAR The change bars have changed.
FTF_CHARTAG The Character Catalog format has changed.
FTF_COLOR The color has changed.
FTF_CONDITIONTAG The condition tag has changed.
FTF_ENCODING The text encoding has changed,
FTF_FAMILY The font family has changed.
FTF_IIF An internal flag having to do with Asian text. input. If there is a
non-zero value for this flag, a front-end processor is controlling that
text and you should not modify the associated text item.
FTF_KERNX The kern-x characteristic has changed.
Text Item Type Text Item Represents Text Item Data
558
TEXTITEMS
CHAPTER 5 OBJECT REFERENCE
5.92. TextItems
An Array of TextItem objects with integer indexing and a length property.
TextItems methods
concat, pop, push.
FTF_KERNY The kern-x characteristic has changed.
FTF_LANGUAGE Character language has changed.
FTF_OUTLINE The outline characteristic has changed.
FTF_OVERLINE The overline characteristic has changed.
FTF_PAIRKERN The pair kerning has changed.
FTF_POSITION The character position has changed.
FTF_SHADOW The shadow characteristic has changed.
FTF_SIZE The font size has changed.
FTF_SPREAD The font spread has changed.
FTF_STRETCH The font stretch value has changed.
FTF_STRIKETHROUGH The strikethrough characteristic has changed.
FTF_TSUME The Tsume setting has changed.
FTF_UNDERLINING The underlining has changed.
FTF_VARIATION The font variation has changed.
FTF_WEIGHT The font weight has changed.
Property name Data Type Description
length number The length of the array
Flags Meaning
559
TEXTLINE
CHAPTER 5 OBJECT REFERENCE
5.93. TextLine
Property name Data Type Description
BasePointX int Horizontal placement of text line
base point relative to left side of the
frame.
BasePointY int Vertical placement of text line base
point relative to top of the frame.
560
TEXTLINE
CHAPTER 5 OBJECT REFERENCE
Language int Hyphenation and Spell Checking
language to use.
• Constants.FV_LANG_NOLAN-
GUAGE (0x00)
• Constants.FV_LANG_ENGLISH
(0x01)
• Constants.FV_LANG_BRITISH
(0x02)
• Constants.FV_LANG_GERMAN
(0x03)
• Constants.FV_LANG_SWISS_-
GERMAN (0x04)
• Constants.FV_LANG_FRENCH
(0x05)
• Constants.FV_LANG_CANADIAN_-
FRENCH (0x06)
• Constants.FV_LANG_SPANISH
(0x07)
• Constants.FV_LANG_CATALAN
(0x08)
• Constants.FV_LANG_ITALIAN
(0x09)
• Constants.FV_LANG_FINNISH
(0x10)
• Constants.FV_LANG_SWEDISH
(0x11)
• Constants.FV_LANG_JAPANESE
(0x12)
• Constants.FV_LANG_TRADITION-
AL_CHINESE (0x13)
• Constants.FV_LANG_SIMPLI-
FIED_CHINESE (0x14)
• Constants.FV_LANG_KOREAN
(0x15)
• Constants.FV_LANG_PORTU-
GUESE (0x0A)
• Constants.FV_LANG_BRA-
ZILIAN (0x0B)
• Constants.FV_LANG_DANISH
(0x0C)
• Constants.FV_LANG_DUTCH
(0x0D)
• Constants.FV_LANG_NORWE-
GIAN (0x0E)
•
Constants FV LANG NYNORSK
Property name Data Type Description
561
TEXTLINE
CHAPTER 5 OBJECT REFERENCE
TextLineType int Type of text line. The value is one of:
• Constants.FV_TEXTLINE_LEFT
(0)
• Constants.FV_TEXTLINE_RIGHT
(1)
• Constants.FV_TEXT-
LINE_CENTER (2)
• Constants.FV_TEXTLINE_MATH
(3)
Angle int Indicates the angle of rotation of the
graphic object.
ArrowBaseAngle int Denotes the arrowhead base angle in
degrees.
ArrowLength int Denotes the arrowhead length
(always rounded down to the
nearemichael.and.st 1/256 point).
ArrowScaleFactor int Indicates the factor by which the
arrowhead is scaled as line width
changes (always rounded down to
nearest 1/16 point). It is not used if
the ArrowScaleHead property is
False.
ArrowScaleHead int Set to 1 if arrowhead is scaled as the
line width changes. Set to 0,
otherwise.
ArrowTipAngle int Denotes the arrowhead tip angle in
degrees.
ArrowType int Denotes the style of the arrowhead.
Possible values are:
• Constants.FV_ARROW_STICK
(0x1)
• Constants.FV_AR-
ROW_HOLLOW (0x2)
• Constants.FV_ARROW_FILLED
(0x3)
Property name Data Type Description
562
TEXTLINE
CHAPTER 5 OBJECT REFERENCE
BorderWidth int Indicates the border width specified
in points. The permissible range is
0.015 pt to 360 points.
Color Color Denotes the spot color.
Dash Metrics Specifies a dash pattern that is
repeated for the length of an object's
border. The pattern is stored in a
MetricsT structure. The 0th element
of the MetricsT.MetricsT_val array
stores the length of the first dash; the
1st element stores the following
space; the 2nd element stores the
next dash; and so on for an even
number of elements.
Fill int Denotes the fill pattern (numbers
between 0 and 15).
Constants are provided for fill
patterns 0, 7 and 15, as follows:
• Constants.FV_FILL_BLACK (0)
• Constants.FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
FrameParent FMObject Denotes the frame containing the
graphic object.
GraphicCantBeSelected int Set to 1 if the graphic object cannot
be selected. Set to 0, otherwise.
GraphicIsSelected int Set to 1, if the graphic object is
selected. Else, set to 0.
GroupParent Group Specifies the group to which the
object belongs.
Note: Anchored frames do NOT have
this property.
HeadArrow int Set to 1 if the line has an arrow head.
Set to 0, otherwise.
Height int Denotes the height of the object
denoted in points. The permissible
range is from 0.125 points to 3600
points.
Property name Data Type Description
563
TEXTLINE
CHAPTER 5 OBJECT REFERENCE
HotspotCmdStr StringT The command string for a hotspot.
Thismust be a valid hypertext
command string.
HotspotTitle StringT The tooltip text for the hotspot in the
outputs that support it (for example
HTML). This property is 0ptional.
IsHotspot Bool Whether the object is a hotspot or
not. If this property is turned off, the
object is no longer a hotspot even if
command string is non-empty.
LineCap int Specifies the type of the end of the
line. The possible values are:
• Constants.FV_CAP_BUTT (0x00)
• Constants.FV_CAP_ROUND
(0x01)
• Constants.FV_CAP_SQUARE
(0x02)
LocX int Specifies the distance of the object
from the left side of the parent frame
(in inches). The permissible range is –
216 inches to 216 inches.
If the graphic object is an anchored
frame, the distance is automatically
calculated from the left side of the
page frame. You cannot set this value
manually for anchored frames.
LocY int Distance of the object from the top of
the parent frame (in inches) The
permissible range is –216 inches to
216 inches.
If the graphic object is an anchored
frame, the distance is automatically
calculated from the top of the page
frame. You cannot set this value
manually for anchored frames.
NextGraphicInDoc FMObject Denotes the next graphic object in
the document.
NextGraphicInFrame FMObject Denotes the next graphic object in
the frame.
Property name Data Type Description
564
TEXTLINE
CHAPTER 5 OBJECT REFERENCE
NextGraphicInGroup FMObject Denotes the next graphic object in
the group.
NextSelectedGraphicInDoc FMObject Denotes the next selected graphic
object in the document.
ObjectAttributes Strings A list of strings. Each string expresses
an attribute that is specified for an
anchored frame in the Object
Properties > Object Attributes dialog
box. Each string is in the form of
string_text.You can use the backslash
to escape characters such as \n, \r, or
\t for newline, carriage return, and
tab, respectively. For a backslash
character in the string text, type \\.
Overprint int Specifies the overprint settings for
the object. The possible values are:
• Constants.FV_KNOCKOUT
(0x00)
• Constants.FV_OVERPRINT
(0x01)
• Constants.FV_FROMCOLOR
(0x02)
Pen int Specifies the pen pattern (numbers
between 0 and 7).
Constants are provided for pen
patterns 0, 7 and 15, as follows:
• Constants.FV_FILL_BLACK (0)
• Constants. FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
PrevGraphicInFrame FMObject Denotes the previous graphic object
in the frame.
PrevGraphicInGroup FMObject Denotes the previous graphic object
in the group.
Property name Data Type Description
565
TEXTLINE
CHAPTER 5 OBJECT REFERENCE
Runaround int Specifies whether text can flow
around the object and, if so, whether
the text follows the contour of the
object or a box shape surrounding
the object. The possible values are:
• Constants.FV_TR_NONE (0x01)
• Constants.FV_TR_CONTOUR
(0x02)
• Constants.FV_TR_BBOX (0x03)
RunaroundGap int Denotes the width of the runaround
gap, if the object is a runaround
object.
TailArrow int Set to 1 if the arrowhead is enabled
at the begining of the line; Set to 0
otherwise.
TintPercent int Specifies the tint percentage.
Unique int Indicates the graphic object's internal
unique number.
Width int Denotes the width of the object. The
permissible range is from 0.125
points to 3600 points.
Direction int Set or get the direction of the
document. Possible values:
•Constants.FV_DIR_Inherit
- Inherit the direction of the
parent
•Constants.FV_DIR_LTR -
Left-to-right
•Constants.FV_DIR_RTL -
Right-to-left
ResolvedDirection int Get the inherited direction of the
document. Possible values:
•Constants.FV_DIR_LTR -
Left-to-right
•Constants.FV_DIR_RTL -
Right-to-left
Property name Data Type Description
566
TEXTLOC
CHAPTER 5 OBJECT REFERENCE
TextLine methods
Delete, GetProps, GetText, ObjectValid, SetProps.
5.94. TextLoc
TextLoc methods
TextLoc.
5.95. TextRange
TextRange methods
TextRange.
5.96. TiApiClient
Property name Data Type Description
obj any The object containing text.
offset int Characters from the start of the
object.
Property name Data Type Description
beg TextLoc The beginning of the text range.
end TextLoc The end of the text range.
Property name Data Type Description
TiClientData string Data used by the client (for example,
an SQL query).
TiClientName string The registered name of the client that
created the inset.
567
TIAPICLIENT
CHAPTER 5 OBJECT REFERENCE
TiClientSource string The name that appears as the source
in the Text Inset Properties dialog
box.
TiClientType string The name that appears as the source
type in the Text Inset Properties
dialog box.
TiIsUnresolved int 1 if the inset is unresolved. A client
should set this property to 0 if it is
unable to resolve the inset.
ImportHint string Record identifying the filter used to
import the text. The FrameMaker
product uses this record to find the
filter to use when updating the inset.
TiLocked int 1 if the inset is locked. To change an
inset’s contents, you must unlock it.
Always relock an inset after you have
finished changing its contents.
Name string A name assigned to the inset by an
FDK client. It is not automatically
assigned by the FrameMaker product.
NextTiInDoc FMObject The ID of the next text inset in the list
of text insets in the document
(Constants.FO_TiApiClient,
Constants.FO_TiText,
Constants.FO_TiTextTable,
or Constants.FO_TiFlow ID).
TextRange TextRange The text range, in the document
containing the text inset, occupied by
the text inset.
TiAutomaticUpdate int 1 if the inset is updated
automatically. TiAutomaticUpdate
has no effect if the document’s
DontUpdateTextInsets property is set
to True.
TiFile string Path of the source file.
TiFileModDate string The modification date of the text
inset’s source file.
Property name Data Type Description
568
TIFLOW
CHAPTER 5 OBJECT REFERENCE
TiApiClient methods
ConvertToText, Delete, DeletePropByName, DeleteTextInsetContents, GetProps, GetText, ObjectValid,
SetProps, UpdateTextInset.
5.97. TiFlow
LastUpdate int Time when the inset was last
updated, expressed in seconds since
1 January, 1970.
Unique int The text inset’s UID.
Property name Data Type Description
TiFlowName string The name of the imported flow if
TiMainFlow is False.
TiFlowPageSpace int The type of pages the imported flow
is on:
• Constants.FV_BODY_PAGE(0x00)
• Constants.FV_REFER-
ENCE_PAGE (0x02)
TiFormat int Source of the imported text’s format:
• Constants.FV_SourceDoc (0) -
The text is formatted with
formats from the source docu-
ment.
• Constants.FV_EnclosingDoc (1) -
The text is formatted with
formats from the document into
which it is imported.
• Constants.FV_PlainText (2) - The
text is formatted as plain text.
TiMainFlow int 1 if the inset text is imported from
the main flow of the source
document.
Property name Data Type Description
569
TIFLOW
CHAPTER 5 OBJECT REFERENCE
TiRemovePageBreaks int 1 if page breaks are removed from
the text when TiFormat is set to
Constants.FV_EnclosingDoc
(1).
TiRemoveOverrides int 1 if format overrides are removed
from the text when TiFormat is set
to
Constants.FV_EnclosingDoc
(1).
ImportHint string Record identifying the filter used to
import the text. The FrameMaker
product uses this record to find the
filter to use when updating the inset.
TiLocked int 1 if the inset is locked. To change an
inset’s contents, you must unlock it.
Always relock an inset after you have
finished changing its contents.
Name string A name assigned to the inset by an
FDK client. It is not automatically
assigned by the FrameMaker product.
NextTiInDoc FMObject The ID of the next text inset in the list
of text insets in the document
(Constants.FO_TiApiClient
(64), Constants.FO_TiText
(62),
Constants.FO_TiTextTable
(63), or Constants.FO_TiFlow
(61) ID ).
TextRange TextRange The text range, in the document
containing the text inset, occupied by
the text inset.
TiAutomaticUpdate int 1 if the inset is updated
automatically.
TiAutomaticUpdate has no
effect if the document’s
DontUpdateTextInsets
property is set to True.
TiFile string Path of the source file.
Property name Data Type Description
570
TITEXT
CHAPTER 5 OBJECT REFERENCE
TiFlow methods
ConvertToText, Delete, DeletePropByName, DeleteTextInsetContents, GetProps, GetText, ObjectValid,
SetProps, UpdateTextInset.
5.98. TiText
TiFileModDate string The modification date of the text
inset’s source file.
LastUpdate int Time when the inset was last
updated, expressed in seconds since
1 January, 1970.
Unique int The text inset’s UID.
Property name Data Type Description
TiEOLisEOP int 1 if line ends in the imported text file
are treated as paragraph ends.
TiTextEncoding string The ImportHintString for the
text inset. If this property is not set to
Constants.FO_TiText (62)
or
Constants.FO_TiTextTable
(63), the string is null.
ImportHint string Record identifying the filter used to
import the text. The FrameMaker
product uses this record to find the
filter to use when updating the inset.
TiLocked int 1 if the inset is locked. To change an
inset’s contents, you must unlock it.
Always relock an inset after you have
finished changing its contents.
Name string A name assigned to the inset by an
ESTK client. It is not automatically
assigned by the FrameMaker product.
Property name Data Type Description
571
TITEXTTABLE
CHAPTER 5 OBJECT REFERENCE
TiText methods
ConvertToText, Delete, DeletePropByName, DeleteTextInsetContents, GetProps, GetText, ObjectValid,
SetProps, UpdateTextInset.
5.99. TiTextTable
NextTiInDoc FMObject The ID of the next text inset in the list
of text insets in the document
(Constants.FO_TiApiClient(
64), Constants.FO_TiText (62),
Constants.FO_TiTextTable
(63), or Constants.FO_TiFlow
(61) ID ).
TextRange TextRange The text range, in the document
containing the text inset, occupied by
the text inset.
TiAutomaticUpdate int 1 if the inset is updated
automatically.
TiAutomaticUpdate has no
effect if the document’s
DontUpdateTextInsets
property is set to True.
TiFile string Path of the source file.
TiFileModDate string The modification date of the text
inset’s source file.
LastUpdate int Time when the inset was last
updated, expressed in seconds since
1 January, 1970.
Unique int The text inset’s UID.
Property name Data Type Description
TiByRows int 1 if each paragraph in the imported
text is converted to a row of table
cells; False if each paragraph in the
imported text is converted to a table
cell.
Property name Data Type Description
572
TITEXTTABLE
CHAPTER 5 OBJECT REFERENCE
TiTblTag string The table format tag of the imported
table
TiHeadersEmpty int 1if the imported text is not used to
fill the heading rows.
TiNumSeparators int If TiSeparator specifies a space,
the number of spaces used as a
separator to parse the text into table
cells.
TiSeparator string If TiByRows is True, a string
specifying a separator, such as a tab,
used to parse the text into table cells.
TiNumCols int If TiByRows is False, the number
of columns in the table.
TiNumHeaderRows int The number of heading rows in the
table.
TiTextEncoding string The ImportHintString for the
text inset. If this property is not set to
Constants.FO_TiText (62) or
Constants.FO_TiTextTable
(63), the string is null.
ImportHint string Record identifying the filter used to
import the text. The FrameMaker
product uses this record to find the
filter to use when updating the inset.
TiLocked int 1 if the inset is locked. To change an
inset’s contents, you must unlock it.
Always relock an inset after you have
finished changing its contents.
Name string A name assigned to the inset by an
FDK client. It is not automatically
assigned by the FrameMaker product.
Property name Data Type Description
573
TYPEDVAL
CHAPTER 5 OBJECT REFERENCE
TiTextTable methods
ConvertToText, Delete, DeletePropByName, DeleteTextInsetContents, GetProps, GetText, ObjectValid,
SetProps, UpdateTextInset.
5.100. TypedVal
NextTiInDoc FMObject The ID of the next text inset in the list
of text insets in the document
(Constants.FO_TiApiClient
(64), Constants.FO_TiText
(62),
Constants.FO_TiTextTable
(63), or Constants.FO_TiFlow
(61) ID ).
TextRange TextRange The text range, in the document
containing the text inset, occupied by
the text inset.
TiAutomaticUpdate int 1 if the inset is updated
automatically.
TiAutomaticUpdate has no
effect if the document’s
DontUpdateTextInsets
property is set to True.
TiFile string Path of the source file.
TiFileModDate string The modification date of the text
inset’s source file.
LastUpdate int Time when the inset was last
updated, expressed in seconds since
1 January, 1970.
Unique int The text inset’s UID.
Property name Data Type Description
valType int The type of value. See the following
table.
sval string String value.
Property name Data Type Description
574
TYPEDVALS
CHAPTER 5 OBJECT REFERENCE
5.101. TypedVals
An Array of TypedVal objects with integer indexing and a length property.
TypedVals methods
concat, pop, push.
ssval Strings Set of strings.
msval Metrics Set of metrics.
psval Points Set of points.
tsval Tabs Set of tabs.
tlval TextLoc Text location.
trval TextRange Text range.
adsval AttributeD
efs
Set of attribute definitions
asval Attribute A single attribute definition
csval ElementCat
alogEntrie
s
Element Catalog values.
isval Ints Set of integers.
osval Objects
uisval UInts Set of unsigned integers.
valsval TypedVals Set of TypedVal entries.
obj any Set of objects.
ival int An integer.
Property name Data Type Description
length number The length of the array
Property name Data Type Description
575
UBYTES
CHAPTER 5 OBJECT REFERENCE
5.102. UBytes
An Array ofobjects with integer indexing and a length property.
UBytes methods
concat, pop, push.
5.103. UInts
An Array ofobjects with integer indexing and a length property.
UInts methods
concat, pop, push.
5.104. UnanchoredFrame
Property name Data Type Description
length number The length of the array
Property name Data Type Description
length number The length of the array
Property name Data Type Description
Name string The name of the frame.
PageFramePage FMObject The page that the unanchored frame
belongs to, if the unanchored frame
is a page frame. The page can be one
of:FO_HiddenPage, FO_BodyPage,
FO_MasterPage, or FO_RefPage ID.
FirstGraphicInFrame FMObject First object in the frame (backmost
object).
LastGraphicInFrame FMObject Last object in the frame (frontmost
object).
Angle int Indicates the angle of rotation of the
graphic object.
576
UNANCHOREDFRAME
CHAPTER 5 OBJECT REFERENCE
ArrowBaseAngle int Denotes the arrowhead base angle in
degrees.
ArrowLength int Denotes the arrowhead length
(always rounded down to the nearest
1/256 point).
ArrowScaleFactor int Indicates the factor by which the
arrowhead is scaled as line width
changes (always rounded down to
nearest 1/16 point). It is not used if
the ArrowScaleHead property is
False.
ArrowScaleHead int Set to 1 if arrowhead is scaled as the
line width changes. Set to 0,
otherwise.
ArrowTipAngle int Denotes the arrowhead tip angle in
degrees.
ArrowType int Denotes the style of the arrowhead.
Possible values are:
• Constants.FV_ARROW_STICK
(0x1)
• Constants.FV_AR-
ROW_HOLLOW (0x2)
• Constants.FV_ARROW_FILLED
(0x3)
BorderWidth int Indicates the border width specified
in points. The permissible range is
0.015 pt to 360 points.
Color Color Denotes the spot color.
Dash Metrics Specifies a dash pattern that is
repeated for the length of an object's
border. The pattern is stored in a
MetricsT structure. The 0th element
of the MetricsT.MetricsT_val array
stores the length of the first dash; the
1st element stores the following
space; the 2nd element stores the
next dash; and so on for an even
number of elements.
Property name Data Type Description
577
UNANCHOREDFRAME
CHAPTER 5 OBJECT REFERENCE
Fill int Denotes the fill pattern (numbers
between 0 and 15).
Constants are provided for fill
patterns 0, 7 and 15, as follows:
• Constants.FV_FILL_BLACK (0)
• Constants.FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
FrameParent FMObject Denotes the frame containing the
graphic object.
GraphicCantBeSelected int Set to 1 if the graphic object cannot
be selected. Set to 0, otherwise.
GraphicIsSelected int Set to 1, if the graphic object is
selected. Else, set to 0.
GroupParent Group Specifies the group to which the
object belongs.
Note: Anchored frames do NOT have
this property.
HeadArrow int Set to 1 if the line has an arrow head.
Set to 0, otherwise.
Height int Denotes the height of the object
denoted in points. The permissible
range is from 0.125 points to 3600
points.
HotspotCmdStr StringT The command string for a hotspot.
Thismust be a valid hypertext
command string.
HotspotTitle StringT The tooltip text for the hotspot in the
outputs that support it (for example
HTML). This property is 0ptional.
IsHotspot Bool Whether the object is a hotspot or
not. If this property is turned off, the
object is no longer a hotspot even if
command string is non-empty.
Property name Data Type Description
578
UNANCHOREDFRAME
CHAPTER 5 OBJECT REFERENCE
LineCap int Specifies the type of the end of the
line. The possible values are:
• Constants.FV_CAP_BUTT (0x00)
• Constants.FV_CAP_ROUND
(0x01)
• Constants.FV_CAP_SQUARE
(0x02)
LocX int Specifies the distance of the object
from the left side of the parent frame
(in inches). The permissible range is –
216 inches to 216 inches.
If the graphic object is an anchored
frame, the distance is automatically
calculated from the left side of the
page frame. You cannot set this value
manually for anchored frames.
LocY int Distance of the object from the top of
the parent frame (in inches) The
permissible range is –216 inches to
216 inches.
If the graphic object is an anchored
frame, the distance is automatically
calculated from the top of the page
frame. You cannot set this value
manually for anchored frames.
NextGraphicInDoc FMObject Denotes the next graphic object in
the document.
NextGraphicInFrame FMObject Denotes the next graphic object in
the frame.
NextGraphicInGroup FMObject Denotes the next graphic object in
the group.
NextSelectedGraphicInDoc FMObject Denotes the next selected graphic
object in the document.
Property name Data Type Description
579
UNANCHOREDFRAME
CHAPTER 5 OBJECT REFERENCE
ObjectAttributes Strings A list of strings. Each string expresses
an attribute that is specified for an
anchored frame in the Object
Properties > Object Attributes dialog
box. Each string is in the form of
string_text.You can use the backslash
to escape characters such as \n, \r, or
\t for newline, carriage return, and
tab, respectively. For a backslash
character in the string text, type \\.
Overprint int Specifies the overprint settings for
the object. The possible values are:
• Constants.FV_KNOCKOUT
(0x00)
• Constants.FV_OVERPRINT
(0x01)
• Constants.FV_FROMCOLOR
(0x02)
Pen int Specifies the pen pattern (numbers
between 0 and 7).
Constants are provided for pen
patterns 0, 7 and 15, as follows:
• Constants.FV_FILL_BLACK (0)
• Constants. FV_FILL_WHITE (7)
• Constants.FV_FILL_CLEAR (15)
PrevGraphicInFrame FMObject Denotes the previous graphic object
in the frame.
PrevGraphicInGroup FMObject Denotes the previous graphic object
in the group.
Runaround int Specifies whether text can flow
around the object and, if so, whether
the text follows the contour of the
object or a box shape surrounding
the object. The possible values are:
• Constants.FV_TR_NONE (0x01)
• Constants.FV_TR_CONTOUR
(0x02)
• Constants.FV_TR_BBOX (0x03)
Property name Data Type Description
580
VAR
CHAPTER 5 OBJECT REFERENCE
UnanchoredFrame methods
Delete, GetProps, ObjectValid, SetProps.
5.105. Var
RunaroundGap int Denotes the width of the runaround
gap, if the object is a runaround
object.
TailArrow int Set to 1 if the arrowhead is enabled
at the begining of the line; Set to 0
otherwise.
TintPercent int Specifies the tint percentage.
Unique int Indicates the graphic object's internal
unique number.
Width int Denotes the width of the object. The
permissible range is from 0.125
points to 3600 points.
Property name Data Type Description
Element Element The element associated with the
variable, if the variable is in a
FrameMaker document.
Locked int 1 if the variable is included in a text
inset that gets its formatting from the
source document. The variable is not
affected by global formatting
performed on the document.
NextVarInDoc Var Next variable instance (FO_Var ID) in
the document.
TextRange TextRange The text range the variable instance
encompasses.
VarFmt VarFmt The variable instance’s format
(FO_VarFmt ID).
Unique int The variable’s unique ID.
Property name Data Type Description
581
VARFMT
CHAPTER 5 OBJECT REFERENCE
Var methods
Delete, GetProps, GetText, ObjectValid, SetProps.
5.106. VarFmt
UserString string A string to which clients can store
private data.
Property name Data Type Description
Fmt string The variable format definition; the
building blocks and text strings used
to create a variable instance with the
variable format.
Name string The variable format’s name.
NextVarFmtInDoc VarFmt Next variable format (FO_VarFmt ID)
in the document’s list of variable
formats.
Property name Data Type Description
582
VARFMT
CHAPTER 5 OBJECT REFERENCE
SystemVar int The variable format’s type.
The following types specify system
variable formats:
• Constants.FV_VAR_CUR-
RENT_PAGE_NUM (1)
• Constants.FV_VAR_PAGE_COUNT (2
)
• Constants.FV_VAR_CURRENT_-
DATE_LONG (3)
• Constants.FV_VAR_CURRENT_-
DATE_SHORT (4)
• Constants.FV_VAR_MODIFICA-
TION_DATE_LONG (5)
• Constants.FV_VAR_MODIFICA-
TION_DATE_SHORT (6)
• Constants.FV_VAR_CREATION_-
DATE_LONG (7)
• Constants.FV_VAR_CREATION_-
DATE_SHORT (8)
• Constants.FV_VAR_-
FILE_NAME_LONG (9)
• Constants.FV_VAR_-
FILE_NAME_SHORT (10)
• Constants.FV_VAR_HEADER_-
FOOTER_1 (11) through
Constants.FV_VAR_HEADER_-
FOOTER_4 (14)
• Constants.FV_VAR_TABLE_CONTIN-
UATION (15)
• Constants.FV_VAR_TABLE_SHEET (1
6)
• Constants.FV_VAR_HEADER_-
FOOTER_5 (19) through
Constants.FV_VAR_HEADER_-
FOOTER_12 (26)
The following type specifies user
defined formats:
Constants.FV_VAR_USER_VARIABLE
(0) - A user defined variable format.
Property name Data Type Description
583
XREF
CHAPTER 5 OBJECT REFERENCE
VarFmt methods
Delete, GetProps, ObjectValid, SetProps.
5.107. XRef
Property name Data Type Description
Element Element The associated element, if the cross
reference is in a FrameMaker
document.
Locked int 1 if the cross-reference is part of a
text inset that retains formatting
information from the source
document.
The cross-reference is not affected by
global formatting performed on the
document.
NextXRefInDoc XRef Next cross-reference instance in
document (FO_XRef ID).
TextRange TextRange Text range that the cross-reference
instance encompasses.
Unique int The cross-reference’s unique ID.
UserString string A string to which clients can store
private data.
XRefFmt XRefFmt ID of the cross-reference’s format
(FO_XrefFmt ID).
XRefFile string The filename of the file containing
the cross-reference source. If the
cross-reference source is in the same
document as the cross reference, the
filename is an empty string ("").
584
XREF
CHAPTER 5 OBJECT REFERENCE
XRefIsUnresolved int 1 if FrameMaker was unable to
resolve the cross-reference the last
time it updated crossreferences.
NOTE: This property is set only when
FrameMaker updates
cross-references. Changes to the
document, in and of themselves, do
not affect this property.
XRefSrcText string If XRefSrcIsElem is False, the
XRefSrcTex property is a string
specifying UID:pgf_tag:text,
where UIDrepresents the unique ID
for the paragraph, pgf_tag is the
name of the paragraph format, and
text is the text content of the
paragraph.If XRefSrcIsElem is
True, the XRefSrcTex property is a
string specifying
UID:src_name:text, where UID
is the value of the ID attribute of the
source element, name is the element
tag, and text is text content of the
source element.
XRefSrcIsElem int 1 if the cross-reference source is a
FrameMaker structural element.
XRefSrcElemNonUniqueId string If XRefSrcIsElem is True, this is
a string specifying the value of @id of
the source element inside the
element identified by the Unique ID
in XRefSrcText. This is required in
cases where the Id of the source
element is not a Unique ID.
XRefAltText string Alternate text for display as the
cross-reference link text. This is given
preference, if present, over the
earlier behavior of getting text from
the source.
XRefClientName string The registered name of the client that
created the cross-reference.
Property name Data Type Description
585
XREFFMT
CHAPTER 5 OBJECT REFERENCE
XRef methods
Delete, GetProps, GetText, ObjectValid, SetProps.
5.108. XRefFmt
XRefFmt methods
Delete, GetProps, ObjectValid, SetProps.
5.109. app
XRefClientType string The identifier for specifying the
source type for thecross-reference.
Property name Data Type Description
Fmt string The cross-reference format (a string
that specifies text and building
blocks).
Name string The cross-reference format’s name.
NextXRefFmtInDoc XRefFmt Denotes the next cross-reference
format (FO_XRefFmt ID).
Property name Data Type Description
ActiveBook Book The book with input focus (FO_Book
ID).
ActiveDoc Doc The document with input focus
(FO_Doc ID).
ActiveView string Sets the current view. The view can
be one of:
WYSIWYG View
Author View
XML View
ApplyFormatRules int 1 if element reformatting is enabled.
Property name Data Type Description
586
APP
CHAPTER 5 OBJECT REFERENCE
AddMarkerTypeToStandardMarkers string The name of a marker type to add to
the standard list of marker types. Use
SetString() to set a marker type
name to this property of the
Constants.FV_SessionId(0)
.
AutoBackup int 1 if Automatic Backup is enabled.
AutoSave int 1 if Automatic Save is enabled.
AutoSaveSeconds int Time between automatic saves in
seconds (60 seconds to 10800
seconds).
Displaying int False if screen refresh is completely
turned off.
DisplayName string The name of the display on which the
FrameMaker product session is
running.
DefaultKeyCatalog Doc Default Key Catalog for the current
workflow.
Workflow values:
KeyCatalogWorkflowAuthoring
KeyCatalogWorkflowPublishing
KeyCatalogWorkflowSearchIng
FirstKeyCatalogInSession Doc First Key Catalog in the session.
KeyCatalogWorkflow int Current workflow related to Key
Catalogs.
IsTempOpenSave int Gets whether temporary open/save is
in progress. Temporary open/save
happens during view switching
operations.
ExportFilters string List of export filters available in the
current session.
FirstCommandInSession Command First command in the list of
commands in the session
(FO_Command ID).
Property name Data Type Description
587
APP
CHAPTER 5 OBJECT REFERENCE
FirstMenuItemInSession FMObject First menu item or menu in the list of
menus, menu items, and menu item
separators in the session
(Constants.FO_Command (56),
Constants.FO_Menu (55),
Constants.FO_MenuItemSepa
rator (57) ID).
FirstOpenBook Book First open book (FO_Book ID) in
session.
FirstOpenDoc Doc First open document (FO_DocID) in
session.
BinDir string Directory path of $FMHOME/bin.
CurrentDir string Name of the directory from which the
FrameMaker product was started
CurrentMenuSet int Type of menu set. The value is one of:
• Constants.FV_MENU_QUICK (1)
• Constants.FV_MENU_COM-
PLETE (2)
• Constants.FV_MENU_CUSTOM
(3)
HelpDir string Path of the FrameMaker product help
directory
HomeDir string Path of $FMHOME
UserSettingsDir string Name of the FrameMaker app
directory. As defined by:
%appdata%\Adobe\FrameMake
r\<version number>
Returns the HomeDir if the app
directory is not found.
iportFilters string List of import filters available in the
current session.
InitDir string Directory path of
$FMHOME/fminit
FontAngleNames Strings List of font angles available in the
current session.
Property name Data Type Description
588
APP
CHAPTER 5 OBJECT REFERENCE
FontFamilyAttributes Ints An array of flags that indicate
attributes for each font family listed
by FontFamilyNames. This array of
integers is indexed the same as the
list of font family names, and
corresponds directly to that list. Each
Int is a packed field; the high order 16
bits indicate a surrogate font, and the
low order bits indicate attributes for
the font family. The flags, their mask
values, and their meaning follow:
• Constants.FV_FAMILY_VISIBLE
(0x00000001) - Family is visible
in menu.
• Constants.FV_FAMILY_SELECT-
ABLE (0x00000002) - Family can
be selected in menu.
• Constants.FV_FAMILY_-
MAPPED (0x00000004) - Family
is always mapped to another
family.
• Constants.FV_FAMILY_SURRO-
GATE (0xFFFF0000): The family
mapped to, if
Constants.FV_FAMILY_-
MAPPED (0x00000004) is True.
FontFamilyNames Strings List of font family names available in
the current session. This list does not
include combined fonts.
FontVariationNames Strings List of font variations available in the
current session.
FontWeightNames Strings List of font weights available in the
current session.
Gravity int 1 if Gravity is turned on for the
session.
GreekSize int Size at which to greek text.
HostName string Name of the host computer.
Property name Data Type Description
589
APP
CHAPTER 5 OBJECT REFERENCE
IconBarOn int 1 if the four icons that appear on the
upper-right side of the document
window are on. Changing this
property affects only the documents
that are opened subsequently; it
does not affect documents that are
already open.
IsIconified int 1 if the FrameMaker product window
is iconified.
IsInFront int 1 if the FrameMaker product window
is in front of other application
windows. You can use this property
to bring the FrameMaker product to
the front or back.
IsOnScreen int 1 if the FrameMaker product window
is visible on the screen.
Label string The title in the FrameMaker product
window title bar.
Property name Data Type Description
590
APP
CHAPTER 5 OBJECT REFERENCE
Language int Product language. The value is one
of:
• Constants.FV_LANG_NOLAN-
GUAGE (0x00)
• Constants.FV_LANG_ENGLISH
(0x01)
• Constants.FV_LANG_BRITISH
(0x02)
• Constants.FV_LANG_GERMAN
(0x03)
• Constants.FV_LANG_FRENCH
(0x05)
• Constants.FV_LANG_SPANISH
(0x07)
• Constants.FV_LANG_ITALIAN
(0x09)
• Constants.FV_LANG_SWEDISH
(0x11)
• Constants.FV_LANG_JAPANESE
(0x12)
• Constants.FV_LANG_TRADITION-
AL_CHINESE (0x13)
• Constants.FV_LANG_SIMPLI-
FIED_CHINESE (0x14)
• Constants.FV_LANG_KOREAN
(0x15)
MarkerNames Strings List of standard marker types for the
current session. For versions prior to
5.5, this property returned the list of
all marker types for the current
session. In version 5.5, marker types
are assigned to the document; use
the MarkerTypeNames property
of Constants.FO_Doc (4) to get
the full list of marker types.
OpenDir string Directory in which FrameMaker is
installed.
Path string Path to search to start the
FrameMaker product.
Property name Data Type Description
591
APP
CHAPTER 5 OBJECT REFERENCE
Platform string Name of the platform on which the
current session is running.
ProductIsDemo bool 1 if the current session is for a demo
version of FrameMaker.
ProductIsStructured bool 1 if FrameMaker is running in
structured mode for the current
session.
ProductName string The FrameMaker product name. The
names for FrameMaker+SGML
indicate FrameMaker running under
the structured product interface.
FrameViewer is retained for
backward compatibility. Can be one
of:
• FrameMaker
• FrameMaker+SGML
•FrameViewer
•DemoMaker
•DemoMaker+SGML
ProductFamily string The FrameMaker product family
name.:
• FrameMaker
• FrameMaker XML Author
ViewQuickAccessBar int 1 if the QuickAccess bar is visible.
ViewFormattingBar int 1 if the formatting bar is visible.
Reformatting int 1 if reformatting is enabled.
RememberMissingFontNames int 1 if Remember Missing Font Names is
activated.
ScreenHeight int Height of the FrameMaker product
window in pixels.
ScreenWidth int Width of the FrameMaker product
window in pixels.
Property name Data Type Description
592
APP
CHAPTER 5 OBJECT REFERENCE
ScreenX int The offset of the FrameMaker
product window in pixels from the
left side of the screen. If you set a
value that would result in the product
window being off the screen, that
value is ignored and the old value is
retained.
ScreenY int The offset of the FrameMaker
product window in pixels from the
top of the screen. If you set a value
that would result in the product
window being off the screen, that
value is ignored and the old value is
retained.
SgmlDir string Directory path of
$FMHOME/structure/sgml.
Snap int 1 if Snap is turned on for the session.
StructureDir string Directory path of
$FMHOME/structure.
TmpDir string Path of the temporary directory for
internal FrameMaker product
processes; the directory specified by
the DOS $TEMP environment
variable.
UserLogin string User login name.
UserName string User name.
Validating int 1 if validation is enabled
(FrameMaker only).
VersionMajor int Frame version number (before the
decimal).
VersionMinor int Frame version number (after the
decimal).
WindowSystem string Name of window system that the
FrameMaker product is running
under.
XmlDir string Directory path of
$FMHOME/structure/xml.
Property name Data Type Description
593
APP
CHAPTER 5 OBJECT REFERENCE
DoNotGenerateErrorLog int When1, the FrameMaker error log is
not generated.
NoFlashInPDF bool When True, the Flash content in the
PDF becomes static. When False,
Flash objects get embedded in the
PDF and are playable. Default is
False.
No3DInPDF bool When True, the 3D objects in the
generated PDF become
2-dimensional. When False, 3D
objects get embedded in the PDF and
do not become 2 dimensional.
Default is False.
DontShowWelcomeScreen bool True when FrameMaker is set not to
show the Welcome screen.
EnableAutoSpellCheck bool When True, Auto Spell Check is
enabled.
AllowNewFileURL bool When True, allows usage of
file:/and file: URLs for
referring to a file.
CharacterReferencesOnXMLExport bool When True, if there are
leading/trailing whitespaces (spaces
and tabs) in elements, save the
whitespaces as character references
to enable round-tripping. Else set to
False.
Default: False
DoNotExportInvalidXML bool When True, FrameMaker does not
save the XML on disk if there are
validation errors during XML export.
DoNotExportInvalidXML bool When True, FrameMaker does not
save the XML on disk if there are
validation errors during XML export.
SuppressXMLParserWarnings bool When True, the warning messages
about duplicate declarations in
DTD/Schema do not appear in the
FrameMaker log.
Property name Data Type Description
594
APP
CHAPTER 5 OBJECT REFERENCE
app methods
Close, GetNamedBook, GetNamedCommand, GetNamedMenu, GetNamedMenuItemSeparator,
GetNamedObject, GetProps, NewNamedBook, NewNamedCommand, NewNamedMenu, NewNamed-
MenuItemSeparator, NewNamedObject, ObjectValid, SetProps.
RemoveExtraWhiteSpacesOnXMLImp
ort
bool When True, the extra while spaces
are removed while importing XML.
NoMultiMediaInPDF bool When True, the Rich Media (audio
and video) objects in the PDF become
static. When False, Rich Media
objects get embedded in the PDF and
are playable. Default is False.
Property name Data Type Description
595
AFRAME
CHAPTER 6 FUNCTION SUMMARY
6. Function Summary
6.1. AFrame
Delete
Description
The Delete() method is used to delete an object from a document. When you delete an object that
contains another object, all child objects are also deleted with the parent object. For example, if you
delete a frame, all objects within the frame are also deleted.
The Delete() method does not take any arguments.
The method returns FE_SUCCESS on success, else returns one of the following values in FA_errno:
Returns
int
Syntax
Delete()
Error Reason
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_BadObjId
(-3)
Invalid object.
Constants.FE_BadDelet
e (-17)
Specified object could not be deleted.
Constants.FE_BadOper
ation (-27)
Function call specified an illegal operation.
Constants.FE_BadPara
meter (-43)
Function call specified an invalid parameter.
Constants.FE_NotMenu
(72)
Object is a menu item but the document to delete does not belong to
the menu.
596
AFRAME
CHAPTER 6 FUNCTION SUMMARY
GetProps
Description
The GetProps() method retrieves the complete property list for a specified object.
The GetProps() method takes no arguments.
The method returns a PropVals object that contains an array of property-value pairs, on success.
If the GetProps() method fails, it sets the len field of the returned structure to 0 and assigns one of
the following values to FA_errno.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
TheSetProps() method sets the properties of a specified object.
The method takes one argument - An array containing the values of the object to be set.
The method does not return anything on success.
On failure, the method returns one of the following values to FA_errno:
Error Reason
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_BadObjId
(-3)
Invalid object.
Constants.FE_WrongPr
oduct (-60)
Current FrameMaker version does not support the specified
operation.
Error Reason
Constants.FE_BadDocId(-2) Invalid document.
Constants.FE_BadName (-33) Specified name is illegal.
Constants.FE_BadNewFrame (-14) The method cannot move the specified object to this
frame.
597
AFRAME
CHAPTER 6 FUNCTION SUMMARY
Constants.FE_BadNewGroup (-15) The method cannot move the specified object to this
graphic object group (FO_Group).
Constants.FE_BadNewSibling (-16) Object cannot be made a sibling of the specified object.
Constants.FE_BadObjId (-3) Invalid object.
Constants.FE_BadPropNum (-4) Specified property number is invalid.
Constants.FE_BadPropType (-5) Incorrect property type for this function.
Constants.FE_BadRange (-36) Specified text range is invalid.
Constants.FE_CantSmooth (-38) Object cannot be smoothed.
Constants.FE_DupName (-32) Property cannot be set to this name because it is already
used by another object.
Constants.FE_GenRuleAmbiguous
(-55)
General rule in structured document is ambiguous.
Constants.FE_GenRuleConnectorEx
pected (-57)
General rule in structured document is missing a
connector.
Constants.FE_GenRuleItemExpecte
d (-51)
General rule in structured document is missing a rule
item.
Constants.FE_GenRuleLeftBracketE
xpected (-53)
General rule in structured document is missing a left
bracket.
Constants.FE_GenRuleMixedConne
ctors (-52)
General rule in structured document has mixed
connectors.
Constants.FE_GenRuleRightBracket
Expected (-54)
General rule in structured document is missing a right
bracket.
Constants.FE_GenRuleSyntaxError
(-56)
General rule in structured document has a syntax error.
Constants.FE_GroupSelect (-9) The method cannot select or deselect an object in the
specified group.
Constants.FE_HiddenPage (-40) The specified value must be a hidden page
(FO_HiddenPage).
Constants.FE_InvContextSpec () The method encountered an invalid context specification
in a FrameMaker document.
Constants.FE_NotBookComponent
(-26)
The specified value must be a book component
(FO_BookComponent).
Constants.FE_NotFrame (-12) The specified value must be a frame.
Error Reason
598
AFRAME
CHAPTER 6 FUNCTION SUMMARY
Returns
Void
Syntax
SetProps(setVal)
Parameters
Constants.FE_NotGraphic (-11) The specified value must be a graphic object.
Constants.FE_NotGroup (-13) The specified value must be a graphic object group
(FO_Group).
Constants.FE_NotTextFrame (-39) The specified value must be a text column
(FO_TextFrame).
Constants.FE_NotTextObject (-41) The specified object must be a text object, such as a
paragraph (FO_Pgf) or a flow (FO_Flow).
Constants.FE_OffsetNotFound (-21) Offset specified for the text location could not be found
in the specified paragraph or text line.
Constants.FE_OutOfRange (-7) Specified property value is out of the legal range for the
specified property.
Constants.FE_PageFrame (-37) The specified value must be a page frame object
(FO_UnanchoredFrame).
Constants.FE_ReadOnly (-6) Property is read-only.
Constants.FE_WithinFrame (-10) The specified object must first be moved to a different
frame.
Constants.FE_WrongProduct (-60) The current FrameMaker version does not support this
operation.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list
Error Reason
599
ARC
CHAPTER 6 FUNCTION SUMMARY
ObjectValid
Description
Indicates whether an object is valid or not.
The method does not take any arguments.
The method returns 1 if the object is valid, else returns 0.
Returns
int
Syntax
ObjectValid()
6.2. Arc
Delete
Description
Deletes the Arc object.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
The GetProps() method retrieves the properties of the Arc object.
See SetProps under the AFrame class for more information.
Returns
PropVals
600
ARC
CHAPTER 6 FUNCTION SUMMARY
Syntax
GetProps()
SetProps
Description
The SetProps() method sets the properties of the Arc object.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the Arc object is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
601
ATTRCONDEXPR
CHAPTER 6 FUNCTION SUMMARY
6.3. AttrCondExpr
ApplyAttributeExpression
Description
ApplyAttributeExpression() is the method to apply the attribute expression to the document.
The method returns FE_Success on success.
Returns
int
Syntax
ApplyAttributeExpression()
GetProps
Description
The GetProps() method gets the properties of the specified attribute expression.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
The SetProps() method sets the properties of the specified attribute expression.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
602
ATTRIBUTE
CHAPTER 6 FUNCTION SUMMARY
Parameters
ObjectValid
Description
Returns 1 if the attribute expression is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.4. Attribute
Attribute
Description
Describes a single attribute.
Returns
Attribute
Syntax
Attribute(name, values, valflags, allow)
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
603
ATTRIBUTEDEF
CHAPTER 6 FUNCTION SUMMARY
Parameters
6.5. AttributeDef
AttributeDef
Description
Describes a single attribute function.
Returns
AttributeDef
Syntax
AttributeDef(name, required, flags, attrType, choices, defValues,
rangeMin, rangeMax)
Parameters
Parameter name
Data
Type
Option
al Description
name strin
g
No Attribute name.
values Strin
gs
No Attribute values.
valflags uint No Validation error flags.
allow uint No Allow error as special case.
Parameter name
Data
Type
Option
al Description
name strin
g
No Attribute name.
required int No 1 if the attribute is required; 0
otherwise.
flags uint No One of read-only, hidden or neither.
attrType int No The attribute type.
604
ATTRIBUTEDEF
CHAPTER 6 FUNCTION SUMMARY
The flags parameter indicates whether the attribute is read-only, hidden or neither.
The attrType parameter can have one of the following values:
choices Strin
gs
No The list of choices if attrType is set
to
Constants.FV_AT_CHOICES(2
)
defValues Strin
gs
No The default value, if attribute is not
mandatory.
rangeMin strin
g
No The minimum allowed value (if any)
rangeMax strin
g
No The maximum allowed value (if any)
Flag Meaning
Constants.FV_AF_READ_ONLY(0x0
001)
The attribute value is read-only.
Constants.FV_AF_HIDDEN(0x0002
)
The attribute value is hidden.
NULL The attribute value is neither read-only nor hidden.
Value Meaning
Constants.FV_AT_STRING(0) Any arbitrary text string.
Constants.FV_AT_STRINGS(1) One or more arbitrary text strings.
Constants.FV_AT_CHOICES(2) A value from a list of choices.
Constants.FV_AT_INTEGER(3) A signed whole number (optionally restricted to a range of
values).
Constants.FV_AT_INTEGERS(4) One or more integers (optionally restricted to a range of
values).
Constants.FV_AT_REAL(5) A real number (optionally restricted to a range of values).
Constants.FV_AT_REALS(6) One or more real numbers (optionally restricted to a range
of values).
Constants.FV_AT_UNIQUE_ID(7) A string that uniquely identifies the element.
Parameter name
Data
Type
Option
al Description
605
ATTRIBUTEDEFS
CHAPTER 6 FUNCTION SUMMARY
6.6. AttributeDefs
An Array of AttributeDef objects with integer indexing and a length property.
concat
Description
The original array is unchanged. If an array is provided as a parameter to concat(), each of its elements
are appended as separate array elements at the end of the new array. Returns a new array, the result of
concatenation the given values to the end of the original array.
Returns
AttributeDefs
Syntax
concat(value)
Parameters
pop
Description
Removes the last element from the array.
Returns
AttributeDef
Constants.FV_AT_UNIQUE_IDREF(
8)
A reference to a UniqueID attribute.
Constants.FV_AT_UNIQUE_IDREFS
(9)
One or more references to a UniqueID attribute.
Parameter name
Data
Type
Option
al Description
value Attri
buteD
efs
No Can also be arrays.
Value Meaning
606
ATTRIBUTES
CHAPTER 6 FUNCTION SUMMARY
Syntax
pop()
push
Description
Returns the new length of the array.
Returns
number
Syntax
push(value)
Parameters
6.7. Attributes
An Array of Attribute objects with integer indexing and a length property.
concat
Description
The original array is unchanged. If an array is provided as a parameter to concat(), each of its elements
are appended as separate array elements at the end of the new array. Returns a new array, the result of
concatenation the given values to the end of the original array.
Returns
Attributes
Syntax
concat(value)
Parameter name
Data
Type
Option
al Description
value Attri
buteD
ef
No Value to push into the array.
607
ATTRIBUTES
CHAPTER 6 FUNCTION SUMMARY
Parameters
pop
Description
Removes the last element from the array.
Returns
Attribute
Syntax
pop()
push
Description
Returns the new length of the array.
Returns
number
Syntax
push(value)
Parameters
Parameter name
Data
Type
Option
al Description
value Attri
butes
No Can also be arrays.
Parameter name
Data
Type
Option
al Description
value Attri
bute
No Value to push into the array.
608
ATTRIBUTESEX
CHAPTER 6 FUNCTION SUMMARY
6.8. AttributesEx
An Array of AttributeEx objects with integer indexing and a length property.
concat
Description
The original array is unchanged. If an array is provided as a parameter to concat(), each of its elements
are appended as separate array elements at the end of the new array. Returns a new array as the result
of concatenation, with the given values to the end of the original array.
Returns
AttributesEx
Syntax
concat(value)
Parameters
pop
Description
Removes the last element from the array.
Returns
AttributeEx
Syntax
pop()
Parameter name
Data
Type
Option
al Description
value Attri
butes
Ex
No Can also be arrays.
609
BODYPAGE
CHAPTER 6 FUNCTION SUMMARY
push
Description
Returns the new length of the array.
Returns
number
Syntax
push(value)
Parameters
6.9. BodyPage
Delete
Description
Deletes the specified Body Page.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
The GetProps() method retrieves the properties of the specified Body Page.
See GetProps under the AFrame class for more information.
Parameter name
Data
Type
Option
al Description
value Attri
buteE
x
No Value to push into the array.
610
BODYPAGE
CHAPTER 6 FUNCTION SUMMARY
Returns
PropVals
Syntax
GetProps()
SetProps
Description
The SetProps() method sets the properties of the specified Body Page.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the Body Page is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
611
BOOK
CHAPTER 6 FUNCTION SUMMARY
ApplyPageLayout
Description
The ApplyPageLayout() method applies the layout of one page to another page.
The method returns FE_Success on success, and sets FA_errno with one of the following values on
error:
Returns
int
Syntax
ApplyPageLayout(srcPage)
Parameters
6.10. Book
Compare
Description
The Compare() method compares the differences between two versions of files and stores the result
in a CompareRet data object.
Error Reason
Constants.FE_WrongProd
uct (-60)
Current FrameMaker version does not support this operation or
fmbatch is running.
Constants.FE_BadOperati
on (-27)
Parameters specified an invalid operation.
Constants.FE_BadParame
ter (-43)
The specified parameter has an invalid value.
Constants.FE_SystemErro
r (-42)
System Error.
Parameter name
Data
Type
Option
al Description
srcPage PageO
bject
No The page to which the layout is to be
applied.
612
BOOK
CHAPTER 6 FUNCTION SUMMARY
You can OR the following values into the flags parameter:
The returned CompareRet object contains the pointers to the summary and composite results docu-
ments.
The method returns the comparison results in the CompareRet object on success. On failure, the
method assigns one of the following values to FA_errno:
Returns
CompareRet
Syntax
Compare(newerDoc, flags, insertCondTag, deleteCondTag, replaceText,
compareThreshold)
Flag Meaning
Constants.FF_CMP_SUMM
ARY_ONLY (0x01)
Generate a summary document, but not a composite document.
Constants.FF_CMP_CHANG
E_BARS (0x02)
Turn on change bars in the composite document.
Constants.FF_CMP_HYPERL
INKS (0x04)
Put hypertext links in the summary document.
Constants.FF_CMP_SUMKI
T (0x08)
Open the summary document.
Constants.FF_CMP_COMPK
IT (0x10)
Open the composite document.
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadCompare
(-35)
Older and newer documents are not the same types of files.
Constants.FE_CompareTypes
(-34)
One of the files is not a FrameMaker document or book or one
file is a book and the other is a document.
Constants.FE_WrongProduct
(-60)
Current FrameMaker version does not support the operation.
613
BOOK
CHAPTER 6 FUNCTION SUMMARY
Parameters
NewBookComponentInHierarchy
Description
The NewBookComponentInHierarchy() method inserts a book component at a specified position
in a FrameMaker structured book, and returns the component that was newly added, on success.
Parameter name
Data
Type
Option
al Description
newerDoc Doc No The newer version of the document
or book.
flags int No Bit flags that specify how to generate
the summary and composite
documents. Specify 0 for the default
flags.
insertCondTag strin
g
No Indicates the condition tag to apply to
insertions shown in the composite
document. To specify a blank insert
condition tag, enter the value null.
deleteCondTag strin
g
No Denotes the condition tag to apply to
deletions shown in the composite
document. To specify a blank delete
condition tag, enter the value null.
replaceText strin
g
No Text to appear in place of the deleted
text. To not specify any replacement
text, enter the value null.
compareThreshold int No Threshold expresses the percentage
of words that can change before
paragraphs are considered not equal.
If two paragraphs are equal, word
differences between them are shown
within a paragraph in the composite
document.
If the compareThreshold property is
set to 0, the Compare() method uses
the default value of 75.
If the compareThreshold property is
set to any other value, the Compare()
method uses the setting in the
FrameMaker configuration files.
614
BOOK
CHAPTER 6 FUNCTION SUMMARY
The method returns the element that was added, on success. On failure, the method assigns one of the
following values to FA_errno:
Returns
Element
Syntax
NewBookComponentInHierarchy(compName, elemLoc)
Parameters
SilentPrintDoc
Description
The SilentPrintDoc() method prints a document or a book using the default print settings. Default
print settings are the settings that appear in the Print dialog box when the user attempts to print a docu-
ment.
SilentPrintDoc() initializes the print page size and printer name if they do not have values.
On success, the method returns FE_Success. On failure, the method sets FA_errno to one of the
following values:
Error Reason
Constants.FE_BadBookId
(-66)
Invalid book.
Constants.FE_BadCompPat
h (-68)
Component name specified for compName is invalid.
Constants.FE_BadNew (-23) The object cannot be created.
Constants.FE_BookUnStruc
tured (-67)
The specified book is unstructured.
Parameter name
Data
Type
Option
al Description
compName strin
g
No The name of the component to add.
elemLoc Eleme
ntLoc
No The position at which to add the new
component.
615
BOOK
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
SilentPrintDoc()
SimpleGenerate
Description
The SimpleGenerate() method generates files for a book.
The method performs the same operation as choosing Update Book from the book Edit menu.
You must set up the book and its generated files before calling SimpleGenerate().
The method returnsFE_Success on success, and assigns FA_errno with one of the following values
on failure:
Returns
int
Syntax
SimpleGenerate(interactive, makeVisible)
Error Reason
Constants.FE_SystemError
(-42)
Could not open or close the printer file.
Constants.FE_BadParamete
r (-43)
Parameter has an invalid value.
Error Reason
Constants.FE_BadOperati
on (-27)
The book is not self-consistent (book generates data in one file that
is source data for another generated file, or page count continually
changes for this operation); there is a duplicate file in the book; all
files in the book are generated files.
Constants.FE_BadParame
ter (-43)
Not a valid book.
Constants.FE_SystemErro
r (-42)
Could not allocate memory, or could not open or save one of the
files in the book.
616
BOOK
CHAPTER 6 FUNCTION SUMMARY
Parameters
SimpleImportFormats
Description
The SimpleImportFormats() method imports formats from a document to a document or a book.
NOTE: If you import formats to a book, SimpleImportFormats() imports formats to each book
component for which the ImportFmtInclude property is set to True.
You can OR the following values into the formatFlags parameter to specify the formats to import.
Parameter name
Data
Type
Option
al Description
interactive int No Set the interactive property to 1 to
display messages and warnings; set
the property to 0 to suppress display
of messages and warnings.
makeVisible int No Specifies whether to display the
generated files. Set to 1 to display the
files, or to 0 to suppress displaying
the files.
Flag What to Import
Constants.FF_UFF_COLOR
(0x0100)
Colors
Constants.FF_UFF_COMBINED_F
ONTS (0x0800)
Combined fonts
Constants.FF_UFF_COND
(0x0010)
Conditions
Constants.FF_UFF_DOCUMENT_
PROPS (0x0400)
Document properties
Constants.FF_UFF_FONT
(0x0002)
Character Catalog formats
Constants.FF_UFF_MATH
(0x0200)
Equation settings
Constants.FF_UFF_PAGE (0x0004) Page layouts
Constants.FF_UFF_PGF (0x0001) Paragraph Catalog formats
617
BOOK
CHAPTER 6 FUNCTION SUMMARY
The method returns FE_Success on success. If the method fails, it sets FA_errno with one of the
following values:
Returns
int
Syntax
SimpleImportFormats(fromDoc, formatFlags)
Parameters
Constants.FF_UFF_REFPAGE
(0x0020)
Reference pages
Constants.FF_UFF_REMOVE_EXC
EPTIONS (0x8000)
Remove exception formats from target documents
Constants.FF_UFF_REMOVE_PAG
E_BREAKS (0x4000)
Remove all forced page breaks from target documents
Constants.FF_UFF_TABLE
(0x0008)
Table Catalog formats
Constants.FF_UFF_VAR (0x0040) Variable formats
Constants.FF_UFF_XREF (0x0080) Cross-reference formats
Error Reason
Constants.FE_WrongPr
oduct (-60)
Current FrameMaker version does not support books.
Constants.FE_BadDocId
(-2)
Invalid book or document.
Constants.FE_Canceled
(-44)
User canceled the operation.
Constants.FE_FailedStat
e (-45)
FrameMaker failed to open one or more of the book's document files
during the import operation.
Parameter name
Data
Type
Option
al Description
fromDoc Doc No The document from which the
formats are to be imported.
Flag What to Import
618
BOOK
CHAPTER 6 FUNCTION SUMMARY
SimpleImportElementDefs
Description
The SimpleImportElementDefs()method imports element definitions and the format change list
catalog from an EDD or FrameMaker document or book to another FrameMaker document or book.
You can OR the following flags into the importFlags parameter:
The method returns FE_Success on success. If the method fails, it assigns one of the following values
to FA_errno:
Returns
int
Syntax
SimpleImportElementDefs(fromDocOrBook, importFlags)
formatFlags int No Bit field specifying the formats to be
imported. Specify 0 for the default
flags.
Flag Meaning
Constants.FF_IED_REMOVE_
OVERRIDES (0x0001)
Clear format overrides.
Constants.FF_IED_REMOVE_
BOOK_INFO (0x0002)
Clears formatting inherited from a parent book, if the element
definitions are being imported from a document.
Constants.FF_IED_DO_NOT_I
MPORT_EDD (0x0004)
If the source document is an EDD, setting this value does NOT
treat it as an EDD; instead the method just imports its element
catalog.
Constants.FF_IED_NO_NOTIF
Y (0x0008)
Do not issue the Constants.FA_Note_PreImportElemDefs (64)
or Constants.FA_Note_PostImportElemDefs (65) notifications.
Error Reason
Constants.FE_WrongPro
duct (-60)
Current product version is not Structured FrameMaker.
Constants.FE_BadDocId
(-2)
Invalid book or document.
Parameter name
Data
Type
Option
al Description
619
BOOK
CHAPTER 6 FUNCTION SUMMARY
Parameters
GetUniqueObject
Description
The GetUniqueObject() method retrieves the object from its persistent unique identifier (UID). The
FrameMaker product assigns a UID to each object in a document or book that is not identified by a name.
The UID, unlike the object's ID, does not change from one session to another.
The GetUniqueObject() method returns the object on success. On failure, it sets FA_errno to one of
the following values:
Returns
Object
Syntax
GetUniqueObject(objType, unique)
Parameters
Parameter name
Data
Type
Option
al Description
fromDocOrBook Doc|B
ook
No The document or book from which to
import element definitions.
importFlags int No Specifies how to import formats.
Error Reason
Constants.FE_BadDocId
(-2)
Invalid document or book.
Constants.FE_TypeUnNa
med (-19)
Objects of the specified type are not identified by UIDs.
Constants.FE_NameNotF
ound (-20)
Object with specified UID could not be found.
Parameter name
Data
Type
Option
al Description
objType int No The type of object (for example,
FO_Pgf).
unique int No The unique ID of the object.
620
BOOK
CHAPTER 6 FUNCTION SUMMARY
Close
Description
Closes a document, book, dialog box, or Frame session.
The flags parameter specifies whether to abort or to close open documents or books if they have
unsaved changes. Set theConstants.FF_CLOSE_MODIFIED flag to True (1) to close open docu-
ments and books regardless of their state.
The method sets FE_Success on success. On failure, the method assigns the following value to
FA_errno:
Returns
int
Syntax
Close(flags)
Parameters
SimpleSave
Description
The SimpleSave() method saves a book.
If you set theinteractive parameter to False and you specify the book's current name for
saveAsName, FrameMaker saves the book under its current name.
Error Reason
Constants.FE_DocMo
dified (-8)
The document was modified and the flags parameter was set to 0.
Parameter name
Data
Type
Option
al Description
flags int No The Close() method closes the
document or book.
NOTE: Flags specify whether to abort
or to close open documents or books
if they have unsaved changes. Set the
FF_CLOSE_MODIFIED flag to True (1)
to close open documents and books
regardless of their state.
621
BOOK
CHAPTER 6 FUNCTION SUMMARY
If you specify another filename for saveAsName, FrameMaker saves the book to that filename.
If you specify an empty string (""), FrameMaker does not save the file. Instead it sets FA_errno to
Constants.FE_BadParameter (-43).
If you set the interactive parameter to True, FrameMaker displays the Save dialog box and allows
the user to choose a filename. The book's current name appears as the default file name.
The SimpleSave() method returns the book it saved, on success.
On failure, the method sets FA_errno, to one of the following values:
Error Reason
•Constants.FE_Can-
celed (-44)
• Constants.FE_CanceledBy-
Client (-86)
• Constants.FV_FileNotWritable (33) - File was not writable.
• Constants.FV_BadSaveFileName (34) - The specified file
name is not allowed by the operating system.
• Constants.FV_BadFileId (35) - The file’s operating system ID
was bad.
• Constants.FV_CancelSaveFileIsInUse (50) - The file is in use
and the user did not or could not reset the lock. Or the file
is in use, and the Constants.FS_FileIsInUse (17)
parameter is set to Constants.FV_DoCancel (0), or it is set to
Constants.FV_ResetLockAndContinue (7) but FrameMaker
could not reset the lock.
• Constants.FV_CancelSaveModDateChanged (52) - The file
has changed since the last time it was opened or saved in
the current session.
• Constants.FV_LockCouldntBeReset (2) - File lock could not
be reset.
• Constants.FV_LockWasReset (0) - File lock was reset.
• Constants.FV_LockNotReset (1) - File lock was not reset.
• Constants.FV_FileIsViewOnly (4) - File was View Only.
• Constants.FV_NonPortableSaveName (37) - File had a name
that is not portable (Macintosh only).
• Constants.FV_NonPortableFileRefs (38) - Referenced
graphics files had filenames that are not portable (Macin-
tosh only).
Constants.FE_WrongProduc
t (-60)
The specified file contains structure and the current product
interface is not Structured FrameMaker.
Constants.FE_FailedState
(-45)
Constants.FE_BadParamete
r (-43)
The filename was invalid.
622
BOOK
CHAPTER 6 FUNCTION SUMMARY
Returns
Book
Syntax
SimpleSave(saveAsName, interactive)
Parameters
NewSeriesObject
Description
The NewSeriesObject() method creates a series object. Series objects include the following object
types:
•BodyPage
• BookComponent
•Pgf
The method allows you to specify the position in the series at which to add the new object.
The method returns the location of the new object, on success. If the method fails, it sets FA_errno to
one of the following values:
Constants.FE_FilterFailed
(-89)
Constants.FV_InvalidSaveFilter (42) - The filter specified by
Constants.FS_SaveFileTypeHint (16) is not installed, or the syntax
for Constants.FS_SaveFileTypeHint (16) is invalid.
Parameter name
Data
Type
Option
al Description
saveAsName strin
g
No The absolute path in which to save
the document or book.
interactive int No Specifies whether FrameMaker
displays messages and warnings to
the user. Set this parameter to 1 to
display messages and warnings.
Error Reason
Constants.FE_BadDocId (-2) Invalid book.
Constants.FE_BadNew (-23) Object cannot be created.
Error Reason
623
BOOK
CHAPTER 6 FUNCTION SUMMARY
Returns
Object
Syntax
NewSeriesObject(objType, previous)
Parameters
NewSeriesBookComponent
Description
The NewSeriesBookComponent() method creates a Book Component.
The method allows you to specify the position in the series at which to add the new object.
See the NewSeriesObject method for more information.
Returns
BookComponent
Constants.FE_BadObjId (-3) Invalid object.
Constants.FE_NotBodyPage (-24) The previous parameter must specify the location of a
body page.
Constants.FE_NotPgf (-25) The previous parameter must specify the location of a
paragraph.
Constants.FE_NotBookCompone
nt (-26)
The previous parameter must specify the location of a book
component.
Parameter name
Data
Type
Option
al Description
objType int No The type of object to create (for
example, FO_BodyPage or FO_Pgf).
previous Objec
t
No The location of the object in the
series after which to add the new
object. To add a paragraph at the start
of a flow, specify the location of the
flow. To add an object at the
beginning of any other series, specify
0.
Error Reason
624
BOOK
CHAPTER 6 FUNCTION SUMMARY
Syntax
NewSeriesBookComponent(previous)
Parameters
NewBookComponentOfTypeInHierarchy
Description
Inserts a book component of a specified type at a specified position in a structured FrameMaker book.
Returns
BookComponent
Syntax
NewBookComponentOfTypeInHierarchy(compName, compType, elemLoc)
Parameters
NOTE: The book you specify for bookId must already be structured.
Parameter name
Data
Type
Option
al Description
previous Objec
t
No The location of the object in the
series after which to add the new
Book Component. To add a paragraph
at the start of a flow, specify the
location of the flow. To add a Book
Component at the beginning of any
other series, specify 0.
Parameter name
Data
Type
Option
al Description
bookId int No The ID of the book to add the
component to
compName strin
g
No The name of the component
elemLoc Eleme
ntLoc
No The position at which to add the new
element
625
BOOK
CHAPTER 6 FUNCTION SUMMARY
GetConditionalSettings
Description
Get a PropVals object containing the conditional settings of the current book.
Returns
PropVals
Syntax
GetConditionalSettings()
ApplyConditionalSettings
Description
Apply conditional settings in the selected book based on the specified settings.
Returns
Void
Syntax
ApplyConditionalSettings(settings)
Parameters
The following are the list of settings can be applied:
Parameter name
Data
Type
Option
al Description
settings PropV
als
No The value of the property to set.
Property Meaning
Constants.FS_ShowState (1) Specify the show state of the conditional text
applied to the book.
• Constants.FV_ShowAll (1)
• Constants.FV_ShowAsPerConditions (2)
• Constants.FV_ShowAsPerExpression (3)
626
BOOK
CHAPTER 6 FUNCTION SUMMARY
The method returns FE_Success if it succeeds. On failure, the method returns one of the following values
to FA_errno:
Constants.FS_ShowConditions
(2)
A string array of the names of the condition tags to
be added to the Show list in the Show/Hide
Conditional Text dialog
Constants.FS_HideConditions
(3)
A string array of the names of the condition tags to
be added to the Hide list in the Show/Hide
Conditional Text dialog
Constants.FS_ActiveCondition
alExpression (6)
The conditional build expression tag to be applied.
• When reading this property: Returns the
currently applied Conditional Build Expression
tag, if (FS_ShowState = FV_ShowAsPerExpres-
sion). Else NULL is returned.
• When applying this property: Applies the
current active Conditional Build expression if
(FS_ShowState = FV_ShowAsPerExpression).
Otherwise ignored.
Constants.FS_ShowConditionI
ndicators (7)
Show / hide the conditional indicators.
Constants.FS_ApplyCondition
alSettingsToViewOnlyDoc (8)
Apply the conditions to view-only documents in the
book.
Constants.FS_ApplyCondition
alSettingsToNestedBooks (9)
Apply the conditions to nested books within the
current book.
Constants.FS_ApplyCondition
alSettingsShowBookErrorLog
(10)
Show erros in the book error log.
Error Reason
Constants.FE_Expressio
nNotFound
Expression Tag to be applied does not exist in the default
document of the book.
Constants.FE_FailedToA
pplyOnOneOrMoreCom
ponents
Failed to apply conditional settings on one or more book
components.
Property Meaning
627
BOOK
CHAPTER 6 FUNCTION SUMMARY
ManageConditionalExpressions
Description
Add, edit, or delete conditional expression tags to the current book. Applies to the options available in
the Add/Edit Conditional Tag dialog.
Returns
Void
Syntax
ManageConditionalExpressions(settings)
Parameters
Use the following are add, edit, and delete settings:
The method returns FE_Success if it succeeds. On failure, the method returns one of the following values
to FA_errno:
Parameter name
Data
Type
Option
al Description
settings PropV
als
No The value of the property to set.
Property Meaning
Constants.FS_AddEditExpressi
ons (1)
String array of pair of strings (expression tag,
expression definition) to be added/edited in
conditional expression catalog.
Constants.FS_DeleteExpressio
ns (2)
String array of expression tags to be deleted from
conditional expression catalog.
Error Reason
Constants.FE_CannotAd
dEditExpressionsInOne
OrMoreComponents
Failed to Add/Edit the Expression on one or more book
components while using
F_ApiManageCondiitonalExpressions(). See FrameMaker
Error pod for more details.
628
BOOK
CHAPTER 6 FUNCTION SUMMARY
GetConditionalExpression
Description
Returns the conditional expression definition for the given named expression.
Returns
exprName
Syntax
GetConditionalExpression(exprName)
Parameters
Save
Description
The Save() method saves a book. The method allows you to script the way FrameMaker saves the file
and to specify responses to warnings and messages that arise while the file is being saved.
You can save a file under its current name or save it as a new file.
The property list for the saveParams parameter is as follows:
The method returns the document it saved, on success.
On failure the method sets FA_errno to one of the following values:
Parameter name
Data
Type
Option
al Description
exprName Strin
g
No Name of the required conditional
build expression.
Property Meaning
Constants.FS_SavedFileNa
me (1)
A string that specifies the full path of the saved file.
Constants.FS_SaveNativeEr
ror (2)
The error condition. If the file is saved successfully, this property
is set to FE_Success.
Constants.FS_SaveStatus
(3)
A bit field indicating what happened when the file was saved.
629
BOOK
CHAPTER 6 FUNCTION SUMMARY
Returns
Object
Error Reason
•Constants.FE_Can-
celed (-44)
• Constants.FE_CanceledBy-
Client (-86)
• Constants.FV_FileNotWritable (33) - File was not writable.
• Constants.FV_BadSaveFileName (34) - The specified file-
name is not allowed by the operating system.
• Constants.FV_BadFileId (35) - The file’s operating system ID
was bad.
• Constants.FV_CancelSaveFileIsInUse (50) - The file is in use
and the user did not or could not reset the lock. Or the file
is in use, and the Constants.FS_FileIsInUse (17)
parameter is set to Constants.FV_DoCancel (0), or it is set to
Constants.FV_ResetLockAndContinue (7) but FrameMaker
could not reset the lock.
• Constants.FV_CancelSaveModDateChanged (52) - The file
has changed since the last time it was opened or saved in
the current session.
• Constants.FV_LockCouldntBeReset (2) - File lock could not
be reset.
• Constants.FV_LockWasReset (0) - File lock was reset.
• Constants.FV_LockNotReset (1) - File lock was not reset.
• Constants.FV_FileIsViewOnly (4) - File was View Only.
• Constants.FV_NonPortableSaveName (37) - File had a name
that is not portable (Macintosh only).
• Constants.FV_NonPortableFileRefs (38) - Referenced
graphics files had filenames that are not portable (Macin-
tosh only).
Constants.FE_WrongProduc
t (-60)
The specified file contains structure and the current product
interface is not Structured FrameMaker.
Constants.FE_FailedState
(-45)
Constants.FE_BadParamete
r (-43)
The filename was invalid.
Constants.FE_FilterFailed
(-89)
Constants.FV_InvalidSaveFilter (42) - The filter specified by
Constants.FS_SaveFileTypeHint (16) is not installed, or the syntax
for Constants.FS_SaveFileTypeHint (16) is invalid.
630
BOOK
CHAPTER 6 FUNCTION SUMMARY
Syntax
Save(saveAsName, saveParams, saveReturnParams)
Parameters
UpdateBook
Description
The UpdateBook() method updates a book.
The method allows you to specify a script (property list) specifying how to update the book and how to
deal with error and warning conditions.
For example, you can specify whether to abort or to continue updating a book if it contains view-only
documents.
NOTE: Always initialize the pointer to the property list that you specify for updateReturnParamspp
to null before you call UpdateBook().
To get a property list to specify for the updateParamsp parameter, use
GetUpdateBookDefaultParams() or create the list from scratch.
The following are the properties that you can use in the property list:
Parameter name
Data
Type
Option
al Description
saveAsName strin
g
No The path for saving the document or
book.
saveParams PropV
als
No A property list that tells FrameMaker
how to save the file and how to
respond to errors and other
conditions. Use
GetSaveDefaultParams() or
AllocatePropVals() to create and
allocate memory for this property list.
To use the default list, specify null.
saveReturnParams PropV
als
No A property list that returns
information about how the
FrameMaker product saved the file.
631
BOOK
CHAPTER 6 FUNCTION SUMMARY
Property Meaning
Constants.FS_AlertUserAboutFailu
re (2)
Alert user with warnings and messages if necessary. Set
this parameter to True or False as desired.
• True - Notify user when unexpected conditions
occur.
• False - Do not notify user when unexpected condi-
tions occur.
Constants.FS_AllowInconsistentNu
mProps (6)
Allow the FrameMaker product to update numbering, text
insets and other properties of all the FrameMaker
documents in the book, even if there are documents in
the book with numbering properties that do not match
the properties specified in the book. The permissible
values are as follows:
• Constants.FV_DoOK (1) - Update numbering even if
there are inconsistent properties in the book.
• Constants.FV_DoCancel (0) - Cancel the update oper-
ation when FrameMaker encounters a document
with inconsistent numbering properties.
• Constants.FV_DoShowDialog (4) - Show a dialog box
and let the user decide.
Constants.FS_AllowNonFMFiles
(1)
Allow the FrameMaker product to update numbering, text
insets, and other properties of all the FrameMaker
documents in the book, even if there are documents in
the book that were not created by FrameMaker. The
permissible values are as follows:
• Constants.FV_DoOK (1) - Update the book even if the
book contains files not created by FrameMaker.
• Constants.FV_DoCancel (0) - Cancel the update oper-
ation when it encounters a document not created by
FrameMaker.
• Constants.FV_DoShowDialog (4) - Show a dialog box
and let the user decide.
632
BOOK
CHAPTER 6 FUNCTION SUMMARY
Constants.FS_AllowViewOnlyFiles
(3)
Allow the FrameMaker product to update view-only
documents in the book. The permissible values are as
follows:
• Constants.FV_DoOK (1) - Update the view-only docu-
ments.
• Constants.FV_DoCancel (0) - Cancel the entire
update operation when it encounters a view-only
document.
• Constants.FV_DoShowDialog (4) - Show a dialog box
and let the user decide.
Constants.FS_MakeVisible (5) Make newly generated files (lists and indexes) visible.
Takes the value True or False.
• True - Make visible.
• False - Do not make visible.
Constants.FS_ShowBookErrorLog
(4)
Display the book error log for this update operation. Takes
the value True or False.
• False - Do not display the error log; all warnings and
errors are redirected to the console.
• True - Display the error log.
Constants.FS_UpdateBookGenerat
edFiles (7)
Update generated files such as TOC, lists, and indexes.
Only update those generated files that have
GenerateInclude set to True in their associated
FO_BookComponent objects. Takes the value True or
False.
• True - Update generated files.
• False - Do not update generated files.
Constants.FS_UpdateBookMaster
Pages (12)
Update automatic assignment of master pages in all the
documents of the book. Takes the value True or False.
• True - Update master pages.
• False - Do not update master pages.
Constants.FS_UpdateBookNumber
ing (8)
Update numbering in all the documents of the book. Takes
the value True or False.
• True - Update numbering.
• False - Do not update numbering.
Property Meaning
633
BOOK
CHAPTER 6 FUNCTION SUMMARY
The property list to which updateReturnParams is set, has the following property:
To determine if a particular Constants.FS_UpdateBookStatus (1) bit is set, use
CheckStatus().
The method returns FE_Success on success.
On failure, the method sets FA_errno to one of the following values:
Constants.FS_UpdateBookOleLink
s (9)
Update OLE links in all the documents of the book. Takes
the value True or False.
• True - Update OLE links.
• False - Do not update OLE links.
Constants.FS_UpdateBookTextRef
erences (10)
Update text insets in all the documents of the book. Takes
the value True or False.
• True - Update text insets.
• False - Do not update text insets.
Constants.FS_UpdateBookXRefs
(11)
Update cross-references in all the documents of the book.
Takes the value True or False.
• True - Update cross-references.
• False - Do not update cross-references.
Property Meaning
Constants.FS_UpdateBookS
tatus (1)
A bit field to indicate what happened during the update.
Error Reason
Constants.FE_BadDocId
(-2)
Invalid book
Constants.FE_BadOperat
ion ()
• Constants.FV_BookNotSelfConsistent (0) - The book is not
self-consistent (book generates data in one file that is source
data for another generated file, or page count continually
changes for this operation).
• Constants.FV_DuplicateFileInBook (1) - One or more files in the
book is a duplicate of another file.
• Constants.FV_NoNonGeneratedFilesInBook (2) - The only files
in the book are generated files.
Property Meaning
634
BOOK
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
UpdateBook(updateParams, updateReturnParams)
Parameters
Constants.FE_BadParam
eter (-43)
• Constants.FV_BadUpdateBookFileId (64) - Specified book is
invalid.
• Constants.FV_BadUpdateBookScriptValue (65) - The update
book script contains an invalid property value.
Constants.FE_Canceled
(-44)Constants.FE_Cance
ledByClient (-86)
• Constants.FV_CancelInconsistentNumPropsInFileInBook (34) -
One or more of the book's document files has numbering prop-
erties that are inconsistent with the properties stored in the
book.
• Constants.FV_CancelNonFMFileInBook (32) - One or more of
the book's document files is not a FrameMaker file.
• Constants.FV_CancelViewOnlyFileInBook (33) - One or more of
the book's document files is view-only.
• Constants.FV_UserCanceledUpdateBook (35) - The user
canceled the update operation.
Constants.FE_SystemErr
or (-42)
• Constants.FV_FileInBookNotOpened (96) - One or more files in
the book could not be opened.
• Constants.FV_FileInBookNotSaved (97) - One or more files in
the book could not be saved.
• Constants.FV_TooManyWindowsUpdateBook (98) - Not
enough memory. Too many windows were open.
Parameter name
Data
Type
Option
al Description
updateParams PropV
als
No A property list specifying how to
update the book and how to respond
to errors and other conditions. To use
the default list, specify null.
Error Reason
635
BOOK
CHAPTER 6 FUNCTION SUMMARY
Import
Description
The Import() method imports text or graphics into a document.
Import() allows you to specify a script (property list) specifying how to import text or graphics and
how to deal with error and warning conditions.
For example, you can specify whether to import a file by reference or by copy.
If you import a file by reference, Import() creates an inset. The following list summarizes the types of
files you can import with Import() and the types of inset objects it creates when you import them by
reference:
• Graphics - FO_Inset
• Text - FO_TiText, FO_TiTextTable
• Frame binary document - FO_TiFlow
• MIF - FO_TiFlow
NOTE: When importing a graphic, you can specify that it be imported at its default resolution by setting
the Constants.FS_GraphicDpi (15) property to 0 and setting the
Constants.FS_FitGraphicInSelectedRect (14) property to False. If the graphic has no
default resolution, it is imported at 72 dpi
To get a property list to specify for the importParamsp parameter, use
GetImportDefaultParams() or create the list from scratch.
NOTE: Always initialize the pointer to the property list that you specify for importReturnParamspp
to null before you call Import().
The following are the list of properties that can be imported:
updateReturnParams PropV
als
No A property list that provides
information about how the
FrameMaker product updated the
book. This parameter must be
initialized before you call
UpdateBook().
Parameter name
Data
Type
Option
al Description
636
BOOK
CHAPTER 6 FUNCTION SUMMARY
Property Meaning
Constants.FS_AlertUserAboutF
ailure (2)
Alert user if an unexpected condition, such as an
unrecognized file type, occurs. Set to either True or False
• True - Notify user when unexpected conditions occur.
• False - Do not notify user when unexpected conditions
occur.
Constants.FS_DisallowDoc (8) Disallow importing FrameMaker binary documents. Set to
either True or False.
• True - Do not allow importing FrameMaker binary docu-
ments.
• False - Allow importing FrameMaker binary documents.
Constants.FS_DisallowFilterTyp
es (11)
Disallow importing filterable files. Set to either True or False.
• True - Do not allow importing filterable files.
• False - Allow importing filterable files.
Constants.FS_DisallowMIF (7) Disallow importing MIF files. Set to either True or False.
• True - Do not allow importing MIF files.
• False - Allow importing MIF files.
Constants.FS_DisallowGraphicT
ypes (9)
Disallow importing graphic files. Set to either True or False.
• True - Do not allow importing graphic files.
• False - Allow importing graphic files.
Constants.FS_DisallowMacEditi
ons (10)
Disallow importing Macintosh editions of files. Set to either
True or False.
• True - Do not allow importing Macintosh editions of
files.
• False - Allow importing Macintosh editions of files.
Constants.FS_DisallowPlainText
(12)
Disallow importing Text Only files. Set to either True or False.
• True - Do not allow importing Text Only files.
• False - Allow importing Text Only files.
Constants.FS_DisallowSgml (33) Disallow importing SGML documents. Set to either True or
False.
• True - Do not allow importing SGML documents.
• False - Allow importing SGML documents.
637
BOOK
CHAPTER 6 FUNCTION SUMMARY
Constants.FS_DisallowXml (43) Disallow importing XML documents. Set to either True or
False.
• True - Do not allow importing XML documents.
• False - Allow importing XML documents.
Constants.FS_DontNotifyAPICli
ents (3)
Notify other clients of the import operation. Set to either
True or False.
• True - Do not notify other clients of the import opera-
tion.
• False - Notify other clients of the import operation.
Constants.FS_FileTypeHint (34) If the file is filterable, this property is a string that enables
FrameMaker to automatically call the correct filter to filter
the file.
If the file is not filterable, this property contains the value
null.
Constants.FS_FileIsSgmlDoc
(32)
File is an SGML document. The possible values are:
• Constants.FV_DoOK (1) - Import it anyway.
• Constants.FV_DoCancel (0) - Cancel the import opera-
tion.
• Constants.FV_DoShowDialog (4) - Show a dialog box
and let the user decide.
Constants.FS_FileIsXmlDoc (37) File is an XML document. The possible values are:
• Constants.FV_DoOK (1) - Import it anyway.
• Constants.FV_DoCancel (0) - Cancel the import opera-
tion.
• Constants.FV_DoShowDialog (4) - Show a dialog box
and let the user decide.
Constants.FS_ForceImportAsTe
xt (17)
Import the file as a Text Only document, even if it is a MIF file
or a filterable file. Set to either True or False.
• True - Import it as a Text Only file.
• False - Import it in a format based on its type.
Constants.FS_HowToImport (4) Import file by reference or copy. The possible values are:
• Constants.FV_DoByRef (5) - Import file by reference.
• Constants.FV_DoByCopy (6) - Import file by copy.
• Constants.FV_DoUserChoice (7) - Allow user to choose
how to import the file.
Property Meaning
638
BOOK
CHAPTER 6 FUNCTION SUMMARY
The syntax of the string passed to the Constants.FS_FileTypeHint (34) is as follows:
record_vers vendor format_id platform filter_vers filter_name
NOTE: The fields in the record are not separated by spaces. Spaces are significant data except those that
appear in the filter_name field.
Constants.FS_ImportAsType
(36)
Specify the format of the file to import. Possible values are:
• Constants.FV_AUTORECOGNIZE (0x00) - Default value;
recognize the file type aoutmatically.
• Constants.FV_TYPE_BINARY (0x01) - A FrameMaker
binary file.
• Constants.FV_TYPE_MIF (0x02) - A MIF file.
• Constants.FV_TYPE_TEXT (0x03) - A file containing plain
text.
• Constants.FV_TYPE_SGML (0x04) - An SGML file.
• Constants.FV_TYPE_XML (0x05) - An XML file.
• Constants.FV_TYPE_FILTER (0xFF) - Use a filter to import
this file. You must specify a valid file type hint for the
Constants.FS_FileTypeHint (34) property.
Constants.FS_ManualUpdate
(5)
Update inset manually. Set to either True or False.
• True - Update inset automatically.
•False - Do not update inset manually.
Constants.FS_SgmlImportAppli
cation (35)
Retained for compatibility with older versions of
FrameMaker. Use the
Constants.FS_StructuredImportApplication (35) property
instead.
Constants.FS_StructuredImport
Application (35)
String specifying the name of the structure application to use
when importing an XML or SGML file. This property takes
precedence over any other structure application
specification. If the specified application does not exist, the
calling function will fail.
If this property is not set, then the value of this property is
null.
Constants.FS_ShowBrowser (1) Display the Import dialog box. Set to either True or False.
• True - Display the Import dialog box.
• False - Do not display the Import dialog box.
Constants.FS_TextInsetName
(6)
Denotes the Inset name. If not set, the value of this property
is null.
Property Meaning
639
BOOK
CHAPTER 6 FUNCTION SUMMARY
For example:
0001PGRFPICTMAC61.0 Built-in PICT reader0001ORBLSVGIAll Platform SVG
reader for 7.0
Each field of the record (except filter_name) specifies a four-byte code. If a code contains fewer than
four alphanumeric characters, the remaining bytes must be filled out with spaces.
record_vers specifies the version of the record, currently 0001.
vendor is a code specifying the filter's vendor. The code is a string of four characters. The following
table lists the possible codes
format_id is a code specifying the format that the filter translates. The code is a string of four charac-
ters. The following are the possible codes:
Code Meaning
PGRF Built-in Frame filters.
FAPI External Frame FDK client filter.
FFLT External Frame filters.
IMAG External ImageMark filters.
XTND External XTND filters.
Code Meaning
CDR CorelDRAW
CGM Computer Graphics Metafile
DIB Device-independent bitmap (Windows)
DRW Micrografx CAD
DXF Autodesk Drawing eXchange file (CAD files)
EMF Enhanced Metafile (Windows)
EPSB Encapsulated PostScript Binary (Windows)
EPSD Encapsulated PostScript with Desktop Control Separations (DCS)
EPSF Encapsulated PostScript (Macintosh)
EPSI Encapsulated PostScript Interchange
FRMI FrameImage
FRMV FrameVector
G4IM CCITT Group 4 to Image
640
BOOK
CHAPTER 6 FUNCTION SUMMARY
platform is a code specifying the platform on which the filter was run. The code is a string of four char-
acters. The following are the possible codes:
GEM GEM file (Windows)
GIF Graphics Interchange Format (Compuserve)
HPGL Hewlett-Packard Graphics Language
IGES Initial Graphics Exchange Specification (CAD files)
IMG4 Image to CCITT Group 4 (UNIX)
MooV QuickTime Movie
OLE Object Linking and Embedding Client (Microsoft)
PCX PC Paintbrush
PICT QuickDraw PICT
PNTG MacPaint
SNRF Sun Raster File
SRGB SGI RGB
SVGI Scalable Vector Graphics
TIFF Tag Image File Format
WMF Windows Metafile
WPG WordPerfect Graphics
XWD X Windows System Window Dump file
Code Meaning
MAC6 Macintosh 68000 series
MACP Power Macintosh
WINT Windows NT
WIN3 Windows 3.1
WIN4 Windows 95
OS/2 IBM OS/2
UNIX Generic X/11 (Sun, HP)
Code Meaning
641
BOOK
CHAPTER 6 FUNCTION SUMMARY
filter_vers is a string of four characters identifying the version of the filter on that platform. For
example, version 1.0 of a filter is represented by the string 1.0.
filter_name is a text string (up to 31 characters long) that describes the filter.
Import() uses the following properties only for importing FrameMaker documents and MIF
files:
Property Meaning
Constants.FS_FileIsMakerDoc
(18)
File is a FrameMaker binary document or a MIF file. The
possible values are:
• Constants.FV_DoOK (1) - Import it anyway.
• Constants.FV_DoCancel (0) - Cancel the import operation.
• Constants.FV_DoShowDialog (4) - Show a dialog box and
let the user decide.
Constants.FS_FormatImporte
dText (22)
Format the imported text. The possible values are:
• Constants.FV_EnclosingDoc (1) - Use formatting in the
enclosing document.
• Constants.FV_PlainText (2) - Format the imported text as
plain text.
• Constants.FV_SourceDoc (0) - Use formatting from the
source documents.
Constants.FS_ImportFlowPag
eSpace (21)
If Constants.FS_UseMainFlow (19) is False, then
Constants.FS_ImportFlowPageSpace (21) indicates the type of
pages to search for the flow specified by the
Constants.FS_ImportFlowTag (20) property. The possible values
are:
• Constants.FV_BodyPage (10) - Search body pages.
• Constants.FV_ReferencePage (9) - Search reference
pages.
Constants.FS_ImportFlowTag
(20)
If Constants.FS_UseMainFlow (19) is False, then
Constants.FS_ImportFlowTag (20) indicates the name of the
flow to import. If this value is not set, the default value is
null.
Constants.FS_RemoveManual
PageBreaks (23)
Remove manual page breaks if FS_FormatImportedTest is set to
Constants.FV_EnclosingDoc (1). Set to either True or False.
• True - Remove manual page breaks.
• False - Do not remove manual page breaks.
642
BOOK
CHAPTER 6 FUNCTION SUMMARY
Import() uses the following properties only for importing graphics files:
Constants.FS_RemoveOverrid
es (24)
Remove format overrides if Constants.FS_FormatImportedTest
is set to Constants.FV_EnclosingDoc (1). Set to either True or
False.
• True - Remove format overrides.
• False - Do not remove format overrides.
Constants.FS_UseMainFlow
(19)
Import text from specified document's main flow. Set to either
True or False.
• True - Import the text from the main flow.
• False - Do not import the text from the main flow.
Property Meaning
Constants.FS_FileIsGraphic
(13)
File is a graphic file. The possible values are:
• Constants.FV_DoOK (1) - Import it.
• Constants.FV_DoCancel (0) - Cancel import operation.
• Constants.FV_DoShowDialog (4) - Display a dialog box and
let the user decide.
Constants.FS_FitGraphicInSel
ectedRect (14)
Fit the graphic in the selected graphic frame. Set to either True
or False.
• True - Fit the graphic in the frame.
• False - Do not fit the graphic in the frame.
Constants.FS_GraphicDpi (15) Integer specifying dots per inch (DPI) at which to import the
graphic. The default value is 72 (to specify 72 DPI).
Constants.FS_InsetRasterDpi Denotes the read-only value to indicate the DPI of the bitmap
facet when importing SVG data.
Constants.FS_RasterDpi (38) Specifies the DPI for the bitmap facet when importing SVG
data. This corresponds to any of the DPI settings in the
Imported Graphic Scaling dialog box.
Constants.FS_RasterImageHei
ght (40)
Specifies the height of the rectangle in which to import the
graphic, when importing SVG data.
NOTE: You should always specify this value in points. This
property corresponds to the height for the Fit in Selected
Rectangle setting in the Imported Graphic Scaling dialog box.
Property Meaning
643
BOOK
CHAPTER 6 FUNCTION SUMMARY
Import() uses the following properties only for importing ASCII text files:
Constants.FS_RasterImageWi
dth (39)
Specifies the width of the rectangle in which to import the
graphic, when importing SVG data.
NOTE: You should always specify this value in points. This
property corresponds to the width for the Fit in Selected
Rectangle setting in the Imported Graphic Scaling dialog box.
Constants.FS_ShowRasterDpi
Dialog (41)
For importing SVG data, show the Imported Graphic Scaling
dialog box. Default is 1 (one). The values are:
• 1 (one) or any non-zero value: Display the Imported
Graphic Scaling dialog box.
• 0 (zero): Do not display the Imported Graphic Scaling
dialog box.
Property Meaning
Constants.FS_CellSeparator
(29)
If Constants.FS_FileIsText (16) is set to
Constants.FV_DoImportAsTable (8), then this property
denotes the delimiter or separator used to parse the text into
cells. The default value is null.
Constants.FS_FileIsText (16) File is a Text Only file. The possible values are:
• Constants.FV_TextFile_EOLisEOP (12) - Import the file
and convert each end-of-line into a paragraph break.
• Constants.FV_TextFile_EOLisNotEOP (13) - Import the
file but do not convert each end-of-line into a paragraph
break.
• Constants.FV_DoImportAsTable (8) - Import the file into
a table.
• Constants.FV_DoCancel (0) - Cancel the import opera-
tion.
Constants.FS_ImportTblTag
(25)
Specifies the table format to use, if Constants.FS_FileIsText
(16) is set to Constants.FV_DoImportAsTable (8). The default
value is null.
Constants.FS_LeaveHeadingRo
wsEmpty (27)
Leave the heading rows empty if Constants.FS_FileIsText (16)
is set to Constants.FV_DoImportAsTable (8).
Constants.FS_LeaveHeadingRowsEmpty (27) is set to either
True or False.
• True - Leave heading rows empty.
• False - Do not leave heading rows empty.
Property Meaning
644
BOOK
CHAPTER 6 FUNCTION SUMMARY
When you import text into a table, in addition to setting Constants.FS_FileIsText (16) to
Constants.FV_DoImportAsTable (8), you must specify a value for the
Constants.FS_ImportTblTag (25) property. If you set the
Constants.FS_TreatParaAsRow (28) property to True, you must also specify a value for the
Constants.FS_CellSeparator (29) property.
The property list returned by GetImportDefaultParams() does not specify values for the
Constants.FS_ImportTblTag (25) and Constants.FS_CellSeparator (29) proper-
ties.
If you use the property list to import a table and do not specify a value for
Constants.FS_ImportTblTag (25), Import() fails and sets FA_errno to
Constants.FE_BadParameter (-43).
If you set Constants.FS_TreatParaAsRow (28) to True and do not specify a cell separator by
setting Constants.FS_CellSeparator (29), Import() fails and sets FA_errno to
Constants.FE_BadParameter (-43).
If GetImportDefaultParams() fails, the Import() method sets the len field of the returned
PropVals structure to 0.
Constants.FS_NumCellSeparato
rs (30)
Denotes the number of spaces to use as a separator, if
Constants.FS_FileIsText (16) is set to
Constants.FV_DoImportAsTable (8), and
Constants.FS_CellSeparator (29) is set to a space (' '). The
default value is 1.
Constants.FS_NumColumns
(31)
Specifies the number of columns in the table, if
Constants.FS_FileIsText (16) is set to
Constants.FV_DoImportAsTable (8), and
Constants.FS_TreatParaAsRow (28) is False. The default value
is 1.
Constants.FS_TblNumHeadingR
ows (26)
Specifies the number of heading rows in the table, if
Constants.FS_FileIsText (16) is set to
Constants.FV_DoImportAsTable (8). The default value is 1.
Constants.FS_TreatParaAsRow
(28)
Convert each line in the text file into a row of table cells and
use Constants.FS_CellSeparator (29) and
Constants.FS_NumCellSeparators (30) to determine how to
divide the line into separate cells, if Constants.FS_FileIsText
(16) is set to Constants.FV_DoImportAsTable (8).
Constants.FS_TreatParaAsRow (28) is set to either True or
False.
• True - Convert each line into a row of table cells.
• False - Convert each line into a table cell instead.
Property Meaning
645
BOOK
CHAPTER 6 FUNCTION SUMMARY
The Import() method returns the object that was imported, on success.
NOTE: Import() returns 0 on success, if it imports a copy or a graphic inset.
On failure, the method assigns one of the following values to FA_errno:
The property list returned to importReturnParamspp has the following properties:
Both the Constants.FS_ImportNativeError (2) property and the FA_errno global variable
indicate the result of a call to the Import() method. The following table lists the possible status flags
and the reasons associated with them:
Error Reason
Constants.FE_SystemError
(-42)
System error, such as an unreadable file or insufficient memory.
Constants.FE_BadParamet
er (-43)
The property list contained an invalid parameter.
Constants.FE_BadFileType
(-83)
The specified file exists, but it does not have the correct file type.
Constants.FE_MissingFile
(-84)
The specified file does not exist.
Constants.FE_NoSuchFlow
(-82)
The script specifies an import flow that does not exist.
Constants.FE_FailedState
(-45)
Internal error.
Constants.FE_CircularRefe
rence (-81)
Importing the specified file causes a circular reference.
Constants.FE_FileClosedBy
Clients
The file was closed by a client before it could be imported.
Property Meaning
Constants.FS_ImportedFileN
ame (1)
A string specifying the source file's path. If you scripted
Constants.FS_ShowBrowser (1), this path can be different from
the one you specified in the Import script.
Constants.FS_ImportNativeE
rror (2)
The error condition; normally the same value as FA_errno. If
the file is imported successfully,
Constants.FS_ImportNativeError (2) is set to
Constants.FE_Success (0).
Constants.FS_ImportStatus
(3)
A bit field indicating what happened when the file was
imported. See the following table for more information.
646
BOOK
CHAPTER 6 FUNCTION SUMMARY
Status Flag Reason
• Constants.FE_BadParameter
(-43)
• Constants.FE_BadFileType
(-83)
• Constants.FE_MissingFile (-84)
• Constants.FE_FailedState (-45)
• Constants.FE_CanceledBy-
Client (-86) (file was not
imported)
• Constants.FV_BadImportFileName (16) - The spec-
ified source filename is invalid.
• Constants.FV_BadImportFileType (17) - The Import
script specified a file type different from the source
file's actual type.
• Constants.FV_BadImportScriptValue (18) - The
Import script contained an invalid property value.
• Constants.FV_BadTextFileTypeHint (29) - The file
was a text file, and the string in Constants.FS_File-
TypeHint (34) was not a valid import hint string.
• Constants.FV_MissingScript: Import() was called
without a script.
• Constants.FV_DisallowedImportType (21) - Source
file's type is disallowed by script.
• Constants.FV_NoMainFlow (22) - A script was spec-
ified to import the main flow, but the source file
does not have a main flow.
• Constants.FV_NoFlowWithSpecifiedName (23) - A
script was specified with a flow name that does not
exist.
• Constants.FV_InsertionPointNotInText (24) - The
insertion point in the enclosing document is not in
the text.
• Constants.FV_InsufficientMemory (27) - There is
insufficient memory to import the source file.
• Constants.FV_BadEnclosingDocId (28) - There is no
open document with the specified ID.
• Constants.FV_ImportFileNotReadable (48) - The
specified source file is unreadable.
647
BOOK
CHAPTER 6 FUNCTION SUMMARY
Constants.FE_Success (0) • Constants.FV_ImportedByCopy (0) - The source file
was imported by copy.
• Constants.FV_ImportTextTable - The source file is a
text file, which was imported into a table.
• Constants.FV_ImportedMIF (3) - The source file is a
MIF file.
• Constants.FV_ImportedMakerDoc (4) - The source
file is a FASL file.
• Constants.FV_ImportedFilteredFile (5) - The source
file was filtered.
• Constants.FV_ImportedGraphicFile (6) - The
source file is a graphics file.
• Constants.FV_ImportedSgmlDoc (8) - The source
file is an SGML document.
• Constants.FV_ImportedXmlDoc (9) - The source file
is an XML document.
Status Flag Reason
648
BOOK
CHAPTER 6 FUNCTION SUMMARY
To determine whether a particular Constants.FS_ImportStatus (3) bit is set, use
CheckStatus().
Constants.FE_Canceled (-44) • Constants.FV_CancelFileText (32) - The file is text,
so the user or the Import script canceled the
Import operation.
• Constants.FV_CancelFileGraphic (36) - The source
file is a graphic, so the user or the Import script
canceled the Import operation.
• Constants.FV_CancelFileMacEdition - The source
file is a Macintosh Edition, so the Import script
canceled the Import operation
• Constants.FV_CancelFileDoc (33) - The file is a FASL
file, so the user or the script canceled the Import
operation.
• Constants.FV_CancelFileSgml (40) - The file is an
SGML document, so the user or the script canceled
the Import operation
• Constants.FV_CancelFileXml (41) - The file is an
XML document, so the user or the script canceled
the Import operation.
• Constants.FV_CancelFileMIF (34) - The source file
is a MIF file, so the user or the script canceled the
Import operation.
• Constants.FV_CancelFileFilterable (35) - The
source file is a filterable file, so the user or the
script canceled the Import operation.
• Constants.FV_InsertionPointInFootnote (26) - The
insertion point was in a footnote and the import
script specified to import the file as a table, so the
file could not be imported.
• Constants.FV_InsertionPointInTableCell (25) - The
insertion point was in a table cell and the import
script specified to import the file as a table, so the
file could not be imported
• Constants.FV_UserCanceledImport (37) - The user
canceled the Import operation.
• Constants.FV_UserCanceledImportBrowser : The
user canceled the Import browser
Status Flag Reason
649
BOOK
CHAPTER 6 FUNCTION SUMMARY
Returns
Object
Syntax
Import(textLocP, filename, importParams, importReturnParams)
Parameters
GetProps
Description
Retrieves the properties of the specified Book.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
Parameter name
Data
Type
Option
al Description
textLocP TextL
oc
No The text location at which to import
the file.
filename strin
g
No The full path of the file to import.
importParams PropV
als
No A property list specifying how to
import the file and how to respond to
errors and other conditions. To use
the default list, specify null.
importReturnParams PropV
als
No A property list that provides
information about how FrameMaker
imported the file. This parameter
must be initialized before you call
Import().
650
BOOKCOMPONENT
CHAPTER 6 FUNCTION SUMMARY
SetProps
Description
Sets the value of the specified property of the Book.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Indicates whether the specified book is valid. Returns 1 if the specified book is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.11. BookComponent
Delete
Description
Deletes the specified BookComponent object.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The value to set.
651
BOOKCOMPONENT
CHAPTER 6 FUNCTION SUMMARY
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
MoveComponent
Description
Moves a particular book component up and down in the book components sequence. In addition , you
can promote and demote operations of a component in a hierarchy using this method.
Returns
Void
Syntax
MoveComponent(moveAction)
Parameters
GetProps
Description
Retrieves the properties of the specified BookComponent object.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
Parameter name
Data
Type
Option
al Description
moveAction int No Specifies the action to move the
component
652
CELL
CHAPTER 6 FUNCTION SUMMARY
SetProps
Description
Sets the property of the BookComponent object.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Indicates whether a BookComponent object is valid. Returns 1 if the specified book component is valid,
else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.12. Cell
StraddleCells
Description
The StraddleCells() method straddles the specified cells in a table.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The value of the property to be set.
653
CELL
CHAPTER 6 FUNCTION SUMMARY
The cells you straddle must all be from the same type of row. You cannot straddle a set of cells that are
in both heading and body rows or footing and body rows. Also, the cells you straddle must be unstrad-
dled. You cannot use this function to further straddle cells that are already straddled.
The StraddleCells() method returns FE_Success on success.
The method assigns one of the following values toFA_errno, on failure:
Returns
int
Syntax
StraddleCells(heightInRows, widthInCols)
Parameters
UnStraddleCells
Description
The UnStraddleCells() method unstraddles the specified cells in a table.
Error Reason
Constants.FE_WrongProd
uct (-60)
Current FrameMaker product does not support tables.
Constants.FE_BadOperati
on (-27)
Parameters specify an action that is invalid.
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_BadParame
ter (-43)
Parameter has an invalid value.
Constants.FE_BadObjId
(-3)
Invalid cell.
Parameter name
Data
Type
Option
al Description
heightInRows int No Denotes the number of cells to
straddle vertically.
widthInCols int No Indicates the number of cells to
straddle horizontally.
654
CELL
CHAPTER 6 FUNCTION SUMMARY
The UnStraddleCells() method returns FE_Success on success.The method assigns one of the
following values to FA_errno, on failure:
Returns
int
Syntax
UnStraddleCells(heightInRows, widthInCols)
Parameters
GetText
Description
The GetText() method gets the text from the following types of objects:
•Cell
•Element
• Flow
•Fn
Error Reason
Constants.FE_WrongProd
uct (-60)
Current FrameMaker product does not support tables.
Constants.FE_BadOperati
on (-27)
Parameters specify an action that is invalid.
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_BadParame
ter (-43)
Parameter has an invalid value.
Constants.FE_BadObjId
(-3)
Invalid cell.
Parameter name
Data
Type
Option
al Description
heightInRows int No The number of cells to unstraddle
vertically.
widthInCols int No The number of cells to unstraddle
horizontally.
655
CELL
CHAPTER 6 FUNCTION SUMMARY
•Pgf
•SubCol
•TextFrame
• TextLine
• TiApiClient
• TiFlow
•TiText
• TiTextTable
•XRef
Call this method on the document as follows:
document.GetText(flags)
GetText() returns an object containing an array of text items. Each text item contains either a string
of text, an object that appears within the text (such as a table or an anchored frame), an indicator that
the text properties have changed, or the object that organizes the text (such as a paragraph or a text
column).
NOTE: Use the DeallocateTextItems() method to deallocate the memory used by the
TextItems structure returned by GetText() when you have finished using it.
To get specific types of text items, OR the constants that represent them (for example, use a bitwise OR
to combine FTI_FlowBegin and FTI_String) into flags. To get all types of text items, specify -1.
The method returns a TextItems object containing the array of text items of the requested text types.
TextItem.dataType can be one of the following constants:
Text Item Type Text Item Represents Text Item Data
FTI_CharPropsChang
e
A change in the text
properties
Flags indicating which properties have
changed (see the following table).
FTI_ElementBegin The beginning of a
container structural
element
FO_Element
FTI_ElementEnd The end of a container
structural element
FO_Element
FTI_ElemPrefixBegin The beginning of an
element’s prefix
FO_Element
FTI_ElemPrefixEnd The end of an element’s
prefix
FO_Element
FTI_ElemSuffixBegin The beginning of an
element’s suffix
FO_Element
656
CELL
CHAPTER 6 FUNCTION SUMMARY
FTI_ElemSuffixEnd The end of an element’s
suffix
FO_Element
FTI_FlowBegin The beginning of a flow FO_Flow
FTI_FlowEnd The end of a flow FO_Flow
FTI_FnAnchor A footnote FO_Fn
FTI_FrameAnchor An anchored frame FO_AFrame
FTI_LineBegin The beginning of a line -
FTI_LineEnd The end of a line and the
line end type
If the line end is a normal line end, the
value is 0;
if it is a forced line end, the
FTI_HardLineEnd flag is set;
if it is a hyphen line end, the
FTI_HyphenLineEnd flag is set
FTI_MarkerAnchor A Marker FO_Marker
FTI_PageBegin The beginning of a page FO_Page
FTI_PageEnd The end of a page FO_Page
FTI_PgfBegin The beginning of a
paragraph
FO_Pgf
FTI_PgfEnd The end of a paragraph FO_Pgf
FTI_String A string of characters with
the same condition and
character format.
A character string
FTI_SubColBegin The beginning of a column FO_SubCol
FTI_SubColEnd The end of a column FO_SubCol
FTI_TblAnchor A Table FO_Tbl
FTI_TextFrameBegin The beginning of a text
frame
FO_TextFrame
FTI_TextFrameEnd The end of a text frame FO_TextFrame
FTI_TextInsetBegin The beginning of a text
inset
FO_TiApiClient, FO_TiFlow, FO_TiText, or
FO_TiTextTable
FTI_TextInsetEnd The end of a text inset FO_TiApiClient, FO_TiFlow, FO_TiText, or
FO_TiTextTable
Text Item Type Text Item Represents Text Item Data
657
CELL
CHAPTER 6 FUNCTION SUMMARY
The following table lists the bit flags that a client can bitwise AND with the idata field of a
Constants.FTI_CharPropsChange (0x00200000) text item. For example, to determine if
the font family changed, bitwise AND the Constants.FTF_FAMILY (0x80000000) flag with the
idata field.
FTI_TextObjId The object to which the
offsets of all the text items
are relative
FO_Pgf or FO_TextLine
FTI_VarBegin The beginning of a variable FO_Var
FTI_VarEnd The end of a variable FO_Var
FTI_XRefBegin The beginning of a
cross-reference
FO_XRef
FTI_XRefEnd The end of a
cross-reference
FO_XRef
Flags Meaning
FTF_ALL OR of all the flags
FTF_ANGLE The font angle has changed.
FTF_CAPITALIZATION The capitalization has changed.
FTF_CHANGEBAR The change bars have changed.
FTF_CHARTAG The Character Catalog format has changed.
FTF_COLOR The color has changed.
FTF_CONDITIONTAG The condition tag has changed.
FTF_ENCODING The text encoding has changed,
FTF_FAMILY The font family has changed.
FTF_IIF An internal flag having to do with Asian text. input. If there is a
non-zero value for this flag, a front-end processor is controlling that
text and you should not modify the associated text item.
FTF_KERNX The kern-x characteristic has changed.
FTF_KERNY The kern-x characteristic has changed.
FTF_LANGUAGE Character language has changed.
FTF_OUTLINE The outline characteristic has changed.
FTF_OVERLINE The overline characteristic has changed.
Text Item Type Text Item Represents Text Item Data
658
CELL
CHAPTER 6 FUNCTION SUMMARY
On success, the method returns a TextItems structure containing the array of text items of the
requested types.
On failure, the method sets the len field of the returned TextItems structure to 0, and returns one
of the following values toFA_errno:
If you call GetText() for an object (FO_Element object), the returned information depends on the type
of element, as shown:
FTF_PAIRKERN The pair kerning has changed.
FTF_POSITION The character position has changed.
FTF_SHADOW The shadow characteristic has changed.
FTF_SIZE The font size has changed.
FTF_SPREAD The font spread has changed.
FTF_STRETCH The font stretch value has changed.
FTF_STRIKETHROUGH The strikethrough characteristic has changed.
FTF_TSUME The Tsume setting has changed.
FTF_UNDERLINING The underlining has changed.
FTF_VARIATION The font variation has changed.
FTF_WEIGHT The font weight has changed.
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadObjId (-3) Invalid Object
Constants.FE_NotTextObjec
t (-41)
Object specified for the text range is not an object that contains
text.
Value Information Returned
Constants.FV_FO_CONTAI
NER (1)
All the text items from the beginning to the end of the element.
Constants.FV_FO_SYS_VA
R (2)
All the text items from the beginning to the end of the variable.
Constants.FV_FO_XREF (3) All the text items from the beginning to the end of the cross
reference.
Flags Meaning
659
CELL
CHAPTER 6 FUNCTION SUMMARY
Returns
TextItems
Syntax
GetText(flags)
Parameters
Constants.FV_FO_FOOTN
OTE (5)
All the text items from the beginning to the end of the footnote.
Constants.FV_FO_TBL_TIT
LE (9)
All the text items from the beginning to the end of the table title.
Constants.FV_FO_TBL_CEL
L (14)
All the text items from the beginning to the end of the cell.
Constants.FV_FO_TBL_HE
ADING (10)
Nothing. GetText() failed.
Constants.FV_FO_TBL_BO
DY (11)
Constants.FV_FO_TBL_FO
OTING (12)
Constants.FV_FO_MARKE
R (4)
Constants.FV_FO_TBL (8)
Constants.FV_FO_GRAPHI
C (6)
Constants.FV_FO_EQN (7)
Constants.FV_FO_TBL_RO
W (13)
Parameter name
Data
Type
Option
al Description
flags int No Denotes the various bit flags that
specify the items to be retrieved.
Value Information Returned
660
CELL
CHAPTER 6 FUNCTION SUMMARY
GetProps
Description
Retrieves the properties of the specified cell object.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the desired property of the cell object.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Indicates whether a cell object is valid. Returns 1 if the cell object is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The value of the property to set.
661
CHARFMT
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
ObjectValid()
6.13. CharFmt
Delete
Description
Deletes the specified CharFmt object.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
Get the properties of the specified CharFmt object.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the value of the property for the specified CharFmt object.
See SetProps under the AFrame class for more information.
662
CMSOBJECT
CHAPTER 6 FUNCTION SUMMARY
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Indicates whether the specified CharFmt object is valid. Returns 1 if the CharFmt object is valid, else
returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.14. CMSObject
CMSSetProperty()
Description
Sets a single property for a CMS object.
Returns
void
Syntax
void CMSSetProperty(cmsSessionId,objectId,propval);
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The value of the property to set.
663
CMSOBJECT
CHAPTER 6 FUNCTION SUMMARY
Parameters
If CMSSetProperty() fails, the method assigns following values to FA_errno:
CMSSetProperties()
Description
Sets multiple properties of a CMS object
Returns
void
Syntax
CMSSetProperties (cmsSessionId,objectId,propVals);
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS Session
cmsObjectId int No The ID of the CMS Object
propVal int No The specified property of a CMS
object as a PropVal data structure
Error Reason
Constants.FE_CMSBadS
essionId
The client specified an invalid session ID.
Constants.FE_CMSBadO
bjectId
The client specified an invalid cms object ID.
Constants.FE_CMSRoot
ObjectExists
The method tries to set a root which already exists.
Constants.FE_CMSBadIt
emFileType
The file type expected by the cms object does not match
the valid file type.
Constants.FE_CMSBadIt
emType
The item type expected by the cms object does not
match the valid item type
Constants.FE_CMSBadIt
emContainerType
The container value expected by the cms object is not
properly set
664
CMSOBJECT
CHAPTER 6 FUNCTION SUMMARY
Parameters
If CMSSetProperties() fails, the method assigns following values to FA_errno:
CMSGetProperty()
Description
Gets a specified property of a CMS object.
Returns
PropVals
Syntax
CMSGetProperty (cmsSessionId, objectId,propertyId);
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS Session
cmsObjectId int No The ID of the CMS Object
propVals int No A property list that specifies the CMS
properties . Properties are added as
propvals with the identifier as
CMSItemPropertyT enum and value.
Error Reason
Constants.FE_CMSBadS
essionId
The client specified an invalid session ID.
Constants.FE_CMSBadO
bjectId
The client specified an invalid cms object ID.
Constants.FE_CMSRoot
ObjectExists
The method tries to set a root which already exists.
Constants.FE_CMSBadIt
emFileType
The file type expected by the cms object does not match
the valid file type.
Constants.FE_CMSBadIt
emType
The item type expected by the cms object does not
match the valid item type
Constants.FE_CMSBadIt
emContainerType
The container value expected by the CMS object is not
properly set
665
CMSOBJECT
CHAPTER 6 FUNCTION SUMMARY
Parameters
If CMSGetProperty() fails, the method assigns following values to FA_errno:
CMSGetProperties()
Description
Gets the properties of a CMS object.
Returns
PropVals
Syntax
CMSGetProperties (cmsSessionId, objectId);
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS Session.
objectId int No The ID of the CMS Object.
propertyId int No F_PropIdentT which allows user to
specify property identifier as Integer
value OR string value based on the
CMS. For e.g. Documentum works on
object name, whereas Generic CMS
works on Integer based identifier ID
of the CMS Object.
Error Reason
Constants.FE_CMSBadS
essionId
The client specified an invalid session ID.
Constants.FE_CMSBadO
bjectId
The client specified an invalid cms object ID.
Constants.FE_BadParam
eter
The function call specified an invalid parameter.
666
CMSOBJECT
CHAPTER 6 FUNCTION SUMMARY
Parameters
If CMSGetProperties() fails, the method assigns following values to FA_errno:
CMSEnableCommand()
Description
Enables the specified CMS command in the context menu of the CMS tree within FrameMaker.
Returns
void
Syntax
CMSEnableCommand (cmsSessionId, objectId, commandId);
Parameters
If CMSEnableCommand() fails, the method assigns following values to FA_errno:
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS Session
objectId int No The ID of the CMS Object
Error Reason
Constants.FE_CMSBadS
essionId
The client specified an invalid session ID.
Constants.FE_CMSBadO
bjectId
The client specified an invalid cms object ID.
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS Session
cmsObjectId int No The ID of the CMS Object
commandId int No The command to enable
667
CMSOBJECT
CHAPTER 6 FUNCTION SUMMARY
CMSDisableCommand()
Description
Disables the specified CMS command in the context menu of the CMS tree within FrameMaker.
Returns
void
Syntax
CMSDisableCommand (cmsSessionId, objectId, commandId);
Parameters
If CMSDisableCommand() fails, the method assigns following values to FA_errno:
Error Reason
Constants.FE_CMSBadS
essionId
The client specified an invalid session ID.
Constants.FE_CMSBadO
bjectId
The client specified an invalid cms object ID.
Constants.FE_CMSBadC
ommandId
The client specified an invalid command ID.
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS Session
cmsObjectId int No The ID of the CMS Object
commandId int No The command to disable
Error Reason
Constants.FE_CMSBadS
essionId
The client specified an invalid session ID.
Constants.FE_CMSBadO
bjectId
The client specified an invalid cms object ID.
Constants.FE_CMSBadC
ommandId
The client specified an invalid command ID.
668
CMSOBJECT
CHAPTER 6 FUNCTION SUMMARY
CMSShowCheckoutUI()
Description
Displays the checkout dialog for a CMS object
Returns
bool
Syntax
CMSShowCheckoutUI (sessionId, objectId, hideUiItems);
Parameters
Enum constants used to customize CMS Object's Checkout user interface.
The possible values of the hideUiItems field are
If CMSShowCheckoutUI() fails, the method assigns following values to FA_errno:
Parameter name
Data
Type
Option
al Description
sessionId int No The ID of the CMS session
objectId int No The ID of the CMS Object
hideUiItems int No Parameter to customize the checkout
dialog. It can take the values from
CMSCustomizeCheckoutUI enum
Value for flags Meaning
FV_CMSCheckoutUI_Id_
ShowDependents
Flag to hide “Show dependents” checkbox
Error Reason
Constants.FE_CMSBadS
essionId
The client specified an invalid session ID
Constants.FE_CMSBadO
bjectId
The client specified an invalid cms object ID
Constants.FE_BadParam
eter
The function call specified an invalid parameter.
669
CMSOBJECT
CHAPTER 6 FUNCTION SUMMARY
CMSShowCheckinUI()
Description
Displays the checkin dialog for a CMS object
Returns
bool
Syntax
CMSShowCheckinUI (sessionId, objectId, hideUiItems);
Parameters
Enum constants used to customize CMS Object's Checkin user interface.
The possible values of the hideUiItems field are
If CMSShowCheckinUI() fails, the method assigns following values to FA_errno:
Parameter name
Data
Type
Option
al Description
sessionId int No The ID of the CMS session
objectId int No The ID of the CMS Object
hideUiItems int No Parameter to customize the checkout
dialog. It can take the values from
CMSCustomizeCheckinUI enum
hideUiItems constants Reason
Constants.FV_CMSChec
kinUI_Id_MajorVersion
Flag to hide “Major version” radio button
Constants.FV_CMSChec
kinUI_Id_VersionLabel
Flag to hide “Version Label” text field
Constants.FV_CMSChec
kinUI_Id_Description
Flag to hide “Description” text field
Constants.FV_CMSChec
kinUI_Id_CheckinComm
ent
Flag to hide “Checkin comment” text field
Constants.FV_CMSChec
kinUI_Id_MakeThisCurr
entVersion
Flag to hide “Make this current version” checkbox
670
CMSOBJECT
CHAPTER 6 FUNCTION SUMMARY
CMSShowCancelCheckoutUI()
Description
Displays the Cancel Check out dialog for a CMS object
Returns
void
Syntax
CMSShowCancelCheckoutUI (sessionId, objectId);
Parameters
If CMSShowCancelCheckoutUI() fails, the method assigns following values to FA_errno:
Error Reason
Constants.FE_CMSBadS
essionId
The client specified an invalid session ID
Constants.FE_CMSBadO
bjectId
The client specified an invalid cms object ID
Constants.FE_BadParam
eter
The function call specified an invalid parameter.
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS session
cmsObjectId int No The ID of the CMS object
Error Reason
Constants.FE_CMSBadS
essionId
The client specified an invalid session ID
Constants.FE_CMSBadO
bjectId
The client specified an invalid cms object ID
671
CMSOBJECT
CHAPTER 6 FUNCTION SUMMARY
CMSShowDeleteUI()
Description
Displays the Delete dialog for a CMS object
Returns
CMSDeleteParam
Syntax
CMSShowDeleteUI (F_ObjHandleT cmsSessionId, objectId, T hideUiItems);
Parameters
Enum constants used to customize CMS Object's Delete user interface.
The user can specify one or more of the following flag constants (using the OR expression for multiple
flags) into the hideUiItems field:
If CMSShowDeleteUI() fails, the method assigns following values to FA_errno:
Parameter name
Data
Type
Option
al Description
sessionId int No The ID of the CMS session
objectId int No The ID of the CMS Object
hideUiItems int No Parameter to customize the delete
dialog. It can take the values from
CMSCustomizeDeleteUI enum
Value for flags Meaning
Constants.FV_CMSDelet
eUI_DeleteAllVersion
Flag to hide “Delete all the version of a file” checkbox
Constants.FV_CMSDelet
eUI_DeleteAllDependen
ts
Flag to hide “Delete all the dependents of a file”
checkbox
Error Reason
Constants.FE_CMSBadS
essionId
The client specified an invalid session ID
Constants.FE_CMSBadO
bjectId
The client specified an invalid cms object ID
672
CMSOBJECT
CHAPTER 6 FUNCTION SUMMARY
CMSShowCommonListUI()
Description
Displays the list-based dialogs such as “Show Version”, “Show Checked out files”, “Show dependents”
and “Show result”. These items are fetched using the CMSGetItems CMS command.
Returns
bool
Syntax
CMSShowCommonListUI (cmsSessionId, objectId, commandId, title,
columnProperties);
Parameters
If CMSShowCommonListUI() fails, the method assigns following values to FA_errno:
Constants.FE_BadParam
eter
The function call specified an invalid parameter.
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS Session
cmsObjectId int No The ID of the CMS Object
commandId int No The ID of the CMS command
title int No The Title of the Show Dialog
columnProperties int No Properties Columns to show
Error Reason
Constants.FE_CMSBadS
essionId
The client specified an invalid session ID.
Constants.FE_CMSBadO
bjectId
The client specified an invalid cms object ID.
Constants.FE_CMSBadC
ommandId
The client specified an invalid command ID.
Error Reason
673
CMSOBJECT
CHAPTER 6 FUNCTION SUMMARY
CMSShowPropertyUI()
Description
Displays the Property dialog for a CMS object
Returns
CMSProperties
Syntax
CMSShowPropertyUI ( cmsSessionId, objectId, props);
Parameters
If CMSShowPropertyUI() fails, the method assigns following values to FA_errno:
Constants.FE_BadParam
eter
The function call specified an invalid parameter.
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS Session
cmsObjectId int No The ID of the CMS Object
props int No CMSPropertiesT structure specifies a
set of CMS object propeties. Set NULL
if user wants to show default
properties
Error Reason
Constants.FE_CMSBadS
essionId
The client specified an invalid session ID
Constants.FE_CMSBadO
bjectId
The client specified an invalid cms object ID
Constants.FE_BadParam
eter
The function call specified an invalid parameter.
Error Reason
674
CMSOBJECT
CHAPTER 6 FUNCTION SUMMARY
CMSShowPropertyUIWithTitle
Description
Displays the Property dialog for a CMS object with a specified title.
Returns
CMSProperties
Syntax
CMSShowPropertyUIWithTitle ( cmsSessionId, objectId, props, title);
Parameters
If CMSShowPropertyUIWithTitle fails, the method assigns following values to FA_errno:
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS Session
cmsObjectId int No The ID of the CMS Object
props int No CMSPropertiesT structure specifies a
set of CMS object propeties. Set NULL
if user wants to show default
properties
title strin
g
No Title of the dialog box
Error Reason
Constants.FE_CMSBadS
essionId
The client specified an invalid session ID
Constants.FE_CMSBadO
bjectId
The client specified an invalid cms object ID
Constants.FE_BadParam
eter
The function call specified an invalid parameter.
675
CMSREGISTRATION
CHAPTER 6 FUNCTION SUMMARY
6.15. CMSRegistration
CMSGetCMSInfo()
Description
Gets the CMS information for a particular CMS registration id.
Returns
CMSInfo
Syntax
CMSGetCMSInfo (cmsId);
Parameters
If CMSGetCMSInfo() fails, the method assigns following values to FA_errno:
CMSConfigLoginUI()
Description
Configures the CMS Connector Manager dialogs within the FrameMaker interface
Returns
void
Syntax
CMSConfigLoginUI (cmsId, userFields, userLoginUI);
Parameter name
Data
Type
Option
al Description
cmsId int No The registration ID of the CMS
Error Reason
Constants.FE_BadParam
eter
The function call specified an invalid parameter.
676
CMSSESSION
CHAPTER 6 FUNCTION SUMMARY
Parameters
If CMSConfigLoginUI() fails, the method assigns following values to FA_errno:
6.16. CMSSession
CMSLogout()
Description
Logs out the user from a particular CMS connection
Returns
void
Syntax
CMSLogout(cmsSessionId);
Parameters
If CMSLogout() fails, the method assigns following values to FA_errno:
Parameter name
Data
Type
Option
al Description
cmsId int No The ID of the CMS
userFields int No Optional user fields with strings. User
can add upto two user fields.
userLoginUI int No 1 if user want to impement his own
custom connection manager dialog
Error Reason
Constants.FE_BadParam
eter
The function call specified an invalid parameter.
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS session
677
CMSSESSION
CHAPTER 6 FUNCTION SUMMARY
GetCMSObjectFromPath()
Description
Gets CMS object from a URL path
Returns
CMS Object
Syntax
GetCMSObjectFromPath (cmsSessionId, urlPath)
Parameters
If GetCMSObjectFromPath() fails, the method assigns following values to FA_errno:
CMSShowBrowseRepositoryUI
Description
Displays repository browser dialog based on flag “showContainerOnly”
Returns
CMS Object
Syntax
CMSShowBrowseRepositoryUI (cmsSessionId,showContainerOnly);
Error Reason
Constants.FE_CMSFaile
dLogout
Failed to log out of the CMS
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS Session
urlPath int No The url pathname of the file or folder
Error Reason
Constants.FE_CMSFaile
dGetItemFrompath
Failed to get the CMS object from the specified path
678
CMSSESSION
CHAPTER 6 FUNCTION SUMMARY
Parameters
CMSCreateObject
Description
Creates a CMS object.
Returns
CMS Object
Syntax
CMSCreateObject (cmsSessionId);
Parameters
If CMSCreateObject() fails, the method assigns following values to FA_errno:
CMSGetCmsIdFromSession
Description
Gets the CMS registration id from CMS Session id
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS session
showContainerOnly int No 1 if only container item is shown 0 if
all items are shown
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS session
Error Reason
Constants.FE_CMSBadS
essionId
The client specified an invalid session ID.
Constants.FE_CMSObje
ctCreationFailed
Method failed to create a cms object.
679
COLOR
CHAPTER 6 FUNCTION SUMMARY
Returns
CMS Object
Syntax
F_ApiCMSGetCmsIdFromSession (cmsSessionId);
Parameters
If CMSGetCmsIdFromSession() fails, the method assigns following values to FA_errno:
6.17. Color
Delete
Description
Deletes the specified color object.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
Retrieves the properties of the specified color object.
See GetProps under the AFrame class for more information.
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS session
Error Reason
Constants.FE_CMSBadS
essionId
The client specified an invalid session ID
680
COLOR
CHAPTER 6 FUNCTION SUMMARY
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the value of the property for the color object.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Determines whether a color object is valid. Returns 1 if the Color object is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The value of the property to be set.
681
COMBINEDFONT
CHAPTER 6 FUNCTION SUMMARY
6.18. CombinedFont
CombinedFont
Description
CombinedFont specifies a set of font characteristics for a combined font. The combinedFont field
specifies a CombinedFont object. From this object you can get information about the combined font
such as the base and Western font families, or the combined font name.
Returns
CombinedFont
Syntax
CombinedFont(combinedFont, variation, weight, angle)
Parameters
6.19. CombinedFontDefn
CombinedFamilyFonts
Description
Returns the permutations of angles, variations, and weights available for a specified combined font defi-
nition.
The method does not take any arguments.
The CombinedFamilyFonts() method returns a CombinedFonts object that provides a list of the
permutations of angles, variations, and weights available for the specified combined font definition.
Parameter name
Data
Type
Option
al Description
combinedFont Combi
nedFo
ntDef
n
No CombinedFont object.
variation uint No Index of the font variation.
weight uint No Index of the font weight.
angle uint No Index of the font angle.
682
COMBINEDFONTDEFN
CHAPTER 6 FUNCTION SUMMARY
Returns
CombinedFonts
Syntax
CombinedFamilyFonts()
Delete
Description
Deletes the specified CombinedFonts object.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
Retrieves the properties of the specified CombinedFonts object.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the value of the desired property of the CombinedFonts object.
See SetProps under the AFrame class for more information.
Returns
Void
683
COMBINEDFONTS
CHAPTER 6 FUNCTION SUMMARY
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Indicates whether a CombinedFonts object is valid. Returns 1 if the CombinedFonts object is valid, else
returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.20. CombinedFonts
An Array of CombinedFont objects with integer indexing and a length property.
concat
Description
The original array is unchanged. If an array is provided as a parameter to concat(), each of its elements
are appended as separate array elements at the end of the new array. Returns a new array, the result of
concatenation the given values to the end of the original array.
Returns
CombinedFonts
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The value of the property to be set.
684
COMBINEDFONTS
CHAPTER 6 FUNCTION SUMMARY
Syntax
concat(value)
Parameters
pop
Description
Removes the last element from the array.
Returns
CombinedFont
Syntax
pop()
push
Description
Returns the new length of the array.
Returns
number
Syntax
push(value)
Parameter name
Data
Type
Option
al Description
value Combi
nedFo
nts
No Can also be arrays.
685
COMMAND
CHAPTER 6 FUNCTION SUMMARY
Parameters
6.21. Command
Delete
Description
Deletes the specified Command object.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
Retrieves the properties of the specified Command object.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
Parameter name
Data
Type
Option
al Description
value Combi
nedFo
nt
No The value to push into the array
686
COMMAND
CHAPTER 6 FUNCTION SUMMARY
SetProps
Description
Sets the value of the specified Command property.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Identifies whether a Command object is valid or not. Returns 1 if the Command object is valid, else
returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
Delete
Description
Deletes the specified Command object.
The method does not take any arguments.
Call the Delete() method directly on the object to be deleted.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The value of the property to set.
687
COMPARERET
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
Delete()
6.22. CompareRet
CompareRet
Description
CompareRet provides the results of a call to the Compare() method. The method returns a
CompareRet object with the summary and composite documents.
Returns
CompareRet
Syntax
CompareRet(sum, comp)
Parameters
6.23. CondFmt
Delete
Description
Deletes the specified CondFmt object.
See Delete under the AFrame class for more information.
Parameter name
Data
Type
Option
al Description
sum Doc No Summary Document.
comp Doc No Composite Document.
688
CONDFMT
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
Delete()
DeleteCondTag
Description
Deletes a conditional tag from a document.
Returns
Status
Syntax
DeleteCondTag(docId, condTagId, action);
Parameters
If DeleteCondTag() fails, the method assigns following values to FA_errno:
Parameter name
Data
Type
Option
al Description
docId int No The id of the document containing
the conditional tag to be deleted
condTagId int No The id of the conditional tag object
(type: FO_CondFmt) in the doc
action int No One of the following:
FF_UNTAGGED_ASK: Prompt the user
FF_UNTAGGED_UNCOND: Make text
unconditional
FF_UNTAGGED_DELETE: Delete text
Error Reason
Constants.FE_ReadOnly Document is read only.
Constants.FE_BadValue Action is not one of the specified values
Constants.FE_Success Deletion was successful
689
CONDFMT
CHAPTER 6 FUNCTION SUMMARY
GetProps
Description
Retrieves the properties of the specified CondFmt object.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the value of the specified CondFmt object property.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Identifies whether a CondFmt object is valid or not. Returns 1 if the CondFmt object is valid, else returns
0.
See ObjectValid under the AFrame class for more information.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The value of the property to set.
690
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
ObjectValid()
6.24. Doc
AddText
Description
Inserts text into a paragraph or a text line.
The text you specify for text must use the FrameMaker character set. To add special characters, you must
specify octal (\) or hexadecimal (\x) sequences. The following table lists some of these sequences.
The method returns the location of the text that was added, on success. On failure, it sets one of the
following error numbers to FA_errno:
Special Character
Hexadecimal
Representation Octal Representation
>\x3e\76
“ (straight double
quotation mark)
\x22 \42
“ (left double quotation
mark)
\xd2 \322
” (right double quotation
mark)
\xd3 323
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadObjId (-3) Invalid Object.
Constants.FE_NotTextObjec
t (-41)
The object that textLoc specifies is not a paragraph (FO_Pgf) or a
text line (FO_TextLine).
Constants.FE_OffsetNotFou
nd (-21)
The offset specified for the text location could not be found in
the specified text object.
Constants.FE_ReadOnly (-6) The document is read only.
691
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
TextLoc
Syntax
AddText(textLoc, text)
Parameters
CenterOnText
Description
Centers a range of text such that the middle of the text appears in the middle of the document window.
The method returns FE_Success if it succeeds. On failure, the method returns one of the following
values toFA_errno:
Constants.FE_BadSelection
ForOperation (-59)
The location that textLoc specifies is invalid. For example, it is
inside a variable or outside the highest level element in a
structured FrameMaker document.
Parameter name
Data
Type
Option
al Description
textLoc TextL
oc
No The text location at which to add the
text.
text strin
g
No The text to add.
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadRange
(-36)
The specified text range is invalid.
Constants.FE_NotTextObjec
t (-41)
The object that textRange specifies is not a paragraph (FO_Pgf) or
a text line (FO_TextLine).
Constants.FE_OffsetNotFou
nd (-21)
The offset specified for the text location could not be found in
the specified paragraph or text line.
Error Reason
692
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
CenterOnText(textRange)
Parameters
Clear
Description
Deletes the current selection from a document.
If you specify 0 for flags, the method suppresses any interactive alerts or warnings that arise, leaves the
selected table cells empty, and deletes hidden text.
You can OR the following values into flags:
The Constants.FF_INTERACTIVE flag takes precedence over other flags. If you specify
Constants.FF_INTERACTIVE | Constants.FF_DONT_DELETE_HIDDEN_TEXT and the
selection contains hidden text, then FrameMaker allows you to select whether to delete the hidden text
or to retain it.
The method returns FE_Success if it succeeds. On failure, the method returns one of the following
values to FA_errno:
Parameter name
Data
Type
Option
al Description
textRange TextR
ange
No The range of text to center.
Flags Meaning
Constants.FF_INTERACTIVE (0x0001) Prompt the user with dialog or alert boxes that
arise.
Constants.FF_CUT_TBL_CELLS (0x0002) Remove cleared table cells.
Constants.FF_VISIBLE_ONLY (0x0010) Clear only the visible portion of the selection.
Constants.FF_DONT_DELETE_HIDDEN_TE
XT (0x0004)
Do not delete hidden text.
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
693
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
Clear(flags)
Parameters
ClearAllChangebars
Description
Clears all change bars from a specified document.
NOTE: The method performs the same function as clicking the Clear All Change Bars box in the Change Bars
dialog box.
The method returns FE_Success if it succeeds. On failure, the method returns one of the following
values to FA_errno:
Constants.FE_BadSelectionForOperat
ion (-59)
Current selection is invalid for this operation.
Constants.FE_Canceled (-44) The User or parameters canceled the operation.
Constants.FE_WrongProduct (-60) The current FrameMaker version does not support the
requested operation.
Parameter name
Data
Type
Option
al Description
flags int No Bit field that specifies how to clear
the text and how to handle
interactive alerts. For default settings,
specify 0.
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_WrongProduc
t (-60)
The current FrameMaker version does not support the requested
operation.
Constants.FE_SystemError
(-42)
A system error occurred.
Error Reason
694
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
ClearAllChangebars()
Compare
Description
Compares two documents or two books.
You can OR the values shown in the following table into the flags argument.
On success, the method returns a CompareRet structure containing the summary and composite docu-
ments detailing the changes found, if any.
On failure, the method returns one of the following values to FA_errno:
Flags Meaning
Constants.FF_CMP_SUMMA
RY_ONLY (0x01)
Generate a summary document, but not a composite
document.
Constants.FF_CMP_CHANGE
_BARS (0x02)
Turn on change bars in the composite document.
Constants.FF_CMP_HYPERLI
NKS (0x04)
Put hypertext links in the summary document.
Constants.FF_CMP_SUMKIT
(0x08)
Open the summary document.
Constants.FF_CMP_COMPKI
T (0x10)
Open the composite document.
Error Reason
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_BadCompa
re (-35)
Documents to be compared are not of the same type.
Constants.FE_CompareT
ypes (-34)
One of the files is not a FrameMaker document or book,
or one file is a book and the other is a document.
Constants.FE_WrongPro
duct (-60)
The current FrameMaker version does not support the
requested operation.
695
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
CompareRet
Syntax
Compare(newerDoc, flags, insertCondTag, deleteCondTag, replaceText,
compareThreshold)
Parameters
Parameter name
Data
Type
Option
al Description
newerDoc Doc No The newer version of the document
to be compared.
flags int No Bit flags that specify how to generate
the summary and composite
documents. Specify 0 for the default
flags.
insertCondTag strin
g
No The condition tag to apply to
insertions shown in the composite
document. For no insert condition
tag, specify null.
deleteCondTag strin
g
No The condition tag to apply to
deletions shown in the composite
document. For no delete condition
tag, specify null.
replaceText strin
g
No Text to appear in place of the deleted
text. For no replacement text, specify
null.
compareThreshold int No Threshold expresses the percentage
of words that can change before
paragraphs are considered not equal.
If two paragraphs are equal, word
differences between them are shown
within a paragraph in the composite
document.
If this value is set to zero, the
compare function uses the default
value of 75.If not zero, the function
uses the setting in the FrameMaker
configuration files.
696
DOC
CHAPTER 6 FUNCTION SUMMARY
Copy
Description
Copies the current selection to the FrameMaker Clipboard.
If the value of the flags parameter is 0, the method suppresses any interactive alerts or warnings that
arise.
You can also OR the following values into flags:
The Constants.FF_INTERACTIVE (0x0001) flag takes precedence over other flags. If you
specify Constants.FF_INTERACTIVE (0x0001)| Constants.FF_VISIBLE_ONLY
(0x0010) and the selection is not visible, then FrameMaker allows the user to choose whether to copy
the selection or not.
The method returns FE_Success if it succeeds. On failure, the method returns one of the following
values to FA_errno:
Returns
int
Syntax
Copy(flags)
Flags Meaning
Constants.FF_INTERACTIVE (0x0001) Prompt user with dialog or alert boxes that arise.
Constants.FF_STRIP_HYPERTEXT
(0x0080)
Do not copy any hypertext markers in the selection.
Constants.FF_VISIBLE_ONLY (0x0010) Copy only the visible portion of the selection.
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_WrongProduct (-60) The current FrameMaker version does not support
the requested operation
Constants.FE_BadSelectionForOperatio
n (-59)
The Selection doesn’t support the requested
operation.
Constants.FE_Canceled (-44) The User or parameters canceled the operation.
Constants.FE_BadOperation (-27) The parameters specified an invalid operation.
697
DOC
CHAPTER 6 FUNCTION SUMMARY
Parameters
Cut
Description
Cuts the current selection to the FrameMaker Clipboard.
If the value of the flags parameter is 0, the method suppresses any interactive alerts or warnings that
arise.
You can OR the following values into flags:
The Constants.FF_INTERACTIVE (0x0001) flag takes precedence over other flags. If you
specify Constants.FF_INTERACTIVE (0x0001)|
Constants.FF_DONT_DELETE_HIDDEN_TEXT (0x0004) and the selection contains hidden
text, then FrameMaker allows the user to choose whether to delete the hidden text or retain it.
The method returns FE_Success if it succeeds. On failure, the method returns one of the following
values to FA_errno:
Parameter name
Data
Type
Option
al Description
flags int No Bit field that specifies how to copy
the text and how to handle
interactive alerts. For default settings,
specify 0.
Flags Meaning
Constants.FF_INTERACTIVE (0x0001) Prompt user with dialog or alert boxes that arise.
Constants.FF_CUT_TBL_CELLS
(0x0002)
Remove cut table cells.
Constants.FF_VISIBLE_ONLY (0x0010) Cut only the visible portion of the selection.
Constants.FF_DONT_DELETE_HIDDEN
_TEXT (0x0004)
Do not cut hidden text.
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_WrongProduct (-60) The current FrameMaker version does not support
the requested operation
Constants.FE_BadSelectionForOperation
(-59)
The Selection doesn’t support the requested
operation.
698
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
Cut(flags)
Parameters
DeleteText
Description
Deletes a specified text range from a document.
The method returns FE_Success if it succeeds. On failure, the method returns one of the following
values to FA_errno:
Constants.FE_Canceled (-44) The User or parameters canceled the operation.
Constants.FE_BadOperation (-27) The parameters specified an invalid operation.
Parameter name
Data
Type
Option
al Description
flags int No Bit field that specifies how to cut the
text and how to handle interactive
alerts. For default settings, specify 0.
Error Reason
Constants.FE_BadDelete (-17) Specified text could not be deleted.
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadObjId (-3) Invalid Object
Constants.FE_BadRange (-36) Specified text range is invalid.
Constants.FE_NotTextObject (-41) Object specified for the text range is not an object that
contains text, for example, a text frame (FO_TextFrame),
a paragraph (FO_Pgf) or a text line (FO_TextLine).
Constants.FE_BadSelectionForOper
ation (-59)
Selection is within a locked text range.
Error Reason
699
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
DeleteText(textRange)
Parameters
DemoteElement
Description
Demotes the selected structural element or elements. The element becomes a child of the sibling
element before it.
NOTE: At least one structural element must be selected in the document, before calling DemoteElement().
The method does not return anything on success.
On failure, the method returns one of the following values toFA_errno:
Returns
Void
Syntax
DemoteElement()
Parameter name
Data
Type
Option
al Description
textRange TextR
ange
No The text range to delete.
Error Reason
Constants.FE_WrongProduct
(-60)
The current FrameMaker version does not support the
requested operation
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadSelectionForO
peration (-59)
Current text selection is invalid for this operation.
700
DOC
CHAPTER 6 FUNCTION SUMMARY
GetTextForRange
Description
Gets the text for a specified text range.
Call the method on the document as follows:
document.GetTextForRange()
You can OR the following constants into the flags parameter, to retrieve various text items:
Text Item Type Text Item Represents Text Item Data
Constants.FTI_CharPr
opsChange
(0x00200000)
A change in the text
properties
Flags indicating which properties have
changed (see the following table).
Constants.FTI_Eleme
ntBegin
(0x00080000)
The beginning of a
container structural
element
FO_Element
Constants.FTI_Eleme
ntEnd (0x00100000)
The end of a container
structural element
FO_Element
Constants.FTI_ElemPr
efixBegin
(0x08000000)
The beginning of an
element’s prefix
FO_Element
Constants.FTI_ElemPr
efixEnd (0x10000000)
The end of an element’s
prefix
FO_Element
Constants.FTI_ElemS
uffixBegin
(0x20000000)
The beginning of an
element’s suffix
FO_Element
Constants.FTI_ElemS
uffixEnd
(0x40000000)
The end of an element’s
suffix
FO_Element
Constants.FTI_FlowB
egin (0x00000020)
The beginning of a flow FO_Flow
Constants.FTI_FlowEn
d (0x00000040)
The end of a flow FO_Flow
Constants.FTI_FnAnc
hor (0x00001000)
A footnote FO_Fn
Constants.FTI_Frame
Anchor (0x00000800)
An anchored frame FO_AFrame
701
DOC
CHAPTER 6 FUNCTION SUMMARY
Constants.FTI_LineBe
gin (0x00000002)
The beginning of a line -
Constants.FTI_LineEn
d (0x00000004)
The end of a line and the
line end type
If the line end is a normal line end, the
value is 0;
if it is a forced line end, the
FTI_HardLineEnd flag is set;
if it is a hyphen line end, the
FTI_HyphenLineEnd flag is set
Constants.FTI_Marke
rAnchor
(0x00004000)
A Marker FO_Marker
Constants.FTI_PageB
egin (0x00000080)
The beginning of a page FO_Page
Constants.FTI_PageE
nd (0x00000100)
The end of a page FO_Page
Constants.FTI_PgfBeg
in (0x00000008)
The beginning of a
paragraph
FO_Pgf
Constants.FTI_PgfEnd
(0x00000010)
The end of a paragraph FO_Pgf
Constants.FTI_String
(0x00000001)
A string of characters with
the same condition and
character format.
A character string
Constants.FTI_SubCol
Begin (0x00000200)
The beginning of a column FO_SubCol
Constants.FTI_SubCol
End (0x00000400)
The end of a column FO_SubCol
Constants.FTI_TblAnc
hor (0x00002000)
A Table FO_Tbl
Constants.FTI_TextFra
meBegin
(0x00400000)
The beginning of a text
frame
FO_TextFrame
Constants.FTI_TextFra
meEnd (0x00800000)
The end of a text frame FO_TextFrame
Constants.FTI_TextIns
etBegin (0x02000000)
The beginning of a text
inset
FO_TiApiClient, FO_TiFlow, FO_TiText, or
FO_TiTextTable
Text Item Type Text Item Represents Text Item Data
702
DOC
CHAPTER 6 FUNCTION SUMMARY
The following table lists the flags for FTI_CharPropsChange. These flags indicate which properties
have changed.
Constants.FTI_TextIns
etEnd (0x04000000)
The end of a text inset FO_TiApiClient, FO_TiFlow, FO_TiText, or
FO_TiTextTable
Constants.FTI_TextOb
jId (0x01000000)
The object to which the
offsets of all the text items
are relative
FO_Pgf or FO_TextLine
Constants.FTI_VarBeg
in (0x00020000)
The beginning of a variable FO_Var
Constants.FTI_VarEnd
(0x00040000)
The end of a variable FO_Var
Constants.FTI_XRefBe
gin (0x00008000)
The beginning of a
cross-reference
FO_XRef
Constants.FTI_XRefEn
d (0x00010000)
The end of a
cross-reference
FO_XRef
Flags Meaning
Constants.FTF_ALL
(0xFFFFFE03)
OR of all the flags
Constants.FTF_ANGL
E (0x10000000)
The font angle has changed.
Constants.FTF_CAPIT
ALIZATION
(0x000040000)
The capitalization has changed.
Constants.FTF_CHAN
GEBAR (0x01000000)
The change bars have changed.
Constants.FTF_CHAR
TAG (0x00008000)
The Character Catalog format has changed.
Constants.FTF_COLO
R (0x00010000)
The color has changed.
Constants.FTF_CONDI
TIONTAG
(0x00000001)
The condition tag has changed.
Constants.FTF_ENCO
DING (0x00000200)
The text encoding has changed,
Text Item Type Text Item Represents Text Item Data
703
DOC
CHAPTER 6 FUNCTION SUMMARY
Constants.FTF_FAMIL
Y (0x80000000)
The font family has changed.
Constants.FTF_IIF
(0x00000002)
An internal flag having to do with Asian text. input. If there is a
non-zero value for this flag, a front-end processor is controlling that
text and you should not modify the associated text item.
Constants.FTF_KERNX
(0x00080000)
The kern-x characteristic has changed.
Constants.FTF_KERNY
(0x00040000)
The kern-x characteristic has changed.
Constants.FTF_LANG
UAGE (0x00000800)
Character language has changed.
Constants.FTF_OUTLI
NE (0x00800000)
The outline characteristic has changed.
Constants.FTF_OVERL
INE (0x02000000)
The overline characteristic has changed.
Constants.FTF_PAIRK
ERN (0x00200000)
The pair kerning has changed.
Constants.FTF_POSITI
ON (0x00002000)
The character position has changed.
Constants.FTF_SHAD
OW (0x00400000)
The shadow characteristic has changed.
Constants.FTF_SIZE
(0x00100000)
The font size has changed.
Constants.FTF_SPREA
D (0x00020000)
The font spread has changed.
Constants.FTF_STRET
CH (0x00001000)
The font stretch value has changed.
Constants.FTF_STRIK
ETHROUGH
(0x04000000)
The strikethrough characteristic has changed.
Constants.FTF_TSUM
E (0x00000400)
The Tsume setting has changed.
Constants.FTF_UNDE
RLINING
(0x08000000)
The underlining has changed.
Flags Meaning
704
DOC
CHAPTER 6 FUNCTION SUMMARY
On success, the method returns a TextItems structure containing the array of text items of the
requested types.
On failure, the method sets the len field of the returned TextItems structure to 0, and returns one
of the following values toFA_errno:
NOTE: The returned TextItems structure references memory that is allocated by the method. Use the Deal-
locateTextItems() method to free this memory when you are done with using it.
Returns
TextItems
Syntax
GetTextForRange(tr, flags)
Parameters
Constants.FTF_VARIA
TION (0x40000000)
The font variation has changed.
Constants.FTF_WEIG
HT (0x20000000)
The font weight has changed.
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadObjId (-3) Invalid Object
Constants.FE_NotTextObjec
t (-41)
Object specified for the text range is not an object that contains
text.
Constants.FE_BadRange
(-36)
Specified text range is invalid.
Constants.FE_OffsetNotFou
nd (-21)
Offset specified for the text location could not be found in the
specified paragraph or text line.
Parameter name
Data
Type
Option
al Description
tr TextR
ange
No The text range containing the text you
want to get.
Flags Meaning
705
DOC
CHAPTER 6 FUNCTION SUMMARY
GetTextForRange2
Description
Gets the text for a specified text range.
You can OR the same flags as in the GetTextForRange() method, for the flags parameter.
On success, the method returns a TextItems structure containing the array of text items of the
requested types.
On failure, the method sets the len field of the returned TextItems structure to 0, and returns one
of the following values toFA_errno:
NOTE: The returned TextItems structure references memory that is allocated by the method. Use the Deal-
locateTextItems() method to free this memory when you are done with using it.
Returns
TextItems
Syntax
GetTextForRange2(tr, flags, flags2)
flags int No Bit flags that specify the type of text
items to retrieve. To get specific types
of text items, OR the constants that
represent them (for example,
FTI_FlowBegin and FTI_String) into
flags. To get all types of text items,
specify -1.
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadObjId (-3) Invalid Object
Constants.FE_NotTextObjec
t (-41)
Object specified for the text range is not an object that contains
text.
Constants.FE_BadRange
(-36)
Specified text range is invalid.
Constants.FE_OffsetNotFou
nd (-21)
Offset specified for the text location could not be found in the
specified paragraph or text line.
Parameter name
Data
Type
Option
al Description
706
DOC
CHAPTER 6 FUNCTION SUMMARY
Parameters
GetTextProps
Description
Gets the text properties (such as the format tag, font family and size, and conditions) for a location in
text.
As the text properties can be different for each character, you can only get the text properties for an indi-
vidual location in the text.
On success, the method returns a PropVals structure with the text property list for the specified loca-
tion.
On failure, the method sets the len field of the returned PropVals structure to 0, and returns one of
the following values toFA_errno:
Parameter name
Data
Type
Option
al Description
tr TextR
ange
No The text range containing the text you
want to get.
flags int No Bit flags for the base set text item
types that of text items to retrieve.
flags2 int No Bit flags for the extended set of text
item types that specify the type of
text items to retrieve. To get specific
types of text items from the extended
set, OR the constants that represent
them (for example, use a bitwise OR
to combine FTI2_RubiTextBegin and
FTI2_RubiTextEnd) into flags2.
To get all types of the extended set of
text items, specify -1.
Error Reason
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_BadObjId
(-3)
Invalid Object
Constants.FE_NotTextObj
ect (-41)
Object specified for the text range is not an object that contains
text.
707
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
PropVals
Syntax
GetTextProps(textLoc)
Parameters
GetTextPropVal
Description
Gets a text property (such as the format tag, font family and size, or conditions) for a location in text.
As a text property can be different for each character, you can get the property for only one location in
text at a time.
On success, the method returns a PropVal structure with the details of the specified property.On
failure, the method returns one of the following values to FA_errno:
Constants.FE_OffsetNotF
ound (-21)
Offset specified for the text location could not be found in the
specified paragraph or text line.
Constants.FE_WrongProd
uct (-60)
The current FrameMaker version does not support the requested
operation
Parameter name
Data
Type
Option
al Description
textLoc TextL
oc
No The text location of the character that
you want to get text properties for.
The returned properties are the
properties that apply to the character
to the right of the specified location.
Error Reason
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_BadObjId
(-3)
Invalid Object
Constants.FE_BadPropN
um (-4)
Specified property number is invalid.
Error Reason
708
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
PropVal
Syntax
GetTextPropVal(textLoc, propNum)
Parameters
NOTE: The returned PropVal structure references memory that is allocated by the method. Use the Deal-
locatePropVal() method to free this memory when you are done with using it.
GetTextVal
Description
Gets the value of a specified text property, which can be of any type.
On success, the method returns a TypedVal structure containing the value of the specified prop-
erty.On failure, the method returns one of the following values to FA_errno:
Constants.FE_BadPropTy
pe (-5)
Incorrect property type for this function.
Constants.FE_WrongPro
duct (-60)
The current FrameMaker version does not support the requested
operation
Parameter name
Data
Type
Option
al Description
textLoc TextL
oc
No The text location of the character for
which you want to get the the text
property. The returned property
applies to the character to the right of
this location.
propNum int No The property to query. Specify a
constant, such as FontFamily.
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadObjId (-3) Invalid Object
Error Reason
709
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
TypedVal
Syntax
GetTextVal(textLoc, propNum)
Parameters
HypertextCommand
Description
Simulates a user-invoked hypertext command.
NOTE: Calling the HypertextCommand() method has the same effect as a user clicking on a hypertext
marker containing the specified text.
The method returns FE_Success on success.
Constants.FE_BadPropNum
(-4)
Specified property number is invalid.
Constants.FE_BadPropType
(-5)
Incorrect property type for this function.
Constants.FE_NotTextObjec
t (-41)
Object specified for the text location is not an object that
contains text.
Constants.FE_OffsetNotFou
nd (-21)
Offset specified for the text location could not be found in the
specified paragraph or text line.
Constants.FE_WrongProduc
t (-60)
The current FrameMaker version does not support the requested
operation
Parameter name
Data
Type
Option
al Description
textLoc TextL
oc
No The text location of the character for
which you want to get the text
property. The returned property
applies to the character to the right of
this location.
propNum int No The property to query. Specify a
constant, such as FontFamily.
Error Reason
710
DOC
CHAPTER 6 FUNCTION SUMMARY
On failure, the method returns the following value to FA_errno:
Returns
int
Syntax
HypertextCommand(hypertext)
Parameters
MergeIntoFirst
Description
Merges the selected structural elements into the first element in the selection.
NOTE: At least two structural elements must be selected in the document before calling the MergeInto-
First() method.
On success, the method does not return any value.
On failure, the method returns one of the following values to FA_errno:
Error Reason
Constants.FE_BadDocId
(-2)
Invalid document.
Parameter name
Data
Type
Option
al Description
hypertext strin
g
No A hypertext command to execute,
such as gotolink
orpreviouslink.You can specify
any command that is valid in a
hypertext marker in the document.
Error Reason
Constants.FE_WrongProduct (-60) The current FrameMaker version does not support the
requested operation
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadSelectionForOpera
tion (-59)
Current text selection is invalid for this operation.
711
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
Void
Syntax
MergeIntoFirst()
MergeIntoLast
Description
Merges the selected structural elements into the last element in the selection.
NOTE: At least two structural elements must be selected in the document before calling the MergeInto-
Last() method.
On success, the method does not return any value.
On failure, the method returns one of the following values to FA_errno:
Returns
Void
Syntax
MergeIntoLast()
NewTable
Description
Inserts a table (FO_Tbl object).
When you create a table in the user interface, you can specify a Table Catalog format for the table.
FrameMaker uses the following properties of the Table Catalog format as the defaults for the new table:
• Number of body rows (TblInitNumBodyRows)
• Number of columns (TblInitNumCols)
• Number of footer rows (TblInitNumFRows)
Error Reason
Constants.FE_WrongProduct (-60) The current FrameMaker version does not support the
requested operation
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadSelectionForOpera
tion (-59)
Current text selection is invalid for this operation.
712
DOC
CHAPTER 6 FUNCTION SUMMARY
• Number of header rows (TblInitNumHRows)
• Paragraph formats for header, body, and footer cells
For example, if the Table Catalog format’s TblInitNumCols property is set to 8, the NumCols prop-
erty of the new table is set to 8.With the NewTable() method, you can use the Table Catalog format
properties as defaults for the number of rows and columns in a new table, or you can provide your own
defaults. After you have create a table, you can add or remove rows with the AddRows() and
DeleteRows() methods. You can add or remove columns with the AddCols() and
DeleteCols() methods. If you use theNewTable() method to create a table in a structured
FrameMaker document, FrameMaker applies default element tags, such as Table, Row, and Cell, to the
table element and its child elements. To make these elements valid, you must add code to change their
tags. In most cases it is easier to add tables to structured documents by calling the
NewElementInHierarchy() or NewElement() methods to add a table element.
On success, the method returns the newly added table.
On failure, the method returns one of the following values to FA_errno:
Returns
Tbl
Syntax
NewTable(format, numCols, numBodyRows, numHeaderRows, numFooterRows,
textLoc)
Error Reason
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_BadObjId
(-3)
Invalid Object
Constants.FE_NotTextObj
ect (-41)
Object specified for the text location is not a paragraph (FO_Pgf).
Constants.FE_OffsetNotF
ound (-21)
Offset specified for the text location could not be found in the
specified paragraph or text line.
Constants.FE_BadOperati
on (-27)
Function call specified an illegal operation.
Constants.FE_BadNew
(-23)
Table cannot be created; the format specified by format may not
exist or the text location specified by textLoc is in a table or a
footnote.
713
DOC
CHAPTER 6 FUNCTION SUMMARY
Parameters
Paste
Description
Pastes the contents of the FrameMaker Clipboard into a specified document at the insertion point.
Cutting and Pasting objects causes FrameMaker to create an ID for the pasted object.
Specifying a value of 0 for the flags parameter, causes the Paste() method to suppress any interactive
alerts or warnings that arise. In addition, the method inserts columns to the left of the current columns
and rows above the current row.
You can OR the following values into flags:
Parameter name
Data
Type
Option
al Description
format strin
g
No The table format tag (for example,
FormatA or Wide Table). To use the
default format, specify NULL.
numCols int No The number of columns in the table.
To use the default number of columns
from the Table Catalog format,
specify -1.
numBodyRows int No The number of rows in the table. To
use the default number of body rows
from the Table Catalog format,
specify -1.
numHeaderRows int No The number of heading rows in the
table. To use the default number of
header rows from the Table Catalog
format, specify -1.
numFooterRows int No The number of footing rows in the
table. To use the default number of
footer rows from the Table Catalog
format, specify -1.
textLoc TextL
oc
No The location at which to insert the
new table. The location cannot be
within a footnote or a table.
Flags Meaning
Constants.FF_INTERACTIVE (0x0001) Prompt the user with dialog or alert boxes that arise.
714
DOC
CHAPTER 6 FUNCTION SUMMARY
When you use the Paste() method to paste table cells into a table, it does not work exactly like the
interactive Paste command.
The interactive Paste command automatically overwrites cells if the Clipboard contains less than an
entire row or column. For example, if the insertion point is in a three-column table and the Clipboard
contains a single cell, the interactive Paste command overwrites the cell containing the insertion point
with the cell on the Clipboard.
If two cells in the table are selected, the interactive Paste command overwrites both of them with the
cell on the Clipboard.
By default, the Paste() method does not overwrite any cells. If the Clipboard contains less than an
entire row or column when you call Paste(), or if the current selection is less than an entire row, the
Paste() method does nothing and returns Constants.FE_BadSelectionForOperation
(-59).The method ensures that you do not inadvertently overwrite any cells.
To make the Paste() method replace cells with the Clipboard contents, you must call it with the
Constants.FF_REPLACE_CELLS (0x0020) flag set. The Constants.FF_INTERACTIVE
(0x0001) flag takes precedence over other flags.
If you specify Constants.FF_INTERACTIVE (0x0001)|Constants.
FF_DONT_DELETE_HIDDEN_TEXT (0x0004) and the selection contains hidden text, FrameMaker
prompts the user, and allows the user to choose whether to delete the hidden text or retain it.
It is illegal to specify Constants.FF_REPLACE_CELLS (0x0020)|
Constants.FF_INSERT_BELOW_RIGHT (0x0008).
The method returns FE_Success on success.
On failure, the method returns one of the following values to FA_errno:
Constants.FF_VISIBLE_ONLY
(0x0010)
Cut only the visible portion of the selection.
Constants.FF_DONT_DELETE_HIDDE
N_TEXT (0x0004)
Do not replace hidden text.
Constants.FF_DONT_APPLY_ALL_RO
WS (0x0040)
Do no’t apply condition setting on the Clipboard to all
rows. If whole table is selected and the Clipboard
contains condition setting, cancel the paste operation.
Constants.FF_REPLACE_CELLS
(0x0020)
Replace selected cells with cells on the Clipboard.
Constants.FF_INSERT_BELOW_RIGH
T (0x0008)
Add columns to the right of the current column or below
the current row.
Flags Meaning
715
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
Paste(flags)
Parameters
PromoteElement
Description
Promotes the selected structural element. The selected element becomes a sibling of its former parent
and appears immediately after its former parent. The siblings that follow it become the element’s chil-
dren.
NOTE: One structural element must be selected when the PromoteElement() method is called. The selected
element cannot be the root element or a child of the root element.
The method does not return anything on success.
On failure, the method returns one of the following values to FA_errno:
Error Reason
Constants.FE_BadOperation
(-27)
Function call specified an illegal operation.
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadSelectionForO
peration (-59)
Current text selection is invalid for this operation.
Constants.FE_Canceled (-44) User canceled the operation.
Parameter name
Data
Type
Option
al Description
flags int No Bit field that specifies how to paste
the text and how to handle
interactive alerts. For default settings,
specify 0.
Error Reason
Constants.FE_WrongProduct (-60) The current FrameMaker version does not support the
requested operation
716
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
Void
Syntax
PromoteElement()
QuickSelect
Description
Implements a quick-key interface that allows the user to choose a string from a list of strings in the docu-
ment Tag area.
The QuickSelect() method highlights the document Tag area and displays a prompt and the first
string in a specified list of strings.
The user can display a string in the Tag area by typing the first few letters of the string. The user can also
scroll through the strings by pressing the up and down arrow keys.
To choose a string, the user presses Return when the string appears in the Tag area. To cancel the choice,
the user clicks in the document without pressing Return.
On success, the method returns an index into the array of strings specified by stringlist or -1 if the user
cancels the quick selection.
On failure, the method returns one of the following values to FA_errno:
Returns
int
Syntax
QuickSelect(prompt, stringlist)
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadSelectionForOper
ation (-59)
Current text selection is invalid for this operation.
Error Reason
Constants.FE_Transpor
t (-1)
A transport error occurred.
Constants.FE_BadDocI
d (-2)
Invalid document.
Error Reason
717
DOC
CHAPTER 6 FUNCTION SUMMARY
Parameters
Redisplay
Description
Updates the display for a specified document to reflect any changes that occurred when the
Displaying property was set to False. If you have set the Displaying property to False and
subsequently reset it to True, you should call the Redisplay() method to redisplay each document
you modified.
The method returns FE_Success on success. On failure, the method returns the following value to
FA_errno:
Returns
int
Syntax
Redisplay()
Reformat
Description
Reformats the specified document. If you have disabled and subsequently re-enabled reformatting by
setting the session property, Reformatting to True, you should call the Reformat() method to
reformat each changed document in the session.
The method returns FE_Success on success. On failure, the method returns the following value to
FA_errno:
Parameter name
Data
Type
Option
al Description
prompt strin
g
No The prompt that appears in the Tag
area
stringlist Strin
gs
No The list of strings from which the user
can choose
Error Reason
Constants.FE_BadDo
cId (-2)
Invalid document.
718
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
Reformat()
Rehyphenate
Description
Rehyphenates a specified document based on changes the user has made to words’ hyphenation points.
The method returns FE_Success on success. On failure, the method returns one of the following
values to FA_errno:
Returns
int
Syntax
Rehyphenate()
ResetEqnSettings
Description
Resets the document equation settings to the default settings.
The method returns FE_Success on success. On failure, the method returns one of the following
values to FA_errno:
Error Reason
Constants.FE_BadDo
cId (-2)
Invalid document.
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_WrongProduct
(-60)
Current FrameMaker version does not support this operation.
Constants.FE_SystemError
(-42)
Could not allocate memory.
719
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
ResetEqnSettings()
ResetReferenceFrames
Description
Resets the reference frames in the specified document. This method is useful for updating a document
after you have programmatically changed a reference frame that is referenced by paragraphs in the
document.
The method returns FE_Success on success. On failure, the method returns one of the following
values to FA_errno:
Returns
int
Syntax
ResetReferenceFrames()
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_WrongProduct
(-60)
Current FrameMaker version does not support this operation.
Constants.FE_SystemError
(-42)
Could not allocate memory.
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_WrongProduct
(-60)
Current FrameMaker version does not support this operation.
Constants.FE_SystemError
(-42)
Could not allocate memory.
720
DOC
CHAPTER 6 FUNCTION SUMMARY
RestartPgfNumbering
Description
Restarts the paragraph numbering for a specified document.
The method returns FE_Success on success. On failure, the method returns one of the following
values to FA_errno:
Returns
int
Syntax
RestartPgfNumbering()
ScrollToText
Description
Scrolls the document window to a specified text range. The method scrolls the document to the end of
the range that is closest to the current display position.
The method returns FE_Success on success. On failure, the method returns one of the following
values to FA_errno:
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_WrongProduct
(-60)
Current FrameMaker version does not support this operation.
Constants.FE_SystemError
(-42)
Could not allocate memory.
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadObjId (-3) Invalid Object
Constants.FE_NotTextObject
(-41)
Object specified for the text location is not a paragraph (FO_Pgf)
or a flow (FO_Flow).
Constants.FE_OffsetNotFou
nd (-21)
Offset specified for the text range could not be found in the
specified paragraph or text line.
Constants.FE_BadRange
(-36)
The specified text range is invalid.
721
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
ScrollToText(textRange)
Parameters
SetTextProps
Description
Sets the text properties (such as the format tag, font family, and size) for a text range.
On success, the method does not return anything.
On failure, the method returns one of the following values to FA_errno:
Parameter name
Data
Type
Option
al Description
textRange TextR
ange
No The text range to which to scroll.
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadName (-33) Specified name is illegal.
Constants.FE_BadRange (-36) Specified text range is invalid.
Constants.FE_GenRuleAmbiguous
(-55)
General rule in structured document is ambiguous.
Constants.FE_GenRuleConnectorExp
ected (-57)
General rule in structured document is missing a
connector.
Constants.FE_GenRuleItemExpected
(-51)
General rule in structured document is missing a rule
item.
Constants.FE_GenRuleLeftBracketEx
pected (-53)
General rule in structured document is missing a left
bracket.
Constants.FE_GenRuleMixedConnec
tors (-52)
General rule in structured document has mixed
connectors.
Constants.FE_GenRuleRightBracketE
xpected (-54)
General rule in structured document is missing a right
bracket.
722
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
Void
Syntax
SetTextProps(textRange, setVal)
Parameters
SetTextPropVal
Description
Sets a text property for a specified text range. The property can be of any type.
On success, the method does not return anything.
On failure, the method returns one of the following values to FA_errno:
Constants.FE_GenRuleSyntaxError(-
56)
General rule in structured document has a syntax error.
Constants.FE_NotTextObject (-41) Object specified for the text range is not a paragraph
(FO_Pgf) or a flow (FO_Flow).
Constants.FE_OffsetNotFound (-21) Offset specified for the text range could not be found in
the specified paragraph or text line.
Constants.FE_OutOfRange (-7) Specified property value is out of the legal range for the
specified property.
Constants.FE_ReadOnly (-6) Property is read-only and cannot be set.
Constants.FE_WrongProduct (-60) Current FrameMaker version does not support this
operation.
Parameter name
Data
Type
Option
al Description
textRange TextR
ange
No The text range to which to apply the
property list.
setVal PropV
als
No The property list to apply to the text
range.
Error Reason
723
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
Void
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadName (-33) Specified name is illegal.
Constants.FE_BadPropType (-5) Incorrect property type for this function.
Constants.FE_BadPropNum (-4) Specified property number is invalid.
Constants.FE_BadRange (-36) Specified text range is invalid.
Constants.FE_GenRuleAmbiguous
(-55)
General rule in structured document is ambiguous.
Constants.FE_GenRuleConnectorExp
ected (-57)
General rule in structured document is missing a
connector.
Constants.FE_GenRuleItemExpected
(-51)
General rule in structured document is missing a rule
item.
Constants.FE_GenRuleLeftBracketEx
pected (-53)
General rule in structured document is missing a left
bracket.
Constants.FE_GenRuleMixedConnec
tors (-52)
General rule in structured document has mixed
connectors.
Constants.FE_GenRuleRightBracketE
xpected (-54)
General rule in structured document is missing a right
bracket.
Constants.FE_GenRuleSyntaxError(-
56)
General rule in structured document has a syntax error.
Constants.FE_NotTextObject (-41) Object specified for the text range is not a paragraph
(FO_Pgf) or a flow (FO_Flow).
Constants.FE_OffsetNotFound (-21) Offset specified for the text range could not be found in
the specified paragraph or text line.
Constants.FE_OutOfRange (-7) Specified property value is out of the legal range for the
specified property.
Constants.FE_ReadOnly (-6) Property is read-only and cannot be set.
Constants.FE_WrongProduct (-60) Current FrameMaker version does not support this
operation.
724
DOC
CHAPTER 6 FUNCTION SUMMARY
Syntax
SetTextPropVal(textRange, setVal)
Parameters
SetTextVal
Description
Sets a specified text property for a text range.
On success, the method does not return anything.
On failure, the method returns one of the following values to FA_errno:
Parameter name
Data
Type
Option
al Description
textRange TextR
ange
No The text range to which the property
is to be applied.
setVal PropV
al
No The property to apply to the text
range.
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadName (-33) Specified name is illegal.
Constants.FE_BadPropType (-5) Incorrect property type for this function.
Constants.FE_BadPropNum (-4) Specified property number is invalid.
Constants.FE_BadRange (-36) Specified text range is invalid.
Constants.FE_GenRuleAmbiguous
(-55)
General rule in structured document is ambiguous.
Constants.FE_GenRuleConnectorExp
ected (-57)
General rule in structured document is missing a
connector.
Constants.FE_GenRuleItemExpected
(-51)
General rule in structured document is missing a rule
item.
Constants.FE_GenRuleLeftBracketEx
pected (-53)
General rule in structured document is missing a left
bracket.
Constants.FE_GenRuleMixedConnec
tors (-52)
General rule in structured document has mixed
connectors.
725
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
Void
Syntax
SetTextVal(textRange, propNum, setVal)
Parameters
SilentPrintDoc
Description
Prints a document or a book using the default print settings. Default print settings are the settings that
appear in the Print dialog box when the user attempts to print a document.
Constants.FE_GenRuleRightBracketE
xpected (-54)
General rule in structured document is missing a right
bracket.
Constants.FE_GenRuleSyntaxError(-
56)
General rule in structured document has a syntax error.
Constants.FE_NotTextObject (-41) Object specified for the text range is not a paragraph
(FO_Pgf) or a flow (FO_Flow).
Constants.FE_OffsetNotFound (-21) Offset specified for the text range could not be found in
the specified paragraph or text line.
Constants.FE_OutOfRange (-7) Specified property value is out of the legal range for the
specified property.
Constants.FE_ReadOnly (-6) Property is read-only and cannot be set.
Constants.FE_WrongProduct (-60) Current FrameMaker version does not support this
operation.
Parameter name
Data
Type
Option
al Description
textRange TextR
ange
No The text range to which the property
is to be applied.
propNum int No The number of the property to set.
setVal Typed
Val
No The value of the property to set.
Error Reason
726
DOC
CHAPTER 6 FUNCTION SUMMARY
The SilentPrintDoc() method initializes the print page size and printer name if they do not have
values.
To change a document’s default print settings, set the document’s print properties. [To be linked to the
print properties]
For example, to change the turn registration marks on when you print a document, use the SetInt()
method to set the document’s RegistrationMarks property.
If you save the document or attempt to print it again within the same session, any changes you make to
a document’s print settings (except PrintStartPage and PrintEndPage) appears the next time
the user displays the Print dialog box for the document.
The method returns FE_Success on success. On failure, the method returns one of the following
values to FA_errno:
Returns
int
Syntax
SilentPrintDoc()
SimpleImportFormats
Description
Imports formats from a document to a document or a book. If you import formats to a book, the method
imports formats to each book component for which the ImportFmtInclude property is set to True.
You can OR the following values into the formatFlags parameter to specify which formats to import.
Error Reason
Constants.FE_SystemErr
or (-42)
Could not open or close the printer file.
Constants.FE_BadParam
eter (-43)
Parameter has an invalid value.
Value Format to Import
Constants.FF_UFF_COLOR
(0x0100)
Colors
Constants.FF_UFF_COMBINED_
FONTS (0x0800)
Combined Fonts
Constants.FF_UFF_COND
(0x0010)
Conditions
727
DOC
CHAPTER 6 FUNCTION SUMMARY
The method returns FE_Success on success. On failure, the method returns one of the following
values to FA_errno:
Constants.FF_UFF_DOCUMENT
_PROPS (0x0400)
Document Properties
Constants.FF_UFF_FONT
(0x0002)
Character Catalog Formats
Constants.FF_UFF_MATH
(0x0200)
Equation Settings
Constants.FF_UFF_PAGE
(0x0004)
Page Layouts
Constants.FF_UFF_PGF
(0x0001)
Paragraph Catalog Formats
Constants.FF_UFF_REFPAGE
(0x0020)
Reference Pages
Constants.FF_UFF_REMOVE_EX
CEPTIONS (0x8000)
Remove exception formats from target documents
Constants.FF_UFF_REMOVE_PA
GE_BREAKS (0x4000)
Remove all forced page breaks from target documents
Constants.FF_UFF_TABLE
(0x0008)
Table Catalog Formats
Constants.FF_UFF_VAR
(0x0040)
Variable Formats
Constants.FF_UFF_XREF
(0x0080)
Cross Reference Formats
Error Reason
Constants.FE_WrongPro
duct (-60)
Current FrameMaker version does not support this operation.
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_Canceled
(-44)
User canceled the operation.
Constants.FE_FailedStat
e (-45)
The FrameMaker product failed to open one or more of the book’s
document files during the import operation.
Value Format to Import
728
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
SimpleImportFormats(fromDoc, formatFlags)
Parameters
You can OR the following values into the formatFlags parameter to specify which formats to import.
Parameter name
Data
Type
Option
al Description
fromDoc Doc No The document or book from which to
import formats.
formatFlags int No Bit field specifying which formats to
import. Specify 0 for the default flags.
Value Import
Constants.FF_UFF_COLOR (0x100) Import colors.
Constants.FF_UFF_COMBINED_FONTS (0x800) Import combined fonts.
Constants.FF_UFF_COND (0x0010) Import conditions.
Constants.FF_UFF_DOCUMENT_PROPS (0x0400) Import document properties.
Constants.FF_UFF_FONT (0x0002) Import Character Catalog formats.
Constants.FF_UFF_MATH (0x200) Import equation settings.
Constants.FF_UFF_PAGE (0x0004) Import page layouts.
Constants.FF_UFF_PGF (0x0001) Import Paragraph Catalog formats.
Constants.FF_UFF_REFPAGE (0x0020) Import reference pages.
Constants.FF_UFF_REMOVE_EXCEPTIONS (0x8000) Remove exception formats from target
documents.
Constants.FF_UFF_REMOVE_PAGE_BREAKS (0x4000) Remove all forced page breaks from
target documents.
Constants.FF_UFF_TABLE (0x0008)Import Table Catalog formats.
Constants.FF_UFF_VAR (0x0040) Import variable formats.
Constants.FF_UFF_XREF (0x0080) Import cross reference formats.
729
DOC
CHAPTER 6 FUNCTION SUMMARY
SplitElement
Description
Splits the structural element containing the insertion point into two elements at the insertion point. The
insertion point must be inside the element you want to split.
The method does not return anything on success.
On failure, the method returns one of the following values to FA_errno:
Returns
Void
Syntax
SplitElement()
TextLocToElementLoc
Description
Returns the element location structure that corresponds to the current text location.
On success, the method returns an ElementLoc structure containing the element location.
On failure, the method returns one of the following values to FA_errno:
Returns
ElementLoc
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadSelectionForOperation
(-59)
Current text selection is invalid for this operation.
Constants.FE_WrongProduct (-60) Current FrameMaker interface is not Structured
FrameMaker.
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadParameter () tloc parameter was empty or was improperly
specified
Constants.FE_WrongProduct (-60) Current FrameMaker interface is not Structured
FrameMaker.
730
DOC
CHAPTER 6 FUNCTION SUMMARY
Syntax
TextLocToElementLoc(tloc)
Parameters
UnWrapElement
Description
Removes the selected structural elements, but leaves their contents and child elements intact in the
document.
The UnWrapElement() method does not remove all the elements in the selection but only removes
the top-level elements.
NOTE: At least one structural element must be selected before calling the UnWrapElement() method.NOTE:
The UnWrapElement() method has no effect on object elements.
The method does not return anything on success.
On failure, the method returns one of the following values to FA_errno:
Returns
Void
Syntax
UnWrapElement()
Parameter name
Data
Type
Option
al Description
tloc TextL
oc
No The text location structure to convert.
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadSelectionForOperation
(-59)
Current text selection is invalid for this operation.
Constants.FE_WrongProduct (-60) Current FrameMaker interface is not Structured
FrameMaker.
731
DOC
CHAPTER 6 FUNCTION SUMMARY
UpdateXRefs
Description
Updates the cross-references in a document. The method performs the same operation as clicking
Update in the Cross-Reference window.
You can OR the following values into the updateXRefFlags parameter:
The method returns FE_Success on success. On failure, the method returns one of the following
values to FA_errno:
Returns
int
Syntax
UpdateXRefs(updateXRefFlags)
Flags Meaning
Constants.FF_XRUI_FORCE_UPDATE
(0x08)
Updates all cross-references, regardless of whether the
source document has changed
Constants.FF_XRUI_INTERNAL
(0x01)
Only update internal cross-references
Constants.FF_XRUI_OPEN_DOCS
(0x02)
Only update cross-references whose sources are in open
documents
Constants.FF_XRUI_CLOSED_DOCS
(0x04)
Only update cross-references whose sources are in
closed documents
Constants.FF_XRUI_EVERYTHING
(0x01|0x02|0x03)
Update all cross references.
Error Reason
Constants.FE_WrongProduct (-60) Current FrameMaker version does not support the
requested operation
Constants.FE_BadDocId (-2) Invalid document
Constants.FE_SomeUnresolved (-22) There are some unresolved references after the
update
732
DOC
CHAPTER 6 FUNCTION SUMMARY
Parameters
UpdateDITAReferences
Description
Updates all DITA references of the specified type.
Returns
void
Syntax
UpdateDITAReferences(docId, flag);
Parameters
If UpdateDITAReferences() fails, the method assigns following values to FA_errno:
Parameter name
Data
Type
Option
al Description
updateXRefFlags int No Flags that indicate which
cross-references to update.
Parameter name
Data
Type
Option
al Description
docId int No The ID of the document containing
the inset.
flag int No The available flags and their values
are as follows:
FF_DITAUpdateAllConrefs: 0x01
FF_DITAUpdateAllXrefs: 0x02
FF_DITAUpdateAllLinks: 0x04
FF_DITAUpdateAllTopicrefs: 0x08
FF_DITAUpdateAllTopicsetrefs: 0x10
FF_DITAUpdateAllReferences:
FF_DITAUpdateAllConrefs |
FF_DITAUpdateAllXrefs |
FF_DITAUpdateAllLinks |
FF_DITAUpdateAllTopicrefs |
FF_DITAUpdateAllTopicsetrefs
733
DOC
CHAPTER 6 FUNCTION SUMMARY
SimpleImportElementDefs
Description
Imports element definitions and the format change list catalog from an EDD or FrameMaker document
or book to a FrameMaker document or book.
NOTE: If you import element definitions to a book,the SimpleImportElementDefs() method imports
element definitions to each book component for which the ImportFmtInclude property is set to True.
You can OR the following flags into the importFlags parameter:
The method returns FE_Success on success.On failure, the method returns one of the following
values to FA_errno:
Error Reason
Constants.FE_WrongPro
duct
Current FrameMaker product doesn’t support the
operation.
Constants.FE_BadDocId The Document ID provided is invalid.
Constants.FE_NonDITAD
ocument
The Document provided is not a DITA document.
Flag Meaning
Constants.FF_IED_REMOVE
_OVERRIDES (0x0001)
Clear format overrides
Constants.FF_IED_REMOVE
_BOOK_INFO (0x0002)
Clear formatting inherited from a parent book, if the method is
called on a document
Constants.FF_IED_DO_NOT
_IMPORT_EDD (0x0004)
Do not treat the target document as an EDD but just import its
element catalog, if the target document is an EDD
Constants.FF_IED_NO_NOT
IFY (0x0008)
Do not issue the
Constants.FA_Note_PreImportElemDefs (64) or
Constants.FA_Note_PostImportElemDefs (65)
notifications.
Error Reason
Constants.FE_WrongProduct (-60) Current FrameMaker version does not support the
requested operation
Constants.FE_BadDocId (-2) Invalid document
734
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
SimpleImportElementDefs(fromDocOrBook, importFlags)
Parameters
GetUniqueObject
Description
Gets the object from its persistent unique identifier (UID).
FrameMaker assigns a UID to each object in a document or book that is not identified by a name. The
UID, unlike the object’s ID, does not change from one session to another.
NOTE: When you copy an object to the clipboard and paste it, FrameMaker changes the UID. This also
happens when you hide and show conditional text.
The method returns the object, on success.
On failure, the method returns one of the following values to FA_errno:
Returns
Object
Syntax
GetUniqueObject(objType, unique)
Parameter name
Data
Type
Option
al Description
fromDocOrBook Doc|B
ook
No The document or book from which
the element definitions are to be
imported
importFlags int No Specifies how to import formats
Error Reason
Constants.FE_BadDocId (-2) Invalid document
Constants.FE_TypeUnNamed (-19) Objects of the specifies type are not identified by
UIDs
Constants.FE_NameNotFound (-20) Objects with the specified UID could not be found
735
DOC
CHAPTER 6 FUNCTION SUMMARY
Parameters
Close
Description
Closes a document or a book.
NOTE: If there are unsaved changes in a document and you set Constants.FF_CLOSE_MODIFIED
(1) for the flags parameter,then the Close() method abandons the changes and closes the file
anyway.NOTE: If you set the flags parameter to 0, the Close() method aborts the Close operation and
returns Constants.FE_DocModified (-8).
The method returns FE_Success, on success.
On failure, the method returns the following value to FA_errno:
Returns
int
Syntax
Close(flags)
Parameters
Parameter name
Data
Type
Option
al Description
objType int No The type of object (for example,
FO_Pgf)
unique int No UID of the object
Error Reason
Constants.FE_DocMo
dified (-8)
The document was modified and the flags parameter was set to 0
Parameter name
Data
Type
Option
al Description
flags int No Specifies whether to abort or close
open documents or books if they
have unsaved changes. Set the
Constants.FF_CLOSE_MODIFIED (1)
flag to close open documents and
books regardless of their state.
736
DOC
CHAPTER 6 FUNCTION SUMMARY
SimpleSave
Description
Saves a document or book.
If you set the interactive parameter to False and specify the document or book’s current name
for saveAsName, FrameMaker saves the document or book under its current name.
If you specify another filename for saveAsName, FrameMaker saves the document or book to that file-
name.
If you specify an empty string (""), FrameMaker does not save the file. Instead it sets FA_errno to
Constants.FE_BadParameter (-43).If you set theinteractive parameter to True,
FrameMaker displays the Save dialog box and allows the user to choose a filename. The document or
book’s current name appears as the default name.
The method returns the document it saved, on success.
On failure, the method returns one of the following values to FA_errno:
Error Reason
•Constants.FE_Can-
celed (-44)
• Constants.FE_CanceledBy-
Client (-86)
• Constants.FV_FileNotWritable (33): File was not writable.
• Constants.FV_BadSaveFileName (34): The specified file
name is not allowed by the operating system.
• Constants.FV_BadFileId (35): The file’s operating system ID
was bad.
• Constants.FV_CancelSaveFileIsInUse (50): The file is in use
and the user did not or could not reset the lock. Or the file
is in use, and the Constants.FS_FileIsInUse (17)
parameter is set to Constants.FV_DoCancel (0), or it is set to
Constants.FV_ResetLockAndContinue (7) but FrameMaker
could not reset the lock.
• Constants.FV_CancelSaveModDateChanged (52): The file
has changed since the last time it was opened or saved in
the current session.
• Constants.FV_LockCouldntBeReset (2): File lock could not
be reset.
• Constants.FV_LockWasReset (0): File lock was reset.
• Constants.FV_LockNotReset (1): File lock was not reset.
• Constants.FV_FileIsViewOnly (4): File was View Only.
• Constants.FV_NonPortableSaveName (37): File had a name
that is not portable (Macintosh only).
• Constants.FV_NonPortableFileRefs (38): Referenced
graphics files had filenames that are not portable (Macin-
tosh only).
737
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
Doc
Syntax
SimpleSave(saveAsName, interactive)
Parameters
NewGraphicObject
Description
Creates the following types of graphic objects:
•Arc
• Ellipse
• Flow
•Group
•Inset
Constants.FE_WrongProduc
t (-60)
The specified file contains structure and the current product
interface is not Structured FrameMaker.
Constants.FE_FailedState
(-45)
Constants.FE_BadParamete
r (-43)
The filename was invalid.
Constants.FE_FilterFailed
(-89)
Constants.FV_InvalidSaveFilter (42): The filter specified by
Constants.FS_SaveFileTypeHint (16) is not
installed, or the syntax for
Constants.FS_SaveFileTypeHint (16) is invalid.
Parameter name
Data
Type
Option
al Description
saveAsName strin
g
No The absolute path in which to save
the document or book.
interactive int No Specifies whether the FrameMaker
product displays messages and
warnings to the user. Setting this to
True displays messages and warnings.
Error Reason
738
DOC
CHAPTER 6 FUNCTION SUMMARY
•Line
•Math
• Polyline
•Polygon
•Rectangle
• RoundRect
•TextFrame
• TextLine
• UnanchoredFrame
NOTE: To create an anchored frame, use NewAnchoredObject().
If there is more than one object within the parent frame, the NewGraphicObject() method adds
the new ESTK graphic object to the end of the linked list of child objects. That is, it puts it in the front of
the back-to-front draw order. The method automatically takes care of updating the object’s
PrevGraphicInFrame and NextGraphicInFrame properties. The NewGraphicObject()
method gives the new method graphic object a set of arbitrary default properties.
The method returns the newly created graphic object, on success.
On failure, the method returns one of the following values to FA_errno:
Returns
Object
Syntax
NewGraphicObject(objType, parent)
Parameters
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadObjId (-3) Invalid object.
Constants.FE_NotFrame (-12) Specified parent object is not a frame.
Constants.FE_BadNew (-23) Object cannot be created.
Parameter name
Data
Type
Option
al Description
objType int No The type of ESTK graphic object to
create (for example, FO_Rectangle or
FO_Line).
739
DOC
CHAPTER 6 FUNCTION SUMMARY
NewArc
Description
Creates an arc object.
See NewGraphicObject for more information.
Returns
Arc
Syntax
NewArc(parent)
Parameters
NewEllipse
Description
Creates an ellipse object.
See NewGraphicObject for more information.
parent Any
Frame
Maker
Graph
ic
Objec
t
No The parent frame in which to create
the object.
Parameter name
Data
Type
Option
al Description
parent Any
Frame
Maker
Graph
ic
Objec
t
No The parent frame in which to create
the arc.
Parameter name
Data
Type
Option
al Description
740
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
Ellipse
Syntax
NewEllipse(parent)
Parameters
NewFlow
Description
Creates a flow object.
See NewGraphicObject for more information.
Returns
Flow
Syntax
NewFlow(parent)
Parameter name
Data
Type
Option
al Description
parent Any
Frame
Maker
Graph
ic
Objec
t
No The parent frame in which to create
the ellipse.
741
DOC
CHAPTER 6 FUNCTION SUMMARY
Parameters
NewGroup
Description
Creates a group object.
See NewGraphicObject for more information.
Returns
Group
Syntax
NewGroup(parent)
Parameters
Parameter name
Data
Type
Option
al Description
parent Any
Frame
Maker
Graph
ic
Objec
t
No The parent frame in which to create
the flow.
Parameter name
Data
Type
Option
al Description
parent Any
Frame
Maker
Graph
ic
Objec
t
No The parent frame in which to create
the group.
742
DOC
CHAPTER 6 FUNCTION SUMMARY
NewInlineComponentOfType
Description
Creates an inline component. Presently only one type of inline component exists, and that is the
mini-TOC.
Returns
Void
Syntax
NewInlineComponentOfType(inlineCompType,tags,hyperLinks,textLocP)
Parameters
NewInset
Description
Creates an inset object.
See NewGraphicObject for more information.
Returns
Inset
Parameter name
Data
Type
Option
al Description
inlineCompType int No Type of inline component. Presently
only one type exists:
Constants.FV_MiniTOC
tags Strin
gs
No Paragraph tags to include for the
inline component
hyperLinks Const
ants.
FP_In
sertL
inks
No Flag that specifies if hyperlinks need
to be created in the inline
component.
textLocP TextL
oc
No Text location in docId at which to
create the inline component.
743
DOC
CHAPTER 6 FUNCTION SUMMARY
Syntax
NewInset(parent)
Parameters
NewLine
Description
Creates a line object.
See NewGraphicObject for more information.
Returns
Line
Syntax
NewLine(parent)
Parameters
Parameter name
Data
Type
Option
al Description
parent Any
Frame
Maker
Graph
ic
Objec
t
No The parent frame in which to create
the inset.
Parameter name
Data
Type
Option
al Description
parent Any
Frame
Maker
Graph
ic
Objec
t
No The parent frame in which to create
the line.
744
DOC
CHAPTER 6 FUNCTION SUMMARY
NewMath
Description
Creates a math object.
See NewGraphicObject for more information.
Returns
Math
Syntax
NewMath(parent)
Parameters
NewMathML
Description
Creates a MathML object.
See NewGraphicObject for more information.
Returns
MathML
Syntax
NewMathML(parent)
Parameter name
Data
Type
Option
al Description
parent Any
Frame
Maker
Graph
ic
Objec
t
No The parent frame in which to create
the math object.
745
DOC
CHAPTER 6 FUNCTION SUMMARY
Parameters
NewPolyline
Description
Creates a polyline object.
See NewGraphicObject for more information.
Returns
Polyline
Syntax
NewPolyline(parent)
Parameters
NewPolygon
Description
Creates a polygon object.
See NewGraphicObject for more information.
Parameter name
Data
Type
Option
al Description
parent Any
Frame
Maker
Graph
ic
Objec
t
No The parent frame in which to create
the MathML object.
Parameter name
Data
Type
Option
al Description
parent Any
Frame
Maker
Graphic
Object
No The parent frame in which to create
the polyline.
746
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
Polygon
Syntax
NewPolygon(parent)
Parameters
NewRectangle
Description
Creates a rectangle object.
See NewGraphicObject for more information.
Returns
Rectangle
Syntax
NewRectangle(parent)
Parameter name
Data
Type
Option
al Description
parent Any
Frame
Maker
Graph
ic
Objec
t
No The parent frame in which to create
the polygon.
747
DOC
CHAPTER 6 FUNCTION SUMMARY
Parameters
NewRoundRect
Description
Creates a round rectangle object.
See NewGraphicObject for more information.
Returns
RoundRect
Syntax
NewRoundRect(parent)
Parameters
NewTextFrame
Description
Creates a text frame object.
Parameter name
Data
Type
Option
al Description
parent Any
Frame
Maker
Graph
ic
Objec
t
No The parent frame in which to create
the rectangle.
Parameter name
Data
Type
Option
al Description
parent Any
Frame
Maker
Graph
ic
Objec
t
No The parent frame in which to create
the round rectangle.
748
DOC
CHAPTER 6 FUNCTION SUMMARY
See NewGraphicObject for more information.
Returns
TextFrame
Syntax
NewTextFrame(parent)
Parameters
NewTextLine
Description
Creates a text line object.
See NewGraphicObject for more information.
Returns
TextLine
Syntax
NewTextLine(parent)
Parameter name
Data
Type
Option
al Description
parent Any
Frame
Maker
Graph
ic
Objec
t
No The parent frame in which to create
the text frame.
749
DOC
CHAPTER 6 FUNCTION SUMMARY
Parameters
NewUnanchoredFrame
Description
Creates an unanchored frame object.
See NewGraphicObject for more information.
Returns
UnanchoredFrame
Syntax
NewUnanchoredFrame(parent)
Parameters
NewAnchoredFormattedObject
Description
Creates the following types of anchored objects:
Parameter name
Data
Type
Option
al Description
parent Any
Frame
Maker
Graph
ic
Objec
t
No The parent frame in which to create
the text line.
Parameter name
Data
Type
Option
al Description
parent Any
Frame
Maker
Graph
ic
Objec
t
No The parent frame in which to create
the unanchored frame.
750
DOC
CHAPTER 6 FUNCTION SUMMARY
•Var
•XRef
•Tbl
NewAnchoredFormattedObject() inserts the object at the specified location in text. It uses arbi-
trary default properties for the new object.
If you call NewAnchoredFormattedObject() to create a table, it uses the default numbers of rows
and columns from the specified Table Catalog format. To use the default Table Catalog format for a new
table, set the format to Null. To specify the number of rows and columns when you create a table, use
NewTable().
NewAnchoredFormattedObject() returns the created anchor object, on success.
On failure, the method sets FA_errno to one of the following values:
Returns
Object
Syntax
NewAnchoredFormattedObject(objType, format, textLoc)
Parameters
Error Reason
Constants.FE_BadDocId(
-2)
Invalid document.
Constants.FE_BadObjId(-
3)
Invalid object.
Constants.FE_NotTextOb
ject (-41)
Object specified for text location is not a paragraph (FO_Pgf).
Constants.FE_OffsetNot
Found(-21)
Offset specified for the text location could not be found in the
specified paragraph or text line.
Constants.FE_BadNew(-
23)
Object cannot be created; the format specified by format may not
exist.
Parameter name
Data
Type
Option
al Description
objType int No The type of object to create (for
example, FO_XRef).
751
DOC
CHAPTER 6 FUNCTION SUMMARY
NewAnchoredFormattedVar
Description
Creates an AnchoredFormattedVar object.
See NewAnchoredFormattedObject under the Doc class for more information.
Returns
Var
Syntax
NewAnchoredFormattedVar(format, textLoc)
Parameters
NewAnchoredFormattedXRef
Description
Creates an AnchoredFormattedXRef object.
format strin
g
No The string that specifies the object’s
format (for example, Heading &
Page for a cross-reference, Format
Afor a table, or Current Date
(Long) for a variable).
textLoc TextL
oc
No The text location at which to insert
the anchored object.
Parameter name
Data
Type
Option
al Description
format strin
g
No The string that specifies the object’s
format (for example, Heading &
Page for a cross-reference, Format
Afor a table, or Current Date
(Long) for a variable).
textLoc TextL
oc
No The text location at which to insert
the AnchoredFormattedVar
object.
Parameter name
Data
Type
Option
al Description
752
DOC
CHAPTER 6 FUNCTION SUMMARY
See NewAnchoredFormattedObject under the Doc class for more information.
Returns
XRef
Syntax
NewAnchoredFormattedXRef(format, textLoc)
Parameters
NewAnchoredFormattedTbl
Description
Creates an AnchoredFormattedTbl object.
See NewAnchoredFormattedObject under the Doc class for more information.
Returns
Tbl
Syntax
NewAnchoredFormattedTbl(format, textLoc)
Parameter name
Data
Type
Option
al Description
format strin
g
No The string that specifies the object’s
format (for example, Heading &
Page for a cross-reference, Format
Afor a table, or Current Date
(Long) for a variable).
textLoc TextL
oc
No The text location at which to insert
the AnchoredFormattedXRef
object.
753
DOC
CHAPTER 6 FUNCTION SUMMARY
Parameters
NewAnchoredObject
Description
Creates any of the following anchored objects:
•AFrame
•Fn
•Marker
• TiApiClient
•Table
NewAnchoredObject() inserts the object at the specified location in text. It uses arbitrary default
properties for the new object. Tables created by NewAnchoredObject() have a single column and a
single body row. It is usually easier to use NewTable() to create tables.
The method returns the created anchored object on success.
On failure, the method assigns one of the following values to FA_errno:
Parameter name
Data
Type
Option
al Description
format strin
g
No The string that specifies the object’s
format (for example, Heading &
Page for a cross-reference, Format
Afor a table, or Current Date
(Long) for a variable).
textLoc TextL
oc
No The text location at which to insert
the AnchoredFormattedTbl
object.
Error Reason
Constants.FE_BadDocId(-2) Invalid document.
Constants.FE_BadNew(-23) Object cannot be created.
Constants.FE_BadObjId(-3) Invalid object.
Constants.FE_BadOperatio
n (-27)
Method call specified a bad operation.
Constants.FE_NotTextObjec
t (-41)
Object specified for text location is not a paragraph (FO_Pgf).
754
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
Object
Syntax
NewAnchoredObject(objType, textloc)
Parameters
NewAnchoredAFrame
Description
Creates an anchored AFrame object.
See NewAnchoredObject under the Doc class for more information.
Returns
AFrame
Syntax
NewAnchoredAFrame(textloc)
Parameters
Constants.FE_OffsetNotFou
nd(-21)
Offset specified for the text location could not be found in the
specified paragraph or text line.
Parameter name
Data
Type
Option
al Description
objType int No The type of object to create (for
example, FO_Marker or FO_Fn).
textloc TextL
oc
No The text location at which to insert
the anchored object.
Parameter name
Data
Type
Option
al Description
textloc TextL
oc
No The text location at which to insert
the anchored AFrame.
Error Reason
755
DOC
CHAPTER 6 FUNCTION SUMMARY
NewAnchoredFn
Description
Creates an anchored Fn object.
See NewAnchoredObject under the Doc class for more information.
Returns
Fn
Syntax
NewAnchoredFn(textloc)
Parameters
NewAnchoredMarker
Description
Creates an anchored Marker object.
See NewAnchoredObject under the Doc class for more information.
Returns
Marker
Syntax
NewAnchoredMarker(textloc)
Parameters
Parameter name
Data
Type
Option
al Description
textloc TextL
oc
No The text location at which to insert
the anchored Fn object.
Parameter name
Data
Type
Option
al Description
textloc TextL
oc
No The text location at which to insert
the anchored Marker.
756
DOC
CHAPTER 6 FUNCTION SUMMARY
NewAnchoredTiApiClient
Description
Creates an anchored TiApiClient object.
See NewAnchoredObject under the Doc class for more information.
Returns
TiApiClient
Syntax
NewAnchoredTiApiClient(textloc)
Parameters
NewAnchoredTbl
Description
Creates an anchored table object.
See NewAnchoredObject under the Doc class for more information.
Returns
Tbl
Syntax
NewAnchoredTbl(textloc)
Parameters
Parameter name
Data
Type
Option
al Description
textloc TextL
oc
No The text location at which to insert
the anchored TiApiClient object.
Parameter name
Data
Type
Option
al Description
textloc TextL
oc
No The text location at which to insert
the anchored Table.
757
DOC
CHAPTER 6 FUNCTION SUMMARY
NewSeriesObject
Description
Creates the following series objects:
•BodyPage
• BookComponent
•Pgf
The method allows you to specify the position in the series at which to add the new object.
The method returns the created series object, on success.
On failure, the method assigns one of the following values to FA_errno:
Returns
One of the following objects: Body page, Pgf and Book Component
Syntax
NewSeriesObject(objType, previous)
Parameters
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadNew (-23) Object cannot be created.
Constants.FE_BadObjId (-3) Invalid object.
Constants.FE_NotBodyPage
(-24)
The prevId parameter must specify a body page.
Constants.FE_NotBodyPgf
(-25)
The prevId parameter must specify a paragraph..
Constants.FE_NotBookCom
ponent (-26)
The prevId parameter must specify a book component..
Parameter name
Data
Type
Option
al Description
objType int No The type of object to create (for
example, FO_BodyPage or FO_Pgf).
758
DOC
CHAPTER 6 FUNCTION SUMMARY
NewSeriesBodyPage
Description
Creates a body page.
See NewSeriesObject under the Doc class for more information.
Returns
BodyPage
Syntax
NewSeriesBodyPage(previous)
Parameters
NewSeriesPgf
Description
Creates a paragraph.
previous One
of:
Body
page,
Pgf
and
Book
Compo
nent
No The object in the series after which to
add the new object. To add a
paragraph at the start of a flow,
specify the flow. To add an object at
the beginning of any other series,
specify 0.
Parameter name
Data
Type
Option
al Description
previous BodyP
age
No The object in the series after which to
add the new body page. To add a
paragraph at the start of a flow,
specify the flow. To add a body page
at the beginning of any other series,
specify 0.
Parameter name
Data
Type
Option
al Description
759
DOC
CHAPTER 6 FUNCTION SUMMARY
See NewSeriesObject under the Doc class for more information.
Returns
Pgf
Syntax
NewSeriesPgf(previous)
Parameters
GetNamedObject
Description
Gets the object with the specified name and type. The method works with the following objects:
• AttrCondExpr
•CharFmt
•Color
• CombinedFontDefn
•Command
• CondFmt
•ElementDef
•FmtChangeList
•Menu
• MenuItemSeparator
• MasterPage
•PgfFmt
•RefPage
• RulingFmt
• TblFmt
• UnanchoredFrame (reference frame)
Parameter name
Data
Type
Option
al Description
previous Pgf No The object in the series after which to
add the new paragraph. To add a
paragraph at the start of a flow,
specify the flow. To add a paragraph
at the beginning of any other series,
specify 0.
760
DOC
CHAPTER 6 FUNCTION SUMMARY
•VarFmt
•XRefFmt
•MarkerType
The method returns the object, on success.
On failure, the method assigns one of the following values to FA_errno:
Returns
Object
Syntax
GetNamedObject(objType, name)
Parameters
GetNamedAttrCondExpr
Description
Gets an attribute conditional expression object.
See GetNamedObject under the Doc class for more information.
Returns
AttrCondExpr
Error Reason
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_TypeUnNam
ed (-19)
Objects of the specified type do not have names.
Constants.NameNotFound
(-20)
Object with the specified name and type does not exist in the
specified document.
Parameter name
Data
Type
Option
al Description
objType int No The type of object (for example
FO_TblFmt).
name strin
g
No The name of the object you want to
get.
761
DOC
CHAPTER 6 FUNCTION SUMMARY
Syntax
GetNamedAttrCondExpr(name)
Parameters
GetNamedCharFmt
Description
Gets a Character Format object.
See GetNamedObject under the Doc class for more information.
Returns
CharFmt
Syntax
GetNamedCharFmt(name)
Parameters
GetNamedColor
Description
Gets a Color object.
See GetNamedObject under the Doc class for more information.
Returns
Color
Parameter name
Data
Type
Option
al Description
name strin
g
No The name of the AttrCondExpr object
you want to get.
Parameter name
Data
Type
Option
al Description
name strin
g
No The name of the CharFmt object you
want to get.
762
DOC
CHAPTER 6 FUNCTION SUMMARY
Syntax
GetNamedColor(name)
Parameters
GetNamedCombinedFontDefn
Description
Gets a Combined Font Definition object.
See GetNamedObject under the Doc class for more information.
Returns
CombinedFontDefn
Syntax
GetNamedCombinedFontDefn(name)
Parameters
GetNamedCondFmt
Description
Gets a Conditional Format object.
See GetNamedObject under the Doc class for more information.
Returns
CondFmt
Parameter name
Data
Type
Option
al Description
name strin
g
No The name of the Color object you
want to get.
Parameter name
Data
Type
Option
al Description
name strin
g
No The name of the CombinedFontDefn
object you want to get.
763
DOC
CHAPTER 6 FUNCTION SUMMARY
Syntax
GetNamedCondFmt(name)
Parameters
GetNamedElementDef
Description
Gets an Element Definition object.
See GetNamedObject under the Doc class for more information.
Returns
ElementDef
Syntax
GetNamedElementDef(name)
Parameters
GetNamedFmtChangeList
Description
Gets a Format Change List object.
See GetNamedObject under the Doc class for more information.
Returns
FmtChangeList
Parameter name
Data
Type
Option
al Description
name strin
g
No The name of the CondFmt object you
want to get.
Parameter name
Data
Type
Option
al Description
name strin
g
No The name of the ElementDef object
you want to get.
764
DOC
CHAPTER 6 FUNCTION SUMMARY
Syntax
GetNamedFmtChangeList(name)
Parameters
GetNamedMasterPage
Description
Gets a MasterPage object.
See GetNamedObject under the Doc class for more information.
Returns
MasterPage
Syntax
GetNamedMasterPage(name)
Parameters
GetNamedPgfFmt
Description
Gets a Paragraph Format object.
See GetNamedObject under the Doc class for more information.
Returns
PgfFmt
Parameter name
Data
Type
Option
al Description
name strin
g
No The name of the FmtChangeList
object you want to get.
Parameter name
Data
Type
Option
al Description
name strin
g
No The name of the MasterPage object
you want to get.
765
DOC
CHAPTER 6 FUNCTION SUMMARY
Syntax
GetNamedPgfFmt(name)
Parameters
GetNamedRefPage
Description
Gets a Reference Page object.
See GetNamedObject under the Doc class for more information.
Returns
RefPage
Syntax
GetNamedRefPage(name)
Parameters
GetNamedRulingFmt
Description
Gets a Ruling Format object.
See GetNamedObject under the Doc class for more information.
Returns
RulingFmt
Parameter name
Data
Type
Option
al Description
name strin
g
No The name of the PgfFmt object you
want to get.
Parameter name
Data
Type
Option
al Description
name strin
g
No The name of the RefPage object you
want to get.
766
DOC
CHAPTER 6 FUNCTION SUMMARY
Syntax
GetNamedRulingFmt(name)
Parameters
GetNamedTblFmt
Description
Gets a Table Format object.
See GetNamedObject under the Doc class for more information.
Returns
TblFmt
Syntax
GetNamedTblFmt(name)
Parameters
GetNamedUnanchoredFrame
Description
Gets an Unanchored Frame object.
See GetNamedObject under the Doc class for more information.
Returns
UnanchoredFrame
Parameter name
Data
Type
Option
al Description
name strin
g
No The name of the RulingFmt object
you want to get.
Parameter name
Data
Type
Option
al Description
name strin
g
No The name of the TblFmt object you
want to get.
767
DOC
CHAPTER 6 FUNCTION SUMMARY
Syntax
GetNamedUnanchoredFrame(name)
Parameters
GetNamedVarFmt
Description
Gets a Variable Format object.
See GetNamedObject under the Doc class for more information.
Returns
VarFmt
Syntax
GetNamedVarFmt(name)
Parameters
GetNamedXRefFmt
Description
Gets a Cross Reference Format object.
See GetNamedObject under the Doc class for more information.
Returns
XRefFmt
Parameter name
Data
Type
Option
al Description
name strin
g
No The name of the Unanchored Frame
object you want to get.
Parameter name
Data
Type
Option
al Description
name strin
g
No The name of the Variable Format
object you want to get.
768
DOC
CHAPTER 6 FUNCTION SUMMARY
Syntax
GetNamedXRefFmt(name)
Parameters
GetNamedMarkerType
Description
Gets a Marker Type object.
See GetNamedObject under the Doc class for more information.
Returns
MarkerType
Syntax
GetNamedMarkerType(name)
Parameters
NewNamedObject
Description
Creates the following named objects:
• AttrCondExpr
•CharFmt
• CombinedFontDefn
•Color
•Command
Parameter name
Data
Type
Option
al Description
name strin
g
No The name of the Cross Reference
Format object you want to get.
Parameter name
Data
Type
Option
al Description
name strin
g
No The name of the Marker Type object
you want to get.
769
DOC
CHAPTER 6 FUNCTION SUMMARY
• CondFmt
•ElementDef
•FmtChangeList
• MasterPage
•Menu
• MenuItemSeparator
•PgfFmt
•RefPage
• RulingFmt
• TblFmt
•VarFmt
•XRefFmt
•MarkerType
This method uses arbitrary default properties for the objects it creates.
NOTE: When you create a new element definition, it does not appear in the Element Catalog unless you
set ElementInCatalog to True. When you create a new book and specify a pathname, you must
specify an absolute pathname for the name argument. To create an untitled book, pass an empty string
for the name argument.
NewNamedObject() returns the created named object on success.
If this method fails, the method assigns one of the following values to FA_errno.
Returns
Objectof type objType
Syntax
NewNamedObject(objType, name)
FA_errno value Meaning
Constants.FE_BadDo
cId (-2)
Invalid document.
Constants.FE_BadNa
me(-33)
Specified name for the new object is invalid.
Constants.FE_BadNe
w (-23)
Object cannot be created.
Constants.FE_DupNa
me(-32)
Specified name for the new object belongs to an
existing object.
770
DOC
CHAPTER 6 FUNCTION SUMMARY
Parameters
NewNamedAttrCondExpr
Description
Creates a named Attribute Conditional Expression.
See NewNamedObject under the Doc class for more information.
Returns
AttrCondExpr
Syntax
NewNamedAttrCondExpr(name)
Parameters
NewNamedCharFmt
Description
Creates a named Character Format.
See NewNamedObject under the Doc class for more information.
Returns
CharFmt
Parameter name
Data
Type
Option
al Description
objType int No The type of object to create (for
example, Constants.FO_MasterPage
or Constants.FO_PgfFmt).
name strin
g
No The name to be assigned to the
created object.
Parameter name
Data
Type
Option
al Description
name strin
g
No The name to be assigned to the
created Attribute Conditional
Expression.
771
DOC
CHAPTER 6 FUNCTION SUMMARY
Syntax
NewNamedCharFmt(name)
Parameters
NewNamedCombinedFontDefn
Description
Creates a named Combined Font Definition.
See NewNamedObject under the Doc class for more information.
Returns
CombinedFontDefn
Syntax
NewNamedCombinedFontDefn(name)
Parameters
NewNamedColor
Description
Creates a named Color.
See NewNamedObject under the Doc class for more information.
Returns
Color
Parameter name
Data
Type
Option
al Description
name strin
g
No The name to be assigned to the
created Character Format.
Parameter name
Data
Type
Option
al Description
name strin
g
No The name to be assigned to the
created Combined Font Definition.
772
DOC
CHAPTER 6 FUNCTION SUMMARY
Syntax
NewNamedColor(name)
Parameters
NewNamedCondFmt
Description
Creates a named Conditional Format.
See NewNamedObject under the Doc class for more information.
Returns
CondFmt
Syntax
NewNamedCondFmt(name)
Parameters
NewNamedElementDef
Description
Creates a named Element Definition.
See NewNamedObject under the Doc class for more information.
Returns
ElementDef
Parameter name
Data
Type
Option
al Description
name strin
g
No The name to be assigned to the
created Color.
Parameter name
Data
Type
Option
al Description
name strin
g
No The name to be assigned to the
created Conditional Format.
773
DOC
CHAPTER 6 FUNCTION SUMMARY
Syntax
NewNamedElementDef(name)
Parameters
NewNamedFmtChangeList
Description
Creates a named Format Change List.
See NewNamedObject under the Doc class for more information.
Returns
FmtChangeList
Syntax
NewNamedFmtChangeList(name)
Parameters
NewNamedMasterPage
Description
Creates a named Master Page.
See NewNamedObject under the Doc class for more information.
Returns
MasterPage
Parameter name
Data
Type
Option
al Description
name strin
g
No The name to be assigned to the
created Element Definition.
Parameter name
Data
Type
Option
al Description
name strin
g
No The name to be assigned to the
created Format Change List.
774
DOC
CHAPTER 6 FUNCTION SUMMARY
Syntax
NewNamedMasterPage(name)
Parameters
NewNamedPgfFmt
Description
Creates a named Paragraph Format.
See NewNamedObject under the Doc class for more information.
Returns
PgfFmt
Syntax
NewNamedPgfFmt(name)
Parameters
NewNamedRefPage
Description
Creates a named Reference Page.
See NewNamedObject under the Doc class for more information.
Returns
RefPage
Parameter name
Data
Type
Option
al Description
name strin
g
No The name to be assigned to the
created Master Page.
Parameter name
Data
Type
Option
al Description
name strin
g
No The name to be assigned to the
created Paragraph Format.
775
DOC
CHAPTER 6 FUNCTION SUMMARY
Syntax
NewNamedRefPage(name)
Parameters
NewNamedRulingFmt
Description
Creates a named Ruling Format.
See NewNamedObject under the Doc class for more information.
Returns
RulingFmt
Syntax
NewNamedRulingFmt(name)
Parameters
NewNamedTblFmt
Description
Creates a named Table Format.
See NewNamedObject under the Doc class for more information.
Returns
TblFmt
Parameter name
Data
Type
Option
al Description
name strin
g
No The name to be assigned to the
created Reference Page.
Parameter name
Data
Type
Option
al Description
name strin
g
No The name to be assigned to the
created Ruling Format.
776
DOC
CHAPTER 6 FUNCTION SUMMARY
Syntax
NewNamedTblFmt(name)
Parameters
NewNamedVarFmt
Description
Creates a named Variable Format.
See NewNamedObject under the Doc class for more information.
Returns
VarFmt
Syntax
NewNamedVarFmt(name)
Parameters
NewNamedXRefFmt
Description
Creates a named Cross Reference Format.
See NewNamedObject under the Doc class for more information.
Returns
XRefFmt
Parameter name
Data
Type
Option
al Description
name strin
g
No The name to be assigned to the
created Table Format.
Parameter name
Data
Type
Option
al Description
name strin
g
No The name to be assigned to the
created Variable Format.
777
DOC
CHAPTER 6 FUNCTION SUMMARY
Syntax
NewNamedXRefFmt(name)
Parameters
NewNamedMarkerType
Description
Creates a named Marker Type.
See NewNamedObject under the Doc class for more information.
Returns
MarkerType
Syntax
NewNamedMarkerType(name)
Parameters
DeleteUnusedFmts
Description
Deletes unused formats (character, paragraph or table) from the document.
The method returns Constants.FE_Success on success.
On failure, the method sets FA_errno to one of the following values:
Parameter name
Data
Type
Option
al Description
name strin
g
No The name to be assigned to the
created Cross Reference Format.
Parameter name
Data
Type
Option
al Description
name strin
g
No The name to be assigned to the
created Marker Type.
778
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
DeleteUnusedFmts(objType)
Parameters
DeleteUnusedCharFmt
Description
Deletes the unused Character Formats.
See DeleteUnusedFmts under the Doc class for more information.
Returns
int
Syntax
DeleteUnusedCharFmt()
DeleteUnusedPgfFmt
Description
Deletes the unused Paragraph Formats.
See DeleteUnusedFmts under the Doc class for more information.
Error Reason
Constants.FE_Bad
DocId (-2)
Invalid document.
Constants.FE_BadDel
ete (-17)
The format to be deleted is not one of character, paragraph or table.
Parameter name
Data
Type
Option
al Description
objType int No The type of format to be deleted.
779
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
DeleteUnusedPgfFmt()
DeleteUnusedTblFmt
Description
Deletes the unused Table Formats.
See DeleteUnusedFmts under the Doc class for more information.
Returns
int
Syntax
DeleteUnusedTblFmt()
Find
Description
Performs the same actions as using the Find dialog box to search a document for text or other types of
content.
The properties you can assign to findParamsp are as follows:
Property Meaning and Possible Values
Constants.FS_FindText (1) The text to search for.
Constants.FS_FindElementTag
(2)
Strings as follows:
propVal.u.ssval.len =
FV_NumFindElementItems;
propVal.u.ssval.val[FV_FindElemTag] =
[an_element_tag];
propVal.u.ssval.val[FV_FindAttrName]=
[an_attribute_name];
propVal.u.ssval.val[FV_FindAttrValue] =
[an_attribute_value];
All of the strings must be present, but any or all may be
empty.
780
DOC
CHAPTER 6 FUNCTION SUMMARY
Constants.FS_FindCharFmt (3) No associated property. One or more of the following
additional properties should be specified to tailor the search.
• FontFamily
• CombinedFont
• FontSize
•FontAngle
• FontWeight
•FontVariation
•Color
•Spread
•Stretch
•Language
• Underline
• Overline
•Strikethrough
• ChangeBar
• Capitalization
• Position
•Tsume
Constants.FS_FindPgfTag (4) Paragraph tag.
Constants.FS_FindCharTag (5) Character tag.
Constants.FS_FindTableTag (6) Table tag.
Constants.FS_FindObject (8) Value is one of:
• Constants.FV_FindAnyMarker (0)
• Constants.FV_FindAnyXRef (1)
• Constants.FV_FindUnresolvedXRef (2)
• Constants.FV_FindAnyTextInset (3)
• Constants.FV_FindUnresolvedTextInset (4)
• Constants.FV_FindAnyPub (5)
• Constants.FV_FindAnyVariable (6)
• Constants.FV_FindAnchoredFrame (7)
• Constants.FV_FindFootnote (8)
• Constants.FV_FindAnyTable (9)
• Constants.FV_FindAutomaticHyphen (10)
• Constants.FV_FindAnyRubi (11)
Property Meaning and Possible Values
781
DOC
CHAPTER 6 FUNCTION SUMMARY
Whenever the Find() method finds something that corresponds to a text range (a word, object anchor,
marker, etc.), it returns a TextRange structure for that range. However, when searching for structure
elements, you can find elements that have no corresponding text range.Structure elements for the
following table parts have no corresponding text range:
• Table title
• Table head
• Table foot
• Table body
Constants.FS_FindMarkerOfTyp
e (9)
Marker type.
Constants.FS_FindMarkerText
(10)
Marker text.
Constants.FS_FindXRefWithFor
mat (11)
Format string.
Constants.FS_FindNamedVaria
ble (12)
Variable name.
Constants.FS_FindCondTextInC
ondTags (13)
Condition tags.
Constants.FS_FindCondTextNot
InCondTags (14)
Condition tag.
Constant.FS_FindCustomization
Flags (15)
An optional parameter of type FT_Integer that may be any of
the following bit flags OR’ed together:
• Constants.FF_FIND_CONSIDER_CASE (0x01)
• Constants.FF_FIND_WHOLE_WORD (0x02)
• Constants.FF_FIND_USE_WILDCARDS (0x04)
• Constants.FF_FIND_BACKWARDS (0x08)
• Constants.FF_FIND_USE_REGEX (0x16)
If no customization flags are specified, the default is to search
forward, to not use wildcards, to not consider case, and to
not use whole words.
Constants.FS_FindWrap (16) A flag that determines whether the find operation wraps
when it reaches the location where the search began. Default
is True; the find operations wraps.If False, after reaching the
location where the search began, the find operation returns
an empty TextRange and FA_errno is set to
Constants.FE_NotFound (-95).
Property Meaning and Possible Values
782
DOC
CHAPTER 6 FUNCTION SUMMARY
•Table row
• Table cell
When the Find() method finds a structure element for one of these objects, it returns an empty
TextRange structure and sets FA_errno to FE_Success. In this case, you can get the document’s
ElementSelection property to return a corresponding ElementRange structure for the table
part structure element.
On failure, an empty text range is returned and FA_errno is set to one of the following values:
Returns
TextRange
Syntax
Find(textLoc, findParams)
Parameters
SetElementRange
Description
Sets an element range property.
To specify a selection that includes the root element, set beg.parentId to 0, beg.childId to the
root element, and end.childId to 0.
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadParameter
(-43)
findParams was empty or a parameter was improperly
specified.
Constants.FE_BadInsertPos
(-65)
The value of the textLoc parameter is invalid.
Constants.FE_NotTextObject
(-41)
textLoc parameter is not a text location.
Parameter name
Data
Type
Option
al Description
textLoc TextL
oc
No The text location to begin searching
from.
findParams PropV
als
No A property list that specifies what to
search for.
783
DOC
CHAPTER 6 FUNCTION SUMMARY
The method does not return anything on success.
On failure, the method sets FA_errno to one of the following values:
Returns
Void
Syntax
SetElementRange(propNum, setVal)
Parameters
ElementLocToTextLoc
Description
Returns the text location structure that corresponds with the current element location.
The method returns the text location structure containing the element location, on success.
On failure, the method sets FA_errno to one of the following values:
Error Reason
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_BadObjId
(-3)
invalid object.
Constants.FE_WrongPro
duct (-60)
Current product interface is not Structured FrameMaker.
Parameter name
Data
Type
Option
al Description
propNum int No The property to set. Specify an ESTK
defined property, such as
ElementSelection.
setVal Eleme
ntRan
ge
No The element range to which the
property must be set.
Error Reason
Constants.FE_BadDocId
(-2)
Invalid document.
784
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
TextLoc
Syntax
ElementLocToTextLoc(eloc)
Parameters
UpdateVariables
Description
Updates all the variables in a document. The method performs the same operation as clicking Update in
the Variable dialog box.
The method returns FE_Success on success.
On failure, the method sets FA_errno to one of the following values:
Returns
int
Constants.FE_Badparam
eter (-43)
The eloc parameter was empty or incorrectly specified.
Constants.FE_WrongPro
duct (-60)
Current product interface is not Structured FrameMaker.
Parameter name
Data
Type
Option
al Description
eloc Eleme
ntLoc
No The element location structure to
convert.
Error Reason
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_WrongProd
uct (-60)
Product does not support the operation.
Constants.FE_SystemErr
or (-42)
Could not allocate memory.
Error Reason
785
DOC
CHAPTER 6 FUNCTION SUMMARY
Syntax
UpdateVariables()
TrackChangesAcceptAll
Description
Accepts all the track changes in the specified document.
The method returns FE_Success on success and returns a non-zero integer on failure.
Returns Constants.FE_AcceptRejectCalledOnWrongPreviewState (-110) if the
document is not in Preview Off state.
Returns
int
Syntax
TrackChangesAcceptAll()
TrackChangesRejectAll
Description
Rejects all the track changes in the specified document.
The method returns FE_Success on success and returns a non-zero integer on failure.
Returns Constants.FE_AcceptRejectCalledOnWrongPreviewState (-110) if the
document is not in Preview Off state.
Returns
int
Syntax
TrackChangesRejectAll()
UpdateXRef
Description
Updates the cross-references in a document. It performs the same operation as clicking Update in the
Cross-Reference window.
You can OR the values listed in the following tables into the updateXRefFlags argument.
786
DOC
CHAPTER 6 FUNCTION SUMMARY
The method returns FE_Success on success.
On failure, the method sets FA_errno to one of the following values:
Returns
int
Syntax
UpdateXRef(srcDoc, xref)
Parameters
Value What to update
Constants.FF_XRUI_INTERNA
L (0x01)
Updates only internal cross-references.
Constants.FF_XRUI_OPEN_D
OCS (0x02)
Updates only cross-references whose sources are in open
documents.
Constants.FF_XRUI_CLOSED_
DOCS (0x04)
Updates only cross-references whose sources are in closed
documents.
Constants.FF_XRUI_FORCE_U
PDATE (0x08)
Updates all cross-references, regardless of whether the source
document has changed.
Constants.FF_XRUI_EVERYTHI
NG (0x01|0x02|0x04|0x08)
Updates all cross references.
Error Reason
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_WrongProd
uct (-60)
Product does not support the operation.
Constants.FE_SomeUnres
olved (-42)
There are some unresolved references after the update.
Parameter name
Data
Type
Option
al Description
srcDoc Doc No The document in which to update
cross-references.
xref XRef No Flags to indicate which
cross-references to update. .
787
DOC
CHAPTER 6 FUNCTION SUMMARY
UpdateDITAReference
Description
Updates a DITA object
UpdateDITAReferences
Description
Updates all DITA references of the specified type.
Error Reason
Constants.FE_WrongProd
uct
Current FrameMaker product doesn’t support the
operation.
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_BadElemen
tId
The Element ID provided is invalid.
Constants.FE_NonDITADo
cument
The document provided is not a DITA document.
Constants.FE_BadParame
ter
The objType provided is invalid or the objType is not
valid for the type of DITA document provided.
Constants.FE_UpdateDIT
AReferenceFailedInvali
dElementType
Update operation failed because either the element
specified is not a reference type of element or it does not
match the specified object type.
Constants.FE_UpdateDIT
AReferenceFailedCannot
ResolveReference
Update operation failed because the reference cannot be
resolved.
Constants.FE_UpdateDIT
AReferenceFailedCannot
FindReferencedFile
Update operation failed because the referenced file cannot
be found at the specified location.
Constants.FE_UpdateDIT
AReferenceFailedCannot
OpenReferencedFile
Update operation failed because the referenced file cannot
be opened from the specified location.
Constants.FE_UpdateDIT
AReferenceFailedCannot
ConvertToFMObject
Update operation failed because the corresponding FM
object cannot be created.
Constants.FE_UpdateDIT
AReferenceFailed
Update operation failed.
788
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
void
Syntax
UpdateDITAReferences(docId, flag);
Parameters
If UpdateDITAReferences() fails, the method assigns following values to FA_errno:
Save
Description
Saves a document.
See Save under the Book class for more information.
Parameter name
Data
Type
Option
al Description
docId int No The ID of the document containing
the inset.
flag int No The available flags and their values
are as follows:
FF_DITAUpdateAllConrefs: 0x01
FF_DITAUpdateAllXrefs: 0x02
FF_DITAUpdateAllLinks: 0x04
FF_DITAUpdateAllTopicrefs: 0x08
FF_DITAUpdateAllTopicsetrefs: 0x10
FF_DITAUpdateAllReferences:
FF_DITAUpdateAllConrefs |
FF_DITAUpdateAllXrefs |
FF_DITAUpdateAllLinks |
FF_DITAUpdateAllTopicrefs |
FF_DITAUpdateAllTopicsetrefs
Error Reason
Constants.FE_WrongPro
duct
Current FrameMaker product doesn’t support the
operation.
Constants.FE_BadDocId The Document ID provided is invalid.
Constants.FE_NonDITAD
ocument
The Document provided is not a DITA document.
789
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
Object
Syntax
Save(saveAsName, saveParams, saveReturnParams)
Parameters
Import
Description
Imports text or graphics into a document.
See Import under the Book class for more information.
Returns
Object
Syntax
Import(textLocP, filename, importParams, importReturnParams)
Parameter name
Data
Type
Option
al Description
saveAsName strin
g
No The path for saving the document or
book.
saveParams PropV
als
No A property list that tells FrameMaker
how to save the file and how to
respond to errors and other
conditions. Use
GetSaveDefaultParams() or
AllocatePropVals() to create and
allocate memory for this property list.
To use the default list, specify null.
saveReturnParams PropV
als
No A property list that returns
information about how the
FrameMaker product saved the file.
790
DOC
CHAPTER 6 FUNCTION SUMMARY
Parameters
AddNewBuildExpr
Description
Adds a Boolean conditional expression to the document.
The method returns FE_Success, on success.
On failure, the method sets FA_errno to one of the following values:
Returns
int
Syntax
AddNewBuildExpr(exprName, exprCondition)
Parameter name
Data
Type
Option
al Description
textLocP TextL
oc
No The text location at which to import
the file.
filename strin
g
No The full path of the file to import.
importParams PropV
als
No A property list specifying how to
import the file and how to respond to
errors and other conditions. To use
the default list, specify null.
importReturnParams PropV
als
No A property list that provides
information about how FrameMaker
imported the file. This parameter
must be initialized before you call
Import().
Error Reason
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_ReadOnly
(-6)
Document is read-only.
Constants.FE_BadName
(-33)
Boolean conditional expression string is invalid.
791
DOC
CHAPTER 6 FUNCTION SUMMARY
Parameters
DeleteBuildExpr
Description
Deletes a Boolean conditional expression from the document.
The method returns FE_Success, on success.
On failure, the method sets FA_errno to one of the following values:
Returns
int
Syntax
DeleteBuildExpr(exprName)
Parameters
Parameter name
Data
Type
Option
al Description
exprName strin
g
No The name of the Boolean conditional
expression.
exprCondition strin
g
No The Boolean conditional expression
string.
Error Reason
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_ReadOnly
(-6)
Document is read-only.
Constants.FE_BadName
(-33)
Boolean conditional expression string is invalid.
Parameter name
Data
Type
Option
al Description
exprName strin
g
No The name of the Boolean conditional
expression to delete.
792
DOC
CHAPTER 6 FUNCTION SUMMARY
SetActiveBuildExpr
Description
Applies the Boolean conditional expression to the document.
The method returns FE_Success, on success.
On failure, the method sets FA_errno to one of the following values:
Returns
int
Syntax
SetActiveBuildExpr(exprName)
Parameters
GetActiveBuildExpr
Description
Returns the name of the active expression in the document or null if none is active.
On failure, the method returns the following value to FA_errno:
Error Reason
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_ReadOnly
(-6)
Document is read-only.
Constants.FE_BadName
(-33)
Boolean conditional expression string is invalid.
Parameter name
Data
Type
Option
al Description
exprName strin
g
No The name of the Boolean conditional
expression to be applied.
Error Reason
Constants.FE_BadD
ocId (-2)
Invalid document.
793
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
string
Syntax
GetActiveBuildExpr()
GetBuildExpr
Description
Returns the Boolean conditional expression in the document with the given name or null if none is found.
On failure, the method returns the following value to FA_errno:
Returns
string
Syntax
GetBuildExpr(exprName)
Parameters
GetBuildExprCatalog
Description
Returns an array of all Boolean conditional expression names in the document.
On failure, the method returns the following value to FA_errno:
Error Reason
Constants.FE_BadD
ocId (-2)
Invalid document.
Constants.FE_BadName () The parameter specified by exprName is invalid.
Parameter name
Data
Type
Option
al Description
exprName strin
g
No The name of Boolean conditional
expression.
794
DOC
CHAPTER 6 FUNCTION SUMMARY
Returns
Strings
Syntax
GetBuildExprCatalog()
GetProps
Description
The GetProps() method retrieves the properties of the Doc object.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
The SetProps() method sets the properties of the Doc object.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Error Reason
Constants.FE_BadD
ocId (-2)
Invalid document.
795
ELEMENT
CHAPTER 6 FUNCTION SUMMARY
Parameters
ObjectValid
Description
Returns 1 if the Doc object is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.25. Element
GetAttributes
Description
Gets an elements attributes.
The Attributes structure returned by GetAttributes() includes the attributes in the following
order:
• Attributes defined in the element definition in the same order in which they are defined in the
element definition.
• Undefined attributes in random order.
If an element does not have attributes, the len field of the Attributes structure is set to 0 and the
val field is set to NULL.
Query the valflags field of the Attributes structure to determine whether the attribute is valid,
or if there are any validation errors . The validation error flags are as follows:
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
796
ELEMENT
CHAPTER 6 FUNCTION SUMMARY
On failure, GetAttributes() assigns one of the following values to FA_errno:
Returns
Attributes
Syntax
GetAttributes()
Error Reason
Constants.FV_AV_REQUIRED
(1)
This attribute is required, but it has no value assigned
to it.
Constants.FV_AV_INVALID_C
HOICE (2)
At least one value for the attribute is not one of the
allowed choices.
Constants.FV_AV_INVALID_F
ORMAT (3)
The attribute value is of the wrong type for the
attribute.
Constants.FV_AV_IDREF_UNR
ESOLVED (4)
The attribute refers to an undefined ID value.
Constants.FV_AV_ID_DUPLIC
ATE_IN_DOC (5)
The attribute value should be unique, but is not unique
within the document.
Constants.FV_AV_TOO_MANY_
TOKENS (7)
The attribute value has more than one token, but the
attribute definition only allows one token.
Constants.FV_AV_UNDEFINED
(8)
The attribute is not defined for the containing element.
Constants.FV_AV_OUT_OF_RA
NGE (9)
The attribute value is out of the range specified in the
attribute definition.
Error Reason
Constants.FE_BadDocI
d (-2)
Invalid document.
Constants.FE_WrongPr
oduct (-60)
Current product interface is not structured FrameMaker.
Constants.FE_BadObjI
d (-3)
Invalid object.
797
ELEMENT
CHAPTER 6 FUNCTION SUMMARY
Delete
Description
Deletes an element.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
UpdateDITAReferences
GetText
Description
Gets the text from the element.
See GetText under the Cell class for more information.
Returns
TextItems
Syntax
GetText(flags)
Parameters
GetProps
Description
Retrieves the properties of the element object.
See GetProps under the AFrame class for more information.
Parameter name
Data
Type
Option
al Description
flags int No Denotes the various bit flags that
specify the items to be retrieved.
798
ELEMENT
CHAPTER 6 FUNCTION SUMMARY
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of the element object.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the element object is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
799
ELEMENTCATALOGENTRIES
CHAPTER 6 FUNCTION SUMMARY
6.26. ElementCatalogEntries
An Array of ElementCatalogEntry objects with integer indexing and a length property.
concat
Description
The original array is unchanged. If an array is provided as a parameter to concat(), each of its elements
are appended as separate array elements at the end of the new array. Returns a new array, the result of
concatenation the given values to the end of the original array.
Returns
ElementCatalogEntries
Syntax
concat(value)
Parameters
pop
Description
Removes the last element from the array.
Returns
ElementCatalogEntry
Syntax
pop()
Parameter name
Data
Type
Option
al Description
value Eleme
ntCat
alogE
ntrie
s
No Can also be arrays.
800
ELEMENTCATALOGENTRY
CHAPTER 6 FUNCTION SUMMARY
push
Description
Returns the new length of the array.
Returns
number
Syntax
push(value)
Parameters
6.27. ElementCatalogEntry
ElementCatalogEntry
Description
Describes a catalog entry in an Element Catalog in FrameMaker.
Returns
ElementCatalogEntry
Syntax
ElementCatalogEntry(obj, flags)
Parameter name
Data
Type
Option
al Description
value Eleme
ntCat
alogE
ntry
No The value to be pushed.
801
ELEMENTDEF
CHAPTER 6 FUNCTION SUMMARY
Parameters
The value of the flags field can be one of the following constants:
If no flags are set, the element is invalid at its current position.
6.28. ElementDef
NewTextFmtRules
Description
Creates a TextFmtRules object. The method allows you to associate the created object with a speci-
fied property of the parent object. For example, you can associate the text format rule as the text format
rule of the element definition.
The following table shows the parent object and the type of the object created by the method:
The method returns the created object, on success. On failure, the method assigns one of the following
values to FA_errno:
Parameter name
Data
Type
Option
al Description
obj Eleme
ntDef
No Element definition.
flags uint No Validation type.
Flag Meaning
Constants.FV_STRICTLY_VALID
(0x01)
Catalog entry is strictly valid.
Constants.FV_LOOSELY_VALID
(0x02)
Catalog entry is loosely valid.
Constants.FV_ALTERNATIVE
(0x04)
Catalog entry is an alternative.
Constants.FV_INCLUSION
(0x08)
Catalog entry is valid because it is an inclusion.
Parent Type of Object Number of Instances That Can be Created
ElementDef FmtRule Multiple
802
ELEMENTDEF
CHAPTER 6 FUNCTION SUMMARY
Returns
FmtRule
Syntax
NewTextFmtRules()
NewObjectFmtRules
Description
Creates a ObjectFmtRules object.
The following table shows the parent object and the type of the object created by the method:
The method returns the created object, on success. On failure, the method assigns one of the following
values to FA_errno:
Error Reason
Constants.FE_BadDocId(-
2)
Invalid document.
Constants.FE_BadObjId(-
3)
Invalid object.
Constants.FE_BadNew(-2
3)
Object cannot be created.
Constants.FE_BadPropNu
m(-4)
The property number is invalid.
Constants.FE_WrongProd
uct(-60)
Current product interface is not Structured Framemaker.
Parent Type of Object Number of Instances That Can be Created
ElementDef FmtRule One
Error Reason
Constants.FE_BadDocId(-
2)
Invalid document.
Constants.FE_BadObjId(-
3)
Invalid object.
Constants.FE_BadNew(-2
3)
Object cannot be created.
803
ELEMENTDEF
CHAPTER 6 FUNCTION SUMMARY
Returns
FmtRule
Syntax
NewObjectFmtRules()
NewPrefixRules
Description
Creates a PrefixRules object.
The following table shows the parent object and the type of the object created by the method:
The method returns the created object, on success. On failure, the method assigns one of the following
values to FA_errno:
Constants.FE_BadPropNu
m(-4)
The property number is invalid.
Constants.FE_WrongProd
uct(-60)
Current product interface is not Structured Framemaker.
Parent Type of Object Number of Instances That Can be Created
ElementDef FmtRule Multiple
Error Reason
Constants.FE_BadDocId(-
2)
Invalid document.
Constants.FE_BadObjId(-
3)
Invalid object.
Constants.FE_BadNew(-2
3)
Object cannot be created.
Constants.FE_BadPropNu
m(-4)
The property number is invalid.
Constants.FE_WrongProd
uct(-60)
Current product interface is not Structured Framemaker.
Error Reason
804
ELEMENTDEF
CHAPTER 6 FUNCTION SUMMARY
Returns
FmtRule
Syntax
NewPrefixRules()
NewSuffixRules
Description
Creates a SuffixRules object.
The following table shows the parent object and the type of the object created by the method:
The method returns the created object, on success. On failure, the method assigns one of the following
values to FA_errno:
Returns
FmtRule
Syntax
NewSuffixRules()
Parent Type of Object Number of Instances That Can be Created
ElementDef FmtRule Multiple
Error Reason
Constants.FE_BadDocId(-
2)
Invalid document.
Constants.FE_BadObjId(-
3)
Invalid object.
Constants.FE_BadNew(-2
3)
Object cannot be created.
Constants.FE_BadPropNu
m(-4)
The property number is invalid.
Constants.FE_WrongProd
uct(-60)
Current product interface is not Structured Framemaker.
805
ELEMENTDEF
CHAPTER 6 FUNCTION SUMMARY
NewFirstPgfRules
Description
Creates a FirstPgfRules object.
The following table shows the parent object and the type of the object created by the method:
The method returns the created object, on success. On failure, the method assigns one of the following
values to FA_errno:
Returns
FmtRule
Syntax
NewFirstPgfRules()
NewLastPgfRules
Description
Creates a LastPgfRules object.
The following table shows the parent object and the type of the object created by the method:
Parent Type of Object Number of Instances That Can be Created
ElementDef FmtRule Multiple
Error Reason
Constants.FE_BadDocId(-
2)
Invalid document.
Constants.FE_BadObjId(-
3)
Invalid object.
Constants.FE_BadNew(-2
3)
Object cannot be created.
Constants.FE_BadPropNu
m(-4)
The property number is invalid.
Constants.FE_WrongProd
uct(-60)
Current product interface is not Structured Framemaker.
Parent Type of Object Number of Instances That Can be Created
ElementDef FmtRule Multiple
806
ELEMENTDEF
CHAPTER 6 FUNCTION SUMMARY
The method returns the created object, on success. On failure, the method assigns one of the following
values to FA_errno:
Returns
FmtRule
Syntax
NewLastPgfRules()
ElementDefIsText
Description
Some structural elements in FrameMaker documents are placeholders for text. For example, when a
Para element contains text with a cross-reference element embedded in it, the ranges of text that
surround the cross-reference element are treated as elements themselves. These elements are called
text nodes.
The ElementDefIsText() method checks the value of an element definition to determine whether
the element it is applied to is a text node.
The method returns 1 if the element definition corresponds to that of a text node, or 0 if it does not
correspond to a text node.
Returns
int
Syntax
ElementDefIsText()
Error Reason
Constants.FE_BadDocId(-
2)
Invalid document.
Constants.FE_BadObjId(-
3)
Invalid object.
Constants.FE_BadNew(-2
3)
Object cannot be created.
Constants.FE_BadPropNu
m(-4)
The property number is invalid.
Constants.FE_WrongProd
uct(-60)
Current product interface is not Structured Framemaker.
807
ELEMENTDEF
CHAPTER 6 FUNCTION SUMMARY
NewElement
Description
Creates a structural element (FO_Element) in a FrameMaker document.
NewElement() inserts the new element at the specified location in text, using the specified element
definition.
For object (noncontainer) elements, NewElement() inserts the appropriate type of object for the
element. If there is a matching format rule, NewElement() uses it to format the object. Otherwise, the
method uses one of the following default formats:
The method returns the created element, on success.
On failure, the method returns one of the following values to FA_errno:
Object Type Object Inserted Format Used By Default
Constants.FV_FO_XREF
(3)
Cross Reference Undefined XRef
Constants.FV_FO_EQN
(7)
Equation Medium
Constants.FV_FO_MARK
ER (4)
Marker Type 11
Constants.FV_FO_T
BL (8)
Table with the format
specified by the table
format.
Format A if it exists; otherwise, a
table with a heading row, 8 body
rows, a footing row, and 5 columns.
Constants.FV_FO_S
YS_VAR (2)
Variable Filename (Long)
Constants.FV_FO_G
RAPHIC (6)
A centered 1.0-inch by
1.0-inch anchored frame
below the current position;
cropped is off, and floating
is on.
-
Error Reason
Constants.FE_BadNew
(-23)
Object cannot be created.
Constants.FE_BadObjId
(-3)
Invalid object.
Constants.FE_NotTextOb
ject(-41)
Object specified for the text location is not a paragraph
(FO_Pgf) or a text line (FO_TextLine).
808
ELEMENTDEF
CHAPTER 6 FUNCTION SUMMARY
Returns
Element
Syntax
NewElement(textLoc)
Parameters
NewElementInHierarchy
Description
Creates a structural element (FO_Element) at a specified location in the element hierarchy of a struc-
tured FrameMaker document or book.
To create the root element for a book, you must use NewElementInHierarchy(). However, you
cannot use NewElementInHierarchy() to add elements to an unstructured document. You must
structure the document first by adding a root element with NewElement().
For object (noncontainer) elements, NewElementInHierarchy() inserts the appropriate type of
object for the element. If there is a matching format rule, NewElementInHierarchy() uses it to
format the object. Otherwise, the method uses one of the following default formats:
Constants.FE_OffsetNot
Found (-21)
Offset specified for the text location could not be found in
the specified paragraph or text line.
Parameter name
Data
Type
Option
al Description
textLoc TextL
oc
No The text location at which to insert
the new element.
Object Type Object Inserted Format Used By Default
Constants.FV_FO_XREF
(3)
Cross Reference Undefined XRef
Constants.FV_FO_EQN
(7)
Equation Medium
Constants.FV_FO_MARK
ER (4)
Marker Type 11
Error Reason
809
ELEMENTDEF
CHAPTER 6 FUNCTION SUMMARY
The method returns the created element, on success.
On failure, the method returns one of the following values to FA_errno:
Returns
Element
Syntax
NewElementInHierarchy(elemLoc)
Parameters
Constants.FV_FO_T
BL (8)
Table with the format and
number of rows and
columns specified by the
table format.
Format A if it exists; otherwise, a
table with a heading row, 8 body
rows, a footing row, and 5 columns.
Constants.FV_FO_S
YS_VAR (2)
Variable Filename (Long)
Constants.FV_FO_G
RAPHIC (6)
A centered 1.0-inch by
1.0-inch anchored frame
below the current position;
cropped is off, and floating
is on.
-
Error Reason
Constants.FE_BadBookId
(-66)
Invalid book.
Constants.FE_BadObjId
(-3)
Invalid object.
Constants.FE_BadInsert
Pos (-65)
elemLoc specifies an invalid place to insert the element;
for example, it specifies a position before the highest
element in the flow.
Parameter name
Data
Type
Option
al Description
elemLoc Eleme
ntLoc
No The location at which the element is
to be inserted.
Object Type Object Inserted Format Used By Default
810
ELEMENTDEF
CHAPTER 6 FUNCTION SUMMARY
WrapElement
Description
Inserts a structural element around the selected text and structural elements in a document.
If the flow that contains the selection is unstructured and the selection does not include the entire flow
contents, WrapElement() wraps the flow contents into a NoName element before wrapping the
selection into the specified element definition.
The method does not return anything on success.
On failure, the method returns one of the following values to FA_errno:
Returns
Void
Syntax
WrapElement()
GetAttributeDefs
Description
Gets the attribute definitions of an element definition.
On success, the method returns an AttributeDefs structure containing the attribute definitions.
The attrType field of the returned AttributeDefs structure identifies the attribute value’s type.
It can specify one of the following constants:
Error Reason
Constants.FE_WrongProduct
(-60)
Current product interface is not Structured
FrameMaker.
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadElementDefId
(-28)
Specified element definition is invalid.
Constants.FE_BadSelectionFor
Operation (-59)
Current text selection is invalid for this operation.
Constant Value
Constant.FV_AT_STRING
(0)
Any arbitrary text string.
811
ELEMENTDEF
CHAPTER 6 FUNCTION SUMMARY
On failure, the method returns one of the following values to FA_errno:
Returns
AttributeDefs
Syntax
GetAttributeDefs()
Constant.FV_AT_STRING
S (1)
One or more arbitrary text strings.
Constants.FV_AT_CHOIC
ES (2)
A value from a list of choices.
Constants.FV_AT_INTEG
ER (3)
A signed whole number (optionally restricted to a range of
values).
Constants.FV_AT_INTEG
ERS (4)
One or more integers (optionally restricted to a range of
values).
Constants.FV_AT_REAL
(5)
A real number (optionally restricted to a range of values).
Constants.FV_AT_REALS
(6)
One or more real numbers (optionally restricted to a range of
values).
Constants.FV_AT_UNIQU
E_ID (7)
A string that uniquely identifies the element.
Constants.FV_AT_UNIQU
E_IDREF (8)
A reference to a UniqueID attribute.
Constants.FV_AT_UNIQU
E_IDREFS (9)
One or more references to UniqueID attributes.
Error Reason
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_WrongProduct
(-60)
Current product interface is not Structured
FrameMaker.
Constants.FE_BadObjId(-3) Invalid object.
Constant Value
812
ELEMENTDEF
CHAPTER 6 FUNCTION SUMMARY
Delete
Description
Deletes an element definition.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
The GetProps() method retrieves the properties of an element definition.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
The SetProps() method sets the properties of an element definition.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
813
ELEMENTLOC
CHAPTER 6 FUNCTION SUMMARY
Parameters
ObjectValid
Description
Returns 1 if the element definition is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.29. ElementLoc
ElementLoc
Description
Contains a structure specifying an element location. The ElementLoc structure contains the returned
parent element, child element and the offset within the child or parent element.
Returns
ElementLoc
Syntax
ElementLoc(parent, child, offset)
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
814
ELEMENTRANGE
CHAPTER 6 FUNCTION SUMMARY
Parameters
6.30. ElementRange
ElementRange
Description
A structure specifying an element’s range.
Returns
ElementRange
Syntax
ElementRange(beg, end)
Parameters
Parameter name
Data
Type
Option
al Description
parent Eleme
nt
No Parent element.
child Eleme
nt
No Child element.
offset int No Offset within the child or parent
element.
Parameter name
Data
Type
Option
al Description
beg Eleme
ntLoc
No Beginning of the element’s range.
end Eleme
ntLoc
No End of the element’s range.
815
ELLIPSE
CHAPTER 6 FUNCTION SUMMARY
6.31. Ellipse
Delete
Description
Deletes an ellipse.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
Retrieves the properties of an ellipse.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of an ellipse.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
816
FILTERARGS
CHAPTER 6 FUNCTION SUMMARY
Parameters
ObjectValid
Description
Returns 1 if the ellipse is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.32. FilterArgs
FilterArgs
Description
FilterArgs stores information that is used in the notification for a file-to-file filter
(FA_Note_FilterFileToFile). The notification handler receives a pointer to this structure.
Returns
FilterArgs
Definition
FilterArgs{infile, outfile, clname, informat, outformat, binname, args}
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
817
FLOW
CHAPTER 6 FUNCTION SUMMARY
Parameters
6.33. Flow
Delete
Description
Deletes a flow.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
Parameter name
Data
Type
Option
al Description
infile strin
g
No The file to filter.
outfile strin
g
No The filter output file.
clname strin
g
No The registered name of the filter.
informat strin
g
No The registered incoming format.
outformat strin
g
No The registered output format.
binname strin
g
No The name of the filter client file.
args Strin
gs
No Reserved for future use. Currently
NULL.
818
FLOW
CHAPTER 6 FUNCTION SUMMARY
GetText
Description
Gets the text from the flow.
See GetText under the Cell class for more information.
Returns
TextItems
Syntax
GetText(flags)
Parameters
GetProps
Description
Retrieves the properties of the flow.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of the flow.
See SetProps under the AFrame class for more information.
Parameter name
Data
Type
Option
al Description
flags int No Denotes the various bit flags that
specify the items to be retrieved.
819
FMTCHANGELIST
CHAPTER 6 FUNCTION SUMMARY
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the flow is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.34. FmtChangeList
Delete
Description
Deletes a format change list.
See Delete under the AFrame class for more information.
Returns
int
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
820
FMTCHANGELIST
CHAPTER 6 FUNCTION SUMMARY
Syntax
Delete()
GetProps
Description
Retrieves the properties of the format change list.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of a format change list.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the format change list is valid, else returns 0.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
821
FMTRULE
CHAPTER 6 FUNCTION SUMMARY
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.35. FmtRule
NewFmtRuleClauses
Description
Creates a FmtRuleClauses object.
The following table shows the parent object and the type of the object created by the method:
The method returns the created object, on success. On failure, the method assigns one of the following
values to FA_errno:
Returns
FmtRuleClause
Parent Type of Object Number of Instances That Can be Created
FmtRule FmtRuleClause Multiple
Error Reason
Constants.FE_BadDocId(-
2)
Invalid document.
Constants.FE_BadObjId(-
3)
Invalid object.
Constants.FE_BadNew(-2
3)
Object cannot be created.
Constants.FE_BadPropNu
m(-4)
The property number is invalid.
Constants.FE_WrongProd
uct(-60)
Current product interface is not Structured Framemaker.
822
FMTRULE
CHAPTER 6 FUNCTION SUMMARY
Syntax
NewFmtRuleClauses()
Delete
Description
Deletes a format rule.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
Retrieves the properties of a format rule.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of a format rule.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
823
FMTRULECLAUSE
CHAPTER 6 FUNCTION SUMMARY
Parameters
ObjectValid
Description
Returns 1 if the format rule is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.36. FmtRuleClause
NewSubFmtRule
Description
Creates a SubFmtRule object.
The following table shows the parent object and the type of the object created by the method:
The method returns the created object, on success. On failure, the method assigns one of the following
values to FA_errno:
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
Parent Type of Object Number of Instances That Can be Created
FmtRuleClause FmtRule One
Error Reason
Constants.FE_BadDocId(-
2)
Invalid document.
824
FMTRULECLAUSE
CHAPTER 6 FUNCTION SUMMARY
Returns
FmtRule
Syntax
NewSubFmtRule()
NewFmtChangeList
Description
Creates a FmtChangeList object.
The following table shows the parent object and the type of the object created by the method:
The method returns the created object, on success. On failure, the method assigns one of the following
values to FA_errno:
Constants.FE_BadObjId(-
3)
Invalid object.
Constants.FE_BadNew(-2
3)
Object cannot be created.
Constants.FE_BadPropNu
m(-4)
The property number is invalid.
Constants.FE_WrongProd
uct(-60)
Current product interface is not Structured Framemaker.
Parent Type of Object Number of Instances That Can be Created
FmtRuleClause FmtChangeList One
Error Reason
Constants.FE_BadDocId(-
2)
Invalid document.
Constants.FE_BadObjId(-
3)
Invalid object.
Constants.FE_BadNew(-2
3)
Object cannot be created.
Constants.FE_BadPropNu
m(-4)
The property number is invalid.
Error Reason
825
FMTRULECLAUSE
CHAPTER 6 FUNCTION SUMMARY
Returns
FmtChangeList
Syntax
NewFmtChangeList()
Delete
Description
Deletes a format rule clause.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
Retrieves the properties of a format rule clause.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of a format rule clause.
Constants.FE_WrongProd
uct(-60)
Current product interface is not Structured Framemaker.
Error Reason
826
FN
CHAPTER 6 FUNCTION SUMMARY
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the format rule clause is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.37. Fn
Delete
Description
Deletes a footnote.
See Delete under the AFrame class for more information.
Returns
int
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
827
FN
CHAPTER 6 FUNCTION SUMMARY
Syntax
Delete()
GetText
Description
Gets the text from the footnote.
See GetText under the Cell class for more information.
Returns
TextItems
Syntax
GetText(flags)
Parameters
GetProps
Description
Retrieves the properties of a footnote.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of a footnote.
Parameter name
Data
Type
Option
al Description
flags int No Denotes the various bit flags that
specify the items to be retrieved.
828
FONT
CHAPTER 6 FUNCTION SUMMARY
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the footnote is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.38. Font
Font
Description
Font specifies a combination of font characteristics. Each field specifies an index into a list of names in
the FrameMaker product session. For example, the family field specifies the index of a name in the list
of names specified by the session property FontFamilyNames.
The weight field specifies the index of a name in the list of names specified by the session property
FontWeightNames.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
829
FONTS
CHAPTER 6 FUNCTION SUMMARY
Returns
Font
Syntax
Font(family, variation, weight, angle)
Parameters
6.39. Fonts
An Array of Font objects with integer indexing and a length property.
concat
Description
The original array is unchanged. If an array is provided as a parameter to concat(), each of its elements
are appended as separate array elements at the end of the new array. Returns a new array as the result
of concatenation, with the given values to the end of the original array.
Returns
Fonts
Syntax
concat(value)
Parameters
Parameter name
Data
Type
Option
al Description
family uint No Index of the font family.
variation uint No Index of the font variation.
weight uint No Index of the font weight.
angle uint No Index of the font angle.
Parameter name
Data
Type
Option
al Description
value Fonts No Can also be arrays.
830
GROUP
CHAPTER 6 FUNCTION SUMMARY
pop
Description
Removes the last element from the array.
Returns
Font
Syntax
pop()
push
Description
Pushes the font on the array and the returns the new length of the array.
Returns
number
Syntax
push(value)
Parameters
6.40. Group
A Group object represents a set of grouped objects. Group objects have the following methods.
Delete
Description
Deletes a group.
See Delete under the AFrame class for more information.
Parameter name
Data
Type
Option
al Description
value Font No Can also be arrays
831
GROUP
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
Delete()
GetProps
Description
Retrieves the properties of the group.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of the group.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
832
HIDDENPAGE
CHAPTER 6 FUNCTION SUMMARY
ObjectValid
Description
Returns 1 if the group is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.41. HiddenPage
GetProps
Description
Retrieves the properties of the hidden page.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of the hidden page.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
833
HIDDENPAGE
CHAPTER 6 FUNCTION SUMMARY
Parameters
ObjectValid
Description
Returns 1 if the hidden page is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
ApplyPageLayout
Description
Applies the layout of a page to another page.
PageObject is any Page object i.e., BodyPage, MasterPage, HiddenPage.
The method returns FE_Success on success.
On failure, the method returns one of the following values to FA_errno:
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
Error Reason
Constants.FE_WrongPr
oduct (-60)
Current FrameMaker product does not support this operation
or fmbatch is running.
Constants.FE_BadOperation
(-27)
Parameter specified an invalid operation.
Constants.FE_BadParameter
(-43)
Parameter has an invalid value.
Constants.FE_SystemError
(-42)
System Error.
834
INSET
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
ApplyPageLayout(srcPage)
Parameters
6.42. Inset
GetIntByName
Description
Queries an integer facet.
GetIntByName() uses a transaction model to query facets. After you have finished a series of queries,
you must commit the transaction by calling GetIntByName() to query a facet named “ “.
If GetIntByName() returns 0, it may not indicate an error, because some facet values can be 0. To
determine if a returned 0 is a property value or an error, check FA_errno.
Returns the specified facet value, on success.
On failure, the method returns one of the following values to FA_errno:
Parameter name
Data
Type
Option
al Description
srcPage PageO
bject
No The page to which the layout must be
applied.
Error Reason
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_BadObjId
(-3)
Invalid object.
Constants.FE_BadPropN
um (-4)
Specified property name is invalid.
Constants.FE_BadPropT
ype (-5)
Incorrect property type.
835
INSET
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
GetIntByName(propName)
Parameters
GetMetricByName
Description
Queries a metric facet.
GetMetricByName() uses a transaction model to query facets. After you have finished a series of
queries, you must commit the transaction by calling GetIntByName() to query a facet named “ “.
If GetMetricByName() returns 0, it may not indicate an error, because some facet values can be 0.
To determine if a returned 0 is a property value or an error, check FA_errno.
Returns the specified facet value, on success.
On failure, the method returns one of the following values to FA_errno:
Constants.FE_WrongPro
duct (-60)
Current FrameMaker does not support this operation.
Parameter name
Data
Type
Option
al Description
propName strin
g
No The name of the facet to query.
Error Reason
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_BadObjId
(-3)
Invalid object.
Constants.FE_BadPropN
um (-4)
Specified property name is invalid.
Constants.FE_BadPropT
ype (-5)
Incorrect property type.
Error Reason
836
INSET
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
GetMetricByName(propName)
Parameters
GetUBytesByName
Description
Queries an unsigned bytes inset facet. The standard facets, EPSI and FrameImage, are examples of
unsigned bytes facets.
If a facet contains a large amount of data, GetUBytesByName() only gets a portion of the data each
time you call it.
To query a facet that contains a large amount of data, call GetUBytesByName() repeatedly until you
have retrieved all the data (that is, until UBytes.len is 0).
GetUBytesByName() uses a transaction model to query facets. After you have finished a series of
queries, you must commit the transaction by calling GetIntByName() to query a facet named “ “.
On success, the method returns a UBytes object containing a portion of the facet’s data.
On failure, the method returns one of the following values to FA_errno:
Constants.FE_WrongPro
duct (-60)
Current FrameMaker does not support this operation.
Parameter name
Data
Type
Option
al Description
propName strin
g
No The name of the facet to query.
Error Reason
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_BadObjId
(-3)
Invalid object.
Error Reason
837
INSET
CHAPTER 6 FUNCTION SUMMARY
NOTE: The returned UBytes object references memory that is allocated by the method. Use
DeallocateUBytes() to free this memory when you are done using it.
Returns
UBytes
Syntax
GetUBytesByName(propName)
Parameters
SetIntByName
Description
Sets an integer inset facet.
SetIntByName() uses a transaction model to set facets. After you have finished setting facets, you
must commit the transaction by calling SetIntByName() to set a facet named“ “ to 0.
The method does not return anything on success.
On failure, the method returns one of the following values to FA_errno:
Constants.FE_BadPropN
um (-4)
Specified property name is invalid.
Constants.FE_BadPropT
ype (-5)
Incorrect property type.
Constants.FE_WrongPro
duct (-60)
Current FrameMaker does not support this operation.
Parameter name
Data
Type
Option
al Description
propName strin
g
No The name of the facet to query.
Error Reason
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_BadObjId
(-3)
Invalid object.
Error Reason
838
INSET
CHAPTER 6 FUNCTION SUMMARY
Returns
Void
Syntax
SetIntByName(propName, setVal)
Parameters
SetMetricByName
Description
Sets a metric facet.
SetMetricByName() uses a transaction model to set facets. After you have finished setting facets,
you must commit the transaction by calling SetIntByName() to set a facet named“ “ to 0.
The method does not return anything on success.
On failure, the method returns one of the following values to FA_errno:
Constants.FE_BadPropN
um (-4)
Specified property name is invalid.
Constants.FE_BadName
(-33)
Specified name is illegal.
Constants.FE_WrongPro
duct (-60)
Current FrameMaker does not support this operation.
Parameter name
Data
Type
Option
al Description
propName strin
g
No The name of the facet to set.
setVal int No The value to which the facet must be
set.
Error Reason
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_BadName
(-33)
Specified name is illegal.
Error Reason
839
INSET
CHAPTER 6 FUNCTION SUMMARY
Returns
Void
Syntax
SetMetricByName(propName, setVal)
Parameters
SetUBytesByName
Description
Sets an unsigned bytes inset facet. The standard facets, EPSI and FrameImage, are examples of unsigned
bytes facets.
Constants.FE_BadObjId
(-3)
Invalid object.
Constants.FE_BadPropT
ype (-5)
Incorrect property type for this function.
Constants.FE_OutOfRan
ge (-7)
Specified property value is out of the legal range for the
specified .property.
Constants.FE_ReadOnly
(-6)
Property is read-only.
Constants.FE_WrongPro
duct (-60)
Current FrameMaker does not support this operation.
Parameter name
Data
Type
Option
al Description
propName strin
g
No The name of the facet to set.
setVal int No The value to which the facet must be
set.
Error Reason
840
INSET
CHAPTER 6 FUNCTION SUMMARY
To set a UBytes facet:
1) Call SetUBytesByName() to set the facet data.
If you are setting a facet with less than 10K of data, you need to call SetUBytesByName() only
once.
If you are setting the facet with more than 10K of data, you should call SetUBytesByName()
multiple times, setting a chunk of the data each time. You can size the chunks between 0 and 10K.
NOTE: If you use larger chunks, the set operation goes faster. However, if the chunks are too large,
you may overload your platform’s interapplication communication mechanism.
2) Call SetUBytesByName() with propNameset to an empty string (“ “).
This lets the ESTK know that you have finshed setting up the facet.
The method does not return anything on success.
On failure, the method returns one of the following value to FA_errno:
Returns
Void
Syntax
SetUBytesByName(propName, setVal)
Parameters
Delete
Description
Deletes an inset.
See Delete under the AFrame class for more information.
Error Reason
Constants.FE_Trans
port (-1)
A transportation error occured.
Parameter name
Data
Type
Option
al Description
propName strin
g
No The name of the facet to set.
setVal UByte
s
No The value to which the facet must be
set.
841
INSET
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
Delete()
DeletePropByName
Description
Deletes an inset facet. Except for inset facets, all properties are identified by integer constants. Facets
are the only properties identified by name.
The method does not return anything on success.
On failure, the method returns one of the following values to FA_errno:
Returns
Void
Syntax
DeletePropByName(propName)
Parameters
Error Reason
Constants.FE_BadPropN
um (-4)
Specified property number is invalid.
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_BadObjId
(-3)
Invalid object.
Constants.FE_BadPropT
ype (-5)
Incorrect property type for this function.
Parameter name
Data
Type
Option
al Description
propName strin
g
No The name of the facet to be deleted.
842
INSET
CHAPTER 6 FUNCTION SUMMARY
GetProps
Description
Retrieves the properties of the inset.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of the inset.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the inset is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
843
INTS
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
ObjectValid()
6.43. Ints
An Array of objects with integer indexing and a length property.
concat
Description
The original array is unchanged. If an array is provided as a parameter to concat(), each of its elements
are appended as separate array elements at the end of the new array. Returns a new array, the result of
concatenation the given values to the end of the original array.
Returns
Ints
Syntax
concat(value)
Parameters
pop
Description
Removes the last element from the array.
Returns
int
Parameter name
Data
Type
Option
al Description
value Ints No Can also be arrays.
844
ITERATOR
CHAPTER 6 FUNCTION SUMMARY
Syntax
pop()
push
Description
Returns the new length of the array.
Returns
number
Syntax
push(value)
Parameters
6.44. Iterator
GetNextIteratorItem
Description
Retrieves the next iterator in the document.
Returns
PropVals
Syntax
GetNextIteratorItem()
Delete
Description
Deletes an iterator.
Parameter name
Data
Type
Option
al Description
value int No Can also be arrays.
845
ITERATOR
CHAPTER 6 FUNCTION SUMMARY
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
Retrieves the properties of the iterator.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of the iterator.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
846
KEYCATALOG
CHAPTER 6 FUNCTION SUMMARY
ObjectValid
Description
Returns 1 if the iterator is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.45. KeyCatalog
NewKeyDefinition
Description
Adds a new key definition to the specified key catalog.
Returns
void
Syntax
NewKeyDefinition(key, href, srcType, srcFile, flags);
Parameters
Parameter name
Data
Type
Option
al Description
key int No The tag of the key for which the key
definition is being added.
href int No The complete path of the file that the
key refers to.
srcType int No The type of the file that contains the
key definition. See the table below for
a list of values.
847
KEYCATALOG
CHAPTER 6 FUNCTION SUMMARY
srcType can have one of the following values:
You can OR the following bit-flags into flags:
If NewKeyDefinition() fails, the method assigns following values to FA_errno:
srcFile int No The complete path of the file that
contains the key definition.
flags int No Bit flags specifying information about
the key definition. See the table
below for a list of flags.
srcType Meaning
Constants.FV_KeySrcTyp
eNone
Source file type not specified.
Constants.FV_KeySrcTyp
eDitamap
Source file is a DITA Map.
Bit mask Meaning
Constants.FF_DUPLICAT
E_KEY_DEFINITION
The specified key definiton is duplicate (that is, it already
exists in the Key Catalog) and will not be used as active
definition for resolving keys.
Constants.FF_FOUND_I
N_REFERENCED_FILE
The specified key definiton is contained in a file
referenced directly or indirectly from the file that
contains the key definition (srcFile).
Constants.FF_INVALID_
KEY
The specified key definiton is invalid due to some reason
but will still be kept in the Key Catalog.
Error Reason
Constants.FE_BadObjId The ID provided does not specify a Key Catalog.
Constants.FE_BadKey The Key provided is not valid.
Constants.FE_KeyDefinit
ionAlreadyExists
The definition for the specified key is already available in
the Key Catalog and the key definition provided is not
duplicate.
Parameter name
Data
Type
Option
al Description
848
KEYCATALOG
CHAPTER 6 FUNCTION SUMMARY
UpdateKeyDefinition
Description
Updates the specified key definition field for the specified key in the specified key catalog.
Returns
void
Syntax
UpdateKeyDefinition(key, keyField, valuep);
Parameters
The valid keyField values and the corresponding value type are as follows:
Parameter name
Data
Type
Option
al Description
key int No The tag of the key for which the key
definition is being updated.
keyField int No The key field (or key information) that
is being updated.
valuep int No The value to update the keyField to.
keyField Value type
Constants.FV_KeydefKe
yTarget
FT_String
Constants.FV_KeydefKe
ySrcFile
FT_String
Constants.FV_KeydefKe
ySrcType
FT_Integer
Constants.FV_KeydefKe
yVarList
FT_Vals
Constants.FV_KeydefKe
yDefaultText
FT_String
Constants.FV_KeydefKe
yFoundInRefFile
FT_Integer
Constants.FV_KeydefKe
yInValid
FT_Integer
849
KEYCATALOG
CHAPTER 6 FUNCTION SUMMARY
If UpdateKeyDefinition() fails, the method assigns following values to FA_errno:
GetKeyDefinition
Description
Gets the specified key definition field for the specified key from the specified key catalog.
Returns
TypedVal
Syntax
GetKeyDefinition(key, keyField);
Constants.FV_KeydefKe
yAttrs
FT_AttributesEx
Error Reason
Constants.FE_BadObjId The ID provided does not specify a Key Catalog.
Constants.FE_BadKey The Key provided is not valid.
Constants.FE_KeyDefinit
ionDoesNotExist
The definition for the specified key is not available in the
Key Catalog.
Constants.FE_BadValue The value is either not specified or it is not as expected
for the specified 'keyField'.
Constants.FE_ReadOnly (only for keyField=FV_KeydefKeyTag or
FV_KeydefKeyDuplicate). The key field cannot be
changed/updated.
Constants.FE_InvAttribu
te
(only for keyField=FV_KeydefKeyAttrs) The Attribute
information provided is not valid.
Constants.FE_WrongPro
duct
(only for keyField=FV_KeydefKeyAttrs) Current
FrameMaker product doesn’t support the operation.
Constants.FE_BadKeyFi
eld
The key field provided is not valid.
keyField Value type
850
KEYCATALOG
CHAPTER 6 FUNCTION SUMMARY
Parameters
The valid keyField values and the corresponding value type are as follows:
If GetKeyDefinition() fails, the method assigns following values to FA_errno:
Parameter name
Data
Type
Option
al Description
key int No The tag of the key for which the key
definition is being asked for.
keyField int No The key field (or key information) that
is being asked for.
keyField Value type
Constants.FV_KeydefKe
yTag
FT_String
Constants.FV_KeydefKe
yTarget
FT_String
Constants.FV_KeydefKe
ySrcFile
FT_String
Constants.FV_KeydefKe
yDuplicate
FT_Integer
Constants.FV_KeydefKe
ySrcType
FT_Integer
Constants.FV_KeydefKe
yVarList
FT_Vals
Constants.FV_KeydefKe
yDefaultText
FT_String
Constants.FV_KeydefKe
yFoundInRefFile
FT_Integer
Constants.FV_KeydefKe
yInValid
FT_Integer
Constants.FV_KeydefKe
yAttrs
FT_AttributesEx
Error Reason
Constants.FE_BadObjId The ID provided does not specify a Key Catalog.
851
KEYCATALOG
CHAPTER 6 FUNCTION SUMMARY
GetAllKeyDefinitions
Description
Gets all the key definitions from the specified key catalog.
Returns
TypedVals
Syntax
GetAllKeyDefinitions(filterType);
Parameters
Returns the information in a TypedVals structure as follows: FieldTag is of type FT_Integer. FieldValue is
of type as specified in the table below.
Constants.FE_BadKey The Key provided is not valid.
Constants.FE_KeyCatalo
gNotLoaded
The Key Catalog provided is currently not loaded.
Constants.FE_KeyCatalo
gIsStale
The Key Catalog provided is currently marked as stale and
needs to be re-loaded before using.
Constants.FE_KeyDefinit
ionDoesNotExist
The definition for the specified key is not available in the
Key Catalog.
Constants.FE_WrongPro
duct
(only for keyField="FV_KeydefKeyAttrs") Current
FrameMaker product doesn’t support the operation.
Constants.FE_BadKeyFi
eld
The key field provided is not valid.
Parameter name
Data
Type
Option
al Description
filterType int No Specifies the kind of key fields to get
for each key definition. flterType can
have the following values:
FV_KeyDefFieldsTypePrimary: Get
only the primary key fields (Tag,
Target, SrcFile, and Duplicate)
FV_KeyDefFieldsTypeAll: Get all key
fields.
Error Reason
852
KEYCATALOG
CHAPTER 6 FUNCTION SUMMARY
If GetAllKeyDefinitions() fails, the method assigns following values to FA_errno:
FieldTag value FieldValue type
Constants.FV_KeydefKe
yAttrs
FT_AttributesEx
Constants.FV_KeydefKe
yDefaultText
FT_String
Constants.FV_KeydefKe
yDuplicate
FT_Integer
Constants.FV_KeydefKe
yFoundInRefFile
FT_Integer
Constants.FV_KeydefKe
yInValid
FT_Integer
Constants.FV_KeydefKe
ySrcFile
FT_String
Constants.FV_KeydefKe
ySrcType
FT_Integer
Constants.FV_KeydefKe
yTag
FT_String
Constants.FV_KeydefKe
yTarget
FT_String
Constants.FV_KeydefKe
yVarList
FT_Vals
Error Reason
Constants.FE_BadObjId The ID provided does not specify a Key Catalog.
Constants.FE_KeyCatalo
gNotLoaded
The Key Catalog provided is currently not loaded.
Constants.FE_KeyCatalo
gIsStale
The Key Catalog provided is currently marked as stale and
needs to be re-loaded before using.
Constants.FE_BadFilterT
ype
The filter type provided is not valid.
853
KEYCATALOG
CHAPTER 6 FUNCTION SUMMARY
DeleteAllKeyDefinitions
Description
Deletes all the key definitions in the specified key catalog.
Returns
void
Syntax
DeleteAllKeyDefinitions();
If DeleteAllKeyDefinitions() fails, the method assigns following values to FA_errno:
GetAllKeys
Description
Gets all the key tags from the specified key catalog.
Returns
Strings
Syntax
GetAllKeys();
If GetAllKeys() fails, the method assigns following values to FA_errno:
Delete
Description
Deletes a key catalog.
Error Reason
Constants.FE_BadObjId The ID provided does not specify a Key Catalog.
Error Reason
Constants.FE_BadObjId The ID provided does not specify a Key Catalog.
Constants.FE_KeyCatalo
gNotLoaded
The Key Catalog provided is currently not loaded.
Constants.FE_KeyCatalo
gIsStale
The Key Catalog provided is currently marked as stale and
needs to be re-loaded before using.
854
KEYCATALOG
CHAPTER 6 FUNCTION SUMMARY
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
Retrieves the properties of the key catalog.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of the key catalog.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
855
LINE
CHAPTER 6 FUNCTION SUMMARY
ObjectValid
Description
Returns 1 if the key catalog is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.46. Line
Delete
Description
Deletes a line.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
Retrieves the properties of the line.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
856
MARKER
CHAPTER 6 FUNCTION SUMMARY
SetProps
Description
Sets the properties of the line.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the line is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.47. Marker
Delete
Description
Deletes a marker.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
857
MARKER
CHAPTER 6 FUNCTION SUMMARY
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
Retrieves the properties of the marker.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of the marker.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The properties list.
858
MARKERTYPE
CHAPTER 6 FUNCTION SUMMARY
ObjectValid
Description
Returns 1 if the marker is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.48. MarkerType
Delete
Description
Deletes a marker type.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
Retrieves the properties of the marker type.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
859
MASTERPAGE
CHAPTER 6 FUNCTION SUMMARY
SetProps
Description
Sets the properties of the marker type.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the marker type is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.49. MasterPage
Delete
Description
Deletes a master page.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
860
MASTERPAGE
CHAPTER 6 FUNCTION SUMMARY
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
Retrieves the properties of the master page.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of the master page.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
861
MASTERPAGE
CHAPTER 6 FUNCTION SUMMARY
ObjectValid
Description
Returns 1 if the master page is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
ApplyPageLayout
Description
Copies the layout of one master page to another.
PageObject is any Page object i.e., BodyPage, MasterPage, HiddenPage.
See ApplyPageLayout under the Body Page class for more information.
Returns
int
Syntax
ApplyPageLayout(srcPage)
Parameters
Parameter name
Data
Type
Option
al Description
srcPage PageO
bject
No The page to which the layout is to be
applied.
862
MATH
CHAPTER 6 FUNCTION SUMMARY
6.50. Math
Delete
Description
Deletes a math object.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
Retrieves the properties of the math object.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of the math object.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
863
MATHML
CHAPTER 6 FUNCTION SUMMARY
Parameters
ObjectValid
Description
Returns 1 if the math object is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.51. MathML
Delete
Description
Deletes a math object.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
Retrieves the properties of the math object.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
864
MATHML
CHAPTER 6 FUNCTION SUMMARY
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of the math object.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the math object is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
865
MENU
CHAPTER 6 FUNCTION SUMMARY
6.52. Menu
DefineAndAddCommand
Description
Defines a command (FO_Command object) and adds it to a menu or menu bar.
The following table lists some FrameMaker product menus and the names you use to specify them:
If you call DefineAndAddCommand() and specify the name of a command that is already defined in
the user’s menu configuration files, FrameMaker gives precedence to the definition in the configuration
files.
If the configuration files assign a label or a shortcut to the command, then FrameMaker uses it instead
of the one you specify.If the command is already a menu item, FrameMaker ignores the menu that you
specify and leaves the menu item where it is.
NOTE: If you want to add a command to more than one menu, do not call DefineAndAddCommand()
repeatedly to add the command to the menus. To add a command to multiple menus, define the
command first by calling DefineCommand()—or call iDefineAndAddCommand(), if you want to define and
add the command to a menu at the same time—and then call AddCommandToMenu() to add the
command to other menus.
The method returns the command, on success.
On failure, the method returns one of the following values to FA_errno:
Menu Title Menu Name
Edit EditMenu
File FileMenu
Format FormatMenu
Graphics GraphicsMenu
Special SpecialMenu
Table TableMenu
View ViewMenu
Help !HelpMenu
Error Reason
Constants.FE_WrongPr
oduct (-60)
Current FrameMaker product does not support this operation
or fmbatch is running.
866
MENU
CHAPTER 6 FUNCTION SUMMARY
Returns
Command
Syntax
DefineAndAddCommand(cmdNum, name, label, shortcut)
Parameters
Constants.FE_BadOper
ation (-27)
Parameters specified an invalid operation.
Constants.FE_NotMenu
(-72)
The specified menu does not exist.
Constants.FE_BadPara
meter (-43)
The specified parameter has an invalid value.
Constants.FE_SystemE
rror (-42)
System Error
Parameter name
Data
Type
Option
al Description
cmdNum numbe
r
No The integer that the FrameMaker
product passes to your client’s
Command()function when the user
chooses the menu item or types the
keyboard shortcut for the command.
The value must be unique for each
command in your client, but need not
be unique for different clients.
name strin
g
No A unique name for the command. If
the user or a client has already
defined a command or menu with
this name, the new command
replaces it.
label strin
g
No The title of the command as it
appears on the menu.
Error Reason
867
MENU
CHAPTER 6 FUNCTION SUMMARY
AddCommandToMenu
Description
Adds a FrameMaker product command or a client-defined command to a menu.
AddCommandToMenu() adds the command at the bottom of the specified menu. To change a
command’s position on a menu, set its PrevMenuItemInMenu and
NextMenuItemInMenuproperties.
To add a command that you have created, set the command parameter to the object returned by the
DefineCommand() call that created the command.To add a FrameMaker product command, you
must get its object. To get its object, call GetNamedObject() with the objectName parameter set
to its name.
The method returns the command, on success.
On failure, the method returns one of the following values to FA_errno:
shortcut strin
g
No The keyboard shortcut sequence.
Many FrameMaker product
commands use shortcuts beginning
with Escape (\!). To specify Escape
when you create a command, use
\\!in the string you pass to shortcut.
Error Reason
Constants.FE_WrongPr
oduct (-60)
Current FrameMaker product does not support this operation
or fmbatch is running.
Constants.FE_BadOper
ation (-27)
Parameters specified an invalid operation.
Constants.FE_NotComm
and (-73)
The command paramter did not specify a command.
Constants.FE_NotMenu
(-72)
The specified menu does not exist.
Constants.FE_BadPara
meter (-43)
The specified parameter has an invalid value.
Constants.FE_SystemE
rror (-42)
System Error
Parameter name
Data
Type
Option
al Description
868
MENU
CHAPTER 6 FUNCTION SUMMARY
Returns
number
Syntax
AddCommandToMenu(command)
Parameters
AddMenuToMenu
Description
Adds a FrameMaker product menu or a menu that you have created to another menu or menu bar.
To add a menu to one of FrameMaker menus or menu bars, you must get the menu or menu bar’s object.
To get its object, call GetNamedObject() with the objectName parameter set to its name.
NOTE: Your menu appears only on the menu bar you specify. For example, if you only add a menu to the
!MakerMainMenu menu bar, the menu will not appear if the user switches to quick menus. For your
menu to appear after the user has switched to quick menus, you must also add it to
!QuickMakerMainMenu.
The following table lists the types of menus you can add a menu to and how FrameMaker implements
the added menu.
To change a menu’s position on a menu or menu bar after you add it, set its PrevMenuItemInMenu
and NextMenuItemInMenu properties.
The method returns the command, on success.
On failure, the method returns one of the following values to FA_errno:
Parameter name
Data
Type
Option
al Description
command Comma
nd
No The command to add.
Type of menu or
menu bar you are
adding a menu to
How FrameMaker
implements the added
menu FrameMaker product adds the menu
Menu bar Pull-down menu At the right of the menu bar.
Pull-down menu Pull-right menu At the bottom of the pull-down menu.
Pop-up menu Pull-right menu At the bottom of the pop-up menu.
Pull-right menu Pull-right menu At the bottom of the pull-right menu.
869
MENU
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
AddMenuToMenu(menu)
Parameters
DefineAndAddMenu
Description
Defines a menu (FO_Menu object) and adds it to another menu.
To add a menu to one of FrameMaker’s menus or menu bars, you must get the menu or menu bar’s
object. To get its object, call GetNamedObject() with the objectName parameter set to its name.
The following table lists some of the menu bars that you can add menus to and the strings that specify
them. Menu bar names preceded by an exclamation mark (!) cannot be removed by the user.
Error Reason
Constants.FE_WrongPr
oduct (-60)
Current FrameMaker product does not support this operation
or fmbatch is running.
Constants.FE_NotMenu
(-72)
The specified menu does not exist.
Constants.FE_BadOper
ation (-27)
Parameters specified an invalid operation.
Constants.FE_BadPara
meter (-43)
The specified parameter has an invalid value.
Constants.FE_SystemE
rror (-42)
System Error
Parameter name
Data
Type
Option
al Description
menu Menu No The new menu to be added.
FrameMaker menubar Menubar string
Menu bar for documents (complete menus) !MakerMainMenu
Menu bar for documents (quick menus) !QuickMakerMainMenu
870
MENU
CHAPTER 6 FUNCTION SUMMARY
NOTE: Your menu appears only on the menu bar you specify. For example, if you only add a menu to the
!MakerMainMenu menu bar, the menu will not appear if the user switches to quick menus. For your
menu to appear after the user has switched to quick menus, you must also add it to
!QuickMakerMainMenu.
If you call DefineAndAddMenu() and specify the name of a menu that is already defined in the user’s
menu configuration files, FrameMaker gives precedence to the definition in the configuration files.
If the configuration files assign a label to the menu, FrameMaker uses it instead of the one you specify.
If the menu is already on a menu or menu bar, FrameMaker ignores the menu that you specify and leaves
the menu where it is.
The following table lists the types of menus you can add a menu to and how FrameMaker implements
the added menu.
The method returns the menu, on success.
On failure, the method returns one of the following values to FA_errno:
Menu bar for documents (custom menus) !CustomMakerMainMenu
Menu bar for books (complete menus) !BookMainMenu
Menu bar for books (quick menus) !QuickBookMainMenu
Structure menu bar (structured product
interface only)
!StructureViewMainMenu
Pop-up menu for documents (complete
menus; UNIX only)
!MakerPopup
Pop-up menu for documents (quick menus;
UNIX only)
!QuickMakerPopup
View-only menu bar !ViewOnlyMainMenu
View-only pop-up menu (UNIX only) !ViewerPopup
Type of menu or
menu bar you are
adding a menu to
How FrameMaker
implements the added
menu FrameMaker product adds the menu
Menu bar Pull-down menu At the right of the menu bar.
Pull-down menu Pull-right menu At the bottom of the pull-down menu.
Pop-up menu Pull-right menu At the bottom of the pop-up menu.
Pull-right menu Pull-right menu At the bottom of the pull-right menu.
FrameMaker menubar Menubar string
871
MENU
CHAPTER 6 FUNCTION SUMMARY
Returns
Menu
Syntax
DefineAndAddMenu(name, label)
Parameters
MenuItemInMenu
Description
Determines if a menu item or menu is on a menu or menu bar.
On success, the method returns the menu on which the menu item is found.
On failure, the method returns one of the following values to FA_errno:
Error Reason
Constants.FE_WrongPr
oduct (-60)
Current FrameMaker product does not support this operation
or fmbatch is running.
Constants.FE_NotMenu
(-72)
The specified menu does not exist.
Constants.FE_BadOper
ation (-27)
Parameters specified an invalid operation.
Constants.FE_BadPara
meter (-43)
The specified parameter has an invalid value.
Constants.FE_SystemE
rror (-42)
System Error
Parameter name
Data
Type
Option
al Description
name strin
g
No A unique name for the new menu. If
the user or an ESTK client has already
defined a command or menu with
this name, the new menu replaces it.
label strin
g
No The title of the menu as it appears on
the menu bar or menu.
872
MENU
CHAPTER 6 FUNCTION SUMMARY
Returns
Menu
Syntax
MenuItemInMenu(menuitem, recursive)
Parameters
Delete
Description
Deletes a menu or menu item.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
Error Reason
Constants.FE_WrongPr
oduct (-60)
Current FrameMaker product does not support this operation
or fmbatch is running.
Constants.FE_BadOper
ation (-27)
Parameters specified an invalid operation.
Constants.FE_BadPara
meter (-43)
The specified parameter has an invalid value.
Parameter name
Data
Type
Option
al Description
menuitem MenuI
temCo
mpone
nt
No The menu item or menu to find.
recursive bool No Specifies whether to search the
submenus of the menu or menu bar
specified by menuitem. Specify
True to search them.
873
MENU
CHAPTER 6 FUNCTION SUMMARY
GetProps
Description
Retrieves the properties of the menu or menu item.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of the menu or menu item.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the menu or menu item is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
874
MENUITEMSEPARATOR
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
ObjectValid()
Delete
Description
Deletes a menu or menu item.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
6.53. MenuItemSeparator
GetProps
Description
Retrieves the properties of the menu item separator.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of the menu item separator.
See SetProps under the AFrame class for more information.
875
MENUITEMSEPARATOR
CHAPTER 6 FUNCTION SUMMARY
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the menu item spearator is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
Delete
Description
Deletes a menu item separator.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
876
METRICS
CHAPTER 6 FUNCTION SUMMARY
6.54. Metrics
An Array of objects with integer indexing and a length property.
concat
Description
The original array is unchanged. If an array is provided as a parameter to concat(), each of its elements
are appended as separate array elements at the end of the new array. Returns a new array, the result of
concatenation the given values to the end of the original array.
Returns
Metrics
Syntax
concat(value)
Parameters
pop
Description
Removes the last element from the array.
Returns
int
Syntax
pop()
push
Description
Returns the new length of the array.
Parameter name
Data
Type
Option
al Description
value Metri
cs
No Can also be arrays.
877
PGF
CHAPTER 6 FUNCTION SUMMARY
Returns
number
Syntax
push(value)
Parameters
6.55. Pgf
Delete
Description
Deletes a paragraph.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetText
Description
Gets the text from the paragraph.
See GetText under the Cell class for more information.
Returns
TextItems
Syntax
GetText(flags)
Parameter name
Data
Type
Option
al Description
value int No The value to push into the array.
878
PGF
CHAPTER 6 FUNCTION SUMMARY
Parameters
GetProps
Description
Retrieves the properties of the paragraph.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of the paragraph.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
Parameter name
Data
Type
Option
al Description
flags int No Denotes the various bit flags that
specify the items to be retrieved.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
879
PGFFMT
CHAPTER 6 FUNCTION SUMMARY
ObjectValid
Description
Returns 1 if the paragraph is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.56. PgfFmt
Delete
Description
Deletes a paragraph format.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
Retrieves the properties of the paragraph format.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
880
POINT
CHAPTER 6 FUNCTION SUMMARY
SetProps
Description
Sets the properties of the paragraph format.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the paragraph format is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.57. Point
Point
Description
Point describes an individual coordinate pair. FrameMaker measures coordinates from the upper-left
corner of the parent frame
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
881
POINTS
CHAPTER 6 FUNCTION SUMMARY
Returns
Point
Syntax
Point(x, y)
Parameters
6.58. Points
An Array of Point objects with integer indexing and a length property.
concat
Description
The original array is unchanged. If an array is provided as a parameter to concat(), each of its elements
are appended as separate array elements at the end of the new array. Returns a new array, the result of
concatenation the given values to the end of the original array.
Returns
Points
Syntax
concat(value)
Parameters
Parameter name
Data
Type
Option
al Description
xint No X coordinate
yint No Y coordinate
Parameter name
Data
Type
Option
al Description
value Point
s
No Can also be arrays.
882
POLYGON
CHAPTER 6 FUNCTION SUMMARY
pop
Description
Removes the last element from the array.
Returns
Point
Syntax
pop()
push
Description
Returns the new length of the array.
Returns
number
Syntax
push(value)
Parameters
6.59. Polygon
Delete
Description
Deletes a polygon.
See Delete under the AFrame class for more information.
Returns
int
Parameter name
Data
Type
Option
al Description
value Point No The value to push into the array.
883
POLYGON
CHAPTER 6 FUNCTION SUMMARY
Syntax
Delete()
GetProps
Description
Retrieves the properties of the polygon.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of the polygon.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the polygon is valid, else returns 0.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
884
POLYLINE
CHAPTER 6 FUNCTION SUMMARY
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.60. Polyline
Delete
Description
Deletes a polyline.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
Retrieves the properties of the polyline.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of the polyline.
885
PROPIDENT
CHAPTER 6 FUNCTION SUMMARY
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the polyline is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.61. PropIdent
PropIdent
Description
PropIdent provides a property identifier. Properties can be identified by either a name or a number
(integer constant). ESTK provides defined constants for property numbers (for example, Fill and Height).
Only inset properties (facets) are identified by names.If a property is identified by a name,
PropIdent.num is set to 0.If a property is identified by a number, PropIdent.name is set to a null
string.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
886
PROPVAL
CHAPTER 6 FUNCTION SUMMARY
Returns
PropIdent
Syntax
PropIdent(num, name)
Parameters
6.62. PropVal
PropVal
Description
Describes a property-value pair.
Returns
PropVal
Syntax
PropVal(propIdent, propVal)
Parameters
Parameter name
Data
Type
Option
al Description
num int No Property number.
name strin
g
No Property name.
Parameter name
Data
Type
Option
al Description
propIdent PropI
dent
No Property identifier.
propVal Typed
Val
No Property value.
887
PROPVALS
CHAPTER 6 FUNCTION SUMMARY
6.63. PropVals
An Array of PropVal objects with integer indexing and a length property.
concat
Description
The original array is unchanged. If an array is provided as a parameter to concat(), each of its elements
are appended as separate array elements at the end of the new array. Returns a new array, the result of
concatenation the given values to the end of the original array.
Returns
PropVals
Syntax
concat(value)
Parameters
pop
Description
Removes the last element from the array.
Returns
PropVal
Syntax
pop()
push
Description
Returns the new length of the array.
Parameter name
Data
Type
Option
al Description
value PropV
als
No Can also be arrays.
888
RECTANGLE
CHAPTER 6 FUNCTION SUMMARY
Returns
number
Syntax
push(value)
Parameters
6.64. Rectangle
Delete
Description
Deletes a rectangle.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
Retrieves the properties of the rectangle.
See GetProps under the AFrame class for more information.
Returns
PropVals
Parameter name
Data
Type
Option
al Description
value PropV
al
No The value to push into the array.
889
RECTANGLE
CHAPTER 6 FUNCTION SUMMARY
Syntax
GetProps()
SetProps
Description
Sets the properties of the rectangle.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the rectangle is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
890
REFPAGE
CHAPTER 6 FUNCTION SUMMARY
6.65. RefPage
Delete
Description
Deletes a reference page.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
Retrieves the properties of the reference page.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of the reference page.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
891
REFPAGE
CHAPTER 6 FUNCTION SUMMARY
Parameters
ObjectValid
Description
Returns 1 if the reference page is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
ApplyPageLayout
Description
PageObject is any Page object i.e., BodyPage, MasterPage, HiddenPage.
See ApplyPageLayout under the BodyPage class for more information.
Returns
int
Syntax
ApplyPageLayout(srcPage)
Parameters
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
Parameter name
Data
Type
Option
al Description
srcPage PageO
bject
No The page to which the layout is to be
applied.
892
ROUNDRECT
CHAPTER 6 FUNCTION SUMMARY
6.66. RoundRect
Delete
Description
Deletes a round rectangle.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
Retrieves the properties of the round rectangle.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of the rounded rectangle.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
893
ROW
CHAPTER 6 FUNCTION SUMMARY
Parameters
ObjectValid
Description
Returns 1 if the rounded rectangle is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.67. Row
AddRows
Description
Adds one or more rows to a table.
The following table lists the constants you can specify for the direction parameter:
The method returns FE_Success on success.
On failure, the method assigns one of the following values to FA_errno:
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
Direction Meaning
Constants.FV_Above (1240) Add rows above the current reference row.
Constants.FV_Below (1241) Add rows below the current reference row
Constants.FV_Body (1237) Add rows at the bottom of the existing body rows.
Constants.FV_Footing (1239) Add rows at the bottom of the existing footer rows.
Constants.FV_Heading (1238) Add rows at the bottom of the existing heading rows
894
ROW
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
AddRows(direction, numNewRows)
Parameters
Delete
Description
Deletes a row.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
Error Reason
Constants.FE_WrongProduct
(-60)
Current FrameMaker product does not support this operation.
Constants.FE_BadDocId (-2) Invalid document.
Constants.FE_BadObjId (-3) Invalid row number.
Constants.FE_BadOperation
(-27)
Parameters specified an invalid operation.
Constants.FE_BadParameter
(-43)
Parameter has an invalid value.
Parameter name
Data
Type
Option
al Description
direction int No The direction from the reference row
in which to add rows.
numNewRows int No The number of rows to add.
895
ROW
CHAPTER 6 FUNCTION SUMMARY
GetProps
Description
Retrieves the properties of the row.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of the row.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the row is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
896
RUBI
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
ObjectValid()
6.68. Rubi
Delete
Description
Deletes a rubi object.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetText2
Description
Gets the text from all the objects available to GetText(), as well as an extended set of document
objects that includes the rubi object.
TextItems.dataType can be one of the following constants (in addition to the constants returned
by GetText ()):
Value Representation Data
Constants.FTI2_RubiTextBegi
n (0x80000001)
The beginning of rubi text. The FO_Rubi object for the rubi
composite that contains the rubi
text.
Constants.FTI2_RubiTextEnd
(0x80000002)
The end of rubi text. The FO_Rubi object for the rubi
composite that contains the rubi
text.
Constants.FTI2_RubiComposi
teBegin (0x80000004)
The beginning of a rubi
composite.
FO_Rubi object.
897
RUBI
CHAPTER 6 FUNCTION SUMMARY
See GetText under the Cell class for more information.
Returns
TextItems
Syntax
GetText2(flags, flags2)
Parameters
Constants.FTI2_RubiComposi
teEnd (0x80000008)
The end of a rubi
composite.
FO_Rubi object.
Constants.FTI2_InlineCompo
nentBegin (0x80000010)
The beginning of inline
component.
InlineComponent object.
Constants.FTI2_InlineCompo
nentEnd (0x80000020)
The end of inline
component.
InlineComponent object.
Parameter name
Data
Type
Option
al Description
flags int No Denotes the various bit flags that
specify the items to be retrieved.
flags2 int No Bit flags for the extended set of text
item types that specify the type of
text items to retrieve. To get specific
types of text items from the extended
set, OR the constants that represent
them (for example, use a bitwise OR
to
combineConstants.FTI2_Rubi
TextBegin (0x80000001) and
Constants.
FTI2_RubiTextEnd
(0x80000002)) into flags2. To get
all types of the extended set of text
items, specify -1.
Value Representation Data
898
RUBI
CHAPTER 6 FUNCTION SUMMARY
GetProps
Description
Retrieves the properties of the rubi object.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of the rubi object.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the rubi object is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
899
RULINGFMT
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
ObjectValid()
6.69. RulingFmt
Delete
Description
Deletes a ruling format.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
Retrieves the properties of the ruling format.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of the ruling format.
See SetProps under the AFrame class for more information.
900
STRINGS
CHAPTER 6 FUNCTION SUMMARY
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the ruling format is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.70. Strings
An Array of objects with integer indexing and a length property.
concat
Description
The original array is unchanged. If an array is provided as a parameter to concat(), each of its elements
are appended as separate array elements at the end of the new array. Returns a new array, the result of
concatenation the given values to the end of the original array.
Returns
Strings
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
901
STRINGS
CHAPTER 6 FUNCTION SUMMARY
Syntax
concat(value)
Parameters
pop
Description
Removes the last element from the array.
Returns
string
Syntax
pop()
push
Description
Returns the new length of the array.
Returns
number
Syntax
push(value)
Parameters
Parameter name
Data
Type
Option
al Description
value Strin
gs
No Can also be arrays.
Parameter name
Data
Type
Option
al Description
value strin
g
No The value to push into the array.
902
SUBCOL
CHAPTER 6 FUNCTION SUMMARY
6.71. SubCol
Delete
Description
Deletes a subcol object.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetText
Description
Gets the text from the subcol object.
See GetText under the Cell class for more information.
Returns
TextItems
Syntax
GetText(flags)
Parameters
GetProps
Description
Retrieves the properties of the subcol object.
See GetProps under the AFrame class for more information.
Parameter name
Data
Type
Option
al Description
flags int No Denotes the various bit flags that
specify the items to be retrieved.
903
SUBCOL
CHAPTER 6 FUNCTION SUMMARY
Returns
PropVals
Syntax
GetProps()
SetProps
Description
Sets the properties of the subcol object.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the subcol object is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
904
TAB
CHAPTER 6 FUNCTION SUMMARY
6.72. Tab
Tab
Description
Describes an individual tab. Note that the character specified by decimal must be a single byte char-
acter.
The type field can contain one of the following constants:
Returns
Tab
Syntax
Tab(x, type, leader, decimal)
Parameters
Constant Tab Type
Constants.FV_TAB_LEFT (0x1) Left tab.
Constants.FV_TAB_CENTER
(0x2)
Center tab.
Constants.FV_TAB_RIGHT (0x3) Right tab.
Constants.FV_TAB_DECIMAL
(0x4).
Decimal tab.
Constants.FV_TAB_RELATIVE_L
EFT (0x5)
Relative left tab (allowed only for format change lists).
Constants.FV_TAB_RELATIVE_C
ENTER (0x6)
elative center tab (allowed only for format change lists).
Constants.FV_TAB_RELATIVE_RI
GHT (0x7)
Relative right tab (allowed only for format change lists).
Constants.FV_TAB_RELATIVE_D
ECIMAL (0x8)
Relative decimal tab (allowed only for format change lists).
Parameter name
Data
Type
Option
al Description
xint No Offset from the left margin.
905
TABS
CHAPTER 6 FUNCTION SUMMARY
6.73. Tabs
An Array of Tab objects with integer indexing and a length property.
concat
Description
The original array is unchanged. If an array is provided as a parameter to concat(), each of its elements
are appended as separate array elements at the end of the new array. Returns a new array, the result of
concatenation the given values to the end of the original array.
Returns
Tabs
Syntax
concat(value)
Parameters
pop
Description
Removes the last element from the array.
type uint No Type of tab.
leader strin
g
No String that appears before the tab.
decimal uint No Character to align tab around - For
example",".
Parameter name
Data
Type
Option
al Description
value Tabs No Can also be arrays.
Parameter name
Data
Type
Option
al Description
906
TBL
CHAPTER 6 FUNCTION SUMMARY
Returns
Tab
Syntax
pop()
push
Description
Returns the new length of the array.
Returns
number
Syntax
push(value)
Parameters
6.74. Tbl
AddCols
Description
Adds columns to a table.
The method returns FE_Success on success.
On failure, the method sets FA_errno to one of the following values:
Parameter name
Data
Type
Option
al Description
value Tab No
Error Reason
Constants.FE_BadDocI
d (-2)
invalid document.
Constants.FE_BadPara
meter (-43)
A parameter specified is invalid.
907
TBL
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
AddCols(refColNum, direction, numNewCols)
Parameters
DeleteCols
Description
Deletes columns from a table. To delete an entire table, use Delete().
The method deletes the column specified by delColNum and (numDelCols-1) columns to the right
of it.
The method returns FE_Success on success.
On failure, the method sets FA_errno to one of the following values:
Constants.FE_BadObjI
d (-3)
Invalid object.
Constants.FE_BadOper
ation (-27)
The method specified an invalid operation.
Parameter name
Data
Type
Option
al Description
refColNum int No The column at which to start adding
columns. The columns are numbered
from left to right starting with column
0.
direction int No The direction from the reference
column in which to add columns. To
add columns to the left of the
reference column, specify FV_Left. To
add them to the right, specify
FV_Right.
numNewCols int No The number of columns to add.
Error Reason
908
TBL
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
DeleteCols(delColNum, numDelCols)
Parameters
DeleteRows
Description
Deletes rows from a table. Like the Delete command in the FrameMaker product user interface, Delete-
Rows() does not allow you to delete more than one type of row at time.
The range of rows you specify must be all body rows, all header rows, or all footer rows.
The method deletes refRow and (numDelRows - 1) rows below it.
The method returns FE_Success on success.
On failure, the method sets FA_errno to one of the following values:
Error Reason
Constants.FE_WrongProd
uct (-60)
Current FrameMaker version does not support the requested
operation.
Constants.FE_BadOperati
on (-27)
The method specified an invalid operation.
Constants.FE_BadDocId
(-2)
invalid document.
Constants.FE_BadObjId
(-3)
Invalid object.
Constants.FE_TableInLock
edTi (-101)
The table is in a locked text inset.
Parameter name
Data
Type
Option
al Description
delColNum int No The first column to delete. Columns
are numbered from left to right,
starting with 0.
numDelCols int No The number of columns to delete.
909
TBL
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
DeleteRows(refRow, numDelRows)
Parameters
GetTableColumnByColNum
Description
Get column object of a table based on the column number.
The method returns FE_Success on success.
On failure, the method sets FA_errno to one of the following values:
Error Reason
Constants.FE_WrongProd
uct (-60)
Current FrameMaker version does not support the requested
operation.
Constants.FE_BadOperati
on (-27)
The method specified an invalid operation.
Constants.FE_BadDocId
(-2)
invalid document.
Constants.FE_BadObjId
(-3)
Invalid object.
Constants.FE_OutOfRang
e (-7)
The refRow parameter does not specify a row in the table, or the
specified range includes more than one type of row (for example,
header rows and body rows).
Parameter name
Data
Type
Option
al Description
refRow Row No The first row to delete.
numDelRows int No The number of rows to delete,
including the value passed in refRow.
910
TBL
CHAPTER 6 FUNCTION SUMMARY
Returns
Column
Syntax
GetTableColumnByColNum (docId,tableId,colNum)
Parameters
MakeTblSelection
Description
Selects a range of cells in a table.
To select an entire table, including the table title, set the topRow parameter to
Constants.FF_SELECT_WHOLE_TABLE (0x80000000). MakeTblSelection() ignores
the values for the other parameters.
Error Reason
Constants.FE_BadDocId
(-2)
invalid document.
Constants.FE_BadObjId
(-3)
Invalid object.
Constants.FE_BadOperati
on (-27)
The method specified an invalid operation.
Constants.FE_OutOfRang
e (-7)
The specified row or column is invalid.
Constants.FE_BadParame
ter (-43)
The parameter specified is invalid.
Parameter name
Data
Type
Option
al Description
docId int No The id of the document containing
the table
tableId int No The id of the table for the required
column object
colNum int No Index of the required column
911
TBL
CHAPTER 6 FUNCTION SUMMARY
NOTE: MakeTblSelection()cannot select different types of rows at the same time, unless you set
topRow to Constants.FF_SELECT_WHOLE_TABLE (0x80000000) or you set topRow and
bottomRow to select one or more entire columns.
The method returns FE_Success on success.
On failure, the method sets FA_errno to one of the following values:
Returns
int
Syntax
MakeTblSelection(topRow, bottomRow, leftCol, rightCol)
Parameters
Error Reason
Constants.FE_BadDocId
(-2)
invalid document.
Constants.FE_BadObjId
(-3)
Invalid object.
Constants.FE_BadOperati
on (-27)
The method specified an invalid operation.
Constants.FE_OutOfRang
e (-7)
The specified row or column is invalid.
Constants.FE_BadParame
ter (-43)
The parameter specified is invalid.
Parameter name
Data
Type
Option
al Description
topRow int No The number of the first row in the
selection. The rows are numbered
from top to bottom, starting with 0
(including heading rows). To select
the entire table, specify
Constants.FF_SELECT_WHOLE
_TABLE (0x80000000).
bottomRow int No The number of the last row in the
selection.
912
TBL
CHAPTER 6 FUNCTION SUMMARY
Delete
Description
Deletes the specified table.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
The GetProps() method retrieves the properties of the specified table.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
The SetProps() method sets the properties of the specified table.
See SetProps under the AFrame class for more information.
leftCol int No The number of the leftmost column
in the selection. The columns are
numbered from left to right, starting
with 0.
rightCol int No The number of the rightmost column
in the selection.
Parameter name
Data
Type
Option
al Description
913
TBLFMT
CHAPTER 6 FUNCTION SUMMARY
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the table is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.75. TblFmt
The method uses an FO_TblFmt object to represent each table format in a document.
Delete
Deletes the specified table format.
See Delete under the AFrame class.
GetProps
See GetProps under the AFrame class.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
914
TEXTFRAME
CHAPTER 6 FUNCTION SUMMARY
SetProps
See SetProps under the AFrame class.
ObjectValid
See ObjectValid under the AFrame class.
6.76. TextFrame
Delete
Description
Deletes the specified text frame.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetText
Description
Gets the text from the text frame.
See GetText under the Cell class for more information.
Returns
TextItems
Syntax
GetText(flags)
915
TEXTFRAME
CHAPTER 6 FUNCTION SUMMARY
Parameters
GetProps
Description
The GetProps() method retrieves the properties of the specified text frame.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
The SetProps() method sets the properties of the specified text frame.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
Parameter name
Data
Type
Option
al Description
flags int No Denotes the various bit flags that
specify the items to be retrieved.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
916
TEXTITEMS
CHAPTER 6 FUNCTION SUMMARY
ObjectValid
Description
Returns 1 if the text frame is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.77. TextItems
An Array of TextItem objects with integer indexing and a length property.
concat
Description
The original array is unchanged. If an array is provided as a parameter to concat(), each of its elements
are appended as separate array elements at the end of the new array. Returns a new array, the result of
concatenation the given values to the end of the original array.
Returns
TextItems
Syntax
concat(value)
Parameters
Parameter name
Data
Type
Option
al Description
value TextI
tems
No Can also be arrays.
917
TEXTLINE
CHAPTER 6 FUNCTION SUMMARY
pop
Description
Removes the last element from the array.
Returns
TextItem
Syntax
pop()
push
Description
Returns the new length of the array.
Returns
number
Syntax
push(value)
Parameters
6.78. TextLine
Delete
Description
Deletes the specified text line.
See Delete under the AFrame class for more information.
Parameter name
Data
Type
Option
al Description
value TextI
tem
No The value to push into the array.
918
TEXTLINE
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
Delete()
GetText
Description
Gets the text from the text line.
See GetText under the Cell class for more information.
Returns
TextItems
Syntax
GetText(flags)
Parameters
GetProps
Description
The GetProps() method retrieves the properties of the specified text line.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
Parameter name
Data
Type
Option
al Description
flags int No Denotes the various bit flags that
specify the items to be retrieved.
919
TEXTLOC
CHAPTER 6 FUNCTION SUMMARY
SetProps
Description
The SetProps() method sets the properties of the specified text line.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the text line is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.79. TextLoc
TextLoc
Description
TextLoc specifies a location within the text of a paragraph or a graphic text line.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
920
TEXTRANGE
CHAPTER 6 FUNCTION SUMMARY
Returns
TextLoc
Syntax
TextLoc(obj, offset)
Parameters
6.80. TextRange
TextRange
Description
TextRange specifies a text range. A text range can span paragraphs. However, it cannot span graphic text
lines or flows.
NOTE: beg.offset and end.offset fields of aTextRange object can specify offsets relative to the
beginning and end of an object. In addition, they can use the special value Constants.FV_OB-
J_END_OFFSET (0x50000000).NOTE: Constants.FV_OBJ_END_OFFSET (0x50000000) specifies the offset of
the last character in the object containing the text range.
Returns
TextRange
Syntax
TextRange(beg, end)
Parameters
Parameter name
Data
Type
Option
al Description
obj any No FO_Pgf or FO_TextLine object.
offset int No Characters from the beginning of the
object.
Parameter name
Data
Type
Option
al Description
beg TextL
oc
No The beginning of the range.
921
TIAPICLIENT
CHAPTER 6 FUNCTION SUMMARY
6.81. TiApiClient
An FO_TiApiClient object represents text imported by an FDK client.
GetText
See GetText under the Cell class.
GetProps
See GetProps under the AFrame class.
SetProps
See SetProps under the AFrame class.
ObjectValid
See ObjectValidunder the AFrame class.
DeleteTextInsetContents
Description
This method deletes the text in a text inset. You must unlock a text inset before you call this function to
delete its contents. After you are done, you must relock the text inset.
Call this method on the text inset for which you want to delete the contents.
If this method fails, the method assigns one of the following values to FA_errno.
end TextL
oc
No The end of the range.
Error Meaning
Constants.FE_BadDelete (-17) Specified text couldn’t be deleted
Constants.FE_BadDocId (-2) Invalid document ID
Constants.FE_BadObjId (-3) Invalid object ID
Parameter name
Data
Type
Option
al Description
922
TIAPICLIENT
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
DeleteTextInsetContents()
UpdateTextInset
Description
Updates the contents of a stale text inset. It determines whether an inset is stale by comparing the inset’s
LastUpdate property with the modification date of the inset’s source file. UpdateTextInset()
does not update a text inset unless it is stale. To make a text inset stale, set its LastUpdate property
to 0. UpdateTextInset() does not update graphic insets (FO_Inset objects).
Call this method on the text inset to be updated.
This method returns FE_Success if it succeeds or FE_SomeUnresolved if some text insets were
unresolved. If UpdateTextInset() fails, it assigns one of the following values to FA_errno.
Returns
int
Constants.FE_BadSelectionFor
Operation (-59)
The specified text inset is locked
Error Meaning
Constants.FE_BadD
ocId (-2)
Invalid document ID
Constants.FE_BadF
ileType (-83)
The inset specifies a file that does not match the import
type (for example, the inset imports a binary document
but the file is a text file or doesn’t exist)
Constants.FE_Some
Unresolved (-22)
Some text insets were unresolved
Constants.FE_Wron
gProduct (-60)
Product doesn’t support the specified operation
Constants.FE_Syst
emError (-42)
Couldn’t allocate memory
Error Meaning
923
TIAPICLIENT
CHAPTER 6 FUNCTION SUMMARY
Syntax
UpdateTextInset()
ConvertToText
Description
This method is called upon a text inset (Examples: TiApiClient(), TiFlow(), TiText(),
TiTextTable()) object and converts it to a text. This method deletes the text inset and removes the
locked text range around it without modifying the content.
Returns
Void
Syntax
ConvertToText()
Delete
See Delete under the AFrame class.
DeletePropByName
Description
Deletes an inset facet. Except for inset facets, all properties are identified by integer constants. Facets
are the only properties identified by name.
If DeletePropByName() fails, the method assigns one of the following values to FA_errno:
Returns
Void
Error Meaning
Constants.FE_BadPr
opNum (-4)
Specified property number is invalid
Constants.FE_BadDo
cId (-2)
Invalid document ID
Constants.FE_BadOb
jId(-3)
Invalid object ID
Constants.FE_BadPr
opType (-5)
Incorrect property type for this function
924
TIFLOW
CHAPTER 6 FUNCTION SUMMARY
Syntax
DeletePropByName(propName)
Parameters
6.82. TiFlow
An FO_TiFlow object represents text imported from a FrameMaker document or a MIF file.
GetText
See GetText under the Cell class.
GetProps
See GetProps under the AFrame class.
SetProps
See SetProps under the AFrame class.
ObjectValid
See ObjectValid under the AFrame class.
DeleteTextInsetContents
See DeleteTextInsetContents under the TiApiClient class.
UpdateTextInset
See UpdateTextInset under the TiApiClient class.
Parameter name
Data
Type
Option
al Description
propName strin
g
No The name of the property to delete
925
TITEXT
CHAPTER 6 FUNCTION SUMMARY
ConvertToText
Description
This method is called upon a text inset (Examples: TiApiClient, TiFlow, TiText, TiTextTable)
object and converts it to a text. This method deletes the text inset and removes the locked text range
around it without modifying the content.
Returns
Void
Syntax
ConvertToText()
Delete
See Delete under the AFrame class.
DeletePropByName
See DeletePropByName under the TiApiClient.
6.83. TiText
An FO_TiText object represents text imported from a text file.
GetText
See GetText under the Cell class.
GetProps
See GetProps under the AFrame class.
SetProps
See SetPropsunder the AFrame class.
ObjectValid
See ObjectValidunder the AFrame class.
926
TITEXTTABLE
CHAPTER 6 FUNCTION SUMMARY
DeleteTextInsetContents
See DeleteTextInsetContents under the TiApiClient class.
UpdateTextInset
See UpdateTextInset under the TiApiClient class.
ConvertToText
Description
This method is called upon a text inset (Examples: TiApiClient, TiFlow, TiText, TiTextTable)
object and converts it to a text. This method deletes the text inset and removes the locked text range
around it without modifying the content.
Returns
Void
Syntax
ConvertToText()
Delete
See Delete under the AFrame class.
DeletePropByName
See DeletePropByName under the TiApiClient class.
6.84. TiTextTable
An FO_TiTextTable object represents text imported from a text file into a table.
GetText
See GetText under the Cell class.
GetProps
See GetProps under the AFrame class.
927
TYPEDVALS
CHAPTER 6 FUNCTION SUMMARY
SetProps
See SetProps under the AFrame class.
ObjectValid
See ObjectValid under the AFrame class.
DeleteTextInsetContents
See DeleteTextInsetContents under the TiApiClient class.
UpdateTextInset
See UpdateTextInset under the TiApiClient class.
ConvertToText
Description
This method is called upon a text inset (Examples: TiApiClient, TiFlow, TiText, TiTextTable)
object and converts it to a text. This method deletes the text inset and removes the locked text range
around it without modifying the content.
Returns
Void
Syntax
ConvertToText()
Delete
See Delete under the AFrame class.
DeletePropByName
See DeletePropByName under the TiApiClient.
6.85. TypedVals
An Array of TypedVal objects with integer indexing and a length property.
928
TYPEDVALS
CHAPTER 6 FUNCTION SUMMARY
concat
Description
The original array is unchanged. If an array is provided as a parameter to concat(), each of its elements
are appended as separate array elements at the end of the new array. Returns a new array, the result of
concatenation the given values to the end of the original array.
Returns
TypedVal
Syntax
concat(value)
Parameters
pop
Description
Removes the last element from the array.
Returns
TypedVal
Syntax
pop()
push
Description
Returns the new length of the array.
Returns
number
Parameter name
Data
Type
Option
al Description
value Typed
Val
No Can also be arrays.
929
UBYTES
CHAPTER 6 FUNCTION SUMMARY
Syntax
push(value)
Parameters
6.86. UBytes
An Array of objects with integer indexing and a length property.
concat
Description
The original array is unchanged. If an array is provided as a parameter to concat(), each of its elements
are appended as separate array elements at the end of the new array. Returns a new array, the result of
concatenation the given values to the end of the original array.
Returns
UBytes
Syntax
concat(value)
Parameters
pop
Description
Removes the last element from the array.
Parameter name
Data
Type
Option
al Description
value Typed
Val
No The value to push into the array.
Parameter name
Data
Type
Option
al Description
value UByte
s
No Can also be arrays.
930
UINTS
CHAPTER 6 FUNCTION SUMMARY
Returns
uint
Syntax
pop()
push
Description
Returns the new length of the array.
Returns
number
Syntax
push(value)
Parameters
6.87. UInts
An Array of objects with integer indexing and a length property.
concat
Description
The original array is unchanged. If an array is provided as a parameter to concat(), each of its elements
are appended as separate array elements at the end of the new array. Returns a new array, the result of
concatenation the given values to the end of the original array.
Returns
UInts
Parameter name
Data
Type
Option
al Description
value uint No The value to push into the array.
931
UINTS
CHAPTER 6 FUNCTION SUMMARY
Syntax
concat(value)
Parameters
pop
Description
Removes the last element from the array.
Returns
uint
Syntax
pop()
push
Description
Returns the new length of the array.
Returns
number
Syntax
push(value)
Parameters
Parameter name
Data
Type
Option
al Description
value UInts No Can also be arrays.
Parameter name
Data
Type
Option
al Description
value uint No The value to push into the array.
932
UNANCHOREDFRAME
CHAPTER 6 FUNCTION SUMMARY
6.88. UnanchoredFrame
Delete
Description
Deletes the specified unanchored frame.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
The GetProps() method retrieves the properties of the specified unanchored frame.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
The SetProps() method sets the properties of the specified unanchored frame.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
933
VAR
CHAPTER 6 FUNCTION SUMMARY
Parameters
ObjectValid
Description
Returns 1 if the unanchored frame is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.89. Var
Delete
Description
Deletes the specified var object.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetText
Description
Gets the text from the var object.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
934
VAR
CHAPTER 6 FUNCTION SUMMARY
See GetText under the Cell class for more information.
Returns
TextItems
Syntax
GetText(flags)
Parameters
GetProps
Description
The GetProps() method retrieves the properties of the specified var object.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
The SetProps() method sets the properties of the specified var object.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameter name
Data
Type
Option
al Description
flags int No Denotes the various bit flags that
specify the items to be retrieved.
935
VARFMT
CHAPTER 6 FUNCTION SUMMARY
Parameters
ObjectValid
Description
Returns 1 if the var object is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.90. VarFmt
Delete
Description
Deletes the specified varfmt object.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
The GetProps() method retrieves the properties of the specified varfmt object.
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
936
VARFMT
CHAPTER 6 FUNCTION SUMMARY
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
The SetProps() method sets the properties of the specified var object.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the varfmt object is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
937
XREF
CHAPTER 6 FUNCTION SUMMARY
6.91. XRef
Delete
Description
Deletes the specified XRef object.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetText
Description
Gets the text from the XRef object.
See GetText under the Cell class for more information.
Returns
TextItems
Syntax
GetText(flags)
Parameters
GetProps
Description
The GetProps() method retrieves the properties of the specified XRef object.
See GetProps under the AFrame class for more information.
Parameter name
Data
Type
Option
al Description
flags int No Denotes the various bit flags that
specify the items to be retrieved.
938
XREF
CHAPTER 6 FUNCTION SUMMARY
Returns
PropVals
Syntax
GetProps()
SetProps
Description
The SetProps() method sets the properties of the specified XRef object.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
Parameters
ObjectValid
Description
Returns 1 if the xref object is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
939
XREFFMT
CHAPTER 6 FUNCTION SUMMARY
6.92. XRefFmt
Delete
Description
Deletes the specified XRefFmt object.
See Delete under the AFrame class for more information.
Returns
int
Syntax
Delete()
GetProps
Description
The GetProps() method retrieves the properties of the specified XRefFmt object.
See GetProps under the AFrame class for more information.
Returns
PropVals
Syntax
GetProps()
SetProps
Description
The SetProps() method sets the properties of the specified XRefFmt object.
See SetProps under the AFrame class for more information.
Returns
Void
Syntax
SetProps(setVal)
940
APP
CHAPTER 6 FUNCTION SUMMARY
Parameters
ObjectValid
Description
Returns 1 if the XRefFmt object is valid, else returns 0.
See ObjectValid under the AFrame class for more information.
Returns
int
Syntax
ObjectValid()
6.93. app
Close
See Close under the Book class.
GetNamedObject
Description
Gets the object with a specified name (Name property) and object type.
If an error occurs, this method returns the the object, or 0. If this method fails, the method assigns one
of the following values to FA_errno:
Parameter name
Data
Type
Option
al Description
setVal PropV
als
No The property list.
Error Meaning
Constants.FE_BadDocId
(-2)
Invalid document.
Constants.FE_TypeUnNa
med (-19)
Objects of the specified type do not have names.
941
APP
CHAPTER 6 FUNCTION SUMMARY
Returns
Object
Syntax
GetNamedObject(objType, name)
Parameters
GetNamedBook
Description
Gets the book object with a specified name.
If this method fails, the method assigns the following value to FA_errno.
Returns
Book
Syntax
GetNamedBook(name)
Constants.FE_NameNotFoun
d (-20)
Object with the specified name and type does not exist in the
specified document.
Parameter name
Data
Type
Option
al Description
objType int No Type of the object to get.
name strin
g
No Name of the object to get.
Error Meaning
Constants.FE_NameNotF
ound (-20)
The book with the specified name does not exist.
Error Meaning
942
APP
CHAPTER 6 FUNCTION SUMMARY
Parameters
GetNamedCommand
Description
Gets aFO_command object with the specified command string.
If this method fails, the method assigns the following value to FA_errno.
Returns
Command
Syntax
GetNamedCommand(name)
Parameters
GetNamedMenu
Description
Gets a menu object with the specified menu string.
If this method fails, the method assigns the following value to FA_errno.
Parameter name
Data
Type
Option
al Description
name strin
g
No The name of the book object you
want to get.
Error Meaning
Constants.FE_NameNotF
ound (-20)
The object with the specified name does not exist.
Parameter name
Data
Type
Option
al Description
name strin
g
No The name of the command object
you want to get.
943
APP
CHAPTER 6 FUNCTION SUMMARY
Returns
Menu
Syntax
GetNamedMenu(name)
Parameters
GetNamedMenuItemSeparator
Description
Gets a menu item separator object with the specified menu item separator string.
If this method fails, the method assigns the following value to FA_errno.
Returns
MenuItemSeparator
Syntax
GetNamedMenuItemSeparator(name)
Error Meaning
Constants.FE_NameNotF
ound (-20)
A menu with the specified name does not exist.
Parameter name
Data
Type
Option
al Description
name strin
g
No The name of the menu object you
want to get.
Error Meaning
Constants.FE_NameNotF
ound (-20)
A menu item separator with the specified name does
not exist.
944
APP
CHAPTER 6 FUNCTION SUMMARY
Parameters
NewNamedObject
Description
Creates a new objects and returns it.
If this method fails, the method assigns one of the following values to FA_errno.
Returns
Object
Syntax
NewNamedObject(objType, name)
Parameters
Parameter name
Data
Type
Option
al Description
name strin
g
No The name of the menu item separator
you want to get.
Error Meaning
FE_BadName(-33) Specified name for the new object is invalid.
FE_BadNew (-23) Object cannot be created.
FE_DupName(-32) Specified name for the new object belongs to an
existing object.
Parameter name
Data
Type
Option
al Description
objType int No The type of the object you want to
create.
name strin
g
No The name of the object you want to
create.
945
APP
CHAPTER 6 FUNCTION SUMMARY
NewNamedBook
Description
Creates a new book objects and returns it.
If this method fails, the method assigns one of the following values to FA_errno.
Returns
Book
Syntax
NewNamedBook(name)
Parameters
NewNamedCommand
Description
Creates a new command object and returns it
If this method fails, the method assigns one of the following values to FA_errno.
Error Meaning
FE_BadName(-33) Specified name is invalid.
FE_BadNew (-23) Object cannot be created.
FE_DupName(-32) Specified name for the new object belongs to an
existing object.
Parameter name
Data
Type
Option
al Description
name strin
g
No The name of the book object to
create.
Error Meaning
FE_BadName(-33) Specified name is invalid.
FE_BadNew (-23) Command cannot be created.
FE_DupName(-32) Specified name for the new command belongs to an
existing command.
946
APP
CHAPTER 6 FUNCTION SUMMARY
Returns
Command
Syntax
NewNamedCommand(name)
Parameters
NewNamedMenu
Description
Creates a menu object with the specified name and returns it
If this method fails, the method assigns one of the following values to FA_errno.
Returns
Menu
Syntax
NewNamedMenu(name)
Parameters
Parameter name
Data
Type
Option
al Description
name strin
g
No Name of the new command object to
create.
Error Meaning
FE_BadName(-33) Specified name is invalid.
FE_BadNew (-23) Menu cannot be created.
FE_DupName(-32) Specified name for the new menu belongs to an
existing menu.
Parameter name
Data
Type
Option
al Description
name strin
g
No Name of the menu object to create.
947
APP
CHAPTER 6 FUNCTION SUMMARY
NewNamedMenuItemSeparator
Description
Creates a new menu item separator with the specified name and returns it
If this method fails, the method assigns one of the following values to FA_errno.
Returns
MenuItemSeparator
Syntax
NewNamedMenuItemSeparator(name)
Parameters
GetProps
See GetProps under the AFrame class.
SetProps
See SetProps under the AFrame class.
ObjectValid
See ObjectValid under the AFrame class.
Error Meaning
FE_BadName(-33) Specified name is invalid.
FE_BadNew (-23) Menu item separator cannot be created.
FE_DupName(-32) Specified name for the new menu item separator
belongs to an existing menu item separator.
Parameter name
Data
Type
Option
al Description
name strin
g
No Name of the new menu item
separator object.
948
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
6.94. global
Alert
Description
Displays an alert box with a message. Depending on the constant you specify for the type parameter,
the alert displays either the OK and Cancel buttons, Yes and No buttons, or a Continue button.
The type parameter takes one of the following values:
The method returns 0 if the user clicked OK, Continue, or Yes.
The method returns -1 if the user clicked Cancel or No.
Returns
int
Syntax
Alert(message, type)
Constant Value
Constants.FF_ALERT_OK_DEFAU
LT (0)
Displays the OK and Cancel buttons; OK is the default.
Constants.FF_ALERT_CANCEL_D
EFAULT (1)
Displays the OK and Cancel buttons; Cancel is the default.
Constants.FF_ALERT_CONTINUE
_NOTE (2)
Displays the OK button.
Constants.FF_ALERT_CONTINUE
_WARN (3)
Displays the OK button with a warning indicator.
Constants.FF_ALERT_YES_DEFA
ULT (4)
Displays the Yes and No buttons; Yes is the default.
Constants.FF_ALERT_NO_DEFAU
LT (5)
Displays the Yes and No buttons; No is the default.
949
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Parameters
Alive
Description
Checks whether the current asynchronous client has a connection with a FrameMaker process. Call this
method after registering the asynchronous client using WinConnectSession().
The method returns a positive integer if there is a current connection to a FrameMaker process. Other-
wise it returns 0.
Returns
int
Syntax
Alive()
CallClient
Description
Allows a client to call another client. The method is useful for calling FrameMaker clients, such as the
structure generator and the element catalog manager.
On success, the method returns FE_Success or the value specified by the target client’s last call to
ReturnValue().
NOTE: Calls to the structure generator always return FE_Success no matter what string is passed to it as
an argument.
On failure, the method assigns the following value to FA_errno:
Parameter name
Data
Type
Option
al Description
message strin
g
No The message that appears in the
dialog box. Messages longer than 255
characters, are truncated.
type int No The dialog box type.
Error Reason
Constants.FE_NameNotFou
nd (-20)
There is no client with the specified name in the current
FrameMaker productsession.
950
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
CallClient(clname, arg)
Parameters
CallClientEx
Description
Allows a client to call another client. The method is useful for calling FrameMaker clients, such as the
structure generator and the element catalog manager.
On success, the method returns FE_Success or the value specified by the target client’s last call to
ReturnValue().
NOTE: Calls to the structure generator always return FE_Success no matter what string is passed to it as
an argument.
On failure, the method assigns the following value to FA_errno:
Constants.FE_BadParamete
r (-43)
For the TableSort client only: One of the arguments is invalid. For
example, you gave a value for the sort key that is greater than the
number of columns or rows in the current table selection, or you
have no table cells selected.
Parameter name
Data
Type
Option
al Description
clname strin
g
No The registered name of the target
client.
arg strin
g
No A string that is passed to the target
client.
Error Reason
Constants.FE_NameNotFou
nd (-20)
There is no client with the specified name in the current
FrameMaker productsession.
Error Reason
951
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Returns
TypedVal
Syntax
CallClientEx(clname, arg)
Parameters
CheckStatus
Description
Checks the scripts returned by Open(), Import(), Save(), and UpdateBook() to determine if a
specified status bit is set.
Returns 1 if the bit is set, else returns 0.
Returns
int
Syntax
CheckStatus(p, statusBit)
Constants.FE_BadParamete
r (-43)
For the TableSort client only: One of the arguments is invalid. For
example, you gave a value for the sort key that is greater than the
number of columns or rows in the current table selection, or you
have no table cells selected.
Parameter name
Data
Type
Option
al Description
clname strin
g
No The registered name of the target
client.
arg strin
g
No A string that is passed to the target
client.
Error Reason
952
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Parameters
ClientDir
Description
Returns the name of the current ESTK client’s directory.
NOTE: Use Free() to free the string returned by ClientDir() when you are done with it.
The method assigns the following value to FA_errno, on failure:
Returns
string
Syntax
ClientDir()
ClientName
Description
Returns the registered name of the current client (the client that calls ClientName()).
NOTE: Use Free() to free the string returned by ClientDir() when you are done with it.
The method assigns the following value to FA_errno, on failure:
Parameter name
Data
Type
Option
al Description
pPropV
als
No The property list returned by Open(),
Save(), Import(), or UpdateBook().
statusBit int No The status bit to test.
Error Reason
Constants.FE_Transpor
t (-1)
A transport error occured.
Error Reason
Constants.FE_Transpor
t (-1)
A transport error occured.
953
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Returns
string
Syntax
ClientName(_)
CMSRegister
Description
Registers a CMS client.
Returns
CMS Object
Syntax
CMSRegister (cmsName);
Parameters
If CMSRegister() fails, the method assigns following values to FA_errno:
CMSGetCmsIdFromName
Description
Gets the CMS registration id from CMS name.
Returns
CMS Object
Parameter name
Data
Type
Option
al Description
cmsName int No Name of the CMS to register
Error Reason
Constants.FE_CMSNam
eAlreadyRegistered
The method attempts to register a CMS that is already
registered.
Constants.FE_BadParam
eter
The function call specified an invalid parameter.
954
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Syntax
CMSGetCmsIdFromName (cmsName);
Parameters
If CMSGetCmsIdFromName() fails, the method assigns following values to FA_errno:
CMSAddMenuEntry
Description
Adds a custom menu entry in the context menu within the FrameMaker interface.
Returns
CMS Object
Syntax
CMSAddMenuEntry (menuId,menuEntryp);
Parameters
If CMSAddMenuEntry() fails, the method assigns following values to FA_errno:
Parameter name
Data
Type
Option
al Description
cmsName int No The Name of the CMS
Error Reason
Constants.FE_BadParam
eter
The function call specified an invalid parameter.
Parameter name
Data
Type
Option
al Description
menuId int No The ID of the Parent menu
menuEntryp int No The F_CMSMenuItemT structure
describes a custom menu definition
Error Reason
Constants.FE_CMSBadO
bjectId
The client specified an invalid menu ID.
955
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
CustomDoc
Description
Creates a new custom document using the FrameMaker product’s default new document template.
The sidedness parameter can have one of the following values:
The method returns the new document on success.
The method assigns the following value to FA_errno, on failure:
Returns
Doc
Syntax
CustomDoc(width, height, numCols, columnGap, topMargin, botMargin,
leftinsideMargin, rightoutsideMargin, sidedness, makeVisible)
Constants.FE_BadParam
eter
The function call specified an invalid parameter.
Vaule Page Characterstics
Constants.FF_Custom_Single
Sided (0)
Single sided.
Constants.FF_Custom_FirstP
ageRight (1)
Double-sided, starting with a right page.
Constants.FF_Custom_FirstP
ageLeft (2)
Double-sided, starting with a left page.
Error Reason
Constants.FE_WrongPr
oduct (-60)
The product version does not support this operation.
Constants.FE_BadPara
meter (-43)
Parameter has an invalid value.
Error Reason
956
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Parameters
DefineMenu
Description
Defines a menu (FO_Menu object). After you define a menu, you can add it to a menu or a menu bar with
AddMenuToMenu().
If you call DefineMenu() and specify the name of a menu that is already defined in the user’s menu
configuration files, the FrameMaker product gives precedence to the definition in the configuration files.
If the configuration files assign a label to the menu, the FrameMaker product uses it instead of the one
you specify.If the user has already defined a menu with the name specified by name, DefineMenu()
ignores the label parameter and uses the label specified by the user.
The method returns the new menu on success.
On failure, the method sets FA_errno to one of the following values:
Parameter name
Data
Type
Option
al Description
width int No The document page width.
height int No The document page height.
numCols int No The default number of columns.
columnGap int No The default column spacing.
topMargin int No The document page top margin.
botMargin int No The document page bottom margin.
leftinsideMargin int No The left margin for single-sided
documents, or the inside margin for
double-sided documents.
rightoutsideMargin int No The right margin for single-sided
documents, or the outside margin for
double-sided documents.
sidedness int No A constant that specifies whether the
document is single-sided or
doublesided and on which side the
document starts.
makeVisible bool No Specifies whether the document is
visible after it is created. Set to True
to make the document visible.
957
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Returns
Menu
Syntax
DefineMenu(name, label)
Parameters
DisconnectFromSession
Description
Ends communication with a FrameMaker product process.
The method returns FE_Success if it succeeds, or a system error code if an error occurs.
Returns
int
Error Reason
Constants.FE_WrongProd
uct (-60)
Current FrameMaker product does not support this operation or
fmbatch is running
Constants.FE_BadParame
ter (-43)
Parameter has an invalid value.
Constants.FE_BadOperati
on (-27)
Parameters specify an invalid operation.
Constants.FE_NotMenu
(-72)
name specifies a command; cannot redefine a command as a
menu.
Constants.FE_SystemErro
r (-42)
System error.
Parameter name
Data
Type
Option
al Description
name strin
g
No A unique name for the menu. If the
user or an ESTK client has already
defined a command or menu with
this name, the new menu replaces it.
label strin
g
No The title of the menu as it appears on
the menu bar or menu.
958
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Syntax
DisconnectFromSession()
Err
Description
Prints the client’s name and a message to the console.
Returns
Void
Syntax
Err(message)
Parameters
FamilyFonts
Description
Returns a Fonts object with the permutations of angles, variations, and weights available for a specified
font family.
Returns
Fonts
Syntax
FamilyFonts(family)
Parameters
Parameter name
Data
Type
Option
al Description
message strin
g
No The message to print.
Parameter name
Data
Type
Option
al Description
family int No The index of the font family (in the list
of fonts in the session).
959
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
GetKeyCatalog
Description
Finds a key catalog with the specified 'tag'.
Returns
KeyCatalog
Syntax
GetKeyCatalog(tag);
Parameters
If GetKeyCatalog() fails, the method assigns following values to FA_errno:
GetEncodingForFamily
Description
Returns the encoding that FrameMaker uses for the font family.
Returns one of the following strings indicating the encoding for the font:
Parameter name
Data
Type
Option
al Description
tag strin
g
No The tag of the new Key Catalog being
created.
Error Reason
Constants.FE_BadName The tag provided is not valid or the key catalog with this
tag does not exist.
Value Meaning
FrameRoman Roman Text.
JISX0208.ShiftJIS Japanese Text.
BIG5 Traditional Chinese Text.
GB2312-80.EUC Simplified Chinese Text.
KSC5601-1992 Korean Text.
Multiple More than one encoding for the font family.
960
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
If the returned string is Multiple, the font family includes variations that are represented by different
encodings. You should use ApiFamilyFonts() to get a list of the variations for the family. Then you
can use GetEncodingForFont() to get the encoding for a specific variation.
Returns
string
Syntax
GetEncodingForFamily(family)
Parameters
GetEncodingForFont
Description
Returns the encoding that FrameMaker uses for a specific font with a specific combination of weight,
angle, and variation.
Returns one of the following strings indicating the encoding for the font:
Returns
string
Syntax
GetEncodingForFont(font)
Parameter name
Data
Type
Option
al Description
family int No The font family for whichthe
encoding is to be retrieved.
Value Meaning
FrameRoman Roman Text.
JISX0208.ShiftJIS Japanese Text.
BIG5 Traditional Chinese Text.
GB2312-80.EUC Simplified Chinese Text.
KSC5601-1992 Korean Text.
961
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Parameters
GetImportDefaultParams
Description
Gets a default property list that you can use to call Import().
The method returns a PropVals structure containing the properties retreived.
For more information see Import.
Returns
PropVals
Syntax
GetImportDefaultParams()
GetOpenDefaultParams
Description
Gets a default property list that you can use to call Open().
Returns
PropVals
Syntax
GetOpenDefaultParams()
GetPropIndex
Description
Gets the index of a property-value pair (PropVal structure) within a property list. GetPropIndex() is
a convenience routine that makes it easier to manipulate the properties in a property list.
The method returns the index (in the property list) of the property’s PropVal structure, or
Constants.FE_BadPropNum (-4) if an error occurs.
Parameter name
Data
Type
Option
al Description
font Font No
962
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
GetPropIndex(propVals, propNum)
Parameters
GetSaveDefaultParams
Description
Gets a default property list that you can use to call Save().
On success, the method returns a PropVals list as shown in the following table.
The first value listed next to each property is the value that GetSaveDefaultParams() assigns to
the property. The other values are values that you can assign to the property as desired.
Parameter name
Data
Type
Option
al Description
propVals PropV
als
No The property list.
propNum int No The property for which the index is to
be retrieved.
Property Values
AlertUserAboutFailure Specifies whether to notify user if something unusual
happens during the Save operation. The value is one
of:
• False: Do not notify user.
• True: Notify user.
AutoBackupOnSave Specifies whether to create a backup file. The value is
one of:
• Constants.FV_SaveUserPrefAutoBackup(2) -
Follow preference specified by the session’s
AutoBackup property.
• Constants.FV_SaveYesAutoBackup(0) - Make a
backup.
• Constants.FV_SaveNoAutoBackup(1) - Do not
make a backup.
963
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
DontNotifyAPIClients Specifies whether to save the file without notifying
other clients. The value is one of:
• False - Notify other clients.
• True - Do not notify other clients.
FileType Specifies the type of file to save to. This file type must
be one that FrameMaker saves natively. Note that
HTML and XML are saved via filters, and so you must
specify a filter hint string via
Constants.FS_SaveFileTypeHint(16).
The value is one of:
• Contants.FV_SaveFmtBinary(0) - Save in Frame
binary format for this version of FrameMaker.
• Constants.FV_SaveFmtBinary60(11) - Save in
binary format for FrameMaker 6.0.
• Constants.FV_SaveFmtInterchange(1) - Save as
MIF.
• Constants.FV_SaveFmtSgml(7) - Save in SGML
format.
• Constants.FV_SaveFmtText(6) - Save in Text
Only format.
• Constants.FV_SaveFmtXml(10) - Save in XML
format.
• Constants.FV_SaveFmtPdf(9) - Save as Post-
Script, and then invoke Acrobat Distiller to
create a PDF version of the document. This is
the same as choosing PDF from the Format
popup menu in the Save As dialog box.
• Constants.FV_SaveFmtFilter(8) - Filter on save,
using
Constants.FS_SaveFileTypeHint(16
)to determine the filter.
Property Values
964
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
FileIsInUse Another user or session is recorded in the file’s lock
file. The value is one of:
• Constants.FV_DoCancel(0) - Cancel the Save
operation.
• Constants.FV_DoShowDialog(4) - Display the
File In Use dialog box.
• Constants.FV_ResetLockAndContinue(7) -
Attempt to reset the file lock and save the docu-
ment.
LockCantBeReset The user clicked Save Anyway in the File In Use dialog
box, or the value of Constants.FS_FileInUse
is set to
Constants.FV_ResetLockAndContinue(7
), but the lock file cannot be reset. This is usually due
to permissions in the lock file.
The value is one of:
• Constants.FV_DoCancel(0) - Cancel the Save
operation.
• Constants.FV_DoShowDialog(4) - Display the
Cannot Lock File dialog box.
• Constants.FV_DoOK(1) - Save the document
anyway.
ModDateChanged The file has changed since the last time it was opened
or saved in the current session. Somebody else has
probably modified the file.
The value is one of:
• Constants.FV_DoCancel(0) - Cancel the Save
operation.
• Constants.FV_DoShowDialog(4) - Display the
File Has Changed alert box.
• Constants.FV_DoOK(1) - Save the document
anyway.
SaveFileNotWritable The file permissions will not allow the file to be
saved.
The value is one of:
• Constants.FV_DoCancel(0) - Cancel the Save
operation.
• Constants.FV_DoShowDialog(4) - Display the
Cannot Lock FIle alert box.
Property Values
965
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
SaveFileTypeHint If Constants.FS_FileType is
Constants.FV_SaveFmtFilter(8), this string enables
the FrameMaker product to call the correct filter.For
example, use 0001ADBEHTML to save as HTML or
0001ADBEXML to save as XML.
MakePageCount Specifies how to round the page count.
The value is one of:
• Constants.FV_UseCurrentSetting(0) - Use
default specified by the document property,
PageRounding.
• Constants.FV_DontChangePageCount(1) -
Leave pages as is.
• Constants.FV_MakePageCountEven(2) - With
odd number of pages, add a page to end of
document.
• Constants.FV_MakePageCountOdd(3) - With
even number of pages, add a page to end of
document.
• Constants.FV_DeleteEmptyPages(4) - Remove
extra pages at end of document.
RetainNameStripe Specifies whether to change the name in document
title bar to the name to which the file is saved.
The value is one of:
• False -Change the name in the title bar to the
name in which the file is saved.
• True - Do not change the name in the title bar.
SaveAsModeName Specifies where to get filename if
Constants.FS_SaveMode(4) is set to
Constants.FV_ModeSaveAs(1).
The value is one of:
• Constants.FV_SaveAsNameProvided(2) - Save
under the filename specified in the
saveAsName parameter of Save().
• Constants.FV_SaveAsUseFileName(1) - Save as
name shown on the document title bar.
• Constants.FV_SaveAsNameAskUser(0) - Prompt
user for name.
Property Values
966
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
SaveMode Specifies whether to use Save or Save As mode.
The value is one of:
• Constants.FV_ModeSaveAs(1) - Use Save As
mode.
• Constants.FV_ModeSave(0) - Use Save mode.
SaveTextExtraBlankLineAtEOP Specifies whether to add an extra line at the end of
each paragraph if the file is being saved as Text Only.
The value is one of:
• False - Do not add an extra line.
• True - Add an extra line.
SaveTextTblSetting Specifies how to deal with tables if the file is being
saved as Text Only.
The value is one of:
• Constants.FV_SaveTblUserPref(0) - Use setting
last specified in Save as Text dialog box.
• Constants.FV_SaveTblRowsAsPgfs(1) - Save
each table cell as a paragraph row-by-row.
• Constants.FV_SaveTblColsAsPgfs(2) - Save each
table cell as a paragraph column-by-column.
• Constants.FV_SaveSkipTbls(3) - Omit tables
from a Text Only file.
• Constants.FV_SaveTextTblCellSeparator - The
character to write as a cell separator in the text
file.
• Constants.FV_SaveTextTblRowColumnSep-
arator - The character to write as a row or
column separator in the text file.
SgmlSaveApplication Retained for compatibility. Use the
StructuredSaveApplication property instead.
StructuredSaveApplication The value is one of:
• String specifying the name of the structure
application to use when saving a structured
document as XML or SGML. This paramater
takes precedence over any other structure
application specification. If the specified appli-
cation does not exist, the calling function will
fail.
• Null - No application used.
Property Values
967
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
On failure, the method sets the len field of the returned structure to 0.
Returns
PropVals
Syntax
GetSaveDefaultParams()
GetSupportedEncodings
Description
Returns the font encodings supported for the current session.
The following strings indicate the encoding for fonts:
Returns
Strings
ShowSaveTextDialog Specifies whether to display dialog box if the file is
being saved in Text Only format.
The value is one of:
• False - Do not display dialog box.
• True - Display dialog box asking user whether to
put paragraph returns at the end of each line.
UpdateFRVList Specifies whether the file will be added to the list of
files recently visited that appears in the File menu.
This is set toc False by default.
The value is one of :
• False - Do not add the file to the list.
• True - Add the file to the list.
Value Meaning
FrameRoman Roman Text.
JISX0208.ShiftJIS Japanese Text.
BIG5 Traditional Chinese Text.
GB2312-80.EUC Simplified Chinese Text.
KSC5601-1992 Korean Text.
Property Values
968
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Syntax
GetSupportedEncodings()
GetUpdateBookDefaultParams
Description
Gets a default property list that you can use to call UpdateBook().
Returns
PropVals
Syntax
GetUpdateBookDefaultParams()
GetNewXMLDefaultParams
Description
Generates default open-parameters for NewXML().
Returns
PropVals
Syntax
GetNewXMLDefaultParams();
A property list (PropVals) with the properties shown in the following table.
Property Instruction or situation and possible values
Constants.FS_Doctype Specifies a doctype to be used for creating a new XML document
Constants.FS_PublicId Specifies a public id to be used for creating a new XML document
Constants.FS_SystemId Specifies a DTD-system id to be used for creating a new xml
document
Constants.FS_Extension Used to provide a custom extension for the new XML document
(like Untitled1.dita). Without customization, FrameMaker
determines the extension by itself based on file type.
Constants.FS_Visible A boolean property that indicates if the new XML document shall
be visible or hidden.
969
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
IsEncodingSupported
Description
Checks whether the specified encoding is supported for the current session. For example, unless
FrameMaker is running on a system that supports Japanese text, Japanese encoding is not supported.
The encodingName parameter can be set to one of the following values:
Returns True if the specified encoding is supported for the current session, else returns False.
Returns
bool
Syntax
IsEncodingSupported(encodingName)
Parameters
LoadMenuCustomizationFile
Description
Loads a menu customization file.
A menu customization file is a text file containing statements that change the menus and commands the
user sees in FrameMaker. For example, a menu customization file can change the name of a command
or move a command from one menu to another.
The method returns FE_Success on success.
Value Meaning
FrameRoman Roman Text.
JISX0208.ShiftJIS Japanese Text.
BIG5 Traditional Chinese Text.
GB2312-80.EUC Simplified Chinese Text.
KSC5601-1992 Korean Text.
Parameter name
Data
Type
Option
al Description
encodingName strin
g
No The encoding that you want to test.
970
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
On failure, the method sets FA_errno to one of the following values:
Returns
Void
Syntax
LoadMenuCustomizationFile(pathname, silent)
Parameters
Error Reason
Constants.FE_WrongPr
oduct (-60)
The product version does not support this operation.
Constants.FE_BadPara
meter (-43)
Parameter has an invalid value.
Constants.FE_BadOper
ation (-27)
Parameters specify an invalid operation.
Constants.FE_SystemE
rror (-42)
System error.
Parameter name
Data
Type
Option
al Description
pathname strin
g
No The pathname of the menu
customization file to load. If you
specify only a filename, the function
looks in the client directory. If
silent is set to False, the pathname
specified by pathname is used as
the default in the Menu
Customization File dialog box.
silent bool No Specifies whether to display the
Menu Customization File dialog box
and allow the user to choose the file.
To display the dialog box and allow
the user to choose the file, specify
False.
To use the file specified by pathname
without asking the user, specify
True.
971
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
NewKeyCatalog
Description
Creates a new key catalog with the specified 'tag'.
Returns
KeyCatalog
Syntax
NewKeyCatalog(tag);
Parameters
If NewKeyCatalog() fails, the method assigns following values to FA_errno:
NewXML
Description
Creates a new, untitled XML.
Returns
Doc
Syntax
ApiNewXML(opennewXMLParams, newXMLReturnParams);
Parameter name
Data
Type
Option
al Description
tag strin
g
No The tag of the new Key Catalog being
created.
Error Reason
Constants.FE_BadName The tag provided is not valid.
Constants.FE_DupName A key catalog for the tag provided already exists.
972
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Parameters
To get a property list to specify for the newXMLParams parameter, use GetNewXMLDefaultParams.
Notification
Description
Requests that the FrameMaker product notify your client whenever a specified event, or stage of an
event, occurs.
NOTE: If FrameMaker encounters an internal error and exits, it does not send any notification to your client
about operations performed after the error occured. For example, after an error, FrameMaker allows the
user to save changes in open documents, but it does not notify any clients of the save operations.
Many events have several notification points or stages for which you can request notification.The
following table lists the notification points and the constants that specify them:
Parameter name
Data
Type
Option
al Description
opennewXMLParamsp PropV
als
No A property list telling the
FrameMaker product how to open
the file and how to respond to errors
and other conditions. To use the
default list, specify NULL.
newXMLopenReturnP
arams
PropV
als
No A property list that returns the
filename and provides information
about how the FrameMaker product
opened the file. It must be initialized
before you call F_ApiNewXMLOpen().
Event Notification Point Notification Constant
Frame binary
document opened
• Before checking the
type of file to be
opened
• After checking the type
of file to be opened
• Before opening the file
• After opening the file
• Constants.FA_Note_PreFileType (9)
• Constants.FA_Note_PostFileType
(10)
• Constants.FA_Note_PreOpenDoc (1)
• Constants.FA_Note_PostOpenDoc
(2)
973
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
MIF document
opened
• Before checking the
type of file to be
opened
• After checking the type
of file to be opened
• Before opening the file
• After opening the file
• Constants.FA_Note_PreFileType (9)
• Constants.FA_Note_PostFileType
(10)
• Constants.FA_Note_PreOpenMIF (3)
• Constants.FA_Note_PostOpenMIF
(4)
SGML document
opened
• Before checking the
type of file to be
opened
• After checking the type
of file to be opened
• Before opening the file
• After opening the file
• Constants.FA_Note_PreFileType (9)
• Constants.FA_Note_PostFileType
(10)
• Constants.FA_Note_PreOpenSGML
(82)
• Constants.FA_Note_PostOpenSGML
(83)
XML document
opened
• Before checking the
type of file to be
opened
• After checking the type
of file to be opened
• Before opening the file
• After opening the file
• Constants.FA_Note_PreFileType (9)
• Constants.FA_Note_PostFileType
(10)
• Constants.FA_Note_PreOpenXML
(95)
• Constants.FA_Note_PostOpenXML
(96)
Filterable
document opened
Before checking the type of
the file to be opened
Constants.FA_Note_FilterIn (14)
Frame binary book
opened
• Before checking the
type of file to be
opened
• After checking the type
of file to be opened
• Before opening the file
• After opening the file
• Constants.FA_Note_PreFileType (9)
• Constants.FA_Note_PostFileType
(10)
• Constants.FA_Note_PreOpenBook
(16)
• Constants.FA_Note_PostOpenBook
(17)
MIF book opened • Before checking the
type of file to be
opened
• After checking the type
of file to be opened
• Before opening the file
• After opening the file
• Constants.FA_Note_PreFileType (9)
• Constants.FA_Note_PostFileType
(10)
• Constants.FA_Note_PreOpen-
BookMIF (18)
• Constants.FA_Note_PostOpe-
nBookMIF (19)
Event Notification Point Notification Constant
974
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
User
double-clicked to
open a document
in a book window
• Before opening the file
• After opening the file
• Constants.FA_Note_PreBookComponen-
tOpen (76)
• Constants.FA_Note_PostBookCompo-
nentOpen (77)
Generating a list or
TOC for a
document or a
book
• Before generating the
file
• After generating the
file
• Constants.FA_Note_PreGenerate
(78)
• Constants.FA_Note_PostGenerate
(79)
Document saved in
Frame binary
format
• Before saving the
document
• After saving the docu-
ment
• Constants.FA_Note_PreSaveDoc (5)
• Constants.FA_Note_PostSaveDoc (6)
Document saved
as MIF
• Before saving the file
as MIF
• After saving the file as
MIF
• Constants.FA_Note_PreSaveMIF (7)
• Constants.FA_Note_PostSaveMIF (8)
Document saved
as SGML
• Before saving the file
as SGML
• After saving the file as
SGML
• Constants.FA_Note_PreSaveSGML
(99)
• Constants.FA_Note_PostSaveSGML
(100)
Document saved
as XML
• Before saving the file
as XML
• After saving the file as
XML
• Constants.FA_Note_PreSaveXML
(97)
• Constants.FA_Note_PostSaveXML
(98)
Document saved
as PDF
• Before specifying
Acrobat settings and
generating PostScript
• After specifying
Acrobat settings and
generating PostScript
• Before distilling the
postscript
• After distilling the post-
script
• Constants.FA_Note_PreSaveAsPDFDi-
alog (71)
• Constants.FA_Note_PostSaveAsPDFDi-
alog (72)
• Constants.FA_Note_PreDistill (73)
• Constants.FA_Note_PostDistill (74)
Document saved
as filterable type
Before the document is
saved
Constants.FA_Note_FilterOut (15)
Event Notification Point Notification Constant
975
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Document exited • Before exiting the
document
• After exiting the docu-
ment
• Constants.FA_Note_PreQuitDoc (11)
• Constants.FA_Note_PostQuitDoc
(40)
Book exited • Before exiting the book
• After exiting the book
• Constants.FA_Note_PreQuitBook
(24)
• Constants.FA_Note_PostQuitBook
(41)
First change made
to a document
since it was
opened or saved
After the document is
changed
Constants.FA_Note_DirtyDoc (12)
First change made
to a book since it
was opened or
saved
After the book is changed Constants.FA_Note_DirtyBook (25)
Book saved in
Frame binary
format
• Before saving the book
• After saving the book
• Constants.FA_Note_PreSaveBook
(20)
• Constants.FA_Note_PostSaveBook
(21)
Book saved in MIF
format
• Before saving the MIF
file
• After saving the MIF
file
• Constants.FA_Note_PreSave-
BookMIF (22)
• Constants.FA_Note_PostSave-
BookMIF (23)
Document saved
with Autosave
• Before saving the
document
• After saving the docu-
ment
• Constants.FA_Note_PreAutoSa-
veDoc (32)
• Constants.FA_Note_PostAutoSa-
veDoc (33)
Document
reverted
• Before reverting the
document
•After reverting the
document
• Constants.FA_Note_PreRevertDoc
(28)
• Constants.FA_Note_PostRevertDoc
(29)
Book reverted • Before reverting the
book
•After reverting the
book
• Constants.FA_Note_PreRevertBook
(30)
• Constants.FA_Note_PostRevert-
Book (31)
Event Notification Point Notification Constant
976
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
FrameMaker
product exited
• Before the OK to Exit
dialog box appears
• Immediately before
exiting the session
• Constants.FA_Note_PreQuitSession
(26)
• Constants.FA_Note_PostQuitSes-
sion (27)
Another client
calls
CallClient()
with clname set to
the current client’s
name
After the call has been made
to CallClient()
Constants.FA_Note_ClientCall (13)
Any user action,
such as a
command choice
or text entry
After the FrameMaker
product finishes processing
the user action
Constants.FA_Note_BackToUser (34)
User clicks on Text
inset owned by the
current client
After the user clicked the
inset
Constants.FA_Note_DisplayClientTiDialog
(35)
FrameMaker
product updates
all text insets
When the client needs to
update insets that belong to
it
Constants.FA_Note_UpdateAllClientTi (36)
FrameMaker
product updates a
specific text inset
When the client needs to
update a specified inset
Constants.FA_Note_UpdateClientTi (37)
Text or graphic
imported
• Before importing the
text or graphic
• After importing the
text or graphic
• Constants.FA_Note_PreImport (38)
• Constants.FA_Note_PostImport (39)
FrameMaker
product command
invoked or text
entered in a
document r
• Before the
FrameMaker product
executes a command
or adds text to the
document
• After the FrameMaker
product executes a
command or adds text
to the document
• Constants.FA_Note_PreFunction
(42)
• Constants.FA_Note_PostFunction
(43)
Event Notification Point Notification Constant
977
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Mouse button
clicked
• Before the
FrameMaker product
responds to the mouse
click
• After the FrameMaker
product responds to
the mouse click
• Constants.FA_Note_PreMouseCom-
mand (44)
•Constants.FA_Note_PostMouseCom-
mand (45)
Hypertext
command invoked
• Before the
FrameMaker product
executes a hypertext
command
• After the FrameMaker
product executes a
hypertext command
• Constants.FA_Note_PreHypertext
(46)
• Constants.FA_Note_PostHypertext
(47)
The user clicked
Go To Source in
the cross reference
dialog box
• Before the
FrameMaker product
goes to the cross refer-
ence source
• After the FrameMaker
product goes to the
cross reference source
• Constants.FA_Note_PreGoToXrefSrc
(80)
• Constants.FA_Note_PostGoToX-
refSrc (81)
Document or book
printed
• After the user clicks OK
in the Print dialog box,
but before the
FrameMaker product
prints the document or
book
• After the FrameMaker
product prints the
document or book
• Constants.FA_Note_PrePrint (48)
• Constants.FA_Note_PostPrint (49)
Body page added
to a document
After the FrameMaker
product adds the body page
Constants.FA_Note_BodyPageAdded (50)
Body page deleted
from a document
After the FrameMaker
product deletes the body
page
Constants.FA_Note_BodyPageDeleted (51)
Structural element
inserted
• Before the element is
inserted
• After the element is
inserted
• Constants.FA_Note_PreInsertEle-
ment (52)
• Constants.FA_Note_PostInsertEle-
ment (53)
Event Notification Point Notification Constant
978
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
The notification constants are numbered sequentially, starting with 0. The method provides a constant,
Constants.FA_Note_Num (128), that specifies the total number of notifications. This makes it
easy to request notification for all notification points.
Structural element
copied
• Before the element is
copied
• After the element is
copied
• Constants.FA_Note_PreCopyEle-
ment (60)
• Constants.FA_Note_PostCopyEle-
ment (61)
Structural element
changed
• Before the element is
changed
• After the element is
changed
• Constants.FA_Note_PreChangeEle-
ment (54)
• Constants.FA_Note_PostChangeEle-
ment (55)
Structural element
wrapped
• Before the element is
wrapped
• After the element is
wrapped
• Constants.FA_Note_PreWrapEle-
ment (56)
• Constants.FA_Note_PostWrapEle-
ment (57)
Structural element
dragged
• Before the element is
dragged
• After the element is
dragged
• Constants.FA_Note_PreDragEle-
ment (58)
• Constants.FA_Note_PostDragEle-
ment (59)
An attribute value
is set
• Before the attribute
value is set
• After the attribute
value is set
• Constants.FA_Note_PreSetAttr-
Value (62)
• Constants.FA_Note_PreSetAttr-
Value (63)
Element
definitions are
imported
• Before the element
definitions are
imported
• After the element defi-
nitions are imported
• Constants.FA_Note_PreImportElem-
Defs (64)
• Constants.FA_Note_PostImportElem-
Defs (65)
Inline input of
double-byte text
• Before the text entry
• After the text entry
• Constants.FA_Note_PreInlineTypeIn
(69)
• Constants.FA_Note_PostInlineTy-
peIn (70)
Filter a file on
import or export
via a filter to file
filter
A file to file filter has been
invoked—this notification
occurs before the file is
imported
Constants.FA_Note_FilterFileToFile (75)
Event Notification Point Notification Constant
979
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
The method returns FE_Success on success. On failure, the method sets FA_errno to one of the
following values:
Returns
int
Syntax
Notification(notification, state)
Parameters
PopClipboard
Description
Pops the Clipboard stack, moving the entry on the top of the stack to the Clipboard.
The method returns FE_Success on success. On failure, the method sets FA_errno to one of the
following values:
Error Reason
Constants.FE_Transport (-1) A transport error occurred.
Constants.FE_BadNotificationNum
(-30)
The specified notification number was invalid.
Parameter name
Data
Type
Option
al Description
notification int No Constant that specifies the
notification point.
state int No Specifies whether to turn notification
on or off. 1 turns it on, and 0 turns it
off
Error Reason
Constants.FE_Transpor
t (-1)
A transport error occurred.
Constants.FE_BadOper
ation (-27)
Clipboard stack is empty.
980
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Returns
int
Syntax
PopClipboard()
Parameters
PrintFAErrno
Description
Prints the current error status, represented by the global variable, FA_errno. The method is useful for
debugging clients.
When a method fails, it stores an error code in the global variable, FA_errno.
FA_errno retains the error code until another function fails and sets it or until your code explicitly sets
it.
To determine whether a method call has failed, initialize FA_errno to FE_Success once before
calling the method and check it once after the method call is completed.For example, if you call the
Notification()method and specify an invalid notification constant, the method sets FA_errno to
Constants.FE_BadNotificationNum (-30). If you subsequently call PrintFAErrno(), it
prints the string FE_BadNotificationNum.
On failure, PrintFAErrno() assigns the following value to FA_errno:
Returns
Void
Syntax
PrintFAErrno(_)
Parameter name
Data
Type
Option
al Description
_Void No NULL
Error Reason
Constants.FE_Transpor
t (-1)
A transport error occurred.
981
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Parameters
PrintImportStatus
Description
Prints status flags returned by Import(). It is useful for debugging your clients.
Returns
Void
Syntax
PrintImportStatus(p)
Parameters
PrintOpenStatus
Description
Prints status flags returned by Open(). It is useful for debugging your clients.
Returns
Void
Syntax
PrintOpenStatus(p)
Parameter name
Data
Type
Option
al Description
_Void No NULL
Parameter name
Data
Type
Option
al Description
pPropV
als
No The property list that Import()
returns in
importReturnParamspp.
982
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Parameters
PrintPropVal
Description
Prints the value of a specified property. It is useful for debugging your clients.
Returns
Void
Syntax
PrintPropVal(p)
Parameters
PrintPropVals
Description
Prints the values in a specified property list. It is useful for debugging your clients.
Returns
Void
Syntax
PrintPropVals(p)
Parameter name
Data
Type
Option
al Description
pPropV
als
No The property list that Open()
returns in openReturnParamspp.
Parameter name
Data
Type
Option
al Description
pPropV
al
No The property to print.
983
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Parameters
PrintSaveStatus
Description
Prints errors returned by Save(). It is useful for debugging your clients.
Returns
Void
Syntax
PrintSaveStatus(p)
Parameters
PrintTextItem
Description
Prints the text in a specified text item. It is useful for debugging clients.
Returns
Void
Syntax
PrintTextItem(textItem)
Parameter name
Data
Type
Option
al Description
pPropV
als
No The property to print.
Parameter name
Data
Type
Option
al Description
pPropV
als
No The property list that Save()
returns in saveReturnParamspp.
984
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Parameters
PrintTextItems
Description
Prints the text in a specified set of text items (TextItems structure). It is useful for debugging clients.
Returns
Void
Syntax
PrintTextItems(textItems)
Parameters
PrintUpdateBookStatus
Description
Prints errors returned by UpdateBook(). It is useful for debugging your clients.
Returns
Void
Syntax
PrintUpdateBookStatus(p)
Parameter name
Data
Type
Option
al Description
textItem TextI
tem
No The text item to print.
Parameter name
Data
Type
Option
al Description
textItems TextI
tems
No The set of text items to print.
985
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Parameters
PushClipboard
Description
Pushes the current Clipboard contents onto the Clipboard stack.The method is useful if you want to use
Clipboard functions, such as Copy() or Cut(), without losing the Clipboard’s original contents.
On failure, the method assigns the following value to FA_errno:
Returns
Void
Syntax
PushClipboard()
Parameters
ReturnValue
Description
Sets a return value for a client-defined callback. The method allows a client to provide status information
to the FrameMaker product or client that called the callback.You can call this method in the following
callbacks:
• DialogEvent()
Parameter name
Data
Type
Option
al Description
pPropV
als
No The property list that
UpdateBook() returns in
updateReturnParamspp.
Error Reason
Constants.FE_Transport
(-1)
A transport error occurred.
Parameter name
Data
Type
Option
al Description
Void No NULL
986
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
•Notify()
ReturnValue() is useful for canceling FrameMaker product operations. When your client receives a
Constants.FA_PreNotificationPoint notification for an operation, it can cancel the opera-
tion by calling ReturnValue() with retvalue set to Constants.FR_CancelOperation
(-10001).
For example, if your client’s Notify() callback responds to all Constants.FA_Note_PrePrint
(48) notifications by calling ReturnValue() with retvalue set to
Constants.FR_CancelOperation (-10001), FrameMaker cancels all print operations.
Your client can also call ReturnValue() in a DialogEvent() callback to prevent FrameMaker
from closing a modal dialog box.
You can set retvalue to any integer. If you client sets retval in response to one of the following notifica-
tions, it can use the following listed constants:
Notification
Values that client can pass
to ReturnValue() Meaning
Constants.FA_NOTE_PreNotific
ationPoint
Constants.FR_CancelOperati
on (-10001)
Cancel the operation for
which the notification was
issued
Constants.FA_Note_ClientCall
(13)
Any value recognized by the
client that called
CallClient().
Client-defined.
Constants.FA_Note_FilterIn
(14)
• The document into
which the file was
filtered.
•0
• The document was
filtered successfully.
• The document was not
filtered successfully.
Constants.FA_Note_DisplayClie
ntTiDialog (35)
Constants.FR_DisplayedTiDia
log (-10002)
The client has displayed its
version of the Text Inset
Properties dialog box.
Constants.FA_Note_PreSaveAs
PDFDialog (71)
• Constants.FR_CancelOper-
ation (-10001)
• Constants.FR_Skip-
Step (-10004)
• Cancel the Save As PDF
operation.
• Do not display the
Acrobat Settings dialog
box
Constants.FA_Note_PostSaveAs
PDFDialog (72)
Constants.FR_CancelOperati
on (-10001)
Cancel the Save as PDF
operation.
NOTE: This event occurs before
the distilling operation
begins. You can now cancel
the peration after the user
closes Save As PDF dialog box.
987
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Calling ReturnValue() for notifications other than those listed above, has no effect.
A client can also call ReturnValue() in a DialogEvent() callback that responds to actions in a
client-defined modal dialog box.
Normally, when the user clicks a button in a client-defined modal dialog box, FrameMaker calls the
client’s DialogEvent() callback and then closes the dialog box. However, if the client’s
DialogEvent() callback calls ReturnValue() with retvalue set to
Constants.FR_DialogStayUp (-10000) , FrameMaker does not close the dialog box.
The following table lists the values that a client can pass to ReturnValue() in a DialogEvent()
callback:
On success, ReturnValue() returns the value of the retvalue parameter that was set, the previous
time ReturnValue() was called in the current callback function.
On failure, the method assigns the following value to FA_errno:
Returns
int
Syntax
ReturnValue(retvalue)
Parameters
Constants.FA_Note_PreDistill
(73)
Constants.FR_CancelOperati
on (-10001)
Cancel the Save as PDF
operation.
Value Meaning
Constants.FR_DialogStayUp
(-10000)
Do not close the modal dialog box in which the event
occurred.
Any other value Close the modal dialog box.
Error Reason
Constants.FE_Transport
(-1)
A transport error occurred.
Parameter name
Data
Type
Option
al Description
retvalue int No The value to return.
Notification
Values that client can pass
to ReturnValue() Meaning
988
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
ShutDown
Description
Closes an ESTK client’s connection.
Returns
Void
Syntax
ShutDown(_)
Parameters
SimpleNewDoc
Description
Creates a new document from a specified template.
NOTE: If you call SimpleNewDoc() with interactive set to True and the user clicks etiher Portrait,
Custom, or Landscape in the New dialog box, SimpleNewDoc() does not create a document. Intead,
it returns 0 and sets FA_errno to either Constants.FE_WantsPortrait (-48),
Constants.FE_WantsCustom (-46), or Constants.FE_WantsLandscape (-47),
respectively. It is up to your client to create a portrait, custom, or landscape document.NOTE: For more
information on creating custom documents, see CustomDoc.
If SimpleNewDoc() fails, the method assigns an error code to FA_errno. The error codes for
SimpleNewDoc() are the same as those for Open(). For a list of these error codes, see Open.
Returns
Doc
Syntax
SimpleNewDoc(templateName, interactive)
Parameter name
Data
Type
Option
al Description
_Void No NULL
989
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Parameters
UserCancel
Description
Determines whether the user has chosen the Cancel command (ESC) since the current callback function
was called.
UserCancel() is useful for clients that conduct extensive processing that the user may want to
cancel. For example, if your client processes all the documents in a book, it can call UserCancel()
after it processes each document.
If UserCancel() returns True, your client can abort the processing.
Returns True if the user has executed the Cancel gesture, or False if the user has not executed the
Cancel gesture.
Returns
int
Syntax
UserCancel()
Parameters
SimpleOpen
Description
Opens a document or book.
Parameter name
Data
Type
Option
al Description
templateName strin
g
No The absolute pathname of the
template to use.
interactive int No Specifies whether FrameMaker
displays messages and warnings to
the user.
Parameter name
Data
Type
Option
al Description
Void No NULL
990
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
If you call SimpleOpen() with interactive set to True, FrameMaker displays the Open dialog
box. It uses the path specified by the session property, OpenDir, as the default path.
If a warning or error condition arises, FrameMaker notifies the user. For example, if a document uses
fonts that are not available, FrameMaker displays a dialog box that allows the user to cancel the opera-
tion or to continue and remap the fonts.If you set interactive to False, FrameMaker does not
display the Open dialog box or other messages and warnings. If it is necessary to modify a file to continue
opening it, SimpleOpen() aborts the operation without notifying the user, and returns 0.
NOTE: You cannot use SimpleOpen() to open filterable files. To open filterable files, use Open
The method returns the document opened, on success.
If SimpleOpen() fails, the method assigns an error code to FA_errno. The error codes for
SimpleOpen() are the same as those for Open.
Returns
Object
Syntax
SimpleOpen(fileName, interactive)
Parameters
UpdateMenus
Description
Updates the top order menu set. For example, when a new menu file is read, or when a view only, book
menu, quick menu or similar is loaded, this updates the newly read menus (in case of menu file) or
different top menu bar (in case of view only, book and quick menus).
Returns
Void
Parameter name
Data
Type
Option
al Description
fileName strin
g
No The absolute pathname of the file to
open.
interactive int No Specifies whether the FrameMaker
product displays messages and
warnings to the user. 1 instructs the
FrameMaker product to display
messages and warnings.
991
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Syntax
UpdateMenus()
Parameters
AddMenu
Description
Adds a menu to a specified menu.
The method returns FE_Success on success.
On failure, the method assigns one of the following values to FA_errno:
Returns
int
Syntax
AddMenu(toMenu, menu, label)
Parameter name
Data
Type
Option
al Description
Void No NULL
Error Reason
Constants.FE_WrongPr
oduct (-60)
Invalid product.
Constants.FE_BadOper
ation (-27)
One of:
•menu is null or empty
•tomenu is null or empty
•value of menu is already defined as a command
Constants.FE_BadPara
meter (-43)
One of:
•tomenu and menu have the same values
•tomenu is not previously defined
•tomenu is not a menu
992
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Parameters
RemoveMenu
Description
Deletes the specified menu.
The method returns FE_Success on success.
On failure, the method assigns one of the following values to FA_errno:
Returns
int
Syntax
RemoveMenu(fromMenu, label)
Parameters
Parameter name
Data
Type
Option
al Description
toMenu strin
g
No The menu tag to which the menu is to
be added.
menu strin
g
No The new menu which is being added
to the existing menu.
label strin
g
No The name by which the newly added
menu is visible.
Error Reason
Constants.FE_WrongPr
oduct (-60)
Invalid product.
Parameter name
Data
Type
Option
al Description
fromMenu strin
g
No The parent menu from which the
menu is to be deleted.
label strin
g
No The menu to delete.
993
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
MenuExists
Description
Indicates whether a specified menu exists.
The method returns 1 if the menu exists or 0 if the menu does not exist.
Returns
int
Syntax
MenuExists(menu)
Parameters
ShortcutExists
Description
Indicates whether a specified command exists.
The method returns 1 if the command exists or 0 if the command does not exist.
Returns
int
Syntax
ShortcutExists(shortcut)
Parameters
Parameter name
Data
Type
Option
al Description
menu strin
g
No The menu to be checked for
existence.
Parameter name
Data
Type
Option
al Description
shortcut strin
g
No The command to be checked for
existence.
994
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
GetExportDefaultParams
Description
Returns the PropVals structure containing the default export parameters.
Returns
PropVals
Syntax
GetExportDefaultParams()
Parameters
PrintExportStatus
Description
Returns
Void
Syntax
PrintExportStatus(p)
Parameters
ErrorName
Description
Returns the string corresponding to the value of FA_errno.
Parameter name
Data
Type
Option
al Description
Void No Null
Parameter name
Data
Type
Option
al Description
pPropV
als
No
995
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Returns
string
Syntax
ErrorName(i)
Parameters
PrintErrno
Description
Prints the value of FA_errno to the console.
Returns
Void
Syntax
PrintErrno(i)
Parameters
NotificationName
Description
Returns
string
Syntax
NotificationName(i)
Parameter name
Data
Type
Option
al Description
iint No
Parameter name
Data
Type
Option
al Description
iint No
996
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Parameters
AllocatePropVals
Description
Allocates memory for a property list.
On success, the method returns a property list (a PropVals data structure).The returned PropVals
structure references memory that is allocated by the method. If AllocatePropVals() fails, the
method sets the len field of the returned structure to 0.
Returns
PropVals
Syntax
AllocatePropVals(numProps)
Parameters
Open
Description
Opens a document or book. It can also create a new document.
Open() allows you to specify a property list telling FrameMaker how to open or create the file and how
to deal with error and warning conditions.
For example, you can specify whether to abort or to continue opening a document if it contains fonts that
are not available. If the file is already open and invisible, it will make the file visible.
To get a property list to specify for the openParams parameter, use GetOpenDefaultParams()
or create the list from scratch.
Parameter name
Data
Type
Option
al Description
iint No
Parameter name
Data
Type
Option
al Description
numProps int No The number of properties in the
property list.
997
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
To create a new document with Open(), set the Constants.FS_NewDoc (29) property in the
openParams property list to True.
NOTE: When creating a new document (Constants.FS_NewDoc(29) is True) and you display the
New dialog box (Constants.FS_ShowBrowser (1) is True) and if the user clicks etiher Portrait,
Custom, or Landscape in the New dialog box, Open() does not create a document. Intead, it returns 0
and sets FA_errno to either Constants.FE_WantsPortrait (-48),
Constants.FE_WantsCustom (-46), or Constants.FE_WantsLandscape (-47),
respectively. It is up to your client to create a portrait, custom, or landscape document.NOTE: For more
information on creating custom documents, see CustomDoc.
The method returns the document or book if it opens it successfully, or 0 if an error occurs.
The property list to which openReturnParams is set has the properties shown in the following table:
Both the Constants.FS_OpenNativeError(2) property and the FA_errno global variable
indicate the result of a call to Open(). The following table lists the possible status flags and the
FA_errno and Constants.FS_OpenNativeError(2) values associated with them.
Property Meaning and possible values
Constants.FS_OpenedFileName (1) A string that specifies the opened file’s pathname. If
you scripted Constants.FS_ShowBrowser (1),
or the file was filtered, or you did not specify the
pathname, this pathname can be different from the
one you specified in the Open script.
Constants.FS_OpenNativeError (2) The error condition; normally the same value as
FA_errno. If the file is opened successfully, it is set to
FE_Success.
Constants.FS_OpenStatus (3) A bit field indicating what happened when the file was
opened.
998
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
999
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
FS_OpenNativeError and
FA_errno values Possible FS_OpenStatus flags
Constants.FE_Success (0) (file
was opened)
• Constants.FV_FileHasNewName (32) - Filename was
changed from the name specified in the Open() call.
• Constants.FV_RecoverFileUsed (33) - Recover file was
present, and it was used.
• Constants.FV_AutoSaveFileUsed (34) - Autosave file was
present, and the user or the Open() script chose to use
it.
• Constants.FV_FileWasFiltered (35) - File was filterable
and it was filtered.
• Constants.FV_FontsWereMapped (36) - The document
contained unavailable fonts, which were mapped to
substitute fonts.
• Constants.FV_FontMetricsChanged (37) - The file
contained fonts with changed metrics, but it was opened
anyway.
• Constants.FV_FontsMappedInCatalog (38) - The Para-
graph or Character Catalog used unavailable fonts, which
were mapped to substitute fonts.
• Constants.FV_LanguagesWerentFound (39) - The docu-
ment used some unavailable languages, but it was
opened anyway.
• Constants.FV_BeefyDoc (40) - The document file was
extremely large, but it was opened anyway.
• Constants.FV_FileIsOldVersion (41) - The file was from an
old FrameMaker product version, but the user or the
Open() script chose to open it anyway.
• Constants.FV_FileStructureStripped (42) - The file had
FrameMaker features, which the user or the Open()
script chose to strip.
• Constants.FV_FileIsText (43) - The file was a Text Only
file, but the user or the Open() script chose to open it
anyway.
• Constants.FV_OpenedViewOnly (44) - The user or the
Open() script chose to open the file as a View Only file.
• Constants.FV_EditableCopyOpened(45) - The file was in
use and the user or the Open() script opened an edit-
able copy.
• Constants.FV_BadFileRefsWereMapped (46) - File refer-
ence contained illegal characters; the illegal characters
were converted to something safe.
• Constants.FV_ReferencedFilesWerentFound (47) -
Imported graphics files could not be found, but the file
was opened anyway.
1000
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Constants.FE_Success (0) (file
was opened)
• Constants.FV_FileAlreadyOpen (48) - The file was in use
and the user or the Open() script opened another copy.
• Constants.FV_UnresolvedXRefs (49) - There were unre-
solved cross-references, but the file was opened anyway.
• Constants.FV_UnresolvedTextInsets(50) - There were
unresolved text insets, but the file was opened anyway.
Constants.FE_SystemError
(-42) (file was not opened)
• Constants.FV_TooManyWindows(128) - Too many
windows were open.
• Constants.FV_BadTemplate (129) - A bad template was
specified.
• Constants.FV_FileNotReadable (130) - Do not have read
permission for the file.
FS_OpenNativeError and
FA_errno values Possible FS_OpenStatus flags
1001
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Constants.FE_BadParameter
(-43) (file was not opened)
• Constants.FV_FileHadStructure(64) - File had
FrameMaker features, but current FrameMaker product
is not FrameMaker.
• Constants.FV_FileAlreadyOpenThisSession (65) - File is
already open and script disallowed opening another
copy.
• Constants.FV_BadFileType (66) - File was an executable
file or other unreadable type.
• Constants.FV_BadFileName (67) - Specified filename was
invalid.
• Constants.FV_CantNewBooks (68) - Script specified a
book that did not exist (the Open operation cannot
create a new book).
• Constants.FV_BadScriptValue (70) - Open() script
contained an invalid property value.
• Constants.FV_MissingScript (71) - Open() was called
without a script.
• Constants.FV_CantForceOpenAsText (72) - Open()
script attempted to open the file as text, but file was of
the wrong type.
• Constants.FV_DisallowedType (73) - File was a Frame
binary document and the Open() script disallowed it.
• Constants.FV_DocDamagedByTextFilter (74) - File was a
text document and was damaged when it was filtered.
• Constants.FV_DocHeadersDamaged (75) - The document
headers were damaged (probably because of a file
system problem).
• Constants.FV_DocWrongSize (76) - File is the wrong size
(probably because of a file system problem).
• Constants.FV_ChecksumDamage (77) - Bad checksum.
FS_OpenNativeError and
FA_errno values Possible FS_OpenStatus flags
1002
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Constants.FE_Canceled (-44)
(file was not opened)
• Constants.FV_CancelUseRecoverFile (96) - A recover file
was present, so the user or the Open() script canceled
the Open operation.
• Constants.FV_CancelUseAutoSaveFile (97) - An Autosave
file was present, so the user or the Open() script
canceled the Open operation.
• Constants.FV_CancelFileIsText (98) - The file was text, so
the user or the Open() script canceled the Open opera-
tion.
• Constants.FV_CancelFileIsInUse (99) - The file was in use,
so the user or the Open() script canceled the Open
operation.
• Constants.FV_CancelFileHasStructure (100) - The file had
structure, so the user or the script canceled the Open
operation.
• Constants.FV_CancelReferencedFilesNotFound (101) -
The file contained referenced files that were not avail-
able, so the user or the Open() script canceled the
Open operation.
• Constants.FV_CancelLanguagesNotFound (102) - The file
contained languages that were not available, so the user
or the Open() script canceled the Open operation.
• Constants.FV_CancelFontsMapped (103) - The docu-
ment contained fonts that needed to be mapped to
other fonts, so the user or the Open() script canceled
the Open operation.
• Constants.FV_CancelFontMetricsChanged (104) - The file
contained fonts with changed metrics, so the user or the
Open() script canceled the Open operation.
• Constants.FV_CancelFontsMappedInCatalog (105) - The
document’s Character Catalog or Paragraph Catalog
contained fonts that needed to be mapped to other
fonts, so the user or the Open() script canceled the
Open operation.
• Constants.FV_CancelFileIsDoc (106) - The file was a docu-
ment and the Open() script disallowed it.
• Constants.FV_CancelFileIsMIF (107) - The file was a MIF
file and the Open() script disallowed it.
• Constants.FV_CancelBook (108) - The file was a book and
the Open() script disallowed it.
• Constants.FV_CancelBookMIF (109) - The file was a MIF
file and the Open() script disallowed it.
• Constants.FV_CancelFileIsFilterable (110) - The file was a
filterable file and the Open() script disallowed it.
• Constants.FV_CancelFileIsOldVersion (111) - The file was
FS_OpenNativeError and
FA_errno values Possible FS_OpenStatus flags
1003
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
To determine if a particular FS_OpenStatus bit is set, use CheckStatus.
Returns
Object
Syntax
Open(fileName, openParams, openReturnParams)
Parameters
• Constants.FE_Success (0)
• Constants.FE_Canceled
(-44)
• Constants.FE_Failed-
State (-45)
• Constants.FE_CanceledBy-
Client (-86)
• Constants.FV_LockWasReset (0) - File lock was reset.
• Constants.FV_LockNotReset (1) - File had a lock that was
not reset.
• Constants.FV_LockCouldntBeReset (2) - File had a lock
that could not be reset.
• Constants.FV_FileWasInUse (3) - File was in use.
• Constants.FV_FileIsViewOnly (4) - File is a View Only file.
• Constants.FV_LockWasInvalid (5) - File had an invalid
lock.
• Constants.FV_FileIsNotWritable (6) - The file was not
writable, and the user canceled the open through the
alert.
• Constants.FV_FileModDateChanged (7) - The file has
changed since the last time it was opened or saved in the
current session.
Parameter name
Data
Type
Option
al Description
fileName strin
g
No The full pathname of the file to open.
If you are using Open() to create a
document, specify the name of the
template to use.
openParams PropV
als
No A property list telling the
FrameMaker product how to open
the file and how to respond to errors
and other conditions. To use the
default list, specify NULL.
FS_OpenNativeError and
FA_errno values Possible FS_OpenStatus flags
1004
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
ScrollBox
Description
Displays an array of items and allows the user to choose one.
NOTE: If you set default to -1, always check to make sure the value returned in selected_item is 0
or greater before you use it as an array index. If you set default to -1 and the user clicks OK without
choosing an item, the value returned in selected_item will be -1.
Returns 0 if the user clicked OK, or a nonzero value if the user clicked Cancel or an error occurred.
On failure, the method assigns the following value to FA_errno:
Returns
int
Syntax
ScrollBox(title, stringslist, _default)
Parameters
openReturnParams PropV
als
No A property list that returns the
filename and provides information
about how FrameMaker opened the
file. It must be initialized before you
call Open().
Error Reason
Constants.FE_Transport
(-1)
The user clicked Cancel, or a transport error occurred.
Parameter name
Data
Type
Option
al Description
title strin
g
No The title that appears on the dialog
box.
stringslist Strin
gs
No The list of items to appear in the
scroll list.
Parameter name
Data
Type
Option
al Description
1005
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
ChooseFile
Description
Displays dialog boxes similar to a FrameMaker’s Open and Save dialog boxes. The method displays direc-
tories and files in a scroll list and allows the user to choose a file or directory.
You can set the following values for mode:
The method returns 0 if the user clicked Open, Select, Use, or Save; a nonzero value if the user clicked
Cancel or an error occurred.
On failure, the method assigns the following value to FA_errno:
Returns
int
Syntax
ChooseFile(title, directory, stuffVal, mode)
_default int No The index of the item that is selected
when the dialog box first appears. For
no default, specify -1.
Mode Constant Dialog Box Type
Constants.FV_ChooseSele
ct (0)
Dialog box that allows the user to choose a file by clicking Select.It
provides an input field into which the user can type a filename.
Constants.FV_ChooseOpe
n (1)
Dialog box that allows the user to choose a file by clicking Open.It
provides an input field into which the user can type a filename.
Constants.FV_ChooseSave
(2)
Dialog box that allows the user to save a file. It provides Save and
Cancel buttons and an input field.
Constants.FV_ChooseOpe
nDir (3)
Dialog box that allows the user to choose a directory.
Error Reason
Constants.FE_Transport
(-1)
A transport error occurred.
Parameter name
Data
Type
Option
al Description
1006
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Parameters
PromptInt
Description
Displays a dialog box that prompts the user for a single integer value. It allows you to provide a default
value, which appears in the entry field when the dialog box appears. The dialog box has OK and Cancel
buttons.
PromptInt() does not assign a value to *intp if the user clicks Cancel. If the user types alphabetic
text after a number, the method ignores the text and just returns the value of the number.
The method returns 0 if the user clicked OK; a nonzero value if the user clicked Cancel or an error
occurred.
On failure, the method assigns the following value to FA_errno:
Returns
int
Parameter name
Data
Type
Option
al Description
title strin
g
No The message that appears in the
dialog box.
directory strin
g
No The default directory when the dialog
box is first displayed. If you specify an
empty string, the last directory used
by an ESTK client is used. If no ESTK
client has used a directory, the
directory specified by the session
property, OpenDir, is used.
stuffVal strin
g
No The default value that appears in the
input field when the dialog box first
appears. If the dialog box type
specified by mode does not have an
input field, this string is ignored.
mode int No A constant specifying the type of
dialog box.
Error Reason
Constants.FE_Transport
(-1)
A transport error occurred.
1007
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Syntax
PromptInt(message, stuffVal)
Parameters
PromptMetric
Description
Displays a dialog box that prompts the user for a single metric value. It allows you to provide a default
value, which appears in the entry field when the dialog box appears. The dialog box has OK and Cancel
buttons.
PromptMetric() does not assign a value to *metricp if the user clicks Cancel.
PromptMetric() dialog boxes behave like metric dialog boxes in the user interface.If the user types
a number followed by a string that represents a unit (for example 10pts or 5"), the method converts the
number into the equivalent number of metric units. If the user does not specify a unit, the method uses
points (metric 65536).
The method returns 0 if the user clicked OK; a nonzero value if the user clicked Cancel or an error
occurred.
On failure, the method assigns the following value to FA_errno:
Returns
int
Syntax
PromptMetric(message, stuffVal, defaultunit)
Parameter name
Data
Type
Option
al Description
message strin
g
No The message that appears in the
dialog box. It must be 255 characters
or less.
stuffVal strin
g
No The default value that appears in the
input field when the dialog box is first
displayed.
Error Reason
Constants.FE_Transport
(-1)
A transport error occurred.
1008
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Parameters
PromptString
Description
Displays a dialog box that prompts the user for a single string value. It allows you to provide a default
string, which appears in the entry field when the dialog box appears. The dialog box has OK and Cancel
buttons.
NOTE: Do not call PromptString() to prompt the user for a pathname. If the user enters a pathname
as a string, the backslash character (\) is interpreted as a special escape character. For example, the char-
acters \s represent a space. If the user enters the pathname c:\sample, this string is interpreted as
c: ample. To prompt the user for a pathname, use ChooseFile to display a file selection dialog box.
The method returns 0 if the user clicked OK; a nonzero value if the user clicked Cancel or an error
occurred.
On failure, the method assigns the following value to FA_errno:
Returns
string
Syntax
PromptString(message, stuffVal)
Parameter name
Data
Type
Option
al Description
message strin
g
No The message that appears in the
dialog box. It must be 255 characters
or less.
stuffVal strin
g
No The default value that appears in the
input field when the dialog box is first
displayed.
defaultunit int No The metric unit to use if the user does
not specify one.
Error Reason
Constants.FE_Transport
(-1)
A transport error occurred.
1009
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Parameters
Service
Description
Services calls from FrameMaker to the ESTK API.
Service() waits for and dispatches a single Windows message. If your application contains its own
message processing loop you need not call this routine.
It is not feasible for console applications to receive ESTK notifications since there is no way for them to
both wait for user input and call Service(). Consequently, console applications should not register for
notifications.
The method returns the number of bits the call to select() selected, if any.
Returns
int
Syntax
Service()
FileScrollBox
Description
Displays a file scrollbox using the given title and the given directory as the path.
Returns
int
Syntax
FileScrollBox(title, directory)
Parameter name
Data
Type
Option
al Description
message strin
g
No The message that appears in the
dialog box. It must be 255 characters
or less.Newline and linefeed
characters are ignored.
stuffVal strin
g
No The default value that appears in the
input field when the dialog box is first
displayed.
1010
GLOBAL
CHAPTER 6 FUNCTION SUMMARY
Parameters
Parameter name
Data
Type
Option
al Description
title strin
g
No The title to display on the scroll box.
directory strin
g
No The directory path to display.
1011
CMS API DATA STRUCTURES AND ENUM CONSTANTS
CHAPTER 7 CMS CONNECTOR FRAMEWORK
7. CMS Connector Framework
7.1. CMS API Data Structures and Enum Constants
CMSResult
CMSResult
Description
Specifies the state of a Command’s result for CMSCommand.
Returns
CMSResult
Syntax
CMSResult(status,opResult,message,cmsItems);
Parameters
Parameter name
Data
Type Optional Description
status int No Command’s status
opResult int No Operation's result. If CMS Command needs
CMSTree update, assign CMSOpResult
values (See following enum),else can
return any value depending on operation.
For example:
opResult = True/False for
FA_CMSIsValidCommand ,
opResult = CMSPropertyNewMaxOpCode
for FA_CMSGetPropertyMaxOpCode
message string No If operation fails, user can send error
message to FrameMaker.For
FA_CMSObjectOpenReadOnly,
FA_CMSObjectEdit command, user can
return file-name which is downloaded.
cmsItems CMSObj
ects
No List of CMS object
1012
CMS API DATA STRUCTURES AND ENUM CONSTANTS
CHAPTER 7 CMS CONNECTOR FRAMEWORK
The possible values of the CMSResult.opResult field are:
If CMSSetProperty() fails, the API assigns following values to FA_errno:
CMSItemFileType
Description
Enum constants used to determine File-Type of a CMS Object.
The posssible values of the Constants.FP_CMSItemProperty_ItemFileType fields are:
opResult constant Meaning
Constants.CMSOpNone None
Constants.CMSOpItemUpdated CMS item is updated
Constants.CMSOpDependentsUpdated Depdendents are updated
Constants.CMSOpDependentsDeleted Depdendents are deleted
Constants.CMSOpItemDeleted CMS item is deleted
Constants.CMSOpChildAdded Child is added
Constants.CMSOpRootUpdated Root is updated
Error Reason
Constants.FE_CMSBadSessi
onId
The client specified an invalid session ID.
Constants.FE_CMSBadObje
ctId
The client specified an invalid cms object ID.
Constants.FE_CMSRootObj
ectExists
The API tries to set a root which already exists.
Constants.FE_CMSBadItem
FileType
The file type expected by the cms object does not match the valid
file type.
Constants.FE_CMSBadItem
Type
The item type expected by the cms object does not match the
valid item type
Constants.FE_CMSBadItem
ContainerType
The container value expected by the cms object is not properly
set
File Type constant Meaning
Constants.FV_CMSItemFileTypeValue
_Xml
File type is XML
1013
CMS API DATA STRUCTURES AND ENUM CONSTANTS
CHAPTER 7 CMS CONNECTOR FRAMEWORK
CMSProperties
Description
A CMSProperties structure specifies a set of CMS object propeties.
CMSMenuItem
Description
The CMSMenuItem structure describes a custom menu definition.
This structure is used for creating a custom menu entry in the context menu available in CMS tree and
CMS dialogs.
CMSCheckinParam
Description
The CMSCheckinParam structure describes the checkin parameter.
This strcuture is returned by CMSShowCheckinUI API for getting all the user interface state after user
accepts the dialog changes by pressing OK button.
Constants.FV_CMSItemFileTypeValue
_FmDoc
File type is FM
Constants.FV_CMSItemFileTypeValue
_Mif
File type is MIF
Constants.FV_CMSItemFileTypeValue
_DitaMap
File type is DITAMAP
Constants.FV_CMSItemFileTypeValue
_DitaTopic
File type is DITA topic
Constants.FV_CMSItemFileTypeValue
_FmBook
File type is Book
Constants.FV_CMSItemFileTypeValue
_Text
File type is text
Constants.FV_CMSItemFileTypeValue
_Img
File type is image
Constants.FV_CMSItemFileTypeValue
_General
File type is General
1014
ERROR CODES
CHAPTER 7 CMS CONNECTOR FRAMEWORK
CMSDeleteParam
Description
The CMSDeleteParam structure describes the delete parameter.
This strcuture is returned by CMSShowDeleteUI API for getting all the user interface state after the user
accepts the dialog changes by clicking OK.
CMSInfo
Description
The CMSInfo structure describes a single CMS registration information definition
CMSInfos
Description
The CMSInfos structure specifies a set of CMS registration information.
7.2. Error Codes
If the CMS API encounters an error condition, the API assigns an error code to the global variable
FA_errno. The following table lists the error codes and their meanings. Error codes are also listed in the
fcmsapi.h header file.
Error code Meaning
Constants.FE_CMSNameAlreadyRegistere
d
The API attempted to register a CMS that is
already registered.
Constants.FE_CMSBadSessionId The client specified an invalid session ID.
Constants.FE_CMSBadObjectId The client specified an invalid CMS object ID.
Constants.FE_CMSSessionFailed The client failed to create a session.
Constants.CMSBadCommandId The client specified an invalid command ID.
Constants.FE_CMSObjectCreationFailed The CMSCreateObject API fails to create a CMS
object.
Constants.FE_CMSRootObjectExists The API tried to set a root that already exists.
Constants.FE_CMSBadItemFileType The file type expected by the CMS object does not
match the valid file type.
Constants.FE_CMSBadItemType The item type expected by the CMS object does
not match the valid item type.
1015
CMS API FUNCTIONS
CHAPTER 7 CMS CONNECTOR FRAMEWORK
7.3. CMS API functions
A list of the prominent CMS API functions:
CMSRegister
CMSCreateObject
CMSEnableCommand()
CMSDisableCommand()
CMSAddMenuEntry
CMSGetCmsIdFromName
CMSGetCMSInfo()
CMSGetCmsIdFromSession
CMSConfigLoginUI()
CMSShowCheckoutUI()
Constants.FE_CMSBadItemContainerType The container value expected by the cms object is
not properly set
Constants.FE_CMSSessionCreationFailed If Session creation fails, set status to this value.
Constants.FE_CMSIsValidCMSCommand If user wants FrameMaker to take care of
IsValidCMSCommand, set opResult to this value.
Constants.FE_CMSFailedLogin The CMSLogin API fails to log into a CMS.
Constants.FE_CMSFailedLogout The CMSLogout API fails to log out from a CMS.
Constants.FE_CMSFailedCheckout The CMSCheckout API failed to checkout a file.
Constants.FE_CMSFailedCheckin The CMSCheckin API failed to check in a file
Constants.FE_CMSFailedCancelCheckout The CMSCancelCheckout API fails to
cancelcheckout of a file.
Constants.FE_CMSFailedDelete The CMSDelete API failed to delete a cms object
Constants.FE_CMSFailedOpenFile The CMSOpenFile API failed to open a file
Constants.FE_CMSFailedUploadObject The CMSUploadObject API failed to upload afile or
folder.
Constants.FE_CMSFailedDownloadObject The CMSzDownloadObject API failed to download
a file.
Constants.FE_CMSFailedGetItemFrompat
h
The GetCMSObjectFromPath API failed to return a
CMS object from server path.
1016
APIS TO AUTOMATE CMS CONNECTOR FUNCTIONALITY
CHAPTER 7 CMS CONNECTOR FRAMEWORK
CMSShowCheckinUI()
CMSShowCancelCheckoutUI()
CMSShowDeleteUI()
CMSShowCommonListUI()
CMSShowPropertyUI()
CMSShowPropertyUIWithTitle
CMSGetProperty()
CMSGetProperties()
CMSSetProperty()
CMSSetProperties()
7.4. APIs to automate CMS connector functionality
CMSLogin
Description
Logs into a particular CMS based on the connection details
Returns
Returns the handle of the new CMS connection if the operation is successful. Else sets FA_errno to
Constants.FE_CMSFailedLogin.
Syntax
CMSLogin (setVal);
1017
APIS TO AUTOMATE CMS CONNECTOR FUNCTIONALITY
CHAPTER 7 CMS CONNECTOR FRAMEWORK
Parameters
CMSLogout
Description
Logs out the user from a particular CMS connection
Returns
Returns FE_Success if the operation is successful, else sets FA_errno to
Constants.FE_CMSFailedLogout
Syntax
CMSLogout(cmsSessionId);
Parameter name
Data
Type
Option
al Description
setVal IdVal
uePai
rs
No Id value pairs to specify the
connection parameter. The valid Ids
are:
Constants.FV_CMSCommandNameID
- Name of the connection
Constants.FV_CMSCommandConnTy
peId -Connection Type
Constants.FV_CMSCommandServerId
-Server Name
Constants.FV_CMSCommandUserNa
meId -User Name
Constants.FV_CMSCommandPasswor
dId- Password
Constants.FV_CMSCommandUserFiel
d1- Optional User Field1
Constants.FV_CMSCommandReposit
oryId- Repository name for
documentum
Constants.FV_CMSCommandUserFiel
d2-Optional User Field2
1018
APIS TO AUTOMATE CMS CONNECTOR FUNCTIONALITY
CHAPTER 7 CMS CONNECTOR FRAMEWORK
Parameters
CMSCheckout
Description
Checks out a file from the CMS
Returns
Returns FE_Success if the operation is successful. Else sets FA_errno to
Constants.FE_CMSFailedCheckout
Syntax
CMSCheckout(cmsSessionId, cmsObjectId, rootWithDescendants);
Parameters
CMSCheckin
Description
Checks in a file into the CMS
Returns
Returns FE_Success if the operation is successful, else sets FA_errno to
Constants.FE_CMSFailedCheckin
Syntax
CMSCheckin (cmsSessionId,objectId, checkinParam);
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS session
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS Session
cmsObjectId int No The ID of the CMS Object
rootWithDescendants bool No True if checked out root with
descendants
1019
APIS TO AUTOMATE CMS CONNECTOR FUNCTIONALITY
CHAPTER 7 CMS CONNECTOR FRAMEWORK
Parameters
CMSCancelCheckout
Description
Cancels check out of a file from the CMS
Returns
Returns FE_Success if the operation is successful, else sets FA_errno to
Constants.FE_CMSFailedCancelCheckout
Syntax
CMSCancelCheckout (cmsSessionId, objectId);
Parameters
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS Session
cmsObjectId int No The ID of the CMS Object
checkinParam IdVal
uePai
rs
No Id value pairs to specify the checkin
parameter. The valid Ids are:
Constants.FV_CMSCommandCheckin
MakeCurrentVersionId
Constants.FV_CMSCommandCheckin
KeepLocalCopyId
Constants.FV_CMSCommandCheckin
MinorVersionId
Constants.FV_CMSCommandCheckin
VersionLabelId
Constants.FV_CMSCommandCheckin
DescriptionId
Constants.FV_CMSCommandCheckin
CommentId
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS Session
cmsObjectId int No The ID of the CMS Object
1020
APIS TO AUTOMATE CMS CONNECTOR FUNCTIONALITY
CHAPTER 7 CMS CONNECTOR FRAMEWORK
CMSDelete
Description
Deletes a file or a folder from CMS
Returns
Returns FE_Success if the operation is successful, else sets FA_errno to
Constants.FE_CMSFailedDelete
Syntax
CMSDelete (cmsSessionId,cmsObjectId, deleteParams);
Parameters
CMSOpenFile
Description
Opens a file or a book from CMS in FrameMaker
Returns
Returns the handle of the file or book if the operation is successful. Else sets FA_errno to
Constants.FE_CMSFailedOpenFile
Syntax
CMSOpenFile(cmsSessionId,cmsObjectId,openParams);
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS Session
cmsObjectId int No The ID of the CMS Object
deleteParams IdVal
uePai
rs
No Id value pairs to specify the delete
parameter.The valid Ids are:
Constants.FV_CMSCommandDeleteAl
lVersionId
Constants.FV_CMSCommandDeleteAl
lDependentsId
1021
APIS TO AUTOMATE CMS CONNECTOR FUNCTIONALITY
CHAPTER 7 CMS CONNECTOR FRAMEWORK
Parameters
CMSUploadObject
Description
Uploads a file or a folder into the CMS
Returns
Returns FE_Success if the operation is successful. Else sets FA_errno to
Constants.FE_CMSFailedUploadObject
Syntax
CMSUploadObject(cmsSessionId,cmsObjectId,localFilePath);
Parameters
CMSDownloadObject
Description
Downloads a file from the CMS
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS Session
cmsObjectId int No The ID of the CMS Object
openParams IdVal
uePai
rs
No Id value pairs to specify the open
parameter.The valid Ids are:
Constants.FV_CMSCommandOpenRe
adOnlyId
Constants.FV_CMSCommandSilentOp
enId
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS Session
cmsObjectId int No The ID of the CMS Object
localFilePath strin
g
No The full pathname of the file or folder
to upload
1022
APIS TO AUTOMATE CMS CONNECTOR FUNCTIONALITY
CHAPTER 7 CMS CONNECTOR FRAMEWORK
Returns
Returns the local file path of the downloaded file if the operation is successful. Else sets FA_errno to
Constants.FE_CMSFailedDownloadObject
Syntax
CMSDownloadObject (cmsSessionId, cmsObjectId);
Parameters
GetCMSObjectFromPath
Description
Gets CMS object from a URL path
Returns
Returns the handle of a CMS object if the operation is successful. Else sets FA_errno to
Constants.FE_CMSFailedGetItemFrompath
Syntax
GetCMSObjectFromPath (cmsSessionId,urlPath);
Parameters
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS Session
cmsObjectId int No The ID of the CMS Object
Parameter name
Data
Type
Option
al Description
cmsSessionId int No The ID of the CMS Session
urlPath strin
g
No The url pathname of the file or folder
1023
CHAPTER 8 LEGAL NOTICES
8. Legal notices
Follow the links: Legal Notices

Navigation menu