Adobe 65030365 - FrameMaker - PC Manual
  1. Manuals
  2. Brands
  3. Adobe Manuals
  4. Software
  5. 65030365 - FrameMaker - PC
  6. Manual
Adobe 65030365 - FrameMaker - PC Manual

Adobe 65030365 - FrameMaker - PC Manual

Scripting guide
Hide thumbs Also See for 65030365 - FrameMaker - PC:
1
2
3
Table Of Contents
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
Table of Contents

Advertisement

Quick Links

Download this manual
Scripting Guide
®
®
ADOBE
FRAMEMAKER
10

Advertisement

Table of Contents
loading

Related Manuals for Adobe 65030365 - FrameMaker - PC

Summary of Contents for Adobe 65030365 - FrameMaker - PC

  • Page 1 Scripting Guide ® ® ADOBE FRAMEMAKER...
  • Page 2 The content of this guide is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Adobe Systems Incorporated. Adobe Systems Incorporated assumes no responsibility or liability for any errors or inaccuracies that may appear in the informational content contained in this guide.
  • Page 3 Unpublished-rights reserved under the copyright laws of the United States. For U.S. Government End Users, Adobe agrees to comply with all applicable equal opportunity laws including, if appropriate, the provisions of Executive Order 11246, as amended, Section 402 of the Vietnam Era Veterans Readjustment Assistance Act of 1974 (38 USC 4212), and Section 503 of the Rehabilitation Act of 1973, as amended, and the regulations at 41 CFR Parts 60-1 through 60-60, 60-250, and 60-741.

  • Page 4: Table Of Contents

    Contents Chapter 1: Overview About this document ....................1 Scripting support in FrameMaker .
  • Page 5 ADOBE FRAMEMAKER SCRIPTING GUIDE Contents ElementCatalogEntries ....................261 ElementCatalogEntry .
  • Page 6 ADOBE FRAMEMAKER SCRIPTING GUIDE Contents ........................380 TblFmt .
  • Page 7 ADOBE FRAMEMAKER SCRIPTING GUIDE Contents ElementCatalogEntries ....................543 ElementCatalogEntry .
  • Page 8 ADOBE FRAMEMAKER SCRIPTING GUIDE Contents TblFmt ......................622 TextFrame .

  • Page 9: Chapter 1: Overview

    Chapter 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.

  • Page 10: Scripting Support In Framemaker

    The Socket object supports low-level TCP connections. For details, see Chapter 6, “External Communication Tools” in JavaScript Tools Guide. • 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.

  • Page 11: Creating Scripts

    In the ExtendScript Toolkit, select Adobe FrameMaker 10 in the pop-up menu. Click If FrameMaker 10 is not already running, a message appears: “Target Adobe FrameMaker 10 is not running. Do you want to launch Adobe FrameMaker 10?” Click Yes.

  • Page 12: Using Script Library

    ADOBE FRAMEMAKER SCRIPTING GUIDE Overview 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.

  • Page 13: Using Object Model Viewer

    ADOBE FRAMEMAKER SCRIPTING GUIDE Overview 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.

  • Page 14: Chapter 2: Sample Estk Scripts

    Chapter 2: 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 10. Note: Sample scripts shipped with FrameMaker are at the following location: <FMINSTALL_DIR>\samples Adding text to a document and enabling change bar The following script adds a sample text to a FrameMaker document and then enables the change bar.
  • Page 15 ADOBE FRAMEMAKER SCRIPTING GUIDE Sample ESTK scripts The script creates the document’s main flow using the method. Use the MainFlowInDoc GetText(FTI_TblAnchor) method to list all tables in the main flow. Using a for loop, for each table, use the method to change TblLeftIndent() the left indentation.

  • Page 16: Chapter 3: 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 10 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.
  • Page 17 ADOBE FRAMEMAKER SCRIPTING GUIDE Differences between scripts and FDK property is readily available to all FrameMaker scripts and maps to the object in FDK. FO_Session In this example, you query the property that returns the in the current ActiveDoc Active Document Object(Doc) FrameMaker Session.
  • Page 18 ADOBE FRAMEMAKER SCRIPTING GUIDE Differences between scripts and FDK The same code can be written in scripts as follows: doc.Capitalization = FV_CAPITAL_CASE_SMALL; However, there is a separate class called that can be used to access these Global Methods. The script code...

  • Page 19: Notifications

    ADOBE FRAMEMAKER SCRIPTING GUIDE Differences between scripts and FDK 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.

  • Page 20: Menus And Commands

    ADOBE FRAMEMAKER SCRIPTING GUIDE Differences between scripts and FDK 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.
  • Page 21 ADOBE FRAMEMAKER SCRIPTING GUIDE Differences between scripts and FDK 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") ;...
  • Page 22 ADOBE FRAMEMAKER SCRIPTING GUIDE Differences between scripts and FDK 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. Finally, the block of code: function Command(cmd) { case 1: alert("Command 1 executed");...

  • Page 23: Chapter 4: Object Reference

    Chapter 4: Object Reference AFrame Property name Data Type Description AFrameIsCropped Indicates whether the anchored frame is cropped or not. bool Possible values are: 0 - (Default) Indicates the frame is not cropped. 1 - Indicates the frame is cropped. AFrameIsFloating Indicates whether the anchored frame is set to be bool...
  • Page 24 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description AnchorType 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_ANCHOR_BOTTOM (4) • Constants.FV_ANCHOR_SUBCOL_LEFT (5) • Constants.FV_ANCHOR_SUBCOL_RIGHT (6) •...
  • Page 25 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description ArrowLength Denotes the arrowhead length (always rounded down to the nearest 1/256 point). ArrowScaleFactor Indicates the factor by which the arrowhead is scaled as line width changes (always rounded down to nearest 1/16 point).
  • Page 26 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description LineCap 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 Specifies the distance of the object from the left side of the parent frame (in inches).

  • Page 27: Arc

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description Runaround 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: •...
  • Page 28 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description ArrowType Denotes the Arrowhead style. Possible values are: • Constants.FV_ARROW_STICK (0x01) • Constants.FV_ARROW_HOLLOW (0x02) • Constants.FV_ARROW_FILLED (0x03) BorderWidth Specifies the border width in points. The permissible range is 0.015 point to 360 point.
  • Page 29 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description LocX 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.

  • Page 30: Attrcondexpr

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description Runaround 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: •...

  • Page 31: Attributedef

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description values Strings The attribute value. valflags The validation error flags. This property is read only. uint allow uint Allow error as special case to suppress reporting by validation. Attribute methods Attribute.

  • Page 32: Attributedefs

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description attrType 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.

  • Page 33: Attributeex

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference AttributeEx Property name Data Type Description name string The name of the attribute. values The attribute value. Strings valflags uint The validation error flags. This property is read only. allow Allow error as special case to suppress reporting by uint validation.

  • Page 34: Bodypage

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference BodyPage 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...

  • Page 35: Book

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Book Property name Data Type Description BookDontUpdateReferences Set to False if FrameMaker is set to update cross- references when it opens the book; Set to True otherwise. BookIsModified Set to if the book has been modified; Set to False, True otherwise.
  • Page 36 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description TypeOfDisplayText 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 component's filename •...
  • Page 37 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description PDFBookmarksOpenLevel 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: •...
  • Page 38 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description PDFPrintPageRange 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.
  • Page 39 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description PrintEmulsion 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.
  • Page 40 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description ElementCatalogDisplay 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. •...
  • Page 41 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description XmlDocType string Contains the DOCTYPE parameter from the source XML. XmlEncoding Specifies the encoding parameter of the XML Declaration string for the source XML. The string is empty if no encoding is specified.
  • Page 42 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description 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.
  • Page 43 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description PDFGenerateForReview 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.

  • Page 44: Bookcomponent

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference BookComponent Property name Data Type Description BookComponentIsGeneratable Set to True if the book component is a generated file (BookComponentType is not set to Constants.FV_BK_NOT_GENERATABLE (16)); set to False, otherwise. BookComponentType Depicts the type of the book component. The possible values are: •...
  • Page 45 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description ChapNumComputeMethod 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.
  • Page 46 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description 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 ( ""...
  • Page 47 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description FnNumComputeMethod 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.
  • Page 48 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description PageNumStyle Page numbering style. The possible values are: • Constants.FV_PAGE_NUM_NUMERIC (0x00) - Arabic • Constants.FV_PAGE_NUM_ROMAN_UC (0x01) - Roman uppercase • Constants.FV_PAGE_NUM_ROMAN_LC (0x02) - Roman lowercase • Constants.FV_PAGE_NUM_ALPHA_UC (0x03) - Alphabetic uppercase •...
  • Page 49 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description TblFnNumStyle Table footnote numbering style. The possible values are: • Constants.FV_FN_NUM_NUMERIC (0x00) - Arabic • Constants.FV_FN_NUM_ROMAN_UC (0x01) - Roman uppercase • Constants.FV_FN_NUM_ROMAN_LC (0x02) - Roman lowercase • Constants.FV_FN_NUM_ALPHA_UC (0x03) - Alphabetic uppercase •...
  • Page 50 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description VolumeNumStyle The volume numbering style. The possible values are: • Constants.FV_NUMSTYLE_NUMERIC (0x00) - Arabic • Constants.FV_NUMSTYLE_ROMAN_UC (0x01) - Roman uppercase • Constants.FV_NUMSTYLE_ROMAN_LC (0x02) - Roman lowercase • Constants.FV_NUMSTYLE_ALPHA_UC (0x03) - Alphabetic uppercase •...
  • Page 51 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description ComponentType 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 •...
  • Page 52 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description SubsecNumComputeMethod 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) SubsectionNumStyle Denotes the subsection numbering style. Possible values are: •...

  • Page 53: Cell

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description BookComponentIsFolderWithTemplate Determines whether a template is associated with a book. Returns True if the BookComponent is a folder and a template is associated with the component. Returns False, otherwise.
  • Page 54 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description CellOverrideFill Indicates the cell's fill pattern. The value is null if there is no override fill pattern. CellOverrideLeftRuling Indicates the cell's left ruling (FO_RulingFmt ID), if there is RulingFmt an override.

  • Page 55: Charfmt

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description 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.
  • Page 56 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description 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 Name that uniquely identifies the Roman component of string a combined font on a specific platform.
  • Page 57 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description KernX 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.
  • Page 58 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description UseKernX Returns True if the KernX property overrides the default value; returns False if the " As Is " setting is used. UseKernY Returns True if the property overrides the default KernY value;...

  • Page 59: Color

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Color Property name Data Type Description Black Represents the percentage of black (metric 0% to 100%). ColorOverprint Overprint setting for the color. Possible values are: • Constants.FV_COLOR_KNOCKOUT (0x00) • Constants.FV_COLOR_OVERPRINT (0x01) ColorPrintCtl Indicates the type of color printing used in the document.

  • Page 60: Combinedfont

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description ReservedColor Color names reserved by FrameMaker. The values are: • Constants.FV_COLOR_NOT_RESERVED (0) • Constants.FV_COLOR_CYAN (1) • Constants.FV_COLOR_MAGENTA (2) • Constants.FV_COLOR_YELLOW (3) • Constants.FV_COLOR_BLACK (4) • Constants.FV_COLOR_WHITE (5) • Constants.FV_COLOR_RED (6) •...

  • Page 61: Combinedfontdefn

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference CombinedFontDefn Property name Data Type Description NextCombinedFontDefnInDoc CombinedFontDefn Represents the next combined font definition instance in the document (FO_CombinedFontDefn ID). Name Indicates the name of the combined font. string BaseFamily Asian font family (specifies index into the arrays of font...

  • Page 62: Command

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Command Property name Data Type Description CanHaveCheckMark 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.
  • Page 63 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description • Constants.FV_ENABLE_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.
  • Page 64 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description HasShiftOrUnshiftCommand 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_UNSHIFT_COMMAND (2) • Constants.FV_ITEM_HAS_NO_SHIFT_OR_UNSHIFT_CO MMAND (3) HelpLink...
  • Page 65 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description MenuItemType 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.

  • Page 66: Compareret

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference CompareRet Property name Data Type Description Specifies the summary document. comp Specifies the composite document. CompareRet methods CompareRet. CondFmt Property name Data Type Description CondFmtIsShown Returns True if the condition is shown. To hide text with a...

  • Page 67: Constants

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description UseSepOverride Returns True if color specified by the SepOverride property is used instead of the default color. BkColor is the text background color property whose Color BkColor value is the color to be used.
  • Page 68 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FE_OutOfRange Value: -7 Constants.FE_DocModified Value: -8 Constants.FE_GroupSelect Value: -9 Constants.FE_WithinFrame Value: -10 Constants.FE_NotGraphic Value: -11 Constants.FE_NotFrame Value: -12 Constants.FE_NotGroup Value: -13 Constants.FE_BadNewFrame Value: -14 Constants.FE_BadNewGroup Value: -15 Constants.FE_BadNewSibling Value: -16 Constants.FE_BadDelete...
  • Page 69 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FE_NotPgf Value: -25 Constants.FE_NotBookComponent Value: -26 Constants.FE_BadOperation Value: -27 Constants.FE_BadElementDefId Value: -28 Constants.FE_BadElementId Value: -29 Constants.FE_BadNotificationNum Value: -30 Constants.FE_BadContainer Value: -104 Constants.FE_BadTemplatePath Value: -105 Constants.FE_BadXmlApplication Value: -106 Constants.FE_DupName Value: -32 Constants.FE_BadName...
  • Page 70 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FE_NotTextObject Value: -41 Constants.FE_SystemError Value: -42 Constants.FE_BadParameter Value: -43 Constants.FE_Canceled Value: -44 Constants.FE_FailedState Value: -45 Constants.FE_WantsCustom Value: -46 Constants.FE_WantsLandscape Value: -47 Constants.FE_WantsPortrait Value: -48 Constants.FE_ViewOnly Value: -49 Constants.FE_BadSaveFileName Value: -50 Constants.FE_GenRuleItemExpected...
  • Page 71 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FE_BadSelectionForOperation Value: -59 Constants.FE_WrongProduct Value: -60 Constants.FE_BookStructured Value: -61 Constants.FE_BadRefFlowId Value: -62 Constants.FE_FlowStructured Value: -63 Constants.FE_BadRefElementId Value: -64 Constants.FE_BadInsertPos Value: -65 Constants.FE_BadBookId Value: -66 Constants.FE_BookUnStructured Value: -67 Constants.FE_BadCompPath Value: -68 Constants.FE_BadElementSelection...
  • Page 72 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FE_BadMenuBar Value: -77 Constants.FE_PropNotSet Value: -78 Constants.FE_InvAttributeDef Value: -79 Constants.FE_InvAttribute Value: -80 Constants.FE_CircularReference Value: -81 Constants.FE_NoSuchFlow Value: -82 Constants.FE_BadFileType Value: -83 Constants.FE_MissingFile Value: -84 Constants.FE_CantUpdateMacEdition Value: -85 Constants.FE_CanceledByClient Value: -86 Constants.FE_EmptyTextObject...
  • Page 73 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FE_NotFound Value: -95 Constants.FE_LanguageNotAvailable Value: -96 Constants.FE_BadBaseColor Value: -97 Constants.FE_BadFamilyName Value: -98 Constants.FE_BadInkName Value: -99 Constants.FE_ReservedColor Value: -100 Constants.FE_TableInLockedTi Value: -101 Constants.FE_XRefUnresolved Value: -102 Constants.FE_BadXRefSrcDocId Value: -103 Constants.FE_InvalidAttrExpr Value: -107 Constants.FE_DocAlreadyHasTrackedEdits...
  • Page 74 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FR_ECMImportSuccess Value: -10003 Constants.FR_SkipStep Value: -10004 Constants.FR_YesOperation Value: -10005 Constants.FR_NoOperation Value: -10006 Constants.FR_DisplayedXRefDialog Value: -10007 Constants.FR_ClosedXRefDialog Value: -10008 Constants.FR_DisplayedModelessDialogForNonContainer Elem Value: -10009 Constants.FR_CancelInsertElementOperation Value: -10010 Constants.FR_HideDialogOnClose Value: -10011 Constants.FR_DisplayedModalDialogForNonContainerEle Value: -10012 Constants.FV_ACCESSBAR_OPEN...
  • Page 75 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_GRAPHIC Value: 9 Constants.FV_THESAURUS Value: 10 Constants.FV_TEMPLATE_BROWSER Value: 11 Constants.FV_HIST Value: 12 Constants.FV_TBL_CATALOG Value: 13 Constants.FV_HELP_INDEX Value: 0 Constants.FV_HELP_KEYS Value: 1 Constants.FV_HELP_SAMPLES Value: 2 Constants.FV_HELP_OVERVIEW Value: 3 Constants.FV_HELP_ONLINE_MANUALS Value: 4 Constants.FV_HELP_CONTEXT...
  • Page 76 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_DIALOG_DOCK_BOTTOM Value: 0x08 Constants.FV_DIALOG_DOCK_ALL Value: 0xFF Constants.IsDialogDocked Value: 2345 Constants.IsDialogVisible Value: 2346 Constants.AlertClientUnique Value: 2290 Constants.AlertClientName Value: 2291 Constants.AlertString Value: 2292 Constants.AlertType Value: 2293 Constants.FV_AlertOneButton Value: 1 Constants.FV_AlertTwoButton Value: 2 Constants.FV_AlertThreeButton...
  • Page 77 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FF_Custom_SingleSided Value: 0 Constants.FF_Custom_FirstPageRight Value: 1 Constants.FF_Custom_FirstPageLeft Value: 2 Constants.FF_CLOSE_MODIFIED Value: 1 Constants.FF_CMP_SUMMARY_ONLY Value: 0x01 Constants.FF_CMP_CHANGE_BARS Value: 0x02 Constants.FF_CMP_HYPERLINKS Value: 0x04 Constants.FF_CMP_SUMKIT Value: 0x08 Constants.FF_CMP_COMPKIT Value: 0x10 Constants.FF_CMP_ATTRIBUTES Value: 0x20 Constants.FF_IMAGE_BACKGROUND...
  • Page 78 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FF_ATTACH_BORDER_PAGENUM Value: 0x0002 Constants.FF_ATTACH_BORDER_ZOOM Value: 0x0004 Constants.FF_ATTACH_BORDER_PAGEUPDOWN Value: 0x0008 Constants.FF_ATTACH_BORDER_RIGHTICONS Value: 0x0010 Constants.FF_ATTACH_ALL Value: (0x0001|0x0002|0x0004|0x0008|0x0010) Constants.FF_UFF_PGF Value: 0x0001 Constants.FF_UFF_FONT Value: 0x0002 Constants.FF_UFF_PAGE Value: 0x0004 Constants.FF_UFF_TABLE Value: 0x0008 Constants.FF_UFF_COND Value: 0x0010 Constants.FF_UFF_REFPAGE...
  • Page 79 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FF_UFF_REMOVE_PAGE_BREAKS Value: 0x4000 Constants.FF_UFF_REMOVE_EXCEPTIONS Value: 0x8000 Constants.FF_UFF_ALL Value: 0xFFFF Constants.FF_INTERACTIVE Value: 0x0001 Constants.FF_CUT_TBL_CELLS Value: 0x0002 Constants.FF_DONT_DELETE_HIDDEN_TEXT Value: 0x0004 Constants.FF_INSERT_BELOW_RIGHT Value: 0x0008 Constants.FF_VISIBLE_ONLY Value: 0x0010 Constants.FF_REPLACE_CELLS Value: 0x0020 Constants.FF_DONT_APPLY_ALL_ROWS Value: 0x0040 Constants.FF_STRIP_HYPERTEXT...
  • Page 80 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FF_PASTE_CLIP_TEXT Value: 12 Constants.FF_COPY_TO_CLIP Value: 13 Constants.FF_CELL_SEL Value: 21 Constants.FF_CELL_EXT Value: 22 Constants.FF_TABLE_SELALL Value: 23 Constants.FF_CELL_RES Value: 24 Constants.FF_CELLS_RES Value: 25 Constants.FF_VIEWER_MENU Value: 32 Constants.FF_CONTEXT_MENU Value: 33 Constants.FF_STRUCTURE_MENU Value: 34 Constants.FF_HYPERTEXT...
  • Page 81 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FF_BUBBLE_EXT Value: 54 Constants.FF_BUBBLE_COPY Value: 55 Constants.FF_COLLAPSE_ELEM Value: 56 Constants.FF_COLLAPSE_ALL Value: 57 Constants.FF_OPEN_BOOK_COMP Value: 58 Constants.FF_PASTE_CLIP_OBJ Value: 61 Constants.FF_OBJ_SEL Value: 62 Constants.FF_OBJ_EXT Value: 63 Constants.FF_OBJ_EXT_BOR Value: 64 Constants.FF_OBJ_Q_COPY Value: 65 Constants.FF_OBJ_ROTATE...
  • Page 82 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FF_RES_VERTEX Value: 83 Constants.FF_RES_ADD Value: 84 Constants.FF_RES_DEL Value: 85 Constants.FF_SHIFT_KEY Value: 0x0001 Constants.FF_CONTROL_KEY Value: 0x0002 Constants.FF_ALT_KEY Value: 0x0004 Constants.FF_CMD_KEY Value: 0x0010 Constants.FF_ATTRDISP Value: 86 Constants.FF_ATTRDISP_ALL Value: 87 Constants.FF_EDIT_ATTRIBUTE Value: 88 Constants.FF_ATTR_SEL...
  • Page 83 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FS_DisallowDoc Value: 8 Constants.FS_DisallowBookMIF Value: 9 Constants.FS_DisallowBookDoc Value: 10 Constants.FS_DisallowFilterTypes Value: 11 Constants.FS_DisallowPlainText Value: 12 Constants.FS_ForceOpenAsText Value: 13 Constants.FS_UseRecoverFile Value: 14 Constants.FS_UseAutoSaveFile Value: 15 Constants.FV_DoCancel Value: 0 Constants.FV_DoOK Value: 1 Constants.FV_DoYes...
  • Page 84 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_ResetLockAndContinue Value: 7 Constants.FV_OpenEditableCopy Value: 8 Constants.FS_BookIsInUse Value: 18 Constants.FS_LockCantBeReset Value: 19 Constants.FS_FileIsOldVersion Value: 20 Constants.FS_FileIsStructured Value: 21 Constants.FV_StripStructureAndOpen Value: 10 Constants.FS_FontNotFoundInDoc Value: 22 Constants.FS_FontChangedMetric Value: 23 Constants.FS_RefFileNotFound Value: 24 Constants.FV_AllowAllRefFilesUnFindable...
  • Page 85 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FS_BeefyDoc Value: 32 Constants.FS_DisallowSgml Value: 33 Constants.FS_FileTypeHint Value: 34 Constants.FS_UpdateTextReferences Value: 35 Constants.FS_UpdateXRefs Value: 36 Constants.FS_OpenDocFluid Value: 37 Constants.FV_DoUserPreference Value: 12 Constants.FS_StructuredOpenApplication Value: 38 Constants.FS_SgmlBookFileName Value: 39 Constants.FS_OpenFileNotWritable Value: 40 Constants.FS_OpenAsType...
  • Page 86 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FS_OpenBookViewOnly Value: 42 Constants.FS_DisallowXml Value: 43 Constants.FS_NoStructuredErrorLog Value: 44 Constants.FS_VerifyInsets Value: 45 Constants.FS_NumOpenParams Value: 45 Constants.FS_OpenedFileName Value: 1 Constants.FS_OpenNativeError Value: 2 Constants.FS_OpenStatus Value: 3 Constants.FS_NumOpenReturnParams Value: 3 Constants.FV_NumOpenStatusFields Value: 5 Constants.FV_LockWasReset...
  • Page 87 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_FileHasNewName Value: 32 Constants.FV_RecoverFileUsed Value: 33 Constants.FV_AutoSaveFileUsed Value: 34 Constants.FV_FileWasFiltered Value: 35 Constants.FV_FontsWereMapped Value: 36 Constants.FV_FontMetricsChanged Value: 37 Constants.FV_FontsMappedInCatalog Value: 38 Constants.FV_LanguagesWerentFound Value: 39 Constants.FV_BeefyDoc Value: 40 Constants.FV_FileIsOldVersion Value: 41 Constants.FV_FileStructureStripped...
  • Page 88 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_UnresolvedTextInsets Value: 50 Constants.FV_OpenedFluid Value: 51 Constants.FV_FontsWithUnavailableEncodingsUsed Value: 53 Constants.FV_FileHadStructure Value: 64 Constants.FV_FileAlreadyOpenThisSession Value: 65 Constants.FV_BadFileType Value: 66 Constants.FV_BadFileName Value: 67 Constants.FV_CantNewBooks Value: 68 Constants.FV_CantOpenBooksViewOnly Value: 69 Constants.FV_BadScriptValue Value: 70 Constants.FV_MissingScript...
  • Page 89 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_CancelUseRecoverFile Value: 96 Constants.FV_CancelUseAutoSaveFile Value: 97 Constants.FV_CancelFileIsText Value: 98 Constants.FV_CancelFileIsInUse Value: 99 Constants.FV_CancelFileHasStructure Value: 100 Constants.FV_CancelReferencedFilesNotFound Value: 101 Constants.FV_CancelLanguagesNotFound Value: 102 Constants.FV_CancelFontsMapped Value: 103 Constants.FV_CancelFontMetricsChanged Value: 104 Constants.FV_CancelFontsMappedInCatalog Value: 105 Constants.FV_CancelFileIsDoc...
  • Page 90 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_CancelBeefyDoc Value: 114 Constants.FV_CancelFileIsSgml Value: 115 Constants.FV_CancelFontsWithUnavailableEncodings Value: 116 Constants.FV_CancelOpenFileNotWritable Value: 117 Constants.FV_CancelTempDiskFull Value: 118 Constants.FV_CancelFileIsXml Value: 119 Constants.FV_TooManyWindows Value: 128 Constants.FV_BadTemplate Value: 129 Constants.FV_FileNotReadable Value: 130 Constants.FS_FileType Value: 1 Constants.FV_SaveFmtBinary...
  • Page 91 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_SaveFmtXml Value: 10 Constants.FV_SaveFmtBinary60 Value: 11 Constants.FV_SaveFmtBinary70 Value: 12 Constants.FV_SaveFmtBinary80 Value: 13 Constants.FV_SaveFmtInterchange70 Value: 14 Constants.FV_SaveFmtInterchange80 Value: 15 Constants.FV_SaveFmtBinary90 Value: 16 Constants.FV_SaveFmtInterchange90 Value: 17 Constants.FV_SaveFmtCompositeDoc Value: 18 Constants.FV_SaveFmtBookWithXml Value: 19 Constants.FV_SaveFmtBookWithFm...
  • Page 92 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_SaveAsUseFileName Value: 1 Constants.FV_SaveAsNameProvided Value: 2 Constants.FS_AutoBackupOnSave Value: 6 Constants.FV_SaveYesAutoBackup Value: 0 Constants.FV_SaveNoAutoBackup Value: 1 Constants.FV_SaveUserPrefAutoBackup Value: 2 Constants.FS_MakePageCount Value: 7 Constants.FV_UseCurrentSetting Value: 0 Constants.FV_DontChangePageCount Value: 1 Constants.FV_MakePageCountEven Value: 2 Constants.FV_MakePageCountOdd...
  • Page 93 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FS_SaveTextExtraBlankLineAtEOP Value: 10 Constants.FS_UseDefaultUNIXpermissions Value: 11 Constants.FS_RetainNameStripe Value: 12 Constants.FS_UNIXpermissions Value: 13 Constants.FS_UpdateFRVList Value: 14 Constants.FS_SaveFileTypeHint Value: 16 Constants.FS_StructuredSaveApplication Value: 18 Constants.FS_SaveFileNotWritable Value: 20 Constants.FS_ModDateChanged Value: 21 Constants.FS_DitavalFile Value: 22 Constants.FS_DitavalCondTag...
  • Page 94 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_FileNotWritable Value: 33 Constants.FV_BadSaveFileName Value: 34 Constants.FV_BadFileId Value: 35 Constants.FV_BadSaveScriptValue Value: 36 Constants.FV_NonPortableSaveName Value: 37 Constants.FV_NonPortableFileRefs Value: 38 Constants.FV_ProductIsMaker Value: 39 Constants.FV_BadSaveObjectId Value: 40 Constants.FV_Unstructured Value: 41 Constants.FV_InvalidSaveFilter Value: 42 Constants.FV_UserCanceledSave...
  • Page 95 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_DoByCopy Value: 6 Constants.FV_DoUserChoice Value: 7 Constants.FS_ManualUpdate Value: 5 Constants.FS_TextInsetName Value: 6 Constants.FS_DisallowGraphicTypes Value: 9 Constants.FS_DisallowMacEditions Value: 10 Constants.FS_FileIsGraphic Value: 13 Constants.FS_FitGraphicInSelectedRect Value: 14 Constants.FS_GraphicDpi Value: 15 Constants.FV_DoImportAsTable Value: 8 Constants.FS_ForceImportAsText...
  • Page 96 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_SourceDoc Value: 0 Constants.FV_EnclosingDoc Value: 1 Constants.FV_PlainText Value: 2 Constants.FS_RemoveManualPageBreaks Value: 23 Constants.FS_RemoveOverrides Value: 24 Constants.FS_ImportTblTag Value: 25 Constants.FS_TblNumHeadingRows Value: 26 Constants.FS_LeaveHeadingRowsEmpty Value: 27 Constants.FS_TreatParaAsRow Value: 28 Constants.FS_CellSeparator Value: 29 Constants.FS_NumCellSeparators...
  • Page 97 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FS_RasterImageHeight Value: 40 Constants.FS_ShowRasterDpiDialog Value: 41 Constants.FS_NumImportParams Value: 45 Constants.FS_InsetData Value: 50 Constants.FS_UseHTTP Value: 51 Constants.FS_PDFPageNum Value: 45 Constants.FS_ImportedFileName Value: 1 Constants.FS_ImportNativeError Value: 2 Constants.FS_ImportStatus Value: 3 Constants.FS_NumImportReturnParams Value: 3 Constants.FV_NumImportStatusFields...
  • Page 98 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_ImportedMacEdition Value: 7 Constants.FV_ImportedSgmlDoc Value: 8 Constants.FV_ImportedXmlDoc Value: 9 Constants.FV_BadImportFileName Value: 16 Constants.FV_BadImportFileType Value: 17 Constants.FV_BadImportScriptValue Value: 18 Constants.FV_MissingImportScript Value: 19 Constants.FV_CantForceImportAsText Value: 20 Constants.FV_DisallowedImportType Value: 21 Constants.FV_NoMainFlow Value: 22 Constants.FV_NoFlowWithSpecifiedName...
  • Page 99 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_CancelFileText Value: 32 Constants.FV_CancelFileDoc Value: 33 Constants.FV_CancelFileMIF Value: 34 Constants.FV_CancelFileFilterable Value: 35 Constants.FV_CancelFileGraphic Value: 36 Constants.FV_UserCanceledImport Value: 37 Constants.FV_CancelImportBrowser Value: 38 Constants.FV_CancelFileIsMacEdition Value: 39 Constants.FV_CancelFileSgml Value: 40 Constants.FV_CancelFileXml Value: 41 Constants.FV_ImportFileNotReadable...
  • Page 100 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FS_ExportFileTypeHint Value: 14 Constants.FS_StructuredExportApplication Value: 16 Constants.FS_ImportExportVersion Value: 17 Constants.FS_NumExportParams Value: 17 Constants.FS_ExportFileName Value: 1 Constants.FS_ExportNativeError Value: 2 Constants.FS_ExportStatus Value: 3 Constants.FV_NumExportStatusFields Value: 2 Constants.FS_NumExportReturnParams Value: 3 Constants.FV_ExportFileHasNewName Value: 0 Constants.FV_ExportProductIsViewer...
  • Page 101 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_BadExportScriptValue Value: 21 Constants.FV_FilterFailed Value: 22 Constants.FV_InvalidExportFilter Value: 23 Constants.FV_UserCanceledExport Value: 32 Constants.FV_CanceledExportObjectNeedsDpi Value: 33 Constants.FV_ApiClientCanceledExport Value: 34 Constants.FS_AllowNonFMFiles Value: 1 Constants.FS_AllowViewOnlyFiles Value: 3 Constants.FS_ShowBookErrorLog Value: 4 Constants.FS_AllowInconsistentNumProps Value: 6 Constants.FS_UpdateBookGeneratedFiles...
  • Page 102 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FS_NumUpdateBookReturnParams Value: 1 Constants.FV_NumUpdateBookStatusFields Value: 4 Constants.FV_BookNotSelfConsistent Value: 0 Constants.FV_DuplicateFileInBook Value: 1 Constants.FV_NoNonGeneratedFilesInBook Value: 2 Constants.FV_CancelNonFMFileInBook Value: 32 Constants.FV_CancelViewOnlyFileInBook Value: 33 Constants.FV_CancelInconsistentNumPropsInFileInBook Value: 34 Constants.FV_UserCanceledUpdateBook Value: 35 Constants.FV_BadUpdateBookFileId Value: 64 Constants.FV_BadUpdateBookScriptValue...
  • Page 103 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_Below Value: 1241 Constants.FV_Left Value: 1242 Constants.FV_Right Value: 1243 Constants.FV_ChooseSelect Value: 0x00000000 Constants.FV_ChooseOpen Value: 0x00000001 Constants.FV_ChooseSave Value: 0x00000002 Constants.FV_ChooseOpenDir Value: 0x00000004 Constants.FV_ChooseMultiSelect Value: 0x00000008 Constants.FV_ChooseMultiOpen Value: 0x00000010 Constants.FV_BrowseLocalOnly Value: 0x00010000 Constants.FV_BrowseCmsOnly...
  • Page 104 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FA_Note_PreOpenMIF Value: 3 Constants.FA_Note_PostOpenMIF Value: 4 Constants.FA_Note_PreSaveDoc Value: 5 Constants.FA_Note_PostSaveDoc Value: 6 Constants.FA_Note_PreSaveMIF Value: 7 Constants.FA_Note_PostSaveMIF Value: 8 Constants.FA_Note_PreFileType Value: 9 Constants.FA_Note_PostFileType Value: 10 Constants.FA_Note_PreQuitDoc Value: 11 Constants.FA_Note_DirtyDoc Value: 12 Constants.FA_Note_ClientCall...
  • Page 105 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FA_Note_PostSaveBook Value: 21 Constants.FA_Note_PreSaveBookMIF Value: 22 Constants.FA_Note_PostSaveBookMIF Value: 23 Constants.FA_Note_PreQuitBook Value: 24 Constants.FA_Note_DirtyBook Value: 25 Constants.FA_Note_PreQuitSession Value: 26 Constants.FA_Note_PostQuitSession Value: 27 Constants.FA_Note_PreRevertDoc Value: 28 Constants.FA_Note_PostRevertDoc Value: 29 Constants.FA_Note_PreRevertBook Value: 30 Constants.FA_Note_PostRevertBook...
  • Page 106 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FA_Note_PostImport Value: 39 Constants.FA_Note_PostQuitDoc Value: 40 Constants.FA_Note_PostQuitBook Value: 41 Constants.FA_Note_PreFunction Value: 42 Constants.FA_Note_PostFunction Value: 43 Constants.FA_Note_PreMouseCommand Value: 44 Constants.FA_Note_PostMouseCommand Value: 45 Constants.FA_Note_PreHypertext Value: 46 Constants.FA_Note_PostHypertext Value: 47 Constants.FA_Note_PrePrint Value: 48 Constants.FA_Note_PostPrint...
  • Page 107 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FA_Note_PostWrapElement Value: 57 Constants.FA_Note_PreDragElement Value: 58 Constants.FA_Note_PostDragElement Value: 59 Constants.FA_Note_PreCopyElement Value: 60 Constants.FA_Note_PostCopyElement Value: 61 Constants.FA_Note_PreSetAttrValue Value: 62 Constants.FA_Note_PostSetAttrValue Value: 63 Constants.FA_Note_PreImportElemDefs Value: 64 Constants.FA_Note_PostImportElemDefs Value: 65 Constants.FA_Note_ECMInternal Value: 66 Constants.FA_Note_PreExport...
  • Page 108 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FA_Note_FilterFileToFile Value: 75 Constants.FA_Note_PreBookComponentOpen Value: 76 Constants.FA_Note_PostBookComponentOpen Value: 77 Constants.FA_Note_PreGenerate Value: 78 Constants.FA_Note_PostGenerate Value: 79 Constants.FA_Note_PreGoToXrefSrc Value: 80 Constants.FA_Note_PostGoToXrefSrc Value: 81 Constants.FA_Note_PreOpenSGML Value: 82 Constants.FA_Note_PostOpenSGML Value: 83 Constants.FA_Note_Dialog Value: 84 Constants.FA_Note_Alert...
  • Page 109 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FA_Note_UndoCheckpoint Value: 93 Constants.FA_Note_FileOpen Value: 94 Constants.FA_Note_PreOpenXML Value: 95 Constants.FA_Note_PostOpenXML Value: 96 Constants.FA_Note_PreSaveXML Value: 97 Constants.FA_Note_PostSaveXML Value: 98 Constants.FA_Note_PreSaveSGML Value: 99 Constants.FA_Note_PostSaveSGML Value: 100 Constants.FA_Note_U3DCommand Value: 101 Constants.FA_Note_Not_U3DCommand Value: 102 Constants.FA_Note_Not_RSC_Supported_File...
  • Page 110 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FA_Note_InsertConRef Value: 111 Constants.FA_Note_GenerateFM Value: 112 Constants.FA_Note_OpenAllTopicrefs Value: 113 Constants.FA_Note_UpdateRefs Value: 114 Constants.FA_Note_AssignId Value: 115 Constants.FA_Note_DITAOptions Value: 116 Constants.FA_Note_NewDitamapFile Value: 117 Constants.FA_Note_NewBookmapFile Value: 118 Constants.FA_Note_NewTopicFile Value: 119 Constants.FA_Note_NewTaskFile Value: 120 Constants.FA_Note_NewConceptFile...
  • Page 111 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FA_Note_UpdateRefs_On_Save Value: 129 Constants.FA_Note_Read_Struct_App Value: 130 Constants.FA_Note_Struct_Wizard Value: 131 Constants.FA_Note_Open_Dtd Value: 132 Constants.FA_Note_Open_Schema Value: 133 Constants.FA_Note_Open_EDD_For_App Value: 134 Constants.FA_Note_PostSetPropertyValue Value: 135 Constants.FA_Note_Not_AI_Supported_File Value: 136 Constants.FA_Note_AI_Supported_File Value: 137 Constants.FA_Note_Poster_Applied Value: 138 Constants.FA_Note_Num...
  • Page 112 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FTI_PageBegin Value: 0x00000080 Constants.FTI_PageEnd Value: 0x00000100 Constants.FTI_SubColBegin Value: 0x00000200 Constants.FTI_SubColEnd Value: 0x00000400 Constants.FTI_FrameAnchor Value: 0x00000800 Constants.FTI_FnAnchor Value: 0x00001000 Constants.FTI_TblAnchor Value: 0x00002000 Constants.FTI_MarkerAnchor Value: 0x00004000 Constants.FTI_XRefBegin Value: 0x00008000 Constants.FTI_XRefEnd Value: 0x00010000 Constants.FTI_VarBegin...
  • Page 113 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FTI_TextInsetBegin Value: 0x02000000 Constants.FTI_TextInsetEnd Value: 0x04000000 Constants.FTI_ElemPrefixBegin Value: 0x08000000 Constants.FTI_ElemPrefixEnd Value: 0x10000000 Constants.FTI_ElemSuffixBegin Value: 0x20000000 Constants.FTI_ElemSuffixEnd Value: 0x40000000 Constants.FTI2_RubiTextBegin Value: 0x80000001 Constants.FTI2_RubiTextEnd Value: 0x80000002 Constants.FTI2_RubiCompositeBegin Value: 0x80000004 Constants.FTI2_RubiCompositeEnd Value: 0x80000008 Constants.FTI_HardLineEnd...
  • Page 114 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FTF_OVERLINE Value: 0x02000000 Constants.FTF_CHANGEBAR Value: 0x01000000 Constants.FTF_OUTLINE Value: 0x00800000 Constants.FTF_SHADOW Value: 0x00400000 Constants.FTF_PAIRKERN Value: 0x00200000 Constants.FTF_SIZE Value: 0x00100000 Constants.FTF_KERNX Value: 0x00080000 Constants.FTF_KERNY Value: 0x00040000 Constants.FTF_SPREAD Value: 0x00020000 Constants.FTF_COLOR Value: 0x00010000 Constants.FTF_CHARTAG...
  • Page 115 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FTF_CONDITIONTAG Value: 0x00000001 Constants.FTF_ALL Value: 0xFFFFFE03 Constants.FV_OBJ_END_OFFSET Value: 0x50000000 Constants.FT_Bad Value: 0 Constants.FT_Integer Value: 1 Constants.FT_Metric Value: 2 Constants.FT_String Value: 3 Constants.FT_Id Value: 4 Constants.FT_Metrics Value: 5 Constants.FT_Strings Value: 6 Constants.FT_Points...
  • Page 116 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FT_UInts Value: 15 Constants.FT_FormatBranches Value: 16 Constants.FT_AttributeDefs Value: 17 Constants.FT_Attributes Value: 18 Constants.FT_ElementRange Value: 19 Constants.FT_Vals Value: 20 Constants.FT_AttributesEx Value: 21 Constants.FT_Num Value: 22 Constants.FI_PLUGIN_PRODUCTNAME Value: 1 Constants.FI_PLUGIN_NAME Value: 2 Constants.FI_PLUGIN_TYPE...
  • Page 117 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FI_PLUGIN_OUTFORMAT Value: 11 Constants.FO_Session Value: 0 Constants.FO_StringResource Value: 1 Constants.FO_Book Value: 2 Constants.FO_BookComponent Value: 3 Constants.FO_Doc Value: 4 Constants.FO_BodyPage Value: 5 Constants.FO_MasterPage Value: 6 Constants.FO_RefPage Value: 7 Constants.FO_HiddenPage Value: 8 Constants.FO_Last_Page...
  • Page 118 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FO_Polygon Value: 16 Constants.FO_Line Value: 17 Constants.FO_TextLine Value: 18 Constants.FO_TextFrame Value: 19 Constants.FO_Inset Value: 20 Constants.FO_Math Value: 21 Constants.FO_DBGroup Value: 22 Constants.FO_Last_Graphic Value: 22 Constants.FO_AFrame Value: 23 Constants.FO_XLast_Graphic Value: 23 Constants.FO_Marker...
  • Page 119 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FO_PgfFmt Value: 32 Constants.FO_CharFmt Value: 33 Constants.FO_CondFmt Value: 34 Constants.FO_Color Value: 35 Constants.FO_Tbl Value: 36 Constants.FO_TblFmt Value: 37 Constants.FO_Row Value: 38 Constants.FO_Cell Value: 39 Constants.FO_RulingFmt Value: 40 Constants.FO_ElementDef Value: 41 Constants.FO_Element...
  • Page 120 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FO_DlgEditBox Value: 50 Constants.FO_DlgRadioButton Value: 51 Constants.FO_DlgLabel Value: 52 Constants.FO_DlgImage Value: 53 Constants.FO_DlgScrollBar Value: 54 Constants.FO_Menu Value: 55 Constants.FO_Command Value: 56 Constants.FO_MenuItemSeparator Value: 57 Constants.FO_FmtChangeList Value: 58 Constants.FO_FmtRule Value: 59 Constants.FO_FmtRuleClause...
  • Page 121 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FO_Rubi Value: 68 Constants.FO_Alert Value: 69 Constants.FO_CursorResource Value: 70 Constants.FO_AttrCondExpr Value: 71 Constants.FO_DlgListView Value: 72 Constants.FO_Num Value: 73 Constants.FO_First_Internal Value: 73 Constants.FO_Page Value: (73+0) Constants.FO_Graphic Value: (73+1) Constants.FO_Frame Value: (73+2) Constants.FO_Cblock...
  • Page 122 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FO_MenuCell Value: (73+11) Constants.FO_TextInset Value: (73+12) Constants.FO_DitaMap Value: (73+13) Constants.FO_Last_Internal Value: (73+14) Constants.FO_CMSConnection Value: (73+15) Constants.FO_CMSObject Value: (73+16) Constants.FO_Bad Value: 255 Constants.FO_AnchoredFrame Value: 23 Constants.FO_UFrame Value: 9 Constants.Name Value: 20 Constants.Unique...
  • Page 123 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.ScreenWidth Value: 35 Constants.ScreenHeight Value: 36 Constants.FV_SessionId Value: 0 Constants.VersionRevision Value: 41 Constants.ProductName Value: 42 Constants.VersionMajor Value: 43 Constants.VersionMinor Value: 44 Constants.Platform Value: 45 Constants.OperatingSystem Value: 46 Constants.WindowSystem Value: 47 Constants.AutoSave...
  • Page 124 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.UndoFDKRecording Value: 2403 Constants.StackWarningLevel Value: 2404 Constants.NoFlashInPDF Value: 2405 Constants.No3DInPDF Value: 2406 Constants.InsetURL Value: 2407 Constants.DontShowWelcomeScreen Value: 2408 Constants.TechSuiteInternal Value: 2409 Constants.IsTechnicalSuiteLicensed Value: 2410 Constants.TechSuiteInternal2 Value: 2411 Constants.IsFMRunningInTrialPeriod Value: 2412 Constants.EnableAutoSpellCheck...
  • Page 125 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FirstOpenDoc Value: 53 Constants.FirstOpenBook Value: 54 Constants.FontFamilyNames Value: 55 Constants.FontVariationNames Value: 56 Constants.FontWeightNames Value: 57 Constants.FontAngleNames Value: 58 Constants.MarkerNames Value: 59 Constants.FontFamilyAttributes Value: 60 Constants.FV_FAMILY_VISIBLE Value: 0x00000001 Constants.FV_FAMILY_SELECTABLE Value: 0x00000002 Constants.FV_FAMILY_MAPPED...
  • Page 126 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.DisableAutofitAfterZoom Value: 67 Constants.DefaultFontFamily Value: 68 Constants.DefaultFontVariation Value: 69 Constants.DefaultFontWeight Value: 70 Constants.DefaultFontAngle Value: 71 Constants.CTFontContext Value: 72 Constants.FontFamilyFullNames Value: 73 Constants.RpcPropertyName Value: 76 Constants.RpcProgramNumber Value: 77 Constants.DisplayName Value: 78 Constants.ProcessNumber...
  • Page 127 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.TmpDir Value: 86 Constants.FM_HomeDir Value: 87 Constants.FM_BinDir Value: 88 Constants.FM_InitDir Value: 89 Constants.FM_CurrentDir Value: 90 Constants.FM_SgmlDir Value: 100 Constants.FM_StructureDir Value: 2031 Constants.FM_XmlDir Value: 2032 Constants.Reformatting Value: 91 Constants.Displaying Value: 92 Constants.ApplyFormatRules...
  • Page 128 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_MENU_COMPLETE Value: 2 Constants.FV_MENU_CUSTOM Value: 3 Constants.IconBarOn Value: 101 Constants.HelpPending Value: 102 Constants.FM_HelpDir Value: 103 Constants.PercentDone Value: 104 Constants.ActiveAlert Value: 105 Constants.Snap Value: 151 Constants.Gravity Value: 107 Constants.KByteAllocationSize Value: 106 Constants.ImportFilters...
  • Page 129 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_Hint_FormatId Value: 2 Constants.FV_Hint_Platform Value: 3 Constants.FV_Hint_FilterVersion Value: 4 Constants.FV_Hint_FilterName Value: 5 Constants.StatusLine Value: 108 Constants.TextSelection Value: 109 Constants.IsOnScreen Value: 110 Constants.NextOpenDocInSession Value: 111 Constants.FirstGraphicInDoc Value: 112 Constants.FirstPgfInDoc Value: 113 Constants.FirstMarkerInDoc...
  • Page 130 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FirstPgfFmtInDoc Value: 122 Constants.FirstCharFmtInDoc Value: 123 Constants.FirstCondFmtInDoc Value: 124 Constants.FirstTblFmtInDoc Value: 125 Constants.FirstRulingFmtInDoc Value: 126 Constants.FirstColorInDoc Value: 127 Constants.FirstSelectedGraphicInDoc Value: 128 Constants.SelectedTbl Value: 129 Constants.FileExtensionOverride Value: 2813 Constants.FirstAttrCondExprInDoc Value: 2815 Constants.DocOpenType...
  • Page 131 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.DocIsViewOnly Value: 133 Constants.ViewOnlyWinPalette Value: 134 Constants.ViewOnlyWinMenubar Value: 135 Constants.ViewOnlyWinBorders Value: 136 Constants.ViewOnlyWinPopup Value: 137 Constants.ViewOnlyXRef Value: 138 Constants.FV_VOX_NOT_ACTIVE Value: 0 Constants.FV_VOX_GOTO_BEHAVIOR Value: 1 Constants.FV_VOX_OPEN_BEHAVIOR Value: 2 Constants.FV_VOX_ALERT Value: 3 Constants.ViewOnlySelect...
  • Page 132 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.MenuBar Value: 143 Constants.ViewOnlyMenuBar Value: 144 Constants.DocSaveType Value: 145 Constants.Untouchable Value: 146 Constants.DocFluidFlow Value: 147 Constants.FirstMarkerTypeInDoc Value: 148 Constants.MarkerTypeNames Value: 149 Constants.AddMarkerTypeToStandardMarkers Value: 150 Constants.ShowAll Value: 155 Constants.ShowCondIndicators Value: 156 Constants.DontUpdateXRefs...
  • Page 133 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.SuperScriptStretch Value: 183 Constants.SubScriptStretch Value: 184 Constants.SmallCapsStretch Value: 185 Constants.RubiSize Value: 186 Constants.RubiFixedSize Value: 187 Constants.NarrowRubiSpaceForJapanese Value: 188 Constants.WideRubiSpaceForJapanese Value: 189 Constants.NarrowRubiSpaceForOther Value: 190 Constants.WideRubiSpaceForOther Value: 191 Constants.FV_WIDE Value: 0 Constants.FV_NARROW...
  • Page 134 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_NUM_READ_FROM_FILE Value: 0x00 Constants.FV_NUM_CONTINUE Value: 0x01 Constants.FV_NUM_RESTART Value: 0x02 Constants.FV_NUM_SAME Value: 0x03 Constants.FV_NUM_PERPAGE Value: 0x03 Constants.VolumeNumber Value: 212 Constants.VolumeNumStyle Value: 213 Constants.VolumeNumText Value: 214 Constants.ChapNumComputeMethod Value: 215 Constants.ChapterNumber Value: 216 Constants.ChapterNumStyle...
  • Page 135 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_NUMSTYLE_ZENKAKU_UC Value: 0x07 Constants.FV_NUMSTYLE_ZENKAKU_LC Value: 0x08 Constants.FV_NUMSTYLE_KANJI_KAZU Value: 0x09 Constants.FV_NUMSTYLE_DAIJI Value: 0x0a Constants.FV_NUMSTYLE_TEXT Value: 0x0b Constants.FV_NUMSTYLE_FULLWIDTH Value: 0x0c Constants.FV_NUMSTYLE_FULLWIDTH_UC Value: 0x0d Constants.FV_NUMSTYLE_FULLWIDTH_LC Value: 0x0e Constants.FV_NUMSTYLE_CHINESE_NUMERIC Value: 0x10 Constants.ChapterNumText Value: 218 Constants.FirstPageNum...
  • Page 136 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_PAGE_NUM_ZENKAKU Value: 0x06 Constants.FV_PAGE_NUM_ZENKAKU_UC Value: 0x07 Constants.FV_PAGE_NUM_ZENKAKU_LC Value: 0x08 Constants.FV_PAGE_NUM_KANJI_KAZU Value: 0x09 Constants.FV_PAGE_NUM_DAIJI Value: 0x0a Constants.FV_PAGE_NUM_FULLWIDTH Value: 0x0c Constants.FV_PAGE_NUM_FULLWIDTH_UC Value: 0x0d Constants.FV_PAGE_NUM_FULLWIDTH_LC Value: 0x0e Constants.FV_PAGE_NUM_CHINESE_NUMERIC Value: 0x10 Constants.DocIsDoubleSided Value: 226 Constants.FirstPageVerso...
  • Page 137 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_POINT_PAGE_NUM_ZENKAKU Value: 0x06 Constants.FV_POINT_PAGE_NUM_ZENKAKU_UC Value: 0x07 Constants.FV_POINT_PAGE_NUM_ZENKAKU_LC Value: 0x08 Constants.FV_POINT_PAGE_NUM_KANJI_KAZU Value: 0x09 Constants.FV_POINT_PAGE_NUM_DAIJI Value: 0x0a Constants.FV_POINT_PAGE_FULLWIDTH Value: 0x0c Constants.FV_POINT_PAGE_FULLWIDTH_UC Value: 0x0d Constants.FV_POINT_PAGE_FULLWIDTH_LC Value: 0x0e Constants.FV_POINT_PAGE_CHINESE_NUMERIC Value: 0x10 Constants.PageRounding Value: 229 Constants.FV_PR_DEL_EMPTY...
  • Page 138 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.ColGap Value: 234 Constants.NumCols Value: 235 Constants.CurrentPage Value: 236 Constants.SmartQuotes Value: 237 Constants.AutoChangeBars Value: 238 Constants.SmartSpaces Value: 239 Constants.CurrentInset Value: 240 Constants.ChangeBarDistance Value: 259 Constants.ChangeBarPosition Value: 260 Constants.FV_CB_COL_LEFT Value: 0x00 Constants.FV_CB_COL_RIGHT...
  • Page 139 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FnRefPrefix Value: 286 Constants.FnInstancePosition Value: 287 Constants.FV_FN_POS_SUPER Value: 0x00 Constants.FV_FN_POS_BASELINE Value: 0x01 Constants.FV_FN_POS_SUB Value: 0x02 Constants.FnInstanceSuffix Value: 288 Constants.FnHeightPerCol Value: 289 Constants.FnNumStyle Value: 290 Constants.FV_FN_NUM_NUMERIC Value: 0x00 Constants.FV_FN_NUM_ROMAN_UC Value: 0x01 Constants.FV_FN_NUM_ROMAN_LC...
  • Page 140 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_FN_NUM_KANJI_KAZU Value: 0x0A Constants.FV_FN_NUM_DAIJI Value: 0x0B Constants.FV_FN_NUM_FULL_WIDTH Value: 0x0C Constants.FV_FN_NUM_FULL_WIDTH_UC Value: 0x0D Constants.FV_FN_NUM_FULL_WIDTH_LC Value: 0x0E Constants.FV_FN_NUM_CHINESE_NUMERIC Value: 0x10 Constants.FnNumberingPerPage Value: 291 Constants.FnRefPosition Value: 292 Constants.FnRefSuffix Value: 293 Constants.FnInstancePrefix Value: 294 Constants.FnNumComputeMethod...
  • Page 141 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.TblFnPrefix Value: 322 Constants.TblFnSuffix Value: 323 Constants.TblFnNumComputeMethod Value: 324 Constants.Symbols Value: 334 Constants.SymbolsList Value: 335 Constants.Variables Value: 336 Constants.Strings Value: 337 Constants.Numbers Value: 338 Constants.Functions Value: 339 Constants.HorizontalSpreadSmall Value: 340 Constants.HorizontalSpreadMed...
  • Page 142 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.EqnSigmaSizeSmall Value: 349 Constants.EqnSigmaSizeMed Value: 350 Constants.EqnSigmaSizeLarge Value: 351 Constants.EqnLevel1SizeSmall Value: 352 Constants.EqnLevel1SizeMed Value: 353 Constants.EqnLevel1SizeLarge Value: 354 Constants.EqnLevel2SizeSmall Value: 355 Constants.EqnLevel2SizeMed Value: 356 Constants.EqnLevel2SizeLarge Value: 357 Constants.EqnLevel3SizeSmall Value: 358 Constants.EqnLevel3SizeMed...
  • Page 143 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_SCROLL_VERTICAL Value: 2 Constants.FV_SCROLL_FACING Value: 3 Constants.ViewGridUnits Value: 386 Constants.Zoom Value: 387 Constants.FV_NO_ZOOM_MANGLING Value: -1 Constants.FV_ZOOM_TO_FIT_TO_WINDOW Value: -2 Constants.FV_FIT_WINDOW_TO_PAGE Value: -3 Constants.ViewTextSymbols Value: 388 Constants.ViewGrid Value: 389 Constants.ViewDisplayUnits Value: 390 Constants.TrackChangesOn...
  • Page 144 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.ViewRulerUnits Value: 391 Constants.SpotColorView Value: 392 Constants.SnapGridUnits Value: 393 Constants.SnapAngle Value: 394 Constants.ViewLinkBoundaries Value: 395 Constants.ViewFontSizeUnits Value: 396 Constants.LeftMasterPage Value: 413 Constants.RightMasterPage Value: 414 Constants.FirstBodyPageInDoc Value: 415 Constants.LastBodyPageInDoc Value: 416 Constants.FirstMasterPageInDoc...
  • Page 145 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.PrintCols Value: 441 Constants.PrintRows Value: 442 Constants.PrintStartPage Value: 443 Constants.PrintStartPoint Value: 444 Constants.PrintOddPages Value: 445 Constants.PrintCollated Value: 446 Constants.PrintLowRes Value: 447 Constants.PrintThumbnails Value: 448 Constants.PrinterName Value: 449 Constants.PrintScale Value: 450 Constants.PrintFileName...
  • Page 146 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.PrintLastSheetFirst Value: 456 Constants.PrintRegistrationMarks Value: 457 Constants.PrintManualFeed Value: 458 Constants.PrintNumCopies Value: 459 Constants.PrintToFile Value: 460 Constants.PrintPaperWidth Value: 461 Constants.PrintPaperHeight Value: 462 Constants.PrintSeps Value: 463 Constants.SkipBlankSeps Value: 464 Constants.PrintImaging Value: 465 Constants.FV_IMG_POSITIVE...
  • Page 147 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.TrapwiseCompatibility Value: 495 Constants.DownloadFonts Value: 496 Constants.PrintSpotBW Value: 498 Constants.FV_PR_DOWNLOAD_NONE Value: 1 Constants.FV_PR_DOWNLOAD_ALL Value: 2 Constants.FV_PR_DOWNLOAD_ALL_BUT_STANDARD_13 Value: 3 Constants.FV_PR_DOWNLOAD_ALL_BUT_STANDARD_35 Value: 4 Constants.PrintDownloadAsianFonts Value: 501 Constants.PrintDownloadTrueTypeAsType1 Value: 502 Constants.GenerateAcrobatInfo Value: 2250 Constants.AcrobatBookmarkDisplayTags...
  • Page 148 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.PDFStructure Value: 2259 Constants.PDFDocInfo Value: 2260 Constants.PDFBookmark Value: 2261 Constants.FileInfoPacket Value: 2262 Constants.PDFJobOption Value: 2263 Constants.PDFOpenPage Value: 2264 Constants.PDFZoomType Value: 2265 Constants.FV_PDFZoomNone Value: 0 Constants.FV_PDFZoomDefault Value: 1 Constants.FV_PDFZoomPage Value: 2 Constants.FV_PDFZoomWidth...
  • Page 149 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.PDFSeparateFiles Value: 2267 Constants.PDFRegistrationMarks Value: 2268 Constants.PDFPageWidth Value: 2269 Constants.PDFPageHeight Value: 2270 Constants.PDFPrintPageRange Value: 2271 Constants.PDFStartPage Value: 2272 Constants.PDFEndPage Value: 2273 Constants.PDFConvertCMYKtoRGB Value: 2274 Constants.PDFBookmarksOpenLevel Value: 2275 Constants.PDFDistillerAbsent Value: 2276 Constants.PDFJobOptionsAbsent...
  • Page 150 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.MaxLeftIndent Value: 474 Constants.MinLeftIndent Value: 475 Constants.MaxRightIndent Value: 476 Constants.MinRightIndent Value: 477 Constants.MaxSpaceAbove Value: 478 Constants.MinSpaceAbove Value: 479 Constants.MaxSpaceBelow Value: 480 Constants.MinSpaceBelow Value: 481 Constants.MaxLeading Value: 482 Constants.MinLeading Value: 483 Constants.MaxFontSize...
  • Page 151 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.MaxRightMargin Value: 705 Constants.MinRightMargin Value: 706 Constants.MaxTopMargin Value: 707 Constants.MinTopMargin Value: 708 Constants.MaxBottomMargin Value: 709 Constants.MinBottomMargin Value: 710 Constants.MaxStretch Value: 711 Constants.MinStretch Value: 712 Constants.MagicMarker Value: 488 Constants.XmlVersion Value: 2800 Constants.XmlEncoding...
  • Page 152 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.XmlUseBOM Value: 2805 Constants.FV_XML_USEBOM_YES Value: 1 Constants.FV_XML_USEBOM_NO Value: 2 Constants.FV_XML_USEBOM_UTF8 Value: 3 Constants.FV_XML_USEBOM_UTF16BE Value: 4 Constants.FV_XML_USEBOM_UTF16LE Value: 5 Constants.FV_XML_USEBOM_UTF32BE Value: 6 Constants.FV_XML_USEBOM_UTF32LE Value: 7 Constants.XmlWellFormed Value: 2806 Constants.FV_XML_WELLFORMED_YES Value: 1 Constants.FV_XML_WELLFORMED_NO...
  • Page 153 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_URL_CHECKED_OUT Value: 2 Constants.NextOpenBookInSession Value: 490 Constants.FirstComponentInBook Value: 491 Constants.BookIsModified Value: 492 Constants.FirstSelectedComponentInBook Value: 493 Constants.BookDontUpdateReferences Value: 494 Constants.BookIsViewOnly Value: 497 Constants.BookIsSelected Value: 499 Constants.TypeOfDisplayText Value: 500 Constants.FV_BK_FILENAME Value: 1 Constants.FV_BK_TEXT...
  • Page 154 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_BK_START_FROM_FILE Value: 0x01 Constants.FV_BK_START_NEXT_AVAILABLE Value: 0x02 Constants.FV_BK_START_LEFT Value: 0x03 Constants.FV_BK_START_RIGHT Value: 0x04 Constants.PageNumComputeMethod Value: 524 Constants.PgfNumComputeMethod Value: 525 Constants.PrevComponentInBook Value: 526 Constants.NextComponentInBook Value: 527 Constants.InsertLinks Value: 528 Constants.ComponentIsSelected Value: 529 Constants.NextSelectedComponentInBook...
  • Page 155 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_BK_LIST_PGF_ALPHA Value: 6 Constants.FV_BK_INDEX_STAN Value: 7 Constants.FV_BK_INDEX_AUTHOR Value: 8 Constants.FV_BK_INDEX_SUBJECT Value: 9 Constants.FV_BK_INDEX_MARKER Value: 10 Constants.FV_BK_LIST_FORMATS Value: 11 Constants.FV_BK_LIST_REFERENCES Value: 12 Constants.FV_BK_INDEX_FORMATS Value: 13 Constants.FV_BK_INDEX_REFERENCES Value: 14 Constants.FV_BK_NUM_BOOK_LIST Value: 15 Constants.FV_BK_NOT_GENERATABLE...
  • Page 156 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.ComponentIsDitaMap Value: 2331 Constants.FV_BK_GENERAL Value: 0x1 Constants.FV_BK_FOLDER Value: 0x2 Constants.FV_BK_BOOK Value: 0x4 Constants.FV_BK_FM Value: 0x8 Constants.FV_BK_MIF Value: 0x10 Constants.FV_BK_XML Value: 0x20 Constants.FV_BK_GROUP Value: 0x40 Constants.FV_BK_DITAMAP Value: 0x80 Constants.FV_BK_BOOKMAP Value: 0x100 Constants.FV_BK_FILE...
  • Page 157 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FA_COMPONENT_MOVEDOWN Value: 2 Constants.FA_COMPONENT_PROMOTE Value: 3 Constants.FA_COMPONENT_DEMOTE Value: 4 Constants.PgfAlignment Value: 547 Constants.FV_PGF_LEFT Value: 0x01 Constants.FV_PGF_RIGHT Value: 0x02 Constants.FV_PGF_CENTER Value: 0x03 Constants.FV_PGF_JUSTIFIED Value: 0x04 Constants.AutoNumString Value: 548 Constants.AutoNumChar Value: 549 Constants.LetterSpace...
  • Page 158 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.Leading Value: 558 Constants.AdjHyphens Value: 559 Constants.HyphMinSuffix Value: 560 Constants.BlockLines Value: 561 Constants.PgfIsAutoNum Value: 562 Constants.NumAtEnd Value: 563 Constants.Hyphenate Value: 564 Constants.KeepWithNext Value: 565 Constants.UseNextTag Value: 566 Constants.Start Value: 567 Constants.FV_PGF_ANYWHERE...
  • Page 159 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.MinSpace Value: 571 Constants.MaxSpace Value: 572 Constants.NumTabs Value: 573 Constants.Tabs Value: 574 Constants.HyphMinPrefix Value: 575 Constants.HyphMinWord Value: 576 Constants.Language Value: 577 Constants.FV_LANG_NOLANGUAGE Value: 0x00 Constants.FV_LANG_ENGLISH Value: 0x01 Constants.FV_LANG_BRITISH Value: 0x02 Constants.FV_LANG_GERMAN...
  • Page 160 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_LANG_BRAZILIAN Value: 0x0B Constants.FV_LANG_DANISH Value: 0x0C Constants.FV_LANG_DUTCH Value: 0x0D Constants.FV_LANG_NORWEGIAN Value: 0x0E Constants.FV_LANG_NYNORSK Value: 0x0F Constants.FV_LANG_FINNISH Value: 0x10 Constants.FV_LANG_SWEDISH Value: 0x11 Constants.FV_LANG_JAPANESE Value: 0x12 Constants.FV_LANG_TRADITIONAL_CHINESE Value: 0x13 Constants.FV_LANG_SIMPLIFIED_CHINESE Value: 0x14 Constants.FV_LANG_KOREAN...
  • Page 161 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_LANG_HUNGARIAN Value: 0x1D Constants.FV_LANG_TURKISH Value: 0x1E Constants.FV_LANG_SLOVAK Value: 0x1F Constants.FV_LANG_SLOVENIAN Value: 0x20 Constants.FV_LANG_BULGARIAN Value: 0x21 Constants.FV_LANG_CROATIAN Value: 0x22 Constants.FV_LANG_ESTONIAN Value: 0x23 Constants.FV_LANG_LATVIAN Value: 0x24 Constants.FV_LANG_LITHUANIAN Value: 0x25 Constants.FV_LANG_ROMANIAN Value: 0x26 Constants.FV_LANG_NUM...
  • Page 162 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_PGF_STRADDLE Value: 5 Constants.FV_PGF_STRADDLE_NORMAL_ONLY Value: 6 Constants.NextPgfFmtInDoc Value: 580 Constants.CellTopMargin Value: 581 Constants.CellBottomMargin Value: 582 Constants.CellLeftMargin Value: 583 Constants.CellRightMargin Value: 584 Constants.CellVAlignment Value: 585 Constants.FV_PGF_V_ALIGN_TOP Value: 0 Constants.FV_PGF_V_ALIGN_MIDDLE Value: 1 Constants.FV_PGF_V_ALIGN_BOTTOM...
  • Page 163 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_PGF_PROPORTIONAL Value: 0x01 Constants.FV_PGF_FLOATING Value: 0x02 Constants.Locked Value: 588 Constants.AcrobatLevel Value: 589 Constants.PDFStructureLevel Value: 600 Constants.FormatOverride Value: 590 Constants.MinJRomSpace Value: 591 Constants.OptJRomSpace Value: 592 Constants.MaxJRomSpace Value: 593 Constants.MinJLetSpace Value: 594 Constants.OptJLetSpace...
  • Page 164 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.CharTag Value: 602 Constants.NextCharFmtInDoc Value: 603 Constants.FontFamily Value: 604 Constants.FontVariation Value: 605 Constants.FontWeight Value: 606 Constants.FontAngle Value: 607 Constants.Underlining Value: 608 Constants.FV_CB_NO_UNDERLINE Value: 0 Constants.FV_CB_SINGLE_UNDERLINE Value: 1 Constants.FV_CB_DOUBLE_UNDERLINE Value: 2 Constants.FV_CB_NUMERIC_UNDERLINE...
  • Page 165 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.KernX Value: 616 Constants.KernY Value: 617 Constants.Spread Value: 618 Constants.Capitalization Value: 619 Constants.FV_CAPITAL_CASE_NORM Value: 0 Constants.FV_CAPITAL_CASE_SMALL Value: 1 Constants.FV_CAPITAL_CASE_LOWER Value: 2 Constants.FV_CAPITAL_CASE_UPPER Value: 3 Constants.Position Value: 620 Constants.FV_POS_NORM Value: 0 Constants.FV_POS_SUPER...
  • Page 166 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.UseFontAngle Value: 624 Constants.UseUnderlining Value: 625 Constants.UseStrikethrough Value: 626 Constants.UseOverline Value: 627 Constants.UseChangeBar Value: 628 Constants.UseOutline Value: 629 Constants.UseShadow Value: 630 Constants.UsePairKern Value: 631 Constants.UseFontSize Value: 632 Constants.UseKernX Value: 633 Constants.UseKernY...
  • Page 167 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FontPanoseName Value: 641 Constants.FontEncodingName Value: 642 Constants.Stretch Value: 643 Constants.UseStretch Value: 644 Constants.UseLanguage Value: 645 Constants.WesternFontPlatformName Value: 646 Constants.WesternFontPostScriptName Value: 647 Constants.WesternFontPanoseName Value: 648 Constants.Tsume Value: 649 Constants.UseTsume Value: 650 Constants.FV_TAB_LEFT...
  • Page 168 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.PageNum Value: 687 Constants.PointPageNum Value: 688 Constants.PageBackground Value: 689 Constants.FV_BGD_DEFAULT Value: 0x00 Constants.FV_BGD_NONE Value: 0x01 Constants.FV_BGD_OTHER Value: 0x02 Constants.MasterPage Value: 690 Constants.PageWidth Value: 691 Constants.PageHeight Value: 692 Constants.PagePrev Value: 693 Constants.PageNext...
  • Page 169 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.PgfSpellChecked Value: 720 Constants.PgfSplit Value: 721 Constants.PgfMarkedForNamedDestination Value: 722 Constants.BorderWidth Value: 740 Constants.Fill Value: 741 Constants.FV_FILL_BLACK Value: 0 Constants.FV_FILL_WHITE Value: 7 Constants.FV_FILL_CLEAR Value: 15 Constants.Pen Value: 742 Constants.HeadArrow Value: 743 Constants.TailArrow...
  • Page 170 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_ARROW_FILLED Value: 0x3 Constants.ArrowScaleHead Value: 750 Constants.Color Value: 751 Constants.Dash Value: 752 Constants.LineCap Value: 753 Constants.FV_CAP_BUTT Value: 0x00 Constants.FV_CAP_ROUND Value: 0x01 Constants.FV_CAP_SQUARE Value: 0x02 Constants.RunaroundGap Value: 754 Constants.TintPercent Value: 755 Constants.Overprint...
  • Page 171 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.PrevGraphicInFrame Value: 775 Constants.NextGraphicInFrame Value: 776 Constants.GroupParent Value: 777 Constants.PrevGraphicInGroup Value: 778 Constants.NextGraphicInGroup Value: 779 Constants.Angle Value: 780 Constants.LocX Value: 781 Constants.LocY Value: 782 Constants.Width Value: 783 Constants.Height Value: 784 Constants.NextSelectedGraphicInDoc...
  • Page 172 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.DesktopWidth Value: 790 Constants.DesktopHeight Value: 791 Constants.FirstGraphicInGroup Value: 807 Constants.LastGraphicInGroup Value: 808 Constants.DTheta Value: 830 Constants.Theta Value: 831 Constants.InsetEditor Value: 850 Constants.InsetUpdater Value: 851 Constants.InsetFile Value: 852 Constants.InsetFileOrigName Value: 2814 Constants.InsetDpi...
  • Page 173 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.InsetSaveDIBFacetToFile Value: 2823 Constants.InsetPosterFileOrigName Value: 2824 Constants.MathFullForm Value: 865 Constants.MathSize Value: 866 Constants.FV_MATH_MEDIUM Value: 0 Constants.FV_MATH_SMALL Value: 1 Constants.FV_MATH_LARGE Value: 2 Constants.AnchorType Value: 875 Constants.FV_ANCHOR_INLINE Value: 1 Constants.FV_ANCHOR_TOP Value: 2 Constants.FV_ANCHOR_BELOW...
  • Page 174 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_ANCHOR_TEXTFRAME_LEFT Value: 11 Constants.FV_ANCHOR_TEXTFRAME_RIGHT Value: 12 Constants.FV_ANCHOR_TEXTFRAME_NEAREST Value: 13 Constants.FV_ANCHOR_TEXTFRAME_FARTHEST Value: 14 Constants.FV_ANCHOR_TEXTFRAME_INSIDE Value: 15 Constants.FV_ANCHOR_TEXTFRAME_OUTSIDE Value: 16 Constants.FV_ANCHOR_RUN_INTO_PARAGRAPH Value: 17 Constants.AFrameIsFloating Value: 876 Constants.SideOffset Value: 877 Constants.AFrameIsCropped Value: 878 Constants.TextLoc...
  • Page 175 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_ALIGN_LEFT Value: 0 Constants.FV_ALIGN_CENTER Value: 1 Constants.FV_ALIGN_RIGHT Value: 2 Constants.FV_ALIGN_INSIDE Value: 3 Constants.FV_ALIGN_OUTSIDE Value: 4 Constants.MifFileEntity Value: 2828 Constants.MifFileName Value: 2829 Constants.PolyIsBezier Value: 906 Constants.NumPoints Value: 907 Constants.Points Value: 908 Constants.RectangleIsSmoothed...
  • Page 176 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FirstCell Value: 978 Constants.LastCell Value: 979 Constants.PrevTextFrameInFlow Value: 980 Constants.NextTextFrameInFlow Value: 981 Constants.Flow Value: 982 Constants.NumColumns Value: 984 Constants.ColGapWidth Value: 985 Constants.FirstSubCol Value: 986 Constants.LastSubCol Value: 987 Constants.LineSpacingFactor Value: 988 Constants.PgfSpacingFactor...
  • Page 177 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.SideHeadGap Value: 1173 Constants.ColumnsAreBalanced Value: 1175 Constants.InTextObj Value: 1000 Constants.InTextFrame Value: 1001 Constants.FnNum Value: 1002 Constants.NextFnInDoc Value: 1003 Constants.PrevFn Value: 1004 Constants.NextFn Value: 1005 Constants.FnAnchorString Value: 1006 Constants.OldTypeNum Value: 1024 Constants.MarkerText...
  • Page 178 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.NextVarInDoc Value: 1046 Constants.VarFmt Value: 1047 Constants.SystemVar Value: 1049 Constants.FV_VAR_USER_VARIABLE Value: 0 Constants.FV_VAR_CURRENT_PAGE_NUM Value: 1 Constants.FV_VAR_PAGE_COUNT Value: 2 Constants.FV_VAR_CURRENT_DATE_LONG Value: 3 Constants.FV_VAR_CURRENT_DATE_SHORT Value: 4 Constants.FV_VAR_MODIFICATION_DATE_LONG Value: 5 Constants.FV_VAR_MODIFICATION_DATE_SHORT Value: 6 Constants.FV_VAR_CREATION_DATE_LONG...
  • Page 179 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_VAR_TABLE_CONTINUATION Value: 15 Constants.FV_VAR_TABLE_SHEET Value: 16 Constants.FV_VAR_HEADER_FOOTER_5 Value: 19 Constants.FV_VAR_HEADER_FOOTER_6 Value: 20 Constants.FV_VAR_HEADER_FOOTER_7 Value: 21 Constants.FV_VAR_HEADER_FOOTER_8 Value: 22 Constants.FV_VAR_HEADER_FOOTER_9 Value: 23 Constants.FV_VAR_HEADER_FOOTER_10 Value: 24 Constants.FV_VAR_HEADER_FOOTER_11 Value: 25 Constants.FV_VAR_HEADER_FOOTER_12 Value: 26 Constants.Fmt...
  • Page 180 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.XRefIsUnresolved Value: 1077 Constants.XRefSrcElemNonUniqueId Value: 1152 Constants.XRefAltText Value: 1153 Constants.XRefClientName Value: 1154 Constants.XRefClientType Value: 1155 Constants.XRefResolvedWithKeyref Value: 1156 Constants.XRefRetainKeydefText Value: 1157 Constants.NextXRefFmtInDoc Value: 1074 Constants.TextLineType Value: 1095 Constants.FV_TEXTLINE_LEFT Value: 0 Constants.FV_TEXTLINE_RIGHT...
  • Page 181 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.UseSepOverride Value: 1141 Constants.StyleOverride Value: 1142 Constants.FV_CN_NO_OVERRIDE Value: 0 Constants.FV_CN_OVERLINE Value: 1 Constants.FV_CN_STRIKETHROUGH Value: 2 Constants.FV_CN_SINGLE_UNDERLINE Value: 3 Constants.FV_CN_DOUBLE_UNDERLINE Value: 4 Constants.FV_CN_CHANGEBAR Value: 5 Constants.FV_CN_NUMERIC_UNDERLINE Value: 6 Constants.FV_CN_NMRIC_AND_CHNGBAR Value: 7 Constants.NextAttrCondExprInDoc...
  • Page 182 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_CS_SINGLE_UNDERLINE Value: 0x04 Constants.FV_CS_DOUBLE_UNDERLINE Value: 0x08 Constants.FV_CS_CHANGEBAR Value: 0x10 Constants.FV_CS_NUMERIC_UNDERLINE Value: 0x20 Constants.NextFlowInDoc Value: 1162 Constants.FlowIsSynchronized Value: 1163 Constants.MinHang Value: 1164 Constants.FlowIsAutoConnect Value: 1165 Constants.FlowIsFeathered Value: 1166 Constants.Spacing Value: 1167 Constants.FlowIsPostScript...
  • Page 183 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.CellUseOverrideTRuling Value: 1192 Constants.CellUseOverrideBRuling Value: 1193 Constants.CellOverrideShading Value: 1194 Constants.CellOverrideFill Value: 1195 Constants.CellUseOverrideFill Value: 1196 Constants.CellUseOverrideShading Value: 1197 Constants.CellRow Value: 1198 Constants.NextCellInTbl Value: 1199 Constants.CellBelowInTbl Value: 1200 Constants.PrevCellInRow Value: 1201 Constants.NextCellInRow...
  • Page 184 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.CellOverrideTopRuling Value: 1210 Constants.CellOverrideBottomRuling Value: 1211 Constants.CellOverrideLeftRuling Value: 1212 Constants.CellOverrideRightRuling Value: 1213 Constants.CellDefaultTopRuling Value: 1214 Constants.CellDefaultBottomRuling Value: 1215 Constants.CellDefaultLeftRuling Value: 1216 Constants.CellDefaultRightRuling Value: 1217 Constants.CellIsShown Value: 1218 Constants.PrevCell Value: 1219 Constants.NextCell...
  • Page 185 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.RowMinHeight Value: 1251 Constants.RowStart Value: 1252 Constants.FV_ROW_ANYWHERE Value: 0 Constants.FV_ROW_TOP_OF_COL Value: 1 Constants.FV_ROW_TOP_OF_PAGE Value: 2 Constants.FV_ROW_TOP_OF_LEFT_PAGE Value: 3 Constants.FV_ROW_TOP_OF_RIGHT_PAGE Value: 4 Constants.RowType Value: 1253 Constants.FV_ROW_HEADING Value: 0 Constants.FV_ROW_BODY Value: 1 Constants.FV_ROW_FOOTING...
  • Page 186 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.TblAlignment Value: 1282 Constants.FV_ALIGN_TBL_LEFT Value: 0 Constants.FV_ALIGN_TBL_CENTER Value: 1 Constants.FV_ALIGN_TBL_RIGHT Value: 2 Constants.TblPlacement Value: 1283 Constants.FV_TBL_ANYWHERE Value: 0 Constants.FV_TBL_TOP_OF_COL Value: 1 Constants.FV_TBL_TOP_OF_PAGE Value: 2 Constants.FV_TBL_TOP_OF_LEFT_PAGE Value: 3 Constants.FV_TBL_TOP_OF_RIGHT_PAGE Value: 4 Constants.FV_TBL_FLOAT...
  • Page 187 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.TblTitlePosition Value: 1289 Constants.FV_TBL_NO_TITLE Value: 0 Constants.FV_TBL_TITLE_ABOVE Value: 1 Constants.FV_TBL_TITLE_BELOW Value: 2 Constants.TblTitleGap Value: 1290 Constants.OrphanRows Value: 1291 Constants.TblCatalogEntry Value: 1292 Constants.TblColRulingPeriod Value: 1293 Constants.TblBodyRowRulingPeriod Value: 1294 Constants.TblLastBodyRuling Value: 1295 Constants.TblHFFill...
  • Page 188 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.TblBodyNextColor Value: 1304 Constants.TblTopRuling Value: 1305 Constants.TblBottomRuling Value: 1306 Constants.TblLeftRuling Value: 1307 Constants.TblRightRuling Value: 1308 Constants.TblColRuling Value: 1309 Constants.TblBodyRowRuling Value: 1310 Constants.TblHFSeparatorRuling Value: 1311 Constants.TblHFRowRuling Value: 1312 Constants.TblOtherBodyRowRuling Value: 1313 Constants.TblOtherColRuling...
  • Page 189 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.NextTblInDoc Value: 1337 Constants.FirstRowInTbl Value: 1338 Constants.LastRowInTbl Value: 1339 Constants.TblWidth Value: 1340 Constants.TopRowSelection Value: 1341 Constants.BottomRowSelection Value: 1342 Constants.LeftColNum Value: 1343 Constants.RightColNum Value: 1344 Constants.TblColWidths Value: 1345 Constants.TblTitleSelected Value: 1346 Constants.NextRulingFmtInDoc...
  • Page 190 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.Magenta Value: 1458 Constants.Yellow Value: 1459 Constants.Black Value: 1460 Constants.ColorViewCtl Value: 1461 Constants.FV_SEP_NORMAL Value: 0x0 Constants.FV_SEP_NONE Value: 0x1 Constants.FV_SEP_WHITE Value: 0x2 Constants.ColorPrintCtl Value: 1462 Constants.FV_PRINT_SPOT Value: 0x0 Constants.FV_PRINT_PROCESS Value: 0x1 Constants.FV_PRINT_NO...
  • Page 191 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_COLOR_RED Value: 6 Constants.FV_COLOR_GREEN Value: 7 Constants.FV_COLOR_BLUE Value: 8 Constants.FV_COLOR_DARKGREY Value: 9 Constants.FV_COLOR_PALEGREEN Value: 10 Constants.FV_COLOR_FORESTGREEN Value: 11 Constants.FV_COLOR_ROYALBLUE Value: 12 Constants.FV_COLOR_MAUVE Value: 13 Constants.FV_COLOR_LIGHTSALMON Value: 14 Constants.FV_COLOR_DARKYELLOW Value: 15 Constants.FV_COLOR_SALMON...
  • Page 192 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_COLOR_OVERPRINT Value: 0x01 Constants.NextRubiInDoc Value: 1469 Constants.OyamojiTextRange Value: 1470 Constants.RubiTextRange Value: 1471 Constants.HypertextDoValidate Value: 2300 Constants.HypertextCommandText Value: 2301 Constants.HypertextParsedArgs Value: 2302 Constants.HypertextParseErr Value: 2303 Constants.FV_HypertextSyntaxOK Value: 0 Constants.FV_HypertextEmptyCommand Value: 1 Constants.FV_HypertextUnrecognizedCommand...
  • Page 193 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_HypertextValid Value: 0 Constants.FV_HypertextUsesDefaultText Value: 200 Constants.FV_HypertextFileNotRegular Value: 210 Constants.FV_HypertextFileNotMakerDoc Value: 211 Constants.FV_HypertextCantOpenDestFile Value: 212 Constants.FV_HypertextDestinationLinkNotFound Value: 220 Constants.FV_HypertextDuplicateLinkName Value: 221 Constants.FV_HypertextPageNameNotFound Value: 230 Constants.FV_HypertextUnrecognizedObjectType Value: 240 Constants.FV_HypertextObjectIDNotFound Value: 241 Constants.FV_HypertextBadMatrixSize...
  • Page 194 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_HypertextCommandIllegalWithinPopup Value: 273 Constants.FV_HypertextFcodeInvalid Value: 280 Constants.HypertextParseBadParam Value: 2305 Constants.HypertextParseErrMsg Value: 2306 Constants.HypertextParsedCmdCode Value: 2307 Constants.FV_CmdNotTyped Value: 0 Constants.FV_CmdError Value: 1 Constants.FV_CmdUnknown Value: 2 Constants.FV_CmdNoop Value: 3 Constants.FV_CmdAlert Value: 8 Constants.FV_CmdAlertTitle...
  • Page 195 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_CmdMatrix Value: 17 Constants.FV_CmdMessage Value: 18 Constants.FV_CmdNewLink Value: 19 Constants.FV_CmdNextPage Value: 20 Constants.FV_CmdPreviousPage Value: 21 Constants.FV_CmdOpenLink Value: 22 Constants.FV_CmdOpenLinkFitWin Value: 23 Constants.FV_CmdOpenNew Value: 24 Constants.FV_CmdOpenObjectId Value: 25 Constants.FV_CmdOpenObjectIdFitWin Value: 26 Constants.FV_CmdOpenPage...
  • Page 196 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_CmdInCodes Value: 258 Constants.FV_CmdApplyMathRules Value: 259 Constants.FV_CmdThesaurusLookup Value: 260 Constants.FV_CmdNative Value: 261 Constants.FV_CmdHelpLink Value: 262 Constants.FV_CmdBeginRange Value: 263 Constants.FV_CmdEndRange Value: 264 Constants.HypertextParsedCmdDest Value: 2308 Constants.FV_DestNowhere Value: 0 Constants.FV_DestMarkerNewLink Value: 1 Constants.FV_DestFirstPage...
  • Page 197 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_ObjectUnknown Value: 0 Constants.FV_ObjectMarker Value: 1 Constants.FV_ObjectPgf Value: 2 Constants.FV_ObjectXref Value: 3 Constants.FV_ObjectGraphic Value: 4 Constants.FV_ObjectElement Value: 5 Constants.FV_ObjectTextInset Value: 6 Constants.FV_ObjectDataLink Value: 7 Constants.HypertextParsedCmdDestObjID Value: 2310 Constants.HypertextParsedCmdMatrixRows Value: 2311 Constants.HypertextParsedCmdMatrixColumns...
  • Page 198 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.HypertextParsedDIFileName Value: 2320 Constants.FirstElementDefInDoc Value: 1483 Constants.ElementBoundaryDisplay Value: 1484 Constants.BooleanConditionExpression Value: 2321 Constants.BooleanConditionState Value: 2322 Constants.BooleanConditionExpressionTag Value: 995 Constants.IsDitamapInResourceManager Value: 2332 Constants.FV_ELEM_DISP_NONE Value: 0 Constants.FV_ELEM_DISP_BRACKETS Value: 1 Constants.FV_ELEM_DISP_TAGS Value: 2 Constants.ElementCatalogDisplay...
  • Page 199 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.ElementCatalog Value: 1488 Constants.FirstFmtChangeListInDoc Value: 1489 Constants.NewElemAttrDisplay Value: 1490 Constants.FV_ATTR_DISP_NONE Value: 1 Constants.FV_ATTR_DISP_REQSPEC Value: 2 Constants.FV_ATTR_DISP_ALL Value: 3 Constants.NewElemAttrEditing Value: 1491 Constants.FV_ATTR_EDIT_NONE Value: 0 Constants.FV_ATTR_EDIT_REQUIRED Value: 1 Constants.FV_ATTR_EDIT_ALWAYS Value: 2 Constants.UseInitialStructure...
  • Page 200 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.StructAppAttrConfigFile Value: 1500 Constants.ShowElementDescriptiveNames Value: 1501 Constants.BkGndColor Value: 1502 Constants.TextColor Value: 1503 Constants.DitaMode Value: 1504 Constants.FV_STRICTLY_VALID Value: 0x01 Constants.FV_LOOSELY_VALID Value: 0x02 Constants.FV_ALTERNATIVE Value: 0x04 Constants.FV_INCLUSION Value: 0x08 Constants.HighestLevelElement Value: 1509 Constants.ComponentElement...
  • Page 201 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.GeneralRuleErrorOffsets Value: 1578 Constants.ElementDefType Value: 1579 Constants.Comment Value: 1581 Constants.TextFmtRules Value: 1582 Constants.ObjectFmtRules Value: 1583 Constants.AttributeDefs Value: 1584 Constants.InitStructurePattern Value: 1585 Constants.TableTagging Value: 1585 Constants.ElementPgfFormat Value: 1586 Constants.PrefixRules Value: 1587 Constants.SuffixRules...
  • Page 202 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.DescriptiveTag Value: 1596 Constants.ElementDescription Value: 1597 Constants.XMLStructuredApplicationList Value: 1598 Constants.FV_FO_UNSPECIFIED Value: 0 Constants.FV_FO_TEXTNODE Value: 0 Constants.FV_FO_CONTAINER Value: 1 Constants.FV_FO_SYS_VAR Value: 2 Constants.FV_FO_XREF Value: 3 Constants.FV_FO_MARKER Value: 4 Constants.FV_FO_FOOTNOTE Value: 5 Constants.FV_FO_GRAPHIC...
  • Page 203 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_FO_TBL_CELL Value: 14 Constants.FV_FO_RUBI_GROUP Value: 15 Constants.FV_FO_RUBI Value: 16 Constants.FV_FO_NUMTYPES Value: 17 Constants.FV_DT_UNSPECIFIED Value: 0 Constants.FV_DT_INTEGER Value: 1 Constants.FV_DT_FLOAT Value: 2 Constants.FV_DT_NUMTYPES Value: 3 Constants.FV_AT_STRING Value: 0 Constants.FV_AT_STRINGS Value: 1 Constants.FV_AT_CHOICES...
  • Page 204 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_AT_NUMTYPES Value: 10 Constants.FV_AF_READ_ONLY Value: 0x0001 Constants.FV_AF_HIDDEN Value: 0x0002 Constants.FV_AF_FIXED Value: 0x0004 Constants.FmtRuleType Value: 2100 Constants.CountElements Value: 2101 Constants.StopCountingAt Value: 2102 Constants.FmtRuleClauses Value: 2103 Constants.FmtRuleClause Value: 2104 Constants.FV_CONTEXT_RULE Value: 0 Constants.FV_LEVEL_RULE...
  • Page 205 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.ContextLabel Value: 2157 Constants.ElemPrefixSuffix Value: 2158 Constants.FmtRule Value: 2159 Constants.ParsedSpecification Value: 2160 Constants.SpecificationForCSS Value: 2161 Constants.ContextForCSS Value: 2162 Constants.ParseFullSpecification Value: 2163 Constants.FV_RC_TAG Value: 0 Constants.FV_RC_SUB_FMTRULE Value: 1 Constants.FV_RC_CHANGELIST Value: 2 Constants.FV_RC_CHANGELIST_TAG...
  • Page 206 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_EDT_NOTFIRST Value: 47 Constants.FV_EDT_NOTLAST Value: 48 Constants.FV_EDT_AFTER Value: 49 Constants.FV_EDT_BEFORE Value: 50 Constants.FV_EDT_BETWEEN Value: 53 Constants.FV_EDT_INSERTPAR Value: 23 Constants.FV_EDT_ONLY Value: 62 Constants.FV_EDT_ATTRGRPO Value: 30 Constants.FV_EDT_ELEMENT Value: 25 Constants.ElementDef Value: 1621 Constants.ParentElement...
  • Page 207 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.MatchingTextClauses Value: 1631 Constants.MatchingObjectClauses Value: 1632 Constants.Attributes Value: 1634 Constants.AttributesEx Value: 1670 Constants.AttrDisplay Value: 1635 Constants.ElementType Value: 1636 Constants.IDAttrValue Value: 1637 Constants.MatchingFirstPgfClauses Value: 1638 Constants.MatchingLastPgfClauses Value: 1639 Constants.MatchingPrefixClauses Value: 1640 Constants.MatchingSuffixClauses...
  • Page 208 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.ElementIsTopicHead Value: 2337 Constants.ElementIsTopicGroup Value: 2338 Constants.TopicRefAbsoluteFilePath Value: 2347 Constants.Element Value: 2170 Constants.TblElement Value: 2171 Constants.TblTitleElement Value: 2172 Constants.TblHeaderElement Value: 2173 Constants.TblBodyElement Value: 2174 Constants.TblFooterElement Value: 2175 Constants.RubiElement Value: 2176 Constants.AllowAsSpecialCase...
  • Page 209 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.ElementIsInvalidInParent Value: 1656 Constants.ElementIsInvalidInPosition Value: 1657 Constants.ElementTypeMismatch Value: 1658 Constants.HoleBeforeElement Value: 1659 Constants.TextIsInvalidInElement Value: 1660 Constants.InvalidHighestLevel Value: 1661 Constants.BookComponentMissing Value: 1662 Constants.ErrorInBookComponent Value: 1663 Constants.NextInvalidElement Value: 1664 Constants.ContentMustBeEmpty Value: 1665 Constants.AttributeValueRequired...
  • Page 210 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_ELEM_INVALID_AT_POSITION Value: 0x0010 Constants.FV_ELEM_HAS_TEXT_INVALID Value: 0x0020 Constants.FV_ELEM_CONTENT_MUST_BE_EMPTY Value: 0x0040 Constants.FV_ELEM_MISSING_CONTENT_BEFORE Value: 0x0080 Constants.FV_ELEM_MISSING_CONTENT_AT_BEG Value: 0x0100 Constants.FV_ELEM_MISSING_CONTENT_AT_END Value: 0x0200 Constants.FV_ELEM_NOT_VALID_AS_ROOT Value: 0x0400 Constants.FV_ELEM_BOOK_COMP_MISSING Value: 0x0800 Constants.FV_ELEM_BOOK_COMP_INVALID Value: 0x1000 Constants.FV_ELEM_ATTRVAL_REQUIRED Value: 0x2000 Constants.FV_ELEM_ATTRVAL_INVALID...
  • Page 211 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_AV_IDREF_UNRESOLVED Value: 4 Constants.FV_AV_ID_DUPLICATE_IN_DOC Value: 5 Constants.FV_AV_ID_DUPLICATE_IN_BOOK Value: 6 Constants.FV_AV_TOO_MANY_TOKENS Value: 7 Constants.FV_AV_UNDEFINED Value: 8 Constants.FV_AV_OUT_OF_RANGE Value: 9 Constants.FV_OVERRIDDEN_DEFAULT Value: 0x00 Constants.FV_OVERRIDDEN_NOVALUE Value: 0x01 Constants.FV_OVERRIDDEN_CONREF_DUCT Value: 0x02 Constants.FV_OVERRIDDEN_KEYDEF_TO_KEYREF Value: 0x03 Constants.FV_Element...
  • Page 212 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.LeftIndentChange Value: 2004 Constants.FirstIndentChange Value: 2005 Constants.RightIndentChange Value: 2006 Constants.LeadingChange Value: 2007 Constants.LineSpacingFixed Value: 2008 Constants.TopSepAtIndent Value: 2009 Constants.BottomSepAtIndent Value: 2010 Constants.FontSizeChange Value: 2012 Constants.SpreadChange Value: 2013 Constants.MoveTabs Value: 2014 Constants.CellTopMarginFixed...
  • Page 213 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.CellLeftMarginChange Value: 2024 Constants.CellRightMarginChange Value: 2025 Constants.StretchChange Value: 2026 Constants.FF_IED_REMOVE_OVERRIDES Value: 0x0001 Constants.FF_IED_REMOVE_BOOK_INFO Value: 0x0002 Constants.FF_IED_DO_NOT_IMPORT_EDD Value: 0x0004 Constants.FF_IED_NO_NOTIFY Value: 0x0008 Constants.FF_IED_DELETE_EMPTY_PAGES Value: 0x0010 Constants.Text Value: 1701 Constants.State Value: 1702 Constants.FV_DlgOptNotActive...
  • Page 214 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.Sensitivity Value: 1708 Constants.MinVal Value: 1709 Constants.MaxVal Value: 1710 Constants.IncrVal Value: 1711 Constants.Size Value: 1712 Constants.Visibility Value: 1713 Constants.PasswordStyle Value: 1714 Constants.TabStops Value: 1715 Constants.Icon Value: 1716 Constants.WindowHandle Value: 1717 Constants.SortingEnabled...
  • Page 215 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_DlgUndo Value: -5 Constants.FV_DlgPrevPage Value: -6 Constants.FV_DlgNextPage Value: -7 Constants.FV_DlgNeedsUpdate Value: -8 Constants.FV_DlgInit Value: -9 Constants.FV_DlgHide Value: -10 Constants.FV_DlgShow Value: -11 Constants.FV_EvShift Value: 0x0001 Constants.FV_EvControl Value: 0x0002 Constants.FV_EvMeta Value: 0x0004 Constants.FV_EvOption...
  • Page 216 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.DbStuffItem Value: 1804 Constants.DbSbxNumLines Value: 1805 Constants.DbRadioButtonGroup Value: 1806 Constants.DbCheckBoxState Value: 1807 Constants.DbFirstFocus Value: 1808 Constants.DbDefaultButton Value: 1809 Constants.DbOKButton Value: 1810 Constants.DbCancelButton Value: 1811 Constants.DbFbTextBox Value: 1812 Constants.DbFbScrollBox Value: 1813 Constants.DbFbCurrentDir...
  • Page 217 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.LineBaseline Value: 1902 Constants.MenuItemIsEnabled Value: 1922 Constants.NextMenuItemInMenu Value: 1923 Constants.PrevMenuItemInMenu Value: 1924 Constants.NextMenuItemInSession Value: 1925 Constants.MenuType Value: 1926 Constants.FV_MENU_MENUBAR Value: 1 Constants.FV_MENU_POPUP Value: 2 Constants.FV_MENU_ADHOCRULER Value: 3 Constants.FV_MENU_DEFAULT Value: 4 Constants.FirstMenuItemInMenu...
  • Page 218 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_MENUITEM_API Value: 2 Constants.FV_MENUITEM_MACRO Value: 3 Constants.FV_MENUITEM_EXPANDOMATIC Value: 4 Constants.ExpandOMaticParent Value: 1934 Constants.EnabledWhen Value: 1935 Constants.FV_ENABLE_ALWAYS_ENABLE Value: 1 Constants.FV_ENABLE_ALWAYS_DISABLE Value: 2 Constants.FV_ENABLE_IN_PARA_TEXT Value: 3 Constants.FV_ENABLE_IN_TEXT_LINE Value: 4 Constants.FV_ENABLE_IS_TEXT_SEL Value: 5 Constants.FV_ENABLE_IN_MATH...
  • Page 219 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_ENABLE_IS_TABLE Value: 14 Constants.FV_ENABLE_IS_OBJ Value: 15 Constants.FV_ENABLE_IS_TEXT_FRAME Value: 16 Constants.FV_ENABLE_IS_OR_IN_FRAME Value: 17 Constants.FV_ENABLE_IS_AFRAME Value: 18 Constants.FV_ENABLE_IS_TEXT_INSET Value: 19 Constants.FV_ENABLE_IS_GRAPHIC_INSET Value: 20 Constants.FV_ENABLE_IN_FLOW Value: 21 Constants.FV_ENABLE_COPY Value: 22 Constants.FV_ENABLE_COPY_FONT Value: 23 Constants.FV_ENABLE_CAN_PASTE...
  • Page 220 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.Fcodes Value: 1937 Constants.HelpLink Value: 1938 Constants.HasShiftOrUnshiftCommand Value: 1939 Constants.FV_ITEM_HAS_SHIFT_COMMAND Value: 1 Constants.FV_ITEM_HAS_UNSHIFT_COMMAND Value: 2 Constants.FV_ITEM_HAS_NO_SHIFT_OR_UNSHIFT_COM MAND Value: 3 Constants.ShiftOrUnshiftCommand Value: 1940 Constants.Mode Value: 1941 Constants.FV_MODE_MATH Value: 1 Constants.FV_MODE_NONMATH Value: 2 Constants.FV_MODE_ALL...
  • Page 221 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.LastUpdate Value: 2052 Constants.TiFile Value: 2053 Constants.TiMacEdition Value: 2054 Constants.ImportHint Value: 2055 Constants.TiLocked Value: 2056 Constants.TiFileModDate Value: 2057 Constants.TiIsNested Value: 2058 Constants.TiMainFlow Value: 2059 Constants.TiFlowName Value: 2060 Constants.TiFlowPageSpace Value: 2061 Constants.FV_BODY_PAGE...
  • Page 222 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_ANSI Value: 3 Constants.FV_MacANSI Value: 4 Constants.FV_JIS Value: 5 Constants.FV_Shitf_JIS Value: 6 Constants.FV_EUC Value: 7 Constants.FV_BIG5 Value: 8 Constants.FV_EUC_CNS Value: 9 Constants.FV_GB Value: 10 Constants.FV_HZ Value: 11 Constants.FV_Korean Value: 12 Constants.TiEOLisEOP...
  • Page 223 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.TiIsUnresolved Value: 2075 Constants.TiClientName Value: 2076 Constants.TiClientSource Value: 2077 Constants.TiClientType Value: 2078 Constants.TiClientData Value: 2079 Constants.ContentHeight Value: 2219 Constants.ParentTextFrame Value: 2200 Constants.PrevSubCol Value: 2201 Constants.NextSubCol Value: 2202 Constants.Overflowed Value: 983 Constants.FirstCombinedFontDefnInDoc...
  • Page 224 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FS_FindText Value: 1 Constants.FS_FindElementTag Value: 2 Constants.FV_FindElemTag Value: 0 Constants.FV_FindAttrName Value: 1 Constants.FV_FindAttrValue Value: 2 Constants.FV_NumFindElementItems Value: 2+1 Constants.FS_FindCharFmt Value: 3 Constants.FS_FindPgfTag Value: 4 Constants.FS_FindCharTag Value: 5 Constants.FS_FindTableTag Value: 6 Constants.FS_FindObject...
  • Page 225 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_FindAnchoredFrame Value: 7 Constants.FV_FindFootnote Value: 8 Constants.FV_FindAnyTable Value: 9 Constants.FV_FindAutomaticHyphen Value: 10 Constants.FV_FindAnyRubi Value: 11 Constants.FV_FindPgfFormatOverride Value: 12 Constants.FV_FindCharacterFormatOverride Value: 13 Constants.FV_FindTableFormatOverride Value: 14 Constants.FS_FindMarkerOfType Value: 9 Constants.FS_FindMarkerText Value: 10 Constants.FS_FindXRefWithFormat...
  • Page 226 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FS_TextBeforeString Value: 1002 Constants.FS_TextAfterString Value: 1003 Constants.FS_WordContainString Value: 1004 Constants.FS_SpellAction Value: 1005 Constants.FV_CheckDocument Value: 1 Constants.FV_CheckCurrentPage Value: 2 Constants.FV_WriteUnknownWordsToFile Value: 3 Constants.FS_OutputFilePathName Value: 1006 Constants.FS_SpellWrap Value: 1007 Constants.FS_NumSpellParams Value: (1007-1000+1) Constants.FV_SpellMisspelling...
  • Page 227 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_SpellStraightQuotes Value: 9 Constants.FV_UserDictionary Value: 1 Constants.FV_DocumentDictionary Value: 2 Constants.FV_WriteDictionaryToFile Value: 4 Constants.FV_MergeDictionaryContents Value: 5 Constants.FV_SetDictionaryToNoneDictionary Value: 6 Constants.FV_ClearDocDictionary Value: 7 Constants.FV_ChangePersonalDictionary Value: 8 Constants.FV_GetDictionaryStrings Value: 9 Constants.CursorData Value: 2294 Constants.CursorTypes...
  • Page 228 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.SubsectionNumber Value: 817 Constants.SubsectionNumText Value: 818 Constants.DoNotGenerateErrorLog Value: 819 Constants.DocOpenClientEncounteredErrors Value: 820 Constants.OpenAndSaveXmlBookComponentDoc Value: 822 Constants.XmlIsBook Value: 823 Constants.AllowNewFileURL Value 2416 Constants.DoPostXSLTValidationOnExport Value 2417 Constants.DoNotExportInvalidXML Value 2418 Constants.SuppressXMLParserWarnings Value 2419 Constants.RemoveExtraWhiteSpacesOnXMLImport...

  • Page 229: Doc

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Constants.FV_ListViewDeleteAllRows Value 4 Constants.FV_ListViewReSortAllRows Value 5 Constants.FV_ListViewActionMax Value 6 Constants.FV_ListViewInitNumParams Value 0 Constants.FV_ListViewAddColumnNumParams Value 4 Constants.FV_ListViewAddColumnParam1 Value 3 Constants.FV_ListViewAddColumnParam2 Value 1 Constants.FV_ListViewAddColumnParam3 Value 1 Constants.FV_ListViewAddColumnParam4 Value 1 Constants.FV_ListViewAddRowNumParams Value 1 Constants.FV_ListViewAddRowParam1...
  • Page 230 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description FirstCombinedFontDefnInDoc CombinedFontDefn Specifies the first combined font definition in the list of the document's combined font definitions. FirstCondFmtInDoc Indicates the first condition tag in the list of the CondFmt document's condition tags.
  • Page 231 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description FirstXRefInDoc XRef Specifies the first cross-reference [FO_XRef ID] in the list of the document's cross-references. HiddenPage Denotes a hidden page [FO_HiddenPage ID] in the HiddenPage document. LastBodyPageInDoc BodyPage Indicates the last body page [FO_BodyPage ID] in the document.
  • Page 232 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description GenerateAcrobatInfo Set to True if Generate Adobe Acrobat Data is on. To generate PDF data, you must set the other document print properties as follows: • PrintToFile - True •...
  • Page 233 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description PDFDistillerAbsent A value of 1 indicates that Acrobat Distiller is not available. Any other value indicates that Acrobat Distiller is available. PDFDocInfo Contains a list of strings expressing values to be set in the...
  • Page 234 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description PDFZoomType 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) •...
  • Page 235 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description ChapterNumStyle The numbering style. The possible value is one of: • Constants.FV_NUMSTYLE_NUMERIC (0x00): Arabic. • Constants.FV_NUMSTYLE_ROMAN_UC (0x01): Roman, uppercase. • Constants.FV_NUMSTYLE_ROMAN_LC (0x02): Roman,lowercase. • Constants.FV_NUMSTYLE_ALPHA_UC (0x03): Alphabetic, uppercase. •...
  • Page 236 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description DocSaveType Denotes the type of document saved. The possible values are: • Constants.FV_DOC_TYPE_BINARY (0x01): Frame binary document • Constants.FV_DOC_TYPE_TEXT (0x02): ASCII text document • Constants.FV_DOC_TYPE_MIF (0x03): MIF document •...
  • Page 237 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description 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...
  • Page 238 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description VolumeNumStyle Denotes the volume numbering style. The value is one of: • Constants.FV_NUMSTYLE_NUMERIC (0x00): Arabic • Constants.FV_NUMSTYLE_ROMAN_UC (0x01): Roman numerals, uppercase. • Constants.FV_NUMSTYLE_ROMAN_LC (0x02): Roman numerals,lowercase. • Constants.FV_NUMSTYLE_ALPHA_UC (0x03): Alphabetic, uppercase.
  • Page 239 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description EqnIntegralSizeLarge Indicates the point size of integral symbol in large equations (2 pt to 400 pt). EqnIntegralSizeMed Indicates the point size of integral symbol in medium equations (2 pt to 400 pt).
  • Page 240 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description 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. HypertextParseErr Contains a non-zero value if there is a parser error.
  • Page 241 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description HypertextValidateErr Set to a non-zero value if the HypertextDoValidate property is set to True and there is a validation error. property is set to one of HypertextValidateErr the following values if there is a validation error: •...
  • Page 242 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description HypertextParseBadParam Denotes the index into the string list contained in the HypertextParsedArgs property, in case of a parser error. HypertextParseErrMsg Denotes the message that FrameMaker generates for a string parser error.
  • Page 243 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description HypertextParsedCmdCode 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 •...
  • Page 244 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description HypertextParsedCmdDest Denotes the destination type for link commands in the HypertextCommandText property, as determined by the parser. The possible value for the HypertextParsedCmdDes property is one of: • Constants.FV_DestNowhere (0) - No destination found •...
  • Page 245 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description HypertextParsedLinkName string Indicates either the value of a newlink command, or a keyword such as FirstPage or LastPage, for links to new targets. HypertextParsedPageName Denotes the pagenumber, for links to pages.
  • Page 246 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description FnNumComputeMethod 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 associated...
  • Page 247 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description DocIsDoubleSided Set to True if the layout of the document is a 2 sided page; False otherwise. FirstPageNum Indicates the page number of the first page. FirstPageVerso Set to False for right first page; True for left first page.
  • Page 248 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description PageWidth 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. PointPageNumStyle Denotes the point page numbering style. The value is one •...
  • Page 249 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description PrintEndPage 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.
  • Page 250 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description PrintScale 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 Denotes the pages to print. The value is one of: •...
  • Page 251 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description NarrowRubiSpaceForOther 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 Set to True if Rubi is allowed to overhang, else set to False.
  • Page 252 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description ElementCatalogDisplay 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 •...
  • Page 253 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description MinFontSize Denotes the minimum font size allowed in the document. MinLeading Denotes the minimum leading allowed in the document. MinLeftIndent Denotes the minimum left indent allowed in the document.
  • Page 254 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description 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 property is set, the XML Declaration...
  • Page 255 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description 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.
  • Page 256 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description TblFnNumStyle Denotes the footnote numbering style for tables in the document. The value is one of: • Constants.FV_FN_NUM_NUMERIC (0x00) - Arabic • Constants.FV_FN_NUM_ROMAN_UC (0x01) - Roman uppercase • Constants.FV_FN_NUM_ROMAN_LC (0x02) - Roman lowercase •...
  • Page 257 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description CondFmtIsShown Returns True if the document conditions are shown. Else, returns False. CombinedFontFamily Contains the Combined font definition CombinedFontDefn (FO_CombinedFontDefn) FontEncodingName string Specifies the font encoding. FontAngle Denotes the font angle (specifies an index into the array...
  • Page 258 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description Strikethrough Returns True if Strikethrough style is enabled. Else, returns False. StyleOverrides Specifies the style condition indicators for conditional text. The value is one of: • Constants.FV_CN_NO_OVERRIDE (0) •...
  • Page 259 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description Label string Denotes the title in the document window title bar. ScreenHeight Denotes the height of the document window in pixels. ScreenWidth Denotes the width of the document window in pixels.
  • Page 260 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description DocFluidFlow Flow Specifies the flow to set to fluid view. To turn this off, set the value of this property to 0. ViewOnlyDeadCodes Indicates the F-codes that cannot be executed in the UInts document.
  • Page 261 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description SecNumComputeMethod 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) SectionNumStyle Denotes the section numbering style.
  • Page 262 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description SubsectionNumStyle Denotes the subsection numbering style. The value is one • Constants.FV_PAGE_NUM_NUMERIC(0x00) - Arabic • Constants.FV_PAGE_NUM_ROMAN_UC(0x01) - Roman uppercase • Constants.FV_PAGE_NUM_ROMAN_LC(0x02) - Roman lowercase • Constants.FV_PAGE_NUM_ALPHA_UC(0x03) - Alphabetic uppercase •...
  • Page 263 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description BooleanConditionExpression string Denotes the actual conditional expression used in the document. BooleanConditionState Set to 1 to indicate that the conditional expression defined by the BooleanConditionExpression parameter is applied to the document.

  • Page 264: Element

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Element Property name Data Type Description AttrDisplay Specifies element’s attribute display properties. The value is one of: • Constants.FV_ATTR_DISP_NONE (1) - Do not display attributes • Constants.FV_ATTR_DISP_REQSPEC (2) - Display required and specified attributes •...
  • Page 265 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description MatchingLastPgfClauses Objects IDs of the last paragraph clauses (FO_FmtRuleClause IDs) in the element’s definition that apply to the element. MatchingObjectClauses IDs of the object clauses (FO_FmtRuleClause IDs) in the Objects element’s definition that apply to the element.
  • Page 266 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description 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 •...
  • Page 267 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description ContentIsStrictlyValid True if the content of the element is strictly valid. ContentMustBeEmpty True if the element cannot have any content. ContentNeededAtBegin True if content is needed at the beginning of the element.
  • Page 268 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description NextInvalidElement Element Next invalid element in the document (FO_Element ID). TextIsInvalidInElement True if the element contains only text and the element definition disallows it. is obsolete and is no TextIsInvalidInElement longer supported.

  • Page 269: Elementcatalogentries

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference ElementCatalogEntries An Array of ElementCatalogEntry objects with integer indexing and a length property. Property name Data Type Description length number The length of the array ElementCatalogEntries methods concat, pop, push. ElementCatalogEntry Property name Data Type Description Denotes the ID of the element definition.
  • Page 270 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description ElementDefType Type of formatter object represented by the element with element definition.Constants.FV_FO_CONTAINER (1) identifies a container element. Other values identify object (non-container) elements. The value is one of: •...

  • Page 271: Elementloc

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description PrefixRules Objects The IDs of the prefix format rules (FO_FmtRule IDs). SuffixRules The IDs of the suffix format rules (FO_FmtRule IDs). Objects TextFmtRules Objects The IDs of the text format rules (FO_FmtRule IDs).

  • Page 272: Elementrange

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference ElementRange Property name Data Type Description ElementLoc Beginning of the element range. End of the element range. ElementLoc ElementRange methods ElementRange. Ellipse Property name Data Type Description RectangleIsSmoothed True if smoothing is enabled. This property is always True for Ellipse objects.
  • Page 273 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description Fill 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 Denotes the frame containing the graphic object FMObject (AFrame or UnAnchoredFrame).
  • Page 274 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description Overprint Specifies the overprint settings for the objec. The value is one of: • Constants.FV_KNOCKOUT (0x00) • Constants.FV_OVERPRINT (0x01) • Constants.FV_FROMCOLOR (0x02) The fill pattern (numbers between 0 and 15). The ESTK provides constants for the following fill patterns: •...

  • Page 275: Fcodes

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference FCodes Property name Data Type FCodes.NULLINPUT Value -1 FCodes.KBD_INPUT Value 1 FCodes.START_DIALOG Value 0xC100 FCodes.END_DIALOG Value 0xC200 FCodes.START_WINDOW Value 0xC400 FCodes.END_WINDOW Value 0xC500 FCodes.LEAVE_DOC Value 0xC600 FCodes.SERVER_CANCEL Value 0xC001 FCodes.SERVER_QUERY Value 0xC002 FCodes.MENU_BARSTART Value 0xC301 FCodes.MENU_WAITBIT...
  • Page 276 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.CSR_HOME Value 0x100 FCodes.CSR_UP Value 0x101 FCodes.CSR_DOWN Value 0x102 FCodes.CSR_RIGHT Value 0x103 FCodes.CSR_LEFT Value 0x104 FCodes.CSR_BOL Value 0x105 FCodes.CSR_EOL Value 0x106 FCodes.CSR_BOW Value 0x107 FCodes.CSR_EOW Value 0x108 FCodes.CSR_BOS Value 0x109 FCodes.CSR_EOS...
  • Page 277 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.DEL_CHARFWD Value 0x113 FCodes.DEL_BOW Value 0x114 FCodes.DEL_EOW Value: 0x115 FCodes.DEL_EOL Value: 0x116 FCodes.DEL_EOS Value: 0x117 FCodes.DEL_SEL Value: 0x118 FCodes.DEL_BOL Value: 0x119 FCodes.KBD_KERNUP Value: 0x11A FCodes.KBD_KERNDOWN Value: 0x11B FCodes.KBD_KERNLEFT Value: 0x11C FCodes.KBD_KERNRIGHT...
  • Page 278 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_OBJLEFT Value: 0x127 FCodes.KBD_OBJRIGHT Value: 0x128 FCodes.CSR_NEXT_BOW Value: 0x140 FCodes.CSR_NEXT_BOS Value: 0x141 FCodes.CSR_NEXT_BOP Value: 0x142 FCodes.CSR_FIRST_COL Value: 0x143 FCodes.CSR_NEXT_COL Value: 0x144 FCodes.CSR_NEXT_ELEMENT Value: 0x145 FCodes.CSR_PREV_ELEMENT Value: 0x146 FCodes.CSR_BOE Value: 0x149 FCodes.CSR_EOE...
  • Page 279 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.DEL_BOS Value: 0x163 FCodes.KBD_NUMLOCK Value: 0x170 FCodes.KBD_GBL_END Value: 0x1FF FCodes.KBD_BACKTAB Value: 0x220 FCodes.KBD_SHFTSPACE Value: 0x221 FCodes.KBD_FIRSTTAB Value: 0x222 FCodes.KBD_TABLE_TAB Value: 0x223 FCodes.KBD_TAB Value: 0x219 FCodes.KBD_XCHARS Value: 0x224 FCodes.KBD_SOFTHYPHEN Value: 0x225 FCodes.KBD_DONTHYPHEN...
  • Page 280 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_OPENLINE Value: 0x22E FCodes.KBD_RETURN Value: 0x22F FCodes.KBD_FPREV Value: 0x230 FCodes.KBD_FNEXT Value: 0x231 FCodes.KBD_RONCE Value: 0x232 FCodes.KBD_RGLOBAL Value: 0x233 FCodes.KBD_RANDF Value: 0x234 FCodes.KBD_SETSEARCH Value: 0x235 FCodes.HIGH_CHAR Value: 0x240 FCodes.HIGH_WORD Value: 0x241 FCodes.HIGH_LINE...
  • Page 281 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_ABORT Value: 0x250 FCodes.KBD_CAPTURE Value: 0x251 FCodes.KBD_ECAPTURE Value: 0x256 FCodes.KBD_RECORD Value: 0x252 FCodes.KBD_GETTRIGGER Value: 0x253 FCodes.KBD_ABORT_DLGS Value: 0x254 FCodes.KBD_WAIT_DLGS Value: 0x255 FCodes.TXT_BOLD Value: 0x260 FCodes.TXT_ITALIC Value: 0x261 FCodes.TXT_UNDERLINE Value: 0x262 FCodes.TXT_PLAIN...
  • Page 282 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.TXT_SQUEEZE Value: 0x269 FCodes.TXT_SPREAD Value: 0x26A FCodes.TXT_NOSTRETCH Value: 0x130 FCodes.TXT_LESSSTRETCH Value: 0x131 FCodes.TXT_MORESTRETCH Value: 0x132 FCodes.TXT_BAM Value: 0x26B FCodes.TXT_STRIKEOUT Value: 0x26C FCodes.TXT_DEFAULT Value: 0x26D FCodes.TXT_OVERLINE Value: 0x26E FCodes.TXT_CHANGEBAR Value: 0x26F FCodes.TXT_KERN...
  • Page 283 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.TXT_DBLUNDERLINE Value: 0x278 FCodes.TXT_NUMUNDERLINE Value: 0x279 FCodes.TXT_TSUME Value: 0x2A5 FCodes.TXT_SELBOLD Value: 0x27A FCodes.TXT_SELITALIC Value: 0x27B FCodes.TXT_SELUNDERLINE Value: 0x27C FCodes.TXT_SELPLAIN Value: 0x27D FCodes.TXT_7 Value: 0xC00 FCodes.TXT_9 Value: 0xC01 FCodes.TXT_10 Value: 0xC02 FCodes.TXT_12...
  • Page 284 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.PGF_APPLY_TAG Value: 0xC10 FCodes.CHAR_APPLY_TAG Value: 0xC11 FCodes.MENU_EXPOSE_WIN Value: 0xC12 FCodes.MRU_SELECT_FILE Value: 0xC13 FCodes.MENU_IMPORT_FILE Value: 0xC14 FCodes.KBD_EXPORT_GRAPHIC Value: 0xC15 FCodes.KBD_EXPORT_DOCUMENT Value: 0xC16 FCodes.TXT_FONT Value: 0xC17 FCodes.PGF_APPLY_CAT_TO_SEL Value: 0xF3D FCodes.CHAR_APPLY_CAT_TO_SEL Value: 0xF3E FCodes.PGF_HYPHENON...
  • Page 285 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.PGF_BAM Value: 0x286 FCodes.PGF_LINEFIX Value: 0x287 FCodes.PGF_LINEFLOAT Value: 0x288 FCodes.PGF_UNIFY Value: 0x289 FCodes.PGF_PAGETOP Value: 0x28A FCodes.PGF_COLTOP Value: 0x28B FCodes.PGF_LEFTTOP Value: 0x28C FCodes.PGF_RIGHTTOP Value: 0x28D FCodes.PGF_ANYPLACE Value: 0x28E FCodes.KBD_ALIGN_TOP Value: 0x290 FCodes.KBD_ALIGN_MIDDLE...
  • Page 286 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.PGF_SINGLE_SPACE Value: 0x293 FCodes.PGF_ONEANDAHALF_SPACE Value: 0x294 FCodes.PGF_DOUBLE_SPACE Value: 0x295 FCodes.PGF_SPACE_BETWEEN Value: 0x296 FCodes.PGF_LINE_SPACE Value: 0x297 FCodes.PGF_UPDATE_ALL Value: 0x298 FCodes.PGF_NEW_FORMAT Value: 0x299 FCodes.KBD_HELP_INDEX Value: 0x2A0 FCodes.KBD_HELP_KEYS Value: 0x2A1 FCodes.KBD_HELP_SAMPLES Value: 0x2A2 FCodes.KBD_HELP_OVERVIEW...
  • Page 287 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_SILENT_OPEN Value: 0x307 FCodes.KBD_HELP Value: 0x302 FCodes.KBD_INFO Value: 0x303 FCodes.KBD_CSHELPMODE Value: 0x304 FCodes.KBD_ABOUTPRODUCT Value: 0x305 FCodes.KBD_BOOKADDFILE Value: 0x30A FCodes.KBD_BOOKEDITDEFINE Value: 0x30B FCodes.KBD_BOOKRENAMEFILE Value: 0x30C FCodes.KBD_BOOKDISPLAYFILENAME Value: 0x30D FCodes.KBD_BOOKDISPLAYTEXT Value: 0x30E FCodes.KBD_BOOKCOMP_EXCLUDE...
  • Page 288 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_MOVE_RIGHT Value: 0x70D FCodes.KBD_OPEN_COMPONENTS Value: 0x3EA FCodes.KBD_CLOSE_COMPONENTS Value: 0x3EB FCodes.KBD_PRINT_COMPONENTS Value: 0x3EC FCodes.KBD_SAVE_COMPONENTS Value: 0x3ED FCodes.KBD_COMPONENT_PROPERTIES Value: 0x3EE FCodes.KBD_DELETE_FILE Value: 0x30F FCodes.KBD_COLLAPSE_ALL Value: 0x3FA FCodes.KBD_EXPAND_ALL Value: 0x3FB FCodes.SWITCH_TO_RESOURCEMANAGER Value: 0x9EA FCodes.SWITCH_TO_DOCUMENTVIEW...
  • Page 289 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_SAVEASXML Value: 0x951 FCodes.KBD_MANCOND Value: 0x952 FCodes.KBD_CONDINDICATOR Value: 0x953 FCodes.KBD_ATTRCOND Value: 0x954 FCodes.KBD_PREVIEWFBA Value: 0xB16 FCodes.AMT_REGISRATION Value: 0x965 FCodes.AMT_DEACTIVATION Value: 0x967 FCodes.AMT_UPDATES Value: 0x968 FCodes.KBD_REVERT Value: 0x312 FCodes.KBD_DOCINFO Value: 0x3DA FCodes.KBD_SETPOSTER...
  • Page 290 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_PAGESETUP Value: 0x319 FCodes.KBD_OPENALL Value: 0x31A FCodes.KBD_QUITALL Value: 0x31B FCodes.KBD_SAVEALL Value: 0x31C FCodes.KBD_REPEATNEW Value: 0x31D FCodes.KBD_PODLOCATION Value: 0x31E FCodes.KBD_COMPARE Value: 0x31F FCodes.KBD_UNDO Value: 0x320 FCodes.KBD_REDO Value: 0x935 FCodes.KBD_HIST Value: 0x936 FCodes.KBD_REPEAT...
  • Page 291 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_STUFF Value: 0x328 FCodes.KBD_SEARCH Value: 0x329 FCodes.KBD_SPELLING Value: 0x32A FCodes.KBD_CAPITAL Value: 0x32B FCodes.KBD_YANK Value: 0x32C FCodes.KBD_SELECT_GENERATED_FILES Value: 0x32D FCodes.KBD_SELECT_NON_GENERATED_FILES Value: 0x32E FCodes.KBD_SELECT_FM_FILES Value: 0x315 FCodes.KBD_SELECT_PRINTABLE_FILES Value: 0x9E2 FCodes.KBD_SELECT_EXCLUDED_FILE Value: 0x9D1 FCodes.KBD_SELECT_NONEXCLUDED_FILE...
  • Page 292 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_ALLLOWERH Value: 0x36A FCodes.KBD_INITCAPH Value: 0x36B FCodes.KBD_THESAURUS Value: 0x3D0 FCodes.KBD_THESAURUS_REPLACE Value: 0x3D3 FCodes.KBD_CREATE_PUBLISHER Value: 0x3D5 FCodes.KBD_SUBSCRIBE_TO Value: 0x3D6 FCodes.KBD_LINK_BOUNDARIES Value: 0x3D7 FCodes.KBD_FONTDESIGN Value: 0x330 FCodes.KBD_PGFDESIGN Value: 0x331 FCodes.KBD_RUBIPROPS Value: 0x3DD FCodes.KBD_COLLAYOUT...
  • Page 293 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_CUST_TEXT_FRAME Value: 0xA01 FCodes.KBD_CONNECT_TEXT_FRAME Value: 0x35B FCodes.KBD_CUTHEAD Value: 0x35C FCodes.KBD_CURTAIL Value: 0x35D FCodes.KBD_CUTBOTH Value: 0xA04 FCodes.KBD_SPLIT Value: 0x35A FCodes.KBD_SPLITR Value: 0xA02 FCodes.KBD_SPLITL Value: 0xA03 FCodes.KBD_ROTPAGE_PLUS Value: 0x34E FCodes.KBD_ROTPAGE_MINUS Value: 0x34F FCodes.KBD_ROTPAGE_NORM...
  • Page 294 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_LASTPAGE Value: 0x341 FCodes.KBD_BODYPAGE Value: 0x342 FCodes.KBD_MASTERPAGE Value: 0x343 FCodes.KBD_REFPAGE Value: 0x344 FCodes.KBD_GOTOPAGE Value: 0x345 FCodes.KBD_ADDPAGE Value: 0x346 FCodes.KBD_DELETEPAGE Value: 0x347 FCodes.KBD_FREEZE Value: 0x34B FCodes.KBD_TEXTCOLPRO Value: 0x339 FCodes.KBD_PREVPAGE Value: 0x34C FCodes.KBD_NEXTPAGE...
  • Page 295 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_VARIABLE Value: 0x353 FCodes.KBD_INSET Value: 0x354 FCodes.KBD_HYPERTEXT Value: 0x359 FCodes.KBD_MARKERS Value: 0x355 FCodes.KBD_EQUATION Value: 0x336 FCodes.KBD_CONDTEXT Value: 0x357 FCodes.KBD_NEWMARKER Value: 0x356 FCodes.KBD_EDITMARKERTYPE Value: 0x409 FCodes.KBD_DELMARKERTYPE Value: 0x358 FCodes.KBD_RENAMEMARKERTYPE Value: 0x35F FCodes.KBD_ADDMARKERTYPE...
  • Page 296 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_VALIDATE_HYPERTEXT Value: 0xF13 FCodes.MENU_HYPERTEXT Value: 0xC18 FCodes.KBD_HYPRTXT_SHTCUT Value: 0x41E FCodes.WEB_GOTOADOBE Value: 0xC19 FCodes.KBD_FMPIP Value: 0x806 FCodes.WEB_PREFERENCES Value: 0xC1A FCodes.WEB_TOPISSUES Value: 0xC1B FCodes.WEB_ADOBEHELP Value: 0xC22 FCodes.WEB_CORPORATENEWS Value: 0xC1D FCodes.WEB_REGISTRATION Value: 0xC1E FCodes.WEB_FRAME_BOOKMARKS...
  • Page 297 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_FINDNEXT Value: 0x955 FCodes.KBD_FINDPREV Value: 0x956 FCodes.KBD_TRACKCHANGE Value: 0x957 FCodes.KBD_TRACKCHANGEDISABLE Value: 0x95D FCodes.KBD_ACCEPTCHANGE Value: 0x958 FCodes.KBD_REJECTCHANGE Value: 0x959 FCodes.KBD_ACCEPTALLCHANGE Value: 0x960 FCodes.KBD_REJECTALLCHANGE Value: 0x961 FCodes.KBD_PREVIEW_ACCEPTALL Value: 0x962 FCodes.KBD_PREVIEW_REJECTALL Value: 0x963 FCodes.KBD_PREVIEW_OFF...
  • Page 298 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_LIST_FIGURE Value: 0x2B1 FCodes.KBD_LIST_TABLE Value: 0x2B2 FCodes.KBD_LIST_PGF Value: 0x2B3 FCodes.KBD_LIST_PGF_ALPHA Value: 0x2B4 FCodes.KBD_LIST_MARKER Value: 0x2B5 FCodes.KBD_LIST_MARKER_ALPHA Value: 0x2B6 FCodes.KBD_LIST_REFERENCES Value: 0x2B7 FCodes.KBD_INDEX_STANDARD Value: 0x2C0 FCodes.KBD_INDEX_AUTHOR Value: 0x2C1 FCodes.KBD_INDEX_SUBJECT Value: 0x2C2 FCodes.KBD_INDEX_MARKER...
  • Page 299 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_COLOR Value: 0x39F FCodes.KBD_CONDVISIBILITY Value: 0x367 FCodes.KBD_CONDTOGGLEOVERR Value: 0x368 FCodes.KBD_TOGGLEDRAW Value: 0x366 FCodes.KBD_VIEWSEP1 Value: 0x36D FCodes.KBD_VIEWSEP2 Value: 0x36E FCodes.KBD_VIEWSEP3 Value: 0x36F FCodes.KBD_VIEWSEP4 Value: 0x37D FCodes.KBD_VIEWSEP5 Value: 0x37E FCodes.KBD_VIEWSEP6 Value: 0x39E FCodes.KBD_MENUCOMPLETE...
  • Page 300 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_SHOW_GRID Value: 0x3F4 FCodes.KBD_SHOW_LINK_BOUNDARIES Value: 0x3F5 FCodes.KBD_SHOW_ELEM_BORDER Value: 0x3F6 FCodes.KBD_SHOW_ELEM_TAGS Value: 0x3F7 FCodes.KBD_SHOW_GRAPHICS Value: 0x3F8 FCodes.KBD_SHOW_COND_IND Value: 0x3F9 FCodes.KBD_HIDE_BORDERS Value: 0x4F1 FCodes.KBD_HIDE_SYMBOLS Value: 0x4F2 FCodes.KBD_HIDE_RULERS Value: 0x4F3 FCodes.KBD_HIDE_GRID Value: 0x4F4 FCodes.KBD_HIDE_LINK_BOUNDARIES...
  • Page 301 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_ROTATE_CCW Value: 0x372 FCodes.KBD_ROT_PLUS Value: 0x372 FCodes.KBD_ROTATE_CCW_SMALL Value: 0x38A FCodes.KBD_SCALE Value: 0x373 FCodes.KBD_SMOOTH Value: 0x374 FCodes.KBD_UNSMOOTH Value: 0x375 FCodes.KBD_RESHAPE Value: 0x376 FCodes.KBD_JOINCURVES Value: 0x377 FCodes.KBD_SETSIDES Value: 0x378 FCodes.KBD_CONSTRAIN Value: 0x379 FCodes.KBD_SNAP...
  • Page 302 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_RUN_GAP Value: 0x671 FCodes.KBD_RUN_PROPS Value: 0x667 FCodes.KBD_SETRUN_PROPS Value: 0x96C FCodes.KBD_FRONT Value: 0x380 FCodes.KBD_BACK Value: 0x381 FCodes.KBD_GROUP Value: 0x382 FCodes.KBD_UNGROUP Value: 0x383 FCodes.KBD_ALIGN Value: 0x384 FCodes.KBD_DISTRIBUTE Value: 0x385 FCodes.KBD_ROTATE_CW Value: 0x386 FCodes.KBD_ROT_MINUS...
  • Page 303 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_REROTATE Value: 0x38E FCodes.KBD_ROTATE_RESET0 Value: 0x38F FCodes.KBD_SETALIGN_PROPS Value: 0x992 FCodes.KBD_SETDISTRIBUTE_PROPS Value: 0x993 FCodes.KBD_CLOSEWIN Value: 0x390 FCodes.KBD_OPENWIN Value: 0x391 FCodes.KBD_CLOPWIN Value: 0x392 FCodes.KBD_MOVEWIN Value: 0x393 FCodes.KBD_EXPOSEWIN Value: 0x395 FCodes.KBD_HIDEWIN Value: 0x396 FCodes.KBD_HISHWIN...
  • Page 304 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_RECTTOOL Value: 0x3A1 FCodes.KBD_POLYGTOOL Value: 0x3A2 FCodes.KBD_POLYLTOOL Value: 0x3A3 FCodes.KBD_ARCTOOL Value: 0x3A4 FCodes.KBD_ROUNDRECT Value: 0x3A5 FCodes.KBD_OVALTOOL Value: 0x3A6 FCodes.KBD_TEXTLTOOL Value: 0x3A7 FCodes.KBD_TEXTRTOOL Value: 0x3A8 FCodes.KBD_FREETOOL Value: 0x3A9 FCodes.KBD_FRAMETOOL Value: 0x3AA FCodes.KBD_LASTTOOL...
  • Page 305 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_DECPEN Value: 0x3B3 FCodes.KBD_FILL0 Value: 0x3B4 FCodes.KBD_FILL1 Value: 0x3B5 FCodes.KBD_INCFILL Value: 0x3B6 FCodes.KBD_DECFILL Value: 0x3B7 FCodes.KBD_SETFILL Value: 0x3B8 FCodes.KBD_SETPEN Value: 0x3B9 FCodes.KBD_SETWIDTH Value: 0x3BA FCodes.KBD_SETCAP Value: 0x3BB FCodes.KBD_SETSEP Value: 0x3BC FCodes.KBD_SETSEP_KEEP...
  • Page 306 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_SETFILL_5 Value: 0x435 FCodes.KBD_SETFILL_6 Value: 0x436 FCodes.KBD_SETFILL_7 Value: 0x437 FCodes.KBD_SETFILL_8 Value: 0x438 FCodes.KBD_SETFILL_9 Value: 0x439 FCodes.KBD_SETFILL_A Value: 0x43A FCodes.KBD_SETFILL_B Value: 0x43B FCodes.KBD_SETFILL_C Value: 0x43C FCodes.KBD_SETFILL_D Value: 0x43D FCodes.KBD_SETFILL_E Value: 0x43E FCodes.KBD_SETFILL_F...
  • Page 307 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_SETPEN_7 Value: 0x447 FCodes.KBD_SETPEN_8 Value: 0x448 FCodes.KBD_SETPEN_9 Value: 0x449 FCodes.KBD_SETPEN_A Value: 0x44A FCodes.KBD_SETPEN_B Value: 0x44B FCodes.KBD_SETPEN_C Value: 0x44C FCodes.KBD_SETPEN_D Value: 0x44D FCodes.KBD_SETPEN_E Value: 0x44E FCodes.KBD_SETPEN_F Value: 0x44F FCodes.KBD_SETWIDTH_0 Value: 0x450 FCodes.KBD_SETWIDTH_1...
  • Page 308 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_SETCAP_3 Value: 0x463 FCodes.KBD_SETCAP_OPTION Value: 0x46F FCodes.KBD_SETDASH_0 Value: 0x470 FCodes.KBD_SETDASH_1 Value: 0x471 FCodes.KBD_SETDASH_2 Value: 0x472 FCodes.KBD_SETDASH_3 Value: 0x473 FCodes.KBD_SETDASH_4 Value: 0x474 FCodes.KBD_SETDASH_5 Value: 0x475 FCodes.KBD_SETDASH_6 Value: 0x476 FCodes.KBD_SETDASH_7 Value: 0x477 FCodes.KBD_SETDASH_8...
  • Page 309 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_SETFROMCOLOR Value: 0x48C FCodes.KBD_SETTINT Value: 0x48D FCodes.KBD_SETSOLID Value: 0x402 FCodes.KBD_SETDASH Value: 0x403 FCodes.KBD_DASH0 Value: 0x404 FCodes.KBD_DASH1 Value: 0x405 FCodes.KBD_INCDASH Value: 0x406 FCodes.KBD_DECDASH Value: 0x407 FCodes.KBD_DASHOPTION Value: 0x408 FCodes.KBD_CHECKSEL Value: 0x3C0 FCodes.KBD_CHECKDOC...
  • Page 310 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_CHANGEDICT Value: 0x3C9 FCodes.KBD_SPELLRESET Value: 0x3CA FCodes.KBD_CHECKPAGE Value: 0x3CB FCodes.KBD_SPOPTIONS Value: 0x3CC FCodes.KBD_HYPHENATE Value: 0x3CD FCodes.KBD_CHECKBATCH Value: 0x3CE FCodes.KBD_REFORMATDOC Value: 0x3CF FCodes.KBD_ASC_CORRECT Value: 0x995 FCodes.KBD_ASC_ADDUSRDICT Value: 0x996 FCodes.KBD_ASC_ADDDOCDICT Value: 0x997 FCodes.KBD_ASC_ENABLE_AUTO_SPELL_CHECK...
  • Page 311 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.HIGH_WORD_PREV Value: 0x411 FCodes.HIGH_LINE_PREV Value: 0x412 FCodes.HIGH_SENT_PREV Value: 0x413 FCodes.HIGH_PGF_PREV Value: 0x414 FCodes.HIGH_LINE_UP Value: 0x415 FCodes.HIGH_LINE_DOWN Value: 0x416 FCodes.HIGH_COL_TOP Value: 0x417 FCodes.HIGH_COL_BOT Value: 0x418 FCodes.HIGH_FLOW_BEG Value: 0x419 FCodes.HIGH_FLOW_END Value: 0x41A FCodes.HIGH_LINE_BEG...
  • Page 312 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_PASTE_RTF Value: 0x502 FCodes.KBD_PAGELAYOUT Value: 0x503 FCodes.KBD_COPYRIGHT Value: 0x504 FCodes.KBD_RESTOREFONT Value: 0x505 FCodes.KBD_SYMFONT Value: 0x506 FCodes.HIGH_CHAR_NEXT Value: 0x510 FCodes.HIGH_WORD_NEXT Value: 0x511 FCodes.HIGH_LINE_NEXT Value: 0x512 FCodes.HIGH_SENT_NEXT Value: 0x513 FCodes.HIGH_PGF_NEXT Value: 0x514 FCodes.HIGH_SAMECB...
  • Page 313 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.OBJ_SEL_NEXT Value: 0x601 FCodes.OBJ_SEL_EXTEND_NEXT Value: 0x602 FCodes.OBJ_SEL_PREV Value: 0x603 FCodes.OBJ_SEL_NEXT_WRAP Value: 0x604 FCodes.OBJ_SEL_PREV_WRAP Value: 0x605 FCodes.OBJ_SEL_LAST Value: 0x606 FCodes.FOCUS_INPUT_DOC Value: 0x620 FCodes.FOCUS_INPUT_SEARCH Value: 0x621 FCodes.FOCUS_INPUT_MARKER Value: 0x622 FCodes.FOCUS_INPUT_SPELL Value: 0x623 FCodes.FOCUS_INPUT_HYPERTEXT...
  • Page 314 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.FOCUS_INPUT_VALIDATION Value: 0x62E FCodes.FOCUS_INPUT_ATTREDITOR Value: 0x62F FCodes.FOCUS_INPUT_ELEM_CTX Value: 0xA32 FCodes.KBD_CLOSE_SEARCH Value: 0x681 FCodes.KBD_CLOSE_MARKER Value: 0x682 FCodes.KBD_CLOSE_SPELL Value: 0x683 FCodes.KBD_CLOSE_PGFFMT Value: 0x684 FCodes.KBD_CLOSE_FONTFMT Value: 0x685 FCodes.KBD_CLOSE_COND Value: 0x686 FCodes.KBD_CLOSE_CUSTRS Value: 0x687 FCodes.KBD_CLOSE_TBLFMT...
  • Page 315 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_PAUSE_0x01 Value: 0x632 FCodes.KBD_SLOW_0x00 Value: 0x633 FCodes.KBD_SLOW_1x00 Value: 0x634 FCodes.KBD_SLOW_0x10 Value: 0x635 FCodes.KBD_SLOW_0x01 Value: 0x636 FCodes.KBD_SET_TEXTFRAME_GRID Value: 0x666 FCodes.KBD_PURIFY_NEW_LEAKS Value: 0x650 FCodes.KBD_PURIFY_ALL_LEAKS Value: 0x651 FCodes.KBD_PURIFY_CLEAR_LEAKS Value: 0x652 FCodes.KBD_COUNT_SBLOCKS Value: 0x653 FCodes.KBD_API...
  • Page 316 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_DSEXIT Value: 0xF01 FCodes.KBD_MEMFAIL Value: 0xF02 FCodes.KBD_SAVEMETA Value: 0xF03 FCodes.KBD_MEM_STATS Value: 0xF04 FCodes.KBD_CACHE_STATS Value: 0xF05 FCodes.KBD_NEWVAR Value: 0xF06 FCodes.KBD_UPDATEREF Value: 0xF07 FCodes.KBD_DEREFREF Value: 0xF08 FCodes.KBD_HEATREF Value: 0xF09 FCodes.KBD_DOC_REPORT Value: 0xF10 FCodes.KBD_FULLRULERS...
  • Page 317 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_RESIZEBOXM Value: 0xF27 FCodes.KBD_ELEMENTWIN Value: 0xF28 FCodes.KBD_SMALLTOOLWIN Value: 0xF29 FCodes.KBD_OBJSELECT_NOPREF Value: 0xF2A FCodes.KBD_ZOOMIN Value: 0xF30 FCodes.KBD_ZOOMOUT Value: 0xF31 FCodes.KBD_ZOOM_FIT_PAGE Value: 0xF32 FCodes.KBD_ZOOM_FIT_WINDOW Value: 0xF33 FCodes.KBD_ZOOM Value: 0xF34 FCodes.KBD_ZOOM100 Value: 0xF35 FCodes.KBD_ZOOM_SET...
  • Page 318 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_RENAMEFRAME Value: 0xF3B FCodes.KBD_FONTQUICK Value: 0xF40 FCodes.KBD_PGFQUICK Value: 0xF41 FCodes.KBD_VARQUICK Value: 0xF42 FCodes.KBD_CELLFMTQUICK Value: 0xF43 FCodes.KBD_CONDINQUICK Value: 0xF44 FCodes.KBD_CONDNOTINQUICK Value: 0xF45 FCodes.KBD_UNCOND Value: 0xF46 FCodes.KBD_CONDVISONLYQUICK Value: 0xF47 FCodes.KBD_INSERTQUICK Value: 0xF48 FCodes.KBD_WRAPQUICK...
  • Page 319 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_SMEQN Value: 0xF50 FCodes.KBD_MEDEQN Value: 0xF51 FCodes.KBD_LGEQN Value: 0xF52 FCodes.KBD_PUTINLINE Value: 0xF53 FCodes.KBD_ANTIPUTINLINE Value: 0xF54 FCodes.KBD_EVACUATE Value: 0xF60 FCodes.KBD_VERIFYCONTEXT Value: 0xF61 FCodes.KBD_SAVEASDBRE Value: 0xF70 FCodes.KBD_TEST_MODAL Value: 0xF71 FCodes.KBD_TEST_MODELESS Value: 0xF72 FCodes.KBD_STUFF_ITEM...
  • Page 320 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_DRE_MODE_W Value: 0xF7B FCodes.KBD_DRE_MODE_M Value: 0xF7C FCodes.KBD_TABLE_INS Value: 0xF80 FCodes.KBD_TABLE_FORMAT Value: 0xF81 FCodes.KBD_TABLE_CELLFMT Value: 0xF84 FCodes.KBD_TABLE_ROWFMT Value: 0xF85 FCodes.KBD_TABLE_CUSTRS Value: 0xF86 FCodes.KBD_TABLE_ADDRC Value: 0xF87 FCodes.KBD_TABLE_RESIZECOL Value: 0xF88 FCodes.KBD_TABLE_STRADDLE Value: 0xF89 FCodes.KBD_TABLE_CONVERT...
  • Page 321 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_TBL_DLG_ADD_LEFT Value: 0xF94 FCodes.KBD_TBL_DLG_ADD_RIGHT Value: 0xF95 FCodes.KBD_TBL_DLG_CLEAR_EMPTY Value: 0xF96 FCodes.KBD_TBL_DLG_CLEAR_X Value: 0xF97 FCodes.KBD_TBL_DLG_PASTE_REPL Value: 0xF98 FCodes.KBD_TBL_DLG_PASTE_BEFORE Value: 0xF99 FCodes.KBD_TBL_DLG_PASTE_AFTER Value: 0xF9A FCodes.KBD_TABLEWIN Value: 0xFBB FCodes.TBL_APPLY_CAT_TO_SEL Value: 0xFBC FCodes.KBD_CLOSE_TABLE_CATALOG Value: 0xFBD FCodes.TBL_APPLY_TAG...
  • Page 322 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_REWRAP_INLINE_MATH Value: 0xFAC FCodes.KBD_MODE_ROTATE_TOOL Value: 0xFAD FCodes.KBD_XYZZY Value: 0xFED FCodes.KBD_XYZZZ Value: 0xEE0 FCodes.KBD_XYZZQ Value: 0xEE1 FCodes.CMD_OPEN_DITAMAP_COMPONENT Value: 0xF14 FCodes.PGF_DESIGNKIT_APPLY Value: 0xAAA FCodes.CHAR_DESIGNKIT_APPLY Value: 0xAAB FCodes.TBL_DESIGNKIT_APPLY Value: 0xAAC FCodes.PGF_DESIGNKIT_UPDATEALL Value: 0xAAD FCodes.CHAR_DESIGNKIT_UPDATEALL...
  • Page 323 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_PGFFMT_DELETE Value: 0xB06 FCodes.KBD_CHARFMT_DELETE Value: 0xB07 FCodes.KBD_TBLFMT_DELETE Value: 0xB08 FCodes.KBD_PGFFMT_DELETE_UNUSED Value: 0xB13 FCodes.KBD_CHARFMT_DELETE_UNUSED Value: 0xB14 FCodes.KBD_TBLFMT_DELETE_UNUSED Value: 0xB15 FCodes.PGF_DESIGNKIT_RESET Value: 0xABA FCodes.CHAR_DESIGNKIT_RESET Value: 0xABB FCodes.TBL_DESIGNKIT_RESET Value: 0xABC FCodes.CONDTEXT_KIT_APPLY Value: 0xB09 FCodes.ALT_TXT_INSET...
  • Page 324 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_TBLIP_TOPLEFT Value: 0xFB0 FCodes.KBD_TBLIP_RIGHT Value: 0xFB1 FCodes.KBD_TBLIP_LEFT Value: 0xFB2 FCodes.KBD_TBLIP_ABOVE Value: 0xFB3 FCodes.KBD_TBLIP_BELOW Value: 0xFB4 FCodes.KBD_TBLIP_LEFTMOST Value: 0xFB5 FCodes.KBD_TBLIP_RIGHTMOST Value: 0xFB6 FCodes.KBD_TBLIP_NEXT Value: 0xFB7 FCodes.KBD_TBLIP_PREV Value: 0xFB8 FCodes.KBD_TBLIP_TOP Value: 0xFB9 FCodes.KBD_TBLIP_BOTTOM...
  • Page 325 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_TBL_DLG_SHRINKWRAP Value: 0xFD0 FCodes.ELEM_INS_CAT_AT_SEL Value: 0xA10 FCodes.ELEM_WRAP_CAT_AT_SEL Value: 0xA11 FCodes.ELEM_CHANGE_CAT_AT_SEL Value: 0xA12 FCodes.ELEM_INSERT_CUSTOM_1 Value: 0xA21 FCodes.ELEM_INSERT_CUSTOM_2 Value: 0xA22 FCodes.ELEM_INSERT_CUSTOM_3 Value: 0xA23 FCodes.ELEM_INSERT_CUSTOM_4 Value: 0xA24 FCodes.ELEM_INSERT_CUSTOM_5 Value: 0xA25 FCodes.ELEM_INSERT_CUSTOM_6 Value: 0xA26 FCodes.ELEM_INSERT_CUSTOM_7...
  • Page 326 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_ELEM_BORDER Value: 0xFD2 FCodes.KBD_ELEM_MERGE_1ST Value: 0xFD3 FCodes.KBD_ELEM_MERGE_LAST Value: 0xFD4 FCodes.KBD_ELEM_SPLIT Value: 0xFD5 FCodes.KBD_ELEM_UNWRAP Value: 0xFD6 FCodes.KBD_ELEM_CAT_OPTS Value: 0xFD7 FCodes.KBD_SETELCATSTRICT Value: 0xFD8 FCodes.KBD_SETELCATLOOSE Value: 0xFD9 FCodes.KBD_SETELCATCHILD Value: 0xFDA FCodes.KBD_SETELCATALL Value: 0xFDB FCodes.KBD_SETELCATFREQ...
  • Page 327 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_VAL_DOC Value: 0xFE3 FCodes.KBD_VAL_IGNORE Value: 0xFE4 FCodes.KBD_VAL_START Value: 0xFE5 FCodes.KBD_VAL_ALLOW Value: 0xFE6 FCodes.KBD_VAL_CLEAR Value: 0xFE7 FCodes.SW_CSR_UP Value: 0xFE8 FCodes.SW_CSR_DOWN Value: 0xFE9 FCodes.SW_CSR_RIGHT Value: 0xFEA FCodes.SW_CSR_LEFT Value: 0xFEB FCodes.KBD_ATTRIBUTE_EDIT Value: 0xFEC FCodes.KBD_ATTR_CONFIG_FILE_MAKER...
  • Page 328 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_ELEM_TRANSPOSE_PREV Value: 0xFF4 FCodes.KBD_ELEM_TRANSPOSE_NEXT Value: 0xFF5 FCodes.KBD_VAL_IGNORE_ATTR Value: 0xFF6 FCodes.KBD_NAMESPACES Value: 0xFF8 FCodes.KBD_TOGGLE_STRUCT_AND_DOCWIN Value: 0xFF9 FCodes.FM_SEPARATOR Value: 0xF12 FCodes.FM_TERMINATE Value: 0xFFF FCodes.FM_RPT_CMDS_BY_TAG Value: 0xD00 FCodes.FM_RPT_CMDS_BY_SHORTCUT Value: 0xD01 FCodes.KBD_PASTESPECIAL Value: 0xD10 FCodes.KBD_CLOSE_TOP_PALETTE...
  • Page 329 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_CLOSE_TABLE_DESIGNER Value: 0xD2A FCodes.KBD_WINDOWFULL_UP Value: 0xD40 FCodes.KBD_WINDOWFULL_DOWN Value: 0xD41 FCodes.KBD_VIEWER_MAKE_DOCUMENT Value: 0xD50 FCodes.KBD_VIEWER_MAKE_PALETTE Value: 0xD51 FCodes.KBD_VIEWER_MAKE_MODELESSDIALOG Value: 0xD52 FCodes.KBD_Item1stLogical Value: 0xD60 FCodes.KBD_ItemNextLogical Value: 0xD61 FCodes.KBD_ItemPrevLogical Value: 0xD62 FCodes.KBD_ItemNextPhysical Value: 0xD63 FCodes.KBD_ItemPrevPhysical...
  • Page 330 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_RENAMEORPLAIN Value: 0x900 FCodes.KBD_WIN_CASCADE Value: 0x903 FCodes.KBD_WIN_TILE Value: 0x904 FCodes.KBD_TAB_LEFT Value: 0x906 FCodes.KBD_TAB_CENTER Value: 0x907 FCodes.KBD_TAB_RIGHT Value: 0x908 FCodes.KBD_TAB_DECIMAL Value: 0x909 FCodes.KBD_PRINTSETUP Value: 0x90A FCodes.KBD_MINIMIZE Value: 0x90F FCodes.KBD_MAXIMIZE Value: 0x910 FCodes.KBD_RESTORE...
  • Page 331 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_EMBEDDED04 Value: 0x924 FCodes.KBD_EMBEDDED05 Value: 0x925 FCodes.KBD_EMBEDDED06 Value: 0x926 FCodes.KBD_EMBEDDED07 Value: 0x927 FCodes.KBD_EMBEDDED08 Value: 0x928 FCodes.KBD_EMBEDDED09 Value: 0x92A FCodes.KBD_EMBEDDED10 Value: 0x92B FCodes.KBD_EMBEDDED11 Value: 0x92C FCodes.KBD_EMBEDDED12 Value: 0x92D FCodes.KBD_EMBEDDED13 Value: 0x92E FCodes.KBD_EMBEDDED14...
  • Page 332 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_SHOWNEXT Value: 0x971 FCodes.KBD_SHOWPREV Value: 0x972 FCodes.KBD_SCREENMODE_TOGGLE Value: 0x978 FCodes.KBD_SCREENMODE_STANDARD Value: 0x979 FCodes.KBD_SCREENMODE_FULLSCREEN_UI Value: 0x97A FCodes.KBD_SCREENMODE_FULLSCREEN Value: 0x97B FCodes.KBD_UI_PREFERENCE Value: 0x980 FCodes.KBD_UIALERTSTRINGS_PREF Value: 0x981 FCodes.KBD_TOOLBAR_SHOWALL Value: 0x989 FCodes.KBD_TOOLBAR_HIDEALL Value: 0x98A FCodes.KBD_TOOLBAR_BASE...
  • Page 333 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.TEXTSEL_WORD Value: 0x0020 FCodes.TEXTSEL_LINE Value: 0x0040 FCodes.TEXTSEL_PGF Value: 0x0080 FCodes.TEXTSEL_SELECT_ONLY Value: 0x0100 FCodes.TEXTSEL_EXTEND_SENT Value: 0x0200 FCodes.TEXTSEL_SENT Value: 0x0400 FCodes.TEXTSEL_EXTEND_ELEMENT Value: 0x0800 FCodes.TEXTSEL_ELEMENT Value: 0x1000 FCodes.TEXTSEL_DRAGGING Value: 0x2000 FCodes.EXTEND_SEL Value: (0x0002|0x0004|0x0008|0x0010|0x0800) FCodes.MIF_SAVE_TEXT...
  • Page 334 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.MIF_SAVE_FCAT Value: 0x000100 FCodes.MIF_SAVE_PCAT Value: 0x000200 FCodes.MIF_SAVE_CCAT Value: 0x000400 FCodes.MIF_SAVE_TMPLT Value: 0x000800 FCodes.MIF_SAVE_DICT Value: 0x001000 FCodes.MIF_SAVE_VARS Value: 0x002000 FCodes.MIF_SAVE_TABLECATS Value: 0x004000 FCodes.MIF_SAVE_TABLES Value: 0x008000 FCodes.MIF_SAVE_ECAT Value: 0x010000 FCodes.MIF_SAVE_ELEMENTS Value: 0x020000 FCodes.MIF_SAVE_COLORCAT...

  • Page 335: Filterargs

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type FCodes.KBD_NEW_XML Value: 0x803 FCodes.KBD_CMS_PREFERENCE Value: 0x804 FCodes.KBD_CMS_UPLOAD_DOC_OR_BOOK Value: 0x805 FCodes.KBD_REFRESH_DITAMAP_RMVIEW Value: 0x807 FilterArgs Property name Data Type Description infile The file to filter. string outfile string The filter output file.

  • Page 336: Fmtchangelist

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description MaxInterPgfPadding Maximum interparagraph spacing. MinHang 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.
  • Page 337 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description MaxSpace Maximum word spacing (percentage of an em space in current font). MinSpace Minimum word spacing (percentage of an em space in current font). OptSpace Optimum word spacing. TopSeparator Name of frame to put above paragraph.
  • Page 338 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description MoveTabs Amount by which to move all tab positions in the paragraph. NumTabs The number of tabs in the paragraph. To clear all the tabs in the paragraph, set to 0.
  • Page 339 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description Language The hyphenation and spell-checking language to use. The value is one of: • Constants.FV_LANG_BRAZILIAN (0x0B) • Constants.FV_LANG_BRITISH (0x02) • Constants.FV_LANG_CANADIAN_FRENCH (0x06) • Constants.FV_LANG_CATALAN (0x08) • Constants.FV_LANG_DANISH (0x0C) •...
  • Page 340 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description KernY 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.
  • Page 341 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description Start Denotes the Vertical placement of a paragraph. The value is one of: • Constants.FV_PGF_ANYWHERE () • Constants.FV_PGF_TOP_OF_COL () • Constants.FV_PGF_TOP_OF_PAGE () • Constants.FV_PGF_TOP_OF_LEFT_PAGE () • Constants.FV_PGF_TOP_OF_RIGHT_PAGE () CellBottomMargin Amount added to default bottom margin of table cell.

  • Page 342: Fmtrule

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference FmtRule 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.
  • Page 343 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description FmtChangeListTag string Denotes the change list’s tag, if If the format rule clause specifies a change list ( RuleClauseType specifies Constants.FV_RC_CHANGELIST_TAG (3) FmtRule The ID of the format rule containing the format rule FmtRule clause (FO_FmtRule ID).

  • Page 344: Font

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description InTextFrame TextFrame Text frame containing the footnote (FO_TextFrame ID). InTextObj Sub column that contains the footnote (FO_SubCol). SubCol LastPgf Last paragraph in the footnote (FO_Pgf ID). NextFnInDoc Next footnote (FO_Fn ID) in the document.

  • Page 345: Group

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Fonts methods concat, pop, push. Group Property name Data Type Description FirstGraphicInGroup First object in the group. FMObject LastGraphicInGroup FMObject Last object in the group. Angle Angle of the object’s rotation. ArrowBaseAngle Arrowhead base angle in degrees.
  • Page 346 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description GraphicIsSelected True if the graphic object is selected; False, otherwise. GroupParent Group that the object is in (FO_Group ID). Group Note: Anchored and unanchored frames do not have this property.

  • Page 347: Hidden

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description PrevGraphicInGroup FMObject Previous graphic object in the group Runaround 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.

  • Page 348: Inset

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Inset Property name Data Type Description InsetDpi 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). ImportHint Record identifying the filter used to import the graphic.
  • Page 349 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description ArrowType Arrowhead style. The value is one of: • Constants.FV_ARROW_STICK (0x1) • Constants.FV_ARROW_HOLLOW (0x2) • Constants.FV_ARROW_FILLED (0x3) BorderWidth Denotes the border width (0.015 points to 360 points). Color Color...
  • Page 350 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description NextGraphicInFrame FMObject Next graphic object in the frame. NextGraphicInGroup Next graphic object in the group. FMObject NextSelectedGraphicInDoc FMObject Next selected graphic object in document. ObjectAttributes A list of strings, each string expressing an attribute that is...

  • Page 351: Ints

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Ints An Array ofobjects with integer indexing and a length property. Property name Data Type Description length number The length of the array Ints methods concat, pop, push. Line Property name Data Type Description NumPoints Specifies the number of vertices.
  • Page 352 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description Fill 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 Frame containing the graphic object (FO_AFrame or FMObject FO_UnanchoredFrame ID).

  • Page 353: Marker

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description 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 Previous graphic object in the frame.

  • Page 354: Markertype

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Marker methods Delete, GetProps, ObjectValid, SetProps. MarkerType Property name Data Type Description NextMarkerTypeInDoc Denotes the next marker type (FO_MarkerType ID). MarkerType Name string The name of this marker type, as it appears in the user interface.

  • Page 355: Math

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Math Property name Data Type Description BasePointX Horizontal placement of text line base point relative to the left side of the frame. BasePointY Vertical placement of text line base point relative to top of the frame.
  • Page 356 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description 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...
  • Page 357 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description NextGraphicInGroup FMObject Indicates the next graphic object in the group. NextSelectedGraphicInDoc Specifies the next selected graphic object in the FMObject document. ObjectAttributes Strings Contains a list of strings, each string expressing an attribute that is specified for an anchored frame in the Object Properties >...

  • Page 358: Menu

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Menu Property name Data Type Description FirstMenuItemInMenu FMObject The first menu item in the menu. MenuType Type of menu. The value is one of: • Constants.FV_MENU_MENUBAR (1) - Amenu bar defined by the FrameMaker product.

  • Page 359: Metrics

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description NextMenuItemInMenu FMObject The next menu item separator in the menu. NextMenuItemInSession The next menu item separator in the list of menu items, FMObject menus, and separators in the session.
  • Page 360 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description NumAtEnd True if numbering position is End of Paragraph; False if it is Beginning of Paragraph. PgfIsAutoNum True if autonumbering is enabled. PgfNumber string The formatted string representation of the paragraph number;...
  • Page 361 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description Position 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 Character stretch (set width) expressed as a percentage of normal stretch for the font (metric –10% to 1000%).
  • Page 362 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description Locked True 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.
  • Page 363 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description Unique The paragraph’s user ID. FirstIndent First-line left margin, measured from left side of current text column (0 cm to 100 cm). LeftIndent Left margin, measured from left side of current text column (0 cm to 100 cm).
  • Page 364 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description Start Vertical placement of paragraph. The value is one of: • Constants.FV_PGF_ANYWHERE (0x00) • Constants.FV_PGF_TOP_OF_COL (0x01) • Constants.FV_PGF_TOP_OF_PAGE (0x02) • Constants.FV_PGF_TOP_OF_LEFT_PAGE (0x03) • Constants.FV_PGF_TOP_OF_RIGHT_PAGE (0x04) InTextFrame Text frame containing the paragraph (FO_TextFrame ID).

  • Page 365: Pgffmt

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference PgfFmt Property name Data Type Description AcrobatLevel Retained in Version 6.0 or later for backward compatibility. Use PDFStructureLevel instead. PgfMarkedForNamedDestination If True, this paragraph will have a corresponding Named Destination in the generated PDF.
  • Page 366 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description FontAngle Font angle (specifies an index into the array of font angles provided by the session property FontAngleNames FontEncodingName The font’s encoding. string FontFamily Font family (specifies an index into the array of font...
  • Page 367 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description HyphMinPrefix Minimum number of letters that must precede hyphen. HyphMinSuffix Minimum number of letters that must follow a hyphen. HyphMinWord Minimum length of a hyphenated word. Language Hyphenation and spell-checking language to use. The value is one of: •...
  • Page 368 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description LineSpacing 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_PROPORTIONAL (0x01): largest font in line •...
  • Page 369 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description 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.

  • Page 370: Point

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description UseNextTag True if Next Paragraph Tag is enabled. LetterSpace True if Word Spacing is enabled. MaxSpace Maximum word spacing (percentage of an em space in current font). MinSpace Minimum word spacing (percentage of an em space in current font).

  • Page 371: Polygon

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Polygon Property name Data Type Description NumPoints Number of polygon vertices. Points Array of x-y coordinate pairs that specify the polygon’s Points vertices. PolyIsBezier True if polygon is smoothed. Angle Indicates the angle of rotation of the graphic object.
  • Page 372 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description GroupParent Group Specifies the group to which the object belongs. Note: Anchored frames do NOT have this property. HeadArrow Set to if the line has an arrow head. Set to...

  • Page 373: Polyline

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description 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) •...
  • Page 374 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description ArrowScaleFactor 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...
  • Page 375 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description LineCap 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 Specifies the distance of the object from the left side of the parent frame (in inches).

  • Page 376: Propident

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description Runaround 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: •...

  • Page 377: Propvals

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference PropVals An Array of PropVal objects with integer indexing and a length property. Property name Data Type Description length number The length of the array PropVals methods concat, pop, push. Rectangle Property name Data Type...
  • Page 378 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description Fill 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) •...
  • Page 379 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description 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...

  • Page 380: Roundrect

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference RefPage Property name Data Type Description Name string Name of the reference page. PageFrame Page frame (FO_UnanchoredFrame ID) UnanchoredFrame PageHeight Height of the page. PageNext Next reference page (FO_RefPage ID) in the document. RefPage PageNum Page number.
  • Page 381 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description 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;...
  • Page 382 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description NextSelectedGraphicInDoc FMObject Denotes the next selected graphic object in the document. ObjectAttributes A list of strings. Each string expresses an attribute that is Strings specified for an anchored frame in the Object Properties >...
  • Page 383 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description CondFmtIsShown True if the condition is shown. Element The ID of the element containing the row in a Element FrameMaker document. FirstCellInRow Cell First cell in row (FO_Cell ID).

  • Page 384: Rubi

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description StyleOverrides Style condition indicators for conditional text: • Constants.FV_CS_NO_OVERRIDE (0x00) • Constants.FV_CS_OVERLINE (0x01) • Constants.FV_CS_STRIKETHROUGH (0x02) • Constants.FV_CS_SINGLE_UNDERLINE (0x04) • Constants.FV_CS_DOUBLE_UNDERLINE (0x08) All style condition indicators are represented as hatched lines for the table rows.

  • Page 385: Rulingfmt

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference RulingFmt Property name Data Type Description Name string Ruling format name. NextRulingFmtInDoc Next ruling format in document (FO_RulingFmt ID). RulingFmt Specifies the pen pattern (numbers between 0 and 7). Constants are provided for pen patterns 0, 7 and 15, as follows: •...
  • Page 386 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description FirstPgf First paragraph in the column (FO_Pgf ID). FrameParent ID of text frame that contains the column (FO_TextFrame TextFrame ID). Height Column Height. LastAFrame Last anchored frame in the column (FO_AFrame ID).

  • Page 387: Tabs

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description Offset from the left margin. type Type of tab. The value is one of: uint • Constants.FV_TAB_LEFT (0x1) - Left tab. • Constants.FV_TAB_CENTER (0x2) - Center tab. • Constants.FV_TAB_RIGHT (0x3) - Right tab.
  • Page 388 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description ContentHeight The height of the table title. Locked True 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.
  • Page 389 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description TblCatalogEntry True if the table’s format is in the Table Catalog. TblColWidths List of column widths. Metrics TblNumbering Direction of autonumbering for the table. The value is one of: •...
  • Page 390 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description LeftColNum Number of the leftmost selected column, if a table is selected (columns are numbered from left to right, starting with 0). RightColNum Number of rightmost selected column, if a table is selected (columns are numbered from left to right, starting with 0).

  • Page 391: Tblfmt

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description LastPgf The last paragraph in the title, if the table has a title. TblTitleGap Gap between the title and top or bottom row of the table. TblTitlePosition The placement of the table title. The value is one of: •...
  • Page 392 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description TblTitleGap Gap between title and top or bottom row. TblTitlePosition The placement of the table title. The value is one of: • Constants.FV_TBL_NO_TITLE (0) - Table has no title •...

  • Page 393: Textframe

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description TblOtherBodyRowRuling RulingFmt Ruling applied to body rows specified by TblBodyRowRulingPeriod FO_RulingFmt ID TblOtherColRuling Ruling applied to table columns specified by RulingFmt TblColRulingPeriod FO_RulingFmt ID TblRightRuling RulingFmt Ruling for the right side of the table (...
  • Page 394 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description LastAFrame AFrame Last anchored frame in the text frame (FO_AFrame ID). LastCell Last table cell in the text frame (FO_Cell ID). Cell LastFn Last footnote in the text frame (FO_Fn ID).
  • Page 395 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description 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;...
  • Page 396 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description NextSelectedGraphicInDoc FMObject Denotes the next selected graphic object in the document. ObjectAttributes A list of strings. Each string expresses an attribute that is Strings specified for an anchored frame in the Object Properties >...

  • Page 397: Textitem

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference TextItem Property name Data Type Description offset Offset from the beginning of the paragraph or the text line. dataType Type of the text item. sdata string Denotes the text item if the text item is a string.
  • Page 398 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Text Item Type Text Item Represents Text Item Data 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_ElemPrefixBegin The beginning of an element’s prefix.

  • Page 399: Textitems

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Flags Meaning 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.

  • Page 400: Textline

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference TextLine Property name Data Type Description BasePointX Horizontal placement of text line base point relative to left side of the frame. BasePointY Vertical placement of text line base point relative to top of the frame.
  • Page 401 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description ArrowBaseAngle Denotes the arrowhead base angle in degrees. ArrowLength Denotes the arrowhead length (always rounded down to the nearemichael.and.st 1/256 point). ArrowScaleFactor Indicates the factor by which the arrowhead is scaled as line width changes (always rounded down to nearest 1/16 point).
  • Page 402 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description LineCap 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 Specifies the distance of the object from the left side of the parent frame (in inches).

  • Page 403: Textloc

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description Runaround 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: •...

  • Page 404: Tiapiclient

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference TiApiClient Property name Data Type Description TiClientData string Data used by the client (for example, an SQL query). TiClientName The registered name of the client that created the inset. string TiClientSource string The name that appears as the source in the Text Inset Properties dialog box.

  • Page 405: Tiflow

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference TiFlow Property name Data Type Description TiFlowName string The name of the imported flow if TiMainFlow False TiFlowPageSpace The type of pages the imported flow is on: • Constants.FV_BODY_PAGE(0x00) • Constants.FV_REFERENCE_PAGE (0x02) TiFormat Source of the imported text’s format: •...

  • Page 406: Titext

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description TiFileModDate string The modification date of the text inset’s source file. LastUpdate Time when the inset was last updated, expressed in seconds since 1 January, 1970. Unique The text inset’s UID.

  • Page 407: Titexttable

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference TiText methods ConvertToText, Delete, DeletePropByName, DeleteTextInsetContents, GetProps, GetText, ObjectValid, SetProps, UpdateTextInset. TiTextTable Property name Data Type Description TiByRows True if each paragraph in the imported text is converted to a row of table cells;...

  • Page 408: Typedval

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description TiFileModDate string The modification date of the text inset’s source file. LastUpdate Time when the inset was last updated, expressed in seconds since 1 January, 1970. Unique The text inset’s UID.

  • Page 409: Ubytes

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description length The length of the array number TypedVals methods concat, pop, push. UBytes An Array ofobjects with integer indexing and a length property. Property name Data Type Description length...
  • Page 410 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description ArrowLength Denotes the arrowhead length (always rounded down to the nearest 1/256 point). ArrowScaleFactor Indicates the factor by which the arrowhead is scaled as line width changes (always rounded down to nearest 1/16 point).
  • Page 411 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description LineCap 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 Specifies the distance of the object from the left side of the parent frame (in inches).
  • Page 412 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description Runaround 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: •...

  • Page 413: Varfmt

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference VarFmt Property name Data Type Description string The variable format definition; the building blocks and text strings used to create a variable instance with the variable format. Name The variable format’s name. string NextVarFmtInDoc VarFmt Next variable format (FO_VarFmt ID) in the document’s...

  • Page 414: Xref

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference XRef Property name Data Type Description Element Element The associated element, if the cross reference is in a FrameMaker document. Locked True if the cross-reference is part of a text inset that retains formatting information from the source document.

  • Page 415: Xreffmt

    ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference XRef methods Delete, GetProps, GetText, ObjectValid, SetProps. XRefFmt Property name Data Type Description The cross-reference format (a string that specifies text string and building blocks). Name string The cross-reference format’s name. NextXRefFmtInDoc XRefFmt Denotes the next cross-reference format (FO_XRefFmt ID).
  • Page 416 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description FirstOpenDoc First open document ( FO_Doc ID) in session. BinDir Directory path of string $FMHOME/bin CurrentDir string Name of the directory from which the FrameMaker product was started CurrentMenuSet Type of menu set.
  • Page 417 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description IsInFront True 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.
  • Page 418 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description 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: •...
  • Page 419 ADOBE FRAMEMAKER SCRIPTING GUIDE Object Reference Property name Data Type Description 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...

  • Page 420: Aframe

    Chapter 5: Function Summary AFrame Delete Description method is used to delete an object from a document. When you delete an object that contains another Delete() 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.
  • Page 421 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Constants.FE_WrongProduct (-60) Current FrameMaker version does not support the specified operation. Returns PropVals Syntax GetProps() SetProps Description method sets the properties of a specified object. SetProps() The method takes one argument - An array containing the values of the object to be set.
  • Page 422 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Constants.FE_InvContextSpec () The API 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.
  • Page 423 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Delete Description Deletes the Arc object. Delete under the AFrame class for more information. Returns Syntax Delete() GetProps Description method retrieves the properties of the Arc object. GetProps() SetProps under the AFrame class for more information.

  • Page 424: Attrcondexpr

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary ObjectValid Description Returns if the Arc object is valid, else returns True False ObjectValid under the AFrame class for more information. Returns Syntax ObjectValid() AttrCondExpr ApplyAttributeExpression Description is the method to apply the attribute expression to the document.

  • Page 425: Attribute

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary SetProps under the AFrame class for more information. Returns Void Syntax SetProps(setVal) Parameters Parameter name Data Type Optional Description setVal PropVals The property list. ObjectValid Description Returns if the attribute expression is valid, else returns...

  • Page 426: Attributedef

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description name string Attribute name. values Attribute values. Strings valflags uint Validation error flags. allow uint Allow error as special case. AttributeDef AttributeDef Description Describes a single attribute function.

  • Page 427: Attributedefs

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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).

  • Page 428: Attributes

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns AttributeDef Syntax pop() push Description Returns the new length of the array. Returns number Syntax push(value) Parameters Parameter name Data Type Optional Description value AttributeDe Value to push into the array. Attributes An Array of Attribute objects with integer indexing and a length property.

  • Page 429: Attributesex

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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 Optional Description value Attribute Value to push into the array.

  • Page 430: Body

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description value AttributesE Can also be arrays. Description Removes the last element from the array. Returns AttributeEx Syntax pop() push Description Returns the new length of the array.
  • Page 431 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax Delete() GetProps Description method retrieves the properties of the specified Body Page. GetProps() GetProps under the AFrame class for more information. Returns PropVals Syntax GetProps() SetProps Description method sets the properties of the specified Body Page.

  • Page 432: Book

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary ApplyPageLayout Description method applies the layout of one page to another page. ApplyPageLayout() The method returns on success, and sets with one of the following values on error: FE_Success FA_errno Error Reason Constants.FE_WrongProduct (-60)
  • Page 433 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary The method returns the comparison results in the object on success. On failure, the method assigns one CompareRet of the following values to FA_errno Error Reason Constants.FE_BadDocId (-2) Invalid document. Constants.FE_BadCompare (-35) Older and newer documents are not the same types of files.
  • Page 434 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Constants.FE_BadBookId (-66) Invalid book. Constants.FE_BadCompPath (-68) Component name specified for compName is invalid. Constants.FE_BadNew (-23) The object cannot be created. Constants.FE_BookUnStructured (-67) The specified book is unstructured. Returns Element Syntax NewBookComponentInHierarchy(compName, elemLoc)
  • Page 435 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary The method returns on success, and assigns with one of the following values on failure: FE_Success FA_errno Error Reason Constants.FE_BadOperation (-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);...
  • Page 436 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Flag What to Import Constants.FF_UFF_REMOVE_EXCEPTIONS Remove exception formats from target documents (0x8000) Constants.FF_UFF_REMOVE_PAGE_BREAKS Remove all forced page breaks from target documents (0x4000) Constants.FF_UFF_TABLE (0x0008) Table Catalog formats Constants.FF_UFF_VAR (0x0040) Variable formats Constants.FF_UFF_XREF (0x0080) Cross-reference formats The method returns on success.
  • Page 437 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Flag Meaning Constants.FF_IED_DO_NOT_IMPORT_EDD If the source document is an EDD, setting this value does NOT treat it as an EDD; instead the (0x0004) method just imports its element catalog. Constants.FF_IED_NO_NOTIFY (0x0008) Do not issue the Constants.FA_Note_PreImportElemDefs (64) or Constants.FA_Note_PostImportElemDefs (65) notifications.
  • Page 438 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description objType The type of object (for example, FO_Pgf). unique The unique ID of the object. Close Description Closes a document, book, dialog box, or Frame session. parameter specifies whether to abort or to close open documents or books if they have unsaved changes.
  • Page 439 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary If you set the parameter to , FrameMaker displays the Save dialog box and allows the user to choose interactive True a filename. The book's current name appears as the default file name. method returns the book it saved, on success.
  • Page 440 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary NewSeriesObject Description method creates a series object. Series objects include the following object types: NewSeriesObject() • BodyPage • BookComponent • Pgf The method allows you to specify the position in the series at which to add the new object.
  • Page 441 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns BookComponent Syntax NewSeriesBookComponent(previous) Parameters Parameter name Data Type Optional Description previous Object 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.
  • Page 442 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary The method returns the document it saved, on success. On failure the method sets to one of the following values: FA_errno Error Reason • • Constants.FE_Canceled (-44) Constants.FV_FileNotWritable (33) - File was not writable.
  • Page 443 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description saveAsName string The path for saving the document or book. saveParams A property list that tells FrameMaker how to save the file and PropVals how to respond to errors and other conditions. Use GetSaveDefaultParams() or AllocatePropVals() to create and allocate memory for this property list.
  • Page 444 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Property Meaning 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: •...
  • Page 445 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Property Meaning Constants.FS_UpdateBookTextReferences (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.
  • Page 446 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns Syntax UpdateBook(updateParams, updateReturnParams) Parameters Parameter name Data Type Optional Description updateParams PropVals A property list specifying how to update the book and how to respond to errors and other conditions. To use the default list,...
  • Page 447 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Property Meaning Constants.FS_DisallowDoc (8) Disallow importing FrameMaker binary documents. Set to either True or False. • True - Do not allow importing FrameMaker binary documents. • False - Allow importing FrameMaker binary documents. Constants.FS_DisallowFilterTypes (11) Disallow importing filterable files.
  • Page 448 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Property Meaning 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 operation. • Constants.FV_DoShowDialog (4) - Show a dialog box and let the user decide.
  • Page 449 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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. For example: 0001PGRFPICTMAC61.0 Built-in PICT reader0001ORBLSVGIAll Platform SVG reader for 7.0 Each field of the record (except ) specifies a four-byte code.
  • Page 450 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Code Meaning IGES Initial Graphics Exchange Specification (CAD files) IMG4 Image to CCITT Group 4 (UNIX) MooV QuickTime Movie Object Linking and Embedding Client (Microsoft) PC Paintbrush PICT QuickDraw PICT PNTG MacPaint SNRF Sun Raster File...
  • Page 451 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Property Meaning Constants.FS_FormatImportedText (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. •...
  • Page 452 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Property Meaning Constants.FS_RasterImageHeight (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.
  • Page 453 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Property Meaning 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).
  • Page 454 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Both the property and the global variable indicate the result of Constants.FS_ImportNativeError (2) FA_errno a call to the method. The following table lists the possible status flags and the reasons associated with them: Import()
  • Page 455 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Status Flag Reason 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.
  • Page 456 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary GetProps Description Retrieves the properties of the specified Book. GetProps under the AFrame class for more information. Returns PropVals Syntax GetProps() SetProps Description Sets the value of the specified property of the Book. See “SetProps” on page 413 under the AFrame class for more information.

  • Page 457: Bookcomponent

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary BookComponent Delete Description Deletes the specified BookComponent object. See “Delete” on page 412 under the AFrame class for more information. Returns 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.

  • Page 458: Cell

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary SetProps Description Sets the property of the BookComponent object. See “SetProps” on page 413 under the AFrame class for more information. Returns Void Syntax SetProps(setVal) Parameters Parameter name Data Type Optional Description setVal The value of the property to be set.
  • Page 459 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Constants.FE_WrongProduct (-60) Current FrameMaker product does not support tables. Constants.FE_BadOperation (-27) Parameters specify an action that is invalid. Constants.FE_BadDocId (-2) Invalid document. Constants.FE_BadParameter (-43) Parameter has an invalid value. Constants.FE_BadObjId (-3) Invalid cell.
  • Page 460 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description heightInRows The number of cells to unstraddle vertically. widthInCols The number of cells to unstraddle horizontally. GetText Description method gets the text from the following types of objects: GetText() •...
  • Page 461 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Text Item Type Text Item Represents Text Item Data 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...
  • Page 462 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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.
  • Page 463 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary If you call for an object (FO_Element object), the returned information depends on the type of element, GetText() as shown: Value Information Returned Constants.FV_FO_CONTAINER (1) All the text items from the beginning to the end of the element.

  • Page 464: Charfmt

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary SetProps Description Sets the desired property of the cell object. See “SetProps” on page 413 under the AFrame class for more information. Returns Void Syntax SetProps(setVal) Parameters Parameter name Data Type Optional Description setVal The value of the property to set.
  • Page 465 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary GetProps Description Get the properties of the specified CharFmt object. See “GetProps” on page 412 under the AFrame class for more information. Returns PropVals Syntax GetProps() SetProps Description Sets the value of the property for the specified CharFmt object.

  • Page 466: Color

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Color Delete Description Deletes the specified color object. See “Delete” on page 412 under the AFrame class for more information. Returns Syntax Delete() GetProps Description Retrieves the properties of the specified color object. See “GetProps” on page 412 under the AFrame class for more information.

  • Page 467: Combinedfont

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary ObjectValid Description Determines whether a color object is valid. Returns if the Color object is valid, else returns True False See “ObjectValid” on page 414 under the AFrame class for more information. Returns Syntax...

  • Page 468: Combinedfontdefn

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary CombinedFontDefn CombinedFamilyFonts Description Returns the permutations of angles, variations, and weights available for a specified combined font definition. The method does not take any arguments. method returns a CombinedFonts object that provides a list of the permutations of CombinedFamilyFonts() angles, variations, and weights available for the specified combined font definition.

  • Page 469: Combinedfonts

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary SetProps Description Sets the value of the desired property of the CombinedFonts object. See “SetProps” on page 413 under the AFrame class for more information. Returns Void Syntax SetProps(setVal) Parameters Parameter name Data Type...

  • Page 470: Command

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax concat(value) Parameters Parameter name Data Type Optional Description value Can also be arrays. CombinedFon Description Removes the last element from the array. Returns CombinedFont Syntax pop() push Description Returns the new length of the array.
  • Page 471 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns Syntax Delete() GetProps Description Retrieves the properties of the specified Command object. See “GetProps” on page 412 under the AFrame class for more information. Returns PropVals Syntax GetProps() SetProps Description Sets the value of the specified Command property.

  • Page 472: Compareret

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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. Returns Syntax Delete() CompareRet CompareRet Description provides the results of a call to the method.

  • Page 473: Condfmt

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary CondFmt Delete Description Deletes the specified object. CondFmt See “Delete” on page 412 under the AFrame class for more information. Returns Syntax Delete() GetProps Description Retrieves the properties of the specified object. CondFmt See “GetProps” on page 412 under the AFrame class for more information.
  • Page 474 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary ObjectValid Description Identifies whether a object is valid or not. Returns if the CondFmt object is valid, else returns CondFmt True False See “ObjectValid” on page 414 under the AFrame class for more information.
  • Page 475 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax AddText(textLoc, text) Parameters Parameter name Data Type Optional Description textLoc The text location at which to add the text. TextLoc text string The text to add. CenterOnText Description Centers a range of text such that the middle of the text appears in the middle of the document window.
  • Page 476 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Flags Meaning 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_TEXT (0x0004) Do not delete hidden text. flag takes precedence over other flags. If you specify Constants.FF_INTERACTIVE...
  • Page 477 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns Syntax ClearAllChangebars() Compare Description Compares two documents or two books. You can OR the values shown in the following table into the flags argument. Flags Meaning Constants.FF_CMP_SUMMARY_ONLY Generate a summary document, but not a composite document.
  • Page 478 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description newerDoc The newer version of the document to be compared. flags Bit flags that specify how to generate the summary and composite documents. Specify 0 for the default flags.
  • Page 479 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns Syntax Copy(flags) Parameters Parameter name Data Type Optional Description flags Bit field that specifies how to copy the text and how to handle interactive alerts. For default settings, specify 0. Description Cuts the current selection to the FrameMaker Clipboard.
  • Page 480 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description flags Bit field that specifies how to cut the text and how to handle interactive alerts. For default settings, specify 0. DeleteText Description Deletes a specified text range from a document.
  • Page 481 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Constants.FE_BadDocId (-2) Invalid document. Constants.FE_BadSelectionForOperation (-59) Current text selection is invalid for this operation. Returns Void Syntax DemoteElement() GetTextForRange Description Gets the text for a specified text range. Call the method on the document as follows: document.GetTextForRange()
  • Page 482 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Text Item Type Text Item Represents Text Item Data Constants.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; (0x00000004) if it is a forced line end, the FTI_HardLineEnd flag is set;...
  • Page 483 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Flags Meaning Constants.FTF_ANGLE The font angle has changed. (0x10000000) Constants.FTF_CAPITALIZATION The capitalization has changed. (0x000040000) Constants.FTF_CHANGEBAR The change bars have changed. (0x01000000) Constants.FTF_CHARTAG The Character Catalog format has changed. (0x00008000) Constants.FTF_COLOR The color has changed.
  • Page 484 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Flags Meaning Constants.FTF_UNDERLINING The underlining has changed. (0x08000000) Constants.FTF_VARIATION The font variation has changed. (0x40000000) Constants.FTF_WEIGHT The font weight has changed. (0x20000000) On success, the method returns a structure containing the array of text items of the requested types.
  • Page 485 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary On failure, the method sets the field of the returned structure to 0, and returns one of the following TextItems values to FA_errno Error Reason Constants.FE_BadDocId (-2) Invalid document. Constants.FE_BadObjId (-3) Invalid Object Constants.FE_NotTextObject (-41) Object specified for the text range is not an object that contains text.
  • Page 486 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Constants.FE_BadObjId (-3) Invalid Object Constants.FE_NotTextObject (-41) Object specified for the text range is not an object that contains text. Constants.FE_OffsetNotFound (-21) Offset specified for the text location could not be found in the specified paragraph or text line.
  • Page 487 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description textLoc TextLoc 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.
  • Page 488 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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 on success. FE_Success...
  • Page 489 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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 MergeIntoLast() method. On success, the method does not return any value.
  • Page 490 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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). Constants.FE_OffsetNotFound (-21) Offset specified for the text location could not be found in the specified paragraph or text line.
  • Page 491 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Flags Meaning Constants.FF_VISIBLE_ONLY (0x0010) Cut only the visible portion of the selection. Constants.FF_DONT_DELETE_HIDDEN_TEXT (0x0004) Do not replace hidden text. Constants.FF_DONT_APPLY_ALL_ROWS (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.
  • Page 492 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description flags Bit field that specifies how to paste the text and how to handle interactive alerts. For default settings, specify 0. PromoteElement Description Promotes the selected structural element. The selected element becomes a sibling of its former parent and appears immediately after its former parent.
  • Page 493 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Constants.FE_Transport (-1) A transport error occurred. Constants.FE_BadDocId (-2) Invalid document. Returns Syntax QuickSelect(prompt, stringlist) Parameters Parameter name Data Type Optional Description prompt The prompt that appears in the Tag area string stringlist...
  • Page 494 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns Syntax Reformat() Rehyphenate Description Rehyphenates a specified document based on changes the user has made to words’ hyphenation points. The method returns on success. On failure, the method returns one of the following values to...
  • Page 495 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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.
  • Page 496 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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_OffsetNotFound (-21) Offset specified for the text range could not be found in the specified paragraph or text line.
  • Page 497 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason 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.
  • Page 498 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason 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.
  • Page 499 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason 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.
  • Page 500 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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 property is set to...
  • Page 501 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description fromDoc The document or book from which to import formats. formatFlags Bit field specifying which formats to import. Specify 0 for the default flags. You can OR the following values into the parameter to specify which formats to import.
  • Page 502 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax SplitElement() TextLocToElementLoc Description Returns the element location structure that corresponds to the current text location. On success, the method returns an structure containing the element location. ElementLoc On failure, the method returns one of the following values to...
  • Page 503 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns Void Syntax UnWrapElement() 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...
  • Page 504 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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...
  • Page 505 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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 Returns Object Syntax GetUniqueObject(objType, unique)
  • Page 506 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary SimpleSave Description Saves a document or book. If you set the parameter to and specify the document or book’s current name for interactive False saveAsName FrameMaker saves the document or book under its current name.
  • Page 507 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax SimpleSave(saveAsName, interactive) Parameters Parameter name Data Type Optional Description saveAsName The absolute path in which to save the document or book. string interactive Specifies whether the FrameMaker product displays messages and warnings to the user. Setting this to True displays messages and warnings.
  • Page 508 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Constants.FE_NotFrame (-12) Specified parent object is not a frame. Constants.FE_BadNew (-23) Object cannot be created. Returns Object Syntax NewGraphicObject(objType, parent) Parameters Parameter name Data Type Optional Description objType The type of ESTK graphic object to create (for example, FO_Rectangle or FO_Line).
  • Page 509 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns Ellipse Syntax NewEllipse(parent) Parameters Parameter name Data Type Optional Description parent The parent frame in which to create the ellipse. FrameMaker Graphic Object NewFlow Description Creates a flow object. NewGraphicObject for more information.
  • Page 510 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description parent The parent frame in which to create the group. FrameMaker Graphic Object NewInset Description Creates an inset object. NewGraphicObject for more information. Returns Inset Syntax NewInset(parent)
  • Page 511 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary NewMath Description Creates a math object. NewGraphicObject for more information. Returns Math Syntax NewMath(parent) Parameters Parameter name Data Type Optional Description parent The parent frame in which to create the math object. FrameMaker Graphic...
  • Page 512 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns Polygon Syntax NewPolygon(parent) Parameters Parameter name Data Type Optional Description parent The parent frame in which to create the polygon. FrameMaker Graphic Object NewRectangle Description Creates a rectangle object. NewGraphicObject for more information.
  • Page 513 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description parent The parent frame in which to create the round rectangle. FrameMaker Graphic Object NewTextFrame Description Creates a text frame object. NewGraphicObject for more information. Returns TextFrame...
  • Page 514 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary NewUnanchoredFrame Description Creates an unanchored frame object. NewGraphicObject for more information. Returns UnanchoredFrame Syntax NewUnanchoredFrame(parent) Parameters Parameter name Data Type Optional Description parent The parent frame in which to create the unanchored frame. FrameMaker...
  • Page 515 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns Object Syntax NewAnchoredFormattedObject(objType, format, textLoc) Parameters Parameter name Data Type Optional Description objType The type of object to create (for example, FO_XRef). format The string that specifies the object’s format (for example, string...
  • Page 516 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax NewAnchoredFormattedXRef(format, textLoc) Parameters Parameter name Data Type Optional Description format The string that specifies the object’s format (for example, string for a cross-reference, for a table, Heading & Page Format A for a variable).
  • Page 517 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary The method returns the created anchored 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_BadNew(-23) Object cannot be created. Constants.FE_BadObjId(-3) Invalid object.
  • Page 518 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary NewAnchoredFn Description Creates an anchored Fn object. NewAnchoredObject under the Doc class for more information. Returns Syntax NewAnchoredFn(textloc) Parameters Parameter name Data Type Optional Description textloc The text location at which to insert the anchored Fn object.
  • Page 519 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax NewAnchoredTiApiClient(textloc) Parameters Parameter name Data Type Optional Description textloc The text location at which to insert the anchored TiApiClient TextLoc object. NewAnchoredTbl Description Creates an anchored table object. NewAnchoredObject under the Doc class for more information.
  • Page 520 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Constants.FE_NotBodyPgf (-25) prevId parameter must specify a paragraph.. Constants.FE_NotBookComponent (-26) parameter must specify a book component.. prevId Returns One of the following objects: Body page, Pgf and Book Component Syntax NewSeriesObject(objType, previous)
  • Page 521 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns Syntax NewSeriesPgf(previous) Parameters Parameter name Data Type Optional Description previous 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.
  • Page 522 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Constants.FE_BadDocId (-2) Invalid document. Constants.FE_TypeUnNamed (-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. Returns...
  • Page 523 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax GetNamedCharFmt(name) Parameters Parameter name Data Type Optional Description name The name of the CharFmt object you want to get. string GetNamedColor Description Gets a Color object. GetNamedObject under the Doc class for more information.
  • Page 524 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary GetNamedCondFmt Description Gets a Conditional Format object. GetNamedObject under the Doc class for more information. Returns CondFmt Syntax GetNamedCondFmt(name) Parameters Parameter name Data Type Optional Description name The name of the CondFmt object you want to get.
  • Page 525 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax GetNamedFmtChangeList(name) Parameters Parameter name Data Type Optional Description name The name of the FmtChangeList object you want to get. string GetNamedMasterPage Description Gets a MasterPage object. GetNamedObject under the Doc class for more information.
  • Page 526 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary GetNamedRefPage Description Gets a Reference Page object. GetNamedObject under the Doc class for more information. Returns RefPage Syntax GetNamedRefPage(name) Parameters Parameter name Data Type Optional Description name The name of the RefPage object you want to get.
  • Page 527 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax GetNamedTblFmt(name) Parameters Parameter name Data Type Optional Description name The name of the TblFmt object you want to get. string GetNamedUnanchoredFrame Description Gets an Unanchored Frame object. GetNamedObject under the Doc class for more information.
  • Page 528 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary GetNamedXRefFmt Description Gets a Cross Reference Format object. GetNamedObject under the Doc class for more information. Returns XRefFmt Syntax GetNamedXRefFmt(name) Parameters Parameter name Data Type Optional Description name The name of the Cross Reference Format object you want to get.
  • Page 529 ADOBE FRAMEMAKER SCRIPTING GUIDE 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.
  • Page 530 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary NewNamedAttrCondExpr Description Creates a named Attribute Conditional Expression. NewNamedObject under the Doc class for more information. Returns AttrCondExpr Syntax NewNamedAttrCondExpr(name) Parameters Parameter name Data Type Optional Description name The name to be assigned to the created Attribute Conditional string Expression.
  • Page 531 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax NewNamedCombinedFontDefn(name) Parameters Parameter name Data Type Optional Description name The name to be assigned to the created Combined Font string Definition. NewNamedColor Description Creates a named Color. NewNamedObject under the Doc class for more information.
  • Page 532 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary NewNamedElementDef Description Creates a named Element Definition. NewNamedObject under the Doc class for more information. Returns ElementDef Syntax NewNamedElementDef(name) Parameters Parameter name Data Type Optional Description name The name to be assigned to the created Element Definition.
  • Page 533 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax NewNamedMasterPage(name) Parameters Parameter name Data Type Optional Description name The name to be assigned to the created Master Page. string NewNamedPgfFmt Description Creates a named Paragraph Format. NewNamedObject under the Doc class for more information.
  • Page 534 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary NewNamedRulingFmt Description Creates a named Ruling Format. NewNamedObject under the Doc class for more information. Returns RulingFmt Syntax NewNamedRulingFmt(name) Parameters Parameter name Data Type Optional Description name The name to be assigned to the created Ruling Format.
  • Page 535 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax NewNamedVarFmt(name) Parameters Parameter name Data Type Optional Description name The name to be assigned to the created Variable Format. string NewNamedXRefFmt Description Creates a named Cross Reference Format. NewNamedObject under the Doc class for more information.
  • Page 536 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary DeleteUnusedFmts Description Deletes unused formats (character, paragraph or table) from the document. The method returns on success. Constants.FE_Success On failure, the method sets to one of the following values: FA_errno Error Reason Invalid document.
  • Page 537 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax DeleteUnusedPgfFmt() DeleteUnusedTblFmt Description Deletes the unused Table Formats. DeleteUnusedFmts under the Doc class for more information. Returns 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.
  • Page 538 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Property Meaning and Possible Values 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 •...
  • Page 539 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Property Meaning and Possible Values 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) •...
  • Page 540 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary • Table foot • Table body • Table row • Table cell When the method finds a structure element for one of these objects, it returns an empty structure Find() TextRange and sets . In this case, you can get the document’s...
  • Page 541 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns Void Syntax SetElementRange(propNum, setVal) Parameters Parameter name Data Type Optional Description propNum The property to set. Specify an ESTK defined property, such as ElementSelection setVal The element range to which the property must be set.
  • Page 542 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Invalid document. Constants.FE_BadDocId (-2) Constants.FE_WrongProduct (-60) Product does not support the operation. Could not allocate memory. Constants.FE_SystemError (-42) Returns Syntax UpdateVariables() TrackChangesAcceptAll Description Accepts all the track changes in the specified document.
  • Page 543 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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 argument. updateXRefFlags...
  • Page 544 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax Save(saveAsName, saveParams, saveReturnParams) Parameters Parameter name Data Type Optional Description saveAsName The path for saving the document or book. string saveParams PropVals A property list that tells FrameMaker how to save the file and how to respond to errors and other conditions.
  • Page 545 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Invalid document. Constants.FE_BadDocId (-2) Constants.FE_ReadOnly (-6) Document is read-only. Boolean conditional expression string is invalid. Constants.FE_BadName (-33) Returns Syntax AddNewBuildExpr(exprName, exprCondition) Parameters Parameter name Data Type Optional Description exprName string The name of the Boolean conditional expression.
  • Page 546 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary SetActiveBuildExpr Description Applies the Boolean conditional expression to the document. The method returns , on success. FE_Success On failure, the method sets to one of the following values: FA_errno Error Reason Invalid document. Constants.FE_BadDocId (-2) Constants.FE_ReadOnly (-6)
  • Page 547 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Invalid document. Constants.FE_BadDocId (-2) Constants.FE_BadName () The parameter specified by exprName is invalid. Returns string Syntax GetBuildExpr(exprName) Parameters Parameter name Data Type Optional Description exprName The name of Boolean conditional expression. string...

  • Page 548: Element

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary SetProps Description method sets the properties of the Doc object. SetProps() SetProps under the AFrame class for more information. Returns Void Syntax SetProps(setVal) Parameters Parameter name Data Type Optional Description setVal The property list.
  • Page 549 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason This attribute is required, but it has no value assigned to it. Constants.FV_AV_REQUIRED (1) Constants.FV_AV_INVALID_CHOICE (2) At least one value for the attribute is not one of the allowed choices. The attribute value is of the wrong type for the attribute.
  • Page 550 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns TextItems Syntax GetText(flags) Parameters Parameter name Data Type Optional Description flags Denotes the various bit flags that specify the items to be retrieved. GetProps Description Retrieves the properties of the element object. GetProps under the AFrame class for more information.

  • Page 551: Elementcatalogentries

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary ObjectValid under the AFrame class for more information. Returns Syntax ObjectValid() 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.

  • Page 552: Elementcatalogentry

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary push Description Returns the new length of the array. Returns number Syntax push(value) Parameters Parameter name Data Type Optional Description value ElementCata The value to be pushed. logEntry ElementCatalogEntry ElementCatalogEntry Description Describes a catalog entry in an Element Catalog in FrameMaker.

  • Page 553: Elementdef

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary If no flags are set, the element is invalid at its current position. ElementDef NewTextFmtRules Description Creates a object. The method allows you to associate the created object with a specified property of the TextFmtRules parent object.
  • Page 554 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Constants.FE_BadDocId(-2) Invalid document. Constants.FE_BadObjId(-3) Invalid object. Constants.FE_BadNew(-23) Object cannot be created. Constants.FE_BadPropNum(-4) The property number is invalid. Constants.FE_WrongProduct(-60) Current product interface is not Structured Framemaker. Returns FmtRule Syntax NewObjectFmtRules() NewPrefixRules Description Creates a object.
  • Page 555 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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 The method returns the created object, on success. On failure, the method assigns one of the following values to...
  • Page 556 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax NewFirstPgfRules() NewLastPgfRules Description Creates a object. LastPgfRules 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...
  • Page 557 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax ElementDefIsText() NewElement Description Creates a structural element in a FrameMaker document. (FO_Element) inserts the new element at the specified location in text, using the specified element definition. NewElement() For object (noncontainer) elements, inserts the appropriate type of object for the element. If there is a...
  • Page 558 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary NewElementInHierarchy Description Creates a structural element ( ) at a specified location in the element hierarchy of a structured FrameMaker FO_Element document or book. To create the root element for a book, you must use .
  • Page 559 ADOBE FRAMEMAKER SCRIPTING GUIDE 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,...
  • Page 560 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Constant Value Constants.FV_AT_UNIQUE_IDREFS (9) One or more references to UniqueID attributes. On failure, the method returns one of the following values to FA_errno Error Reason Invalid document. Constants.FE_BadDocId (-2) Constants.FE_WrongProduct (-60) Current product interface is not Structured FrameMaker.

  • Page 561: Elementloc

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary SetProps Description method sets the properties of an element definition. SetProps() SetProps under the AFrame class for more information. Returns Void Syntax SetProps(setVal) Parameters Parameter name Data Type Optional Description setVal The property list.

  • Page 562: Ellipse

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description parent Element Parent element. child Child element. Element offset Offset within the child or parent element. ElementRange ElementRange Description A structure specifying an element’s range. Returns ElementRange...
  • Page 563 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary GetProps Description Retrieves the properties of an ellipse. GetProps under the AFrame class for more information. Returns PropVals Syntax GetProps() SetProps Description Sets the properties of an ellipse. SetProps under the AFrame class for more information.

  • Page 564: Flow

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary FilterArgs FilterArgs Description FilterArgs stores information that is used in the notification for a file-to-file filter ( ). The FA_Note_FilterFileToFile notification handler receives a pointer to this structure. Returns FilterArgs Definition FilterArgs{infile, outfile, clname, informat, outformat, binname, args}...
  • Page 565 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary GetText Description Gets the text from the flow. GetText under the Cell class for more information. Returns TextItems Syntax GetText(flags) Parameters Parameter name Data Type Optional Description flags Denotes the various bit flags that specify the items to be retrieved.

  • Page 566: Fmtchangelist

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description setVal PropVals The property list. ObjectValid Description Returns if the flow is valid, else returns True False ObjectValid under the AFrame class for more information. Returns Syntax...

  • Page 567: Fmtrule

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary SetProps Description Sets the properties of a format change list. SetProps under the AFrame class for more information. Returns Void Syntax SetProps(setVal) Parameters Parameter name Data Type Optional Description setVal The property list. PropVals...
  • Page 568 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Constants.FE_BadDocId(-2) Invalid document. Constants.FE_BadObjId(-3) Invalid object. Constants.FE_BadNew(-23) Object cannot be created. Constants.FE_BadPropNum(-4) The property number is invalid. Constants.FE_WrongProduct(-60) Current product interface is not Structured Framemaker. Returns FmtRuleClause Syntax NewFmtRuleClauses() Delete Description Deletes a format rule.

  • Page 569: Fmtruleclause

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns Void Syntax SetProps(setVal) Parameters Parameter name Data Type Optional Description setVal PropVals The property list. ObjectValid Description Returns if the format rule is valid, else returns True False ObjectValid under the AFrame class for more information.
  • Page 570 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Constants.FE_WrongProduct(-60) Current product interface is not Structured Framemaker. Returns FmtRule Syntax NewSubFmtRule() NewFmtChangeList Description Creates a object. FmtChangeList The following table shows the parent object and the type of the object created by the method:...
  • Page 571 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax Delete() GetProps Description Retrieves the properties of a format rule clause. GetProps under the AFrame class for more information. Returns PropVals Syntax GetProps() SetProps Description Sets the properties of a format rule clause.
  • Page 572 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Delete Description Deletes a footnote. Delete under the AFrame class for more information. Returns Syntax Delete() GetText Description Gets the text from the footnote. GetText under the Cell class for more information. Returns TextItems...

  • Page 573: Font

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary SetProps Description Sets the properties of a footnote. SetProps under the AFrame class for more information. Returns Void Syntax SetProps(setVal) Parameters Parameter name Data Type Optional Description setVal The property list. PropVals ObjectValid Description...

  • Page 574: Fonts

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax Font(family, variation, weight, angle) Parameters Parameter name Data Type Optional Description family Index of the font family. uint variation uint Index of the font variation. weight Index of the font weight. uint angle uint Index of the font angle.

  • Page 575: Group

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary push Description Pushes the font on the array and the returns the new length of the array. Returns number Syntax push(value) Parameters Parameter name Data Type Optional Description value Font Group A Group object represents a set of grouped objects. Group objects have the following methods.

  • Page 576: Hidden

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary SetProps Description Sets the properties of the group. SetProps under the AFrame class for more information. Returns Void Syntax SetProps(setVal) Parameters Parameter name Data Type Optional Description setVal The property list. PropVals ObjectValid Description...
  • Page 577 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary SetProps Description Sets the properties of the hidden page. SetProps under the AFrame class for more information. Returns Void Syntax SetProps(setVal) Parameters Parameter name Data Type Optional Description setVal The property list. PropVals ObjectValid...

  • Page 578: Inset

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns Syntax ApplyPageLayout(srcPage) Parameters Parameter name Data Type Optional Description srcPage PageObject The page to which the layout must be applied. Inset GetIntByName Description Queries an integer facet. uses a transaction model to query facets. After you have finished a series of queries, you must...
  • Page 579 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary GetMetricByName Description Queries a metric facet. uses a transaction model to query facets. After you have finished a series of queries, you must GetMetricByName() commit the transaction by calling to query a facet named GetIntByName() "...
  • Page 580 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Invalid document. Constants.FE_BadDocId (-2) Constants.FE_BadObjId (-3) Invalid object. Specified property name is invalid. Constants.FE_BadPropNum (-4) Constants.FE_BadPropType (-5) Incorrect property type. Current FrameMaker does not support this operation. Constants.FE_WrongProduct (-60) Note: The returned object references memory that is allocated by the API.
  • Page 581 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description propName string The name of the facet to set. setVal The value to which the facet must be set. SetMetricByName Description Sets a metric facet. uses a transaction model to set facets. After you have finished setting facets, you must commit...
  • Page 582 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary To set a UBytes facet: Call to set the facet data. SetUBytesByName() If you are setting a facet with less than 10K of data, you need to call only once. SetUBytesByName() If you are setting the facet with more than 10K of data, you should call...
  • Page 583 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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...

  • Page 584: Ints

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns Void Syntax SetProps(setVal) Parameters Parameter name Data Type Optional Description setVal PropVals The property list. ObjectValid Description Returns if the inset is valid, else returns True False ObjectValid under the AFrame class for more information.

  • Page 585: Line

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Description Removes the last element from the array. Returns Syntax pop() push Description Returns the new length of the array. Returns number Syntax push(value) Parameters Parameter name Data Type Optional Description value Line Delete Description Deletes a line.
  • Page 586 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary GetProps Description Retrieves the properties of the line. GetProps under the AFrame class for more information. Returns PropVals Syntax GetProps() SetProps Description Sets the properties of the line. SetProps under the AFrame class for more information.

  • Page 587: Marker

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Marker Delete Description Deletes a marker. Delete under the AFrame class for more information. Returns Syntax Delete() GetProps Description Retrieves the properties of the marker. GetProps under the AFrame class for more information. Returns...

  • Page 588: Markertype

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary ObjectValid Description Returns if the marker is valid, else returns True False ObjectValid under the AFrame class for more information. Returns Syntax ObjectValid() MarkerType Delete Description Deletes a marker type. Delete under the AFrame class for more information.

  • Page 589: Master

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary SetProps under the AFrame class for more information. Returns Void Syntax SetProps(setVal) Parameters Parameter name Data Type Optional Description setVal PropVals The property list. ObjectValid Description Returns if the marker type is valid, else returns...
  • Page 590 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary GetProps under the AFrame class for more information. Returns PropVals Syntax GetProps() SetProps Description Sets the properties of the master page. SetProps under the AFrame class for more information. Returns Void Syntax SetProps(setVal) Parameters...

  • Page 591: Math

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns Syntax ApplyPageLayout(srcPage) Parameters Parameter name Data Type Optional Description srcPage PageObject The page to which the layout is to be applied. Math Delete Description Deletes a math object. Delete under the AFrame class for more information.

  • Page 592: Menu

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns Void Syntax SetProps(setVal) Parameters Parameter name Data Type Optional Description setVal PropVals The property list. ObjectValid Description Returns if the math object is valid, else returns True False ObjectValid under the AFrame class for more information.
  • Page 593 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary If you call and specify the name of a command that is already defined in the user’s menu DefineAndAddCommand() 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...
  • Page 594 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary AddCommandToMenu Description Adds a FrameMaker product command or a client-defined command to a menu. adds the command at the bottom of the specified menu. To change a command’s position on AddCommandToMenu() a menu, set its properties.
  • Page 595 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Type of menu or menu bar How FrameMaker implements the FrameMaker product adds the menu you are adding a menu to added menu Menu bar Pull-down menu At the right of the menu bar.
  • Page 596 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary FrameMaker menubar Menubar string Menu bar for documents (quick menus) !QuickMakerMainMenu 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;...
  • Page 597 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax DefineAndAddMenu(name, label) Parameters Parameter name Data Type Optional Description name A unique name for the new menu. If the user or an ESTK client string has already defined a command or menu with this name, the new menu replaces it.
  • Page 598 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns Syntax Delete() GetProps Description Retrieves the properties of the menu or menu item. GetProps under the AFrame class for more information. Returns PropVals Syntax GetProps() SetProps Description Sets the properties of the menu or menu item.

  • Page 599: Menuitemseparator

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax ObjectValid() Delete Description Deletes a menu or menu item. Delete under the AFrame class for more information. Returns Syntax Delete() MenuItemSeparator GetProps Description Retrieves the properties of the menu item separator. GetProps under the AFrame class for more information.

  • Page 600: Metrics

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description setVal PropVals The property list. ObjectValid Description Returns if the menu item spearator is valid, else returns True False ObjectValid under the AFrame class for more information.
  • Page 601 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax concat(value) Parameters Parameter name Data Type Optional Description value Can also be arrays. Metrics Description Removes the last element from the array. Returns Syntax pop() push Description Returns the new length of the array.
  • Page 602 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns Syntax Delete() GetText Description Gets the text from the paragraph. GetText under the Cell class for more information. Returns TextItems Syntax GetText(flags) Parameters Parameter name Data Type Optional Description flags Denotes the various bit flags that specify the items to be retrieved.

  • Page 603: Pgffmt

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax SetProps(setVal) Parameters Parameter name Data Type Optional Description setVal The property list. PropVals ObjectValid Description Returns if the paragraph is valid, else returns True False ObjectValid under the AFrame class for more information.

  • Page 604: Point

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax GetProps() SetProps Description Sets the properties of the paragraph format. SetProps under the AFrame class for more information. Returns Void Syntax SetProps(setVal) Parameters Parameter name Data Type Optional Description setVal The property list.

  • Page 605: Points

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax Point(x, y) Parameters Parameter name Data Type Optional Description X coordinate Y coordinate 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.

  • Page 606: Polygon

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary push Description Returns the new length of the array. Returns number Syntax push(value) Parameters Parameter name Data Type Optional Description value Point The value to push into the array. Polygon Delete Description Deletes a polygon.

  • Page 607: Polyline

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary SetProps Description Sets the properties of the polygon. SetProps under the AFrame class for more information. Returns Void Syntax SetProps(setVal) Parameters Parameter name Data Type Optional Description setVal The property list. PropVals ObjectValid Description...
  • Page 608 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary GetProps Description Retrieves the properties of the polyline. GetProps under the AFrame class for more information. Returns PropVals Syntax GetProps() SetProps Description Sets the properties of the polyline. SetProps under the AFrame class for more information.

  • Page 609: Propval

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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,...

  • Page 610: Propvals

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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.

  • Page 611: Rectangle

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description value PropVal The value to push into the array. Rectangle Delete Description Deletes a rectangle. Delete under the AFrame class for more information. Returns Syntax Delete() GetProps Description Retrieves the properties of the rectangle.
  • Page 612 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description setVal PropVals The property list. ObjectValid Description Returns if the rectangle is valid, else returns True False ObjectValid under the AFrame class for more information. Returns Syntax...
  • Page 613 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary SetProps Description Sets the properties of the reference page. SetProps under the AFrame class for more information. Returns Void Syntax SetProps(setVal) Parameters Parameter name Data Type Optional Description setVal The property list. PropVals ObjectValid...

  • Page 614: Roundrect

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description srcPage PageObject The page to which the layout is to be applied. RoundRect Delete Description Deletes a round rectangle. Delete under the AFrame class for more information.
  • Page 615 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description setVal PropVals The property list. ObjectValid Description Returns if the rounded rectangle is valid, else returns True False ObjectValid under the AFrame class for more information. Returns...
  • Page 616 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Constants.FE_BadParameter (-43) Parameter has an invalid value. Returns Syntax AddRows(direction, numNewRows) Parameters Parameter name Data Type Optional Description direction The direction from the reference row in which to add rows. numNewRows The number of rows to add.

  • Page 617: Rubi

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary SetProps under the AFrame class for more information. Returns Void Syntax SetProps(setVal) Parameters Parameter name Data Type Optional Description setVal PropVals The property list. ObjectValid Description Returns if the row is valid, else returns...
  • Page 618 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary GetText2 Description Gets the text from all the objects available to , as well as an extended set of document objects that includes GetText() the rubi object. can be one of the following constants (in addition to the constants returned by TextItems.dataType...

  • Page 619: Rulingfmt

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax GetProps() SetProps Description Sets the properties of the rubi object. SetProps under the AFrame class for more information. Returns Void Syntax SetProps(setVal) Parameters Parameter name Data Type Optional Description setVal The property list.
  • Page 620 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax Delete() GetProps Description Retrieves the properties of the ruling format. GetProps under the AFrame class for more information. Returns PropVals Syntax GetProps() SetProps Description Sets the properties of the ruling format. SetProps under the AFrame class for more information.

  • Page 621: Strings

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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.

  • Page 622: Subcol

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description value string The value to push into the array. SubCol Delete Description Deletes a subcol object. Delete under the AFrame class for more information. Returns Syntax Delete()
  • Page 623 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns PropVals Syntax GetProps() SetProps Description Sets the properties of the subcol object. SetProps under the AFrame class for more information. Returns Void Syntax SetProps(setVal) Parameters Parameter name Data Type Optional Description setVal PropVals The property list.

  • Page 624: Tabs

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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_LEFT (0x5) Relative left tab (allowed only for format change lists). Constants.FV_TAB_RELATIVE_CENTER (0x6) elative center tab (allowed only for format change lists).
  • Page 625 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description value Tabs Can also be arrays. Description Removes the last element from the array. Returns Syntax pop() push Description Returns the new length of the array. Returns...
  • Page 626 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Constants.FE_BadParameter (-43) A parameter specified is invalid. Constants.FE_BadObjId (-3) Invalid object. Constants.FE_BadOperation (-27) The method specified an invalid operation. Returns Syntax AddCols(refColNum, direction, numNewCols) Parameters Parameter name Data Type Optional Description refColNum The column at which to start adding columns.
  • Page 627 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description delColNum The first column to delete. Columns are numbered from left to right, starting with 0. numDelCols The number of columns to delete. DeleteRows Description Deletes rows from a table. Like the Delete command in the FrameMaker product user interface, DeleteRows() does not allow you to delete more than one type of row at time.
  • Page 628 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary To select an entire table, including the table title, set the topRow parameter to Constants.FF_SELECT_WHOLE_TABLE ignores the values for the other parameters. (0x80000000) MakeTblSelection() Note: cannot select different types of rows at the same time, unless you set...
  • Page 629 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary GetProps Description method retrieves the properties of the specified table. GetProps() GetProps under the AFrame class for more information. Returns PropVals Syntax GetProps() SetProps Description method sets the properties of the specified table. SetProps() SetProps under the AFrame class for more information.

  • Page 630: Tblfmt

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary TblFmt The API uses an object to represent each table format in a document. FO_TblFmt Delete Deletes the specified table format. See “Delete” on page 412 under the AFrame class. GetProps See “GetProps” on page 412 under the AFrame class.
  • Page 631 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax GetText(flags) Parameters Parameter name Data Type Optional Description flags Denotes the various bit flags that specify the items to be retrieved. GetProps Description method retrieves the properties of the specified text frame. GetProps() GetProps under the AFrame class for more information.

  • Page 632: Textitems

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns Syntax ObjectValid() 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.

  • Page 633: Textline

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns number Syntax push(value) Parameters Parameter name Data Type Optional Description value TextItem The value to push into the array. TextLine Delete Description Deletes the specified text line. Delete under the AFrame class for more information.
  • Page 634 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary GetProps Description method retrieves the properties of the specified text line. GetProps() GetProps under the AFrame class for more information. Returns PropVals Syntax GetProps() SetProps Description method sets the properties of the specified text line.

  • Page 635: Textrange

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary TextLoc TextLoc Description TextLoc specifies a location within the text of a paragraph or a graphic text line. Returns TextLoc Syntax TextLoc(obj, offset) Parameters Parameter name Data Type Optional Description FO_Pgf or FO_TextLine object.

  • Page 636: Tiapiclient

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary TiApiClient object represents text imported by an FDK client. FO_TiApiClient GetText See “GetText” on page 452 under the Cell class. GetProps See “GetProps” on page 412 under the AFrame class. SetProps See “SetProps” on page 413 under the AFrame class.
  • Page 637 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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. does not update a text inset unless UpdateTextInset() it is stale.

  • Page 638: Tiflow

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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. fails, the API assigns one of the following values to...

  • Page 639: Titext

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary DeleteTextInsetContents DeleteTextInsetContents under the TiApiClient class. UpdateTextInset UpdateTextInset under the TiApiClient class. ConvertToText Description This method is called upon a text inset (Examples: ) object and converts TiApiClient TiFlow TiText TiTextTable it to a text. This method deletes the text inset and removes the locked text range around it without modifying the content.

  • Page 640: Titexttable

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary DeleteTextInsetContents DeleteTextInsetContents under the TiApiClient class. UpdateTextInset UpdateTextInset under the TiApiClient class. ConvertToText Description This method is called upon a text inset (Examples: ) object and converts TiApiClient TiFlow TiText TiTextTable it to a text. This method deletes the text inset and removes the locked text range around it without modifying the content.

  • Page 641: Typedvals

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary DeleteTextInsetContents DeleteTextInsetContents under the TiApiClient class. UpdateTextInset UpdateTextInset under the TiApiClient class. ConvertToText Description This method is called upon a text inset (Examples: ) object and converts TiApiClient TiFlow TiText TiTextTable it to a text. This method deletes the text inset and removes the locked text range around it without modifying the content.

  • Page 642: Ubytes

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description value TypedVal Can also be arrays. Description Removes the last element from the array. Returns TypedVal Syntax pop() push Description Returns the new length of the array.

  • Page 643: Uints

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns UBytes Syntax concat(value) Parameters Parameter name Data Type Optional Description value UBytes Can also be arrays. Description Removes the last element from the array. Returns uint Syntax pop() push Description Returns the new length of the array.
  • Page 644 ADOBE FRAMEMAKER SCRIPTING GUIDE 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.

  • Page 645: Unanchoredframe

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary UnanchoredFrame Delete Description Deletes the specified unanchored frame. Delete under the AFrame class for more information. Returns Syntax Delete() GetProps Description method retrieves the properties of the specified unanchored frame. GetProps() GetProps under the AFrame class for more information.
  • Page 646 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary ObjectValid Description Returns if the unanchored frame is valid, else returns True False ObjectValid under the AFrame class for more information. Returns Syntax ObjectValid() Delete Description Deletes the specified var object. Delete under the AFrame class for more information.
  • Page 647 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary GetProps Description method retrieves the properties of the specified var object. GetProps() GetProps under the AFrame class for more information. Returns PropVals Syntax GetProps() SetProps Description method sets the properties of the specified var object.

  • Page 648: Varfmt

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary VarFmt Delete Description Deletes the specified varfmt object. Delete under the AFrame class for more information. Returns Syntax Delete() GetProps Description method retrieves the properties of the specified varfmt object. GetProps() GetProps under the AFrame class for more information.

  • Page 649: Xref

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary ObjectValid Description Returns if the varfmt object is valid, else returns True False ObjectValid under the AFrame class for more information. Returns Syntax ObjectValid() XRef Delete Description Deletes the specified XRef object. Delete under the AFrame class for more information.
  • Page 650 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary GetProps Description method retrieves the properties of the specified XRef object. GetProps() GetProps under the AFrame class for more information. Returns PropVals Syntax GetProps() SetProps Description method sets the properties of the specified XRef object.

  • Page 651: Xreffmt

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary XRefFmt Delete Description Deletes the specified XRefFmt object. Delete under the AFrame class for more information. Returns Syntax Delete() GetProps Description method retrieves the properties of the specified XRefFmt object. GetProps() GetProps under the AFrame class for more information.
  • Page 652 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary ObjectValid Description Returns if the XRefFmt object is valid, else returns True False ObjectValid under the AFrame class for more information. Returns Syntax ObjectValid() Close See “Close” on page 430 under the Book class.
  • Page 653 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary GetNamedBook Description Gets the book object with a specified name. If this method fails, the API assigns the following value to FA_errno Error Meaning Constants. FE_NameNotFound (-20) The book with the specified name does not exist.
  • Page 654 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary If this method fails, the API assigns the following value to FA_errno Error Meaning Constants. A menu with the specified name does not exist. FE_NameNotFound (-20) Returns Menu Syntax GetNamedMenu(name) Parameters Parameter name Data Type...
  • Page 655 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Meaning Specified name for the new object is invalid. FE_BadName(-33) FE_BadNew (-23) Object cannot be created. Specified name for the new object belongs to an existing object. FE_DupName(-32) Returns Object Syntax NewNamedObject(objType, name)
  • Page 656 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary If this method fails, the API assigns one of the following values to FA_errno Error Meaning Specified name is invalid. FE_BadName(-33) FE_BadNew (-23) Command cannot be created. Specified name for the new command belongs to an existing command.

  • Page 657: Global

    ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary If this method fails, the API assigns one of the following values to FA_errno Error Meaning Specified name is invalid. FE_BadName(-33) FE_BadNew (-23) Menu item separator cannot be created. Specified name for the new menu item separator belongs to an existing menu item FE_DupName(-32) separator.
  • Page 658 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Constant Value Constants.FF_ALERT_CONTINUE_WARN (3) Displays the OK button with a warning indicator. Constants.FF_ALERT_YES_DEFAULT (4) Displays the Yes and No buttons; Yes is the default. Constants.FF_ALERT_NO_DEFAULT (5) Displays the Yes and No buttons; No is the default.
  • Page 659 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Constants.FE_NameNotFound (-20) There is no client with the specified name in the current FrameMaker productsession. Constants.FE_BadParameter (-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.
  • Page 660 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Constants.FE_Transport (-1) A transport error occured. 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.
  • Page 661 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns Syntax CustomDoc(width, height, numCols, columnGap, topMargin, botMargin, leftinsideMargin, rightoutsideMargin, sidedness, makeVisible) Parameters Parameter name Data Type Optional Description width The document page width. height The document page height. numCols The default number of columns.
  • Page 662 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Constants.FE_SystemError (-42) System error. Returns Menu Syntax DefineMenu(name, label) Parameters Parameter name Data Type Optional Description name string 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.
  • Page 663 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary FamilyFonts Description Returns a object with the permutations of angles, variations, and weights available for a specified font family. Fonts Returns Fonts Syntax FamilyFonts(family) Parameters Parameter name Data Type Optional Description family The index of the font family (in the list of fonts in the session).
  • Page 664 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary 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: Value...
  • Page 665 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Returns PropVals Syntax GetOpenDefaultParams() GetPropIndex Description Gets the index of a property-value pair (PropVal structure) within a property list. ) is a convenience GetPropIndex( routine that makes it easier to manipulate the properties in a property list.
  • Page 666 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Property Values AutoBackupOnSave Specifies whether to create a backup file. The value is one of: • Constants.FV_SaveUserPrefAutoBackup(2) - Follow preference specified by the session’s property. AutoBackup • Constants.FV_SaveYesAutoBackup(0) - Make a backup. • Constants.FV_SaveNoAutoBackup(1) - Do not make a backup.
  • Page 667 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Property Values 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.
  • Page 668 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Property Values 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.
  • Page 669 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary On failure, the method sets the 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:...
  • Page 670 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary parameter can be set to one of the following values: encodingName Value Meaning FrameRoman Roman Text. JISX0208.ShiftJIS Japanese Text. BIG5 Traditional Chinese Text. GB2312-80.EUC Simplified Chinese Text. KSC5601-1992 Korean Text. Returns if the specified encoding is supported for the current session, else returns...
  • Page 671 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description pathname string The pathname of the menu customization file to load. If you specify only a filename, the function looks in the client directory. silent is set to False, the pathname specified by pathname is used as the default in the Menu Customization File dialog box.
  • Page 672 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Event Notification Point Notification Constant XML document opened • • Before checking the type of file to be Constants.FA_Note_PreFileType (9) opened • Constants.FA_Note_PostFileType (10) • After checking the type of file to be •...
  • Page 673 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Event Notification Point Notification Constant Document saved as PDF • • Before specifying Acrobat settings and Constants.FA_Note_PreSaveAsPDFDialog (71) generating PostScript • Constants.FA_Note_PostSaveAsPDFDialog (72) • After specifying Acrobat settings and • Constants.FA_Note_PreDistill (73) generating PostScript •...
  • Page 674 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Event Notification Point Notification Constant FrameMaker product updates When the client needs to update insets that Constants.FA_Note_UpdateAllClientTi (36) all text insets belong to it FrameMaker product updates When the client needs to update a specified Constants.FA_Note_UpdateClientTi (37)
  • Page 675 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Event Notification Point Notification Constant Structural element dragged • • Before the element is dragged Constants.FA_Note_PreDragElement (58) • • After the element is dragged Constants.FA_Note_PostDragElement (59) An attribute value is set • • Before the attribute value is set Constants.FA_Note_PreSetAttrValue (62)
  • Page 676 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Constants.FE_Transport (-1) A transport error occurred. Constants.FE_BadOperation (-27) Clipboard stack is empty. Returns Syntax PopClipboard() Parameters Parameter name Data Type Optional Description NULL Void PrintFAErrno Description Prints the current error status, represented by the global variable, .
  • Page 677 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary PrintImportStatus Description Prints status flags returned by . It is useful for debugging your clients. Import() Returns Void Syntax PrintImportStatus(p) Parameters Parameter name Data Type Optional Description PropVals The property list that Import() returns in...
  • Page 678 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description PropVal The property to print. PrintPropVals Description Prints the values in a specified property list. It is useful for debugging your clients. Returns Void Syntax PrintPropVals(p) Parameters...
  • Page 679 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax PrintTextItem(textItem) Parameters Parameter name Data Type Optional Description textItem The text item to print. TextItem PrintTextItems Description Prints the text in a specified set of text items ( structure). It is useful for debugging clients.
  • Page 680 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary On failure, the method assigns the following value to FA_errno Error Reason Constants.FE_Transport (-1) A transport error occurred. Returns Void Syntax PushClipboard() Parameters Parameter name Data Type Optional Description NULL Void 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:...
  • Page 681 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Notification Values that client can pass to Meaning ReturnValue() Constants.FA_Note_DisplayClientTiDialog (35) Constants.FR_DisplayedTiDialog (-10002) The client has displayed its version of the Text Inset Properties dialog box. Constants.FA_Note_PreSaveAsPDFDialog (71) • • Constants.FR_CancelOperation (-10001) Cancel the Save As PDF operation.
  • Page 682 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary ShutDown Description Closes an ESTK client’s connection. Returns Void Syntax ShutDown(_) Parameters Parameter name Data Type Optional Description Void NULL SimpleNewDoc Description Creates a new document from a specified template. Note: If you call...
  • Page 683 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary is useful for clients that conduct extensive processing that the user may want to cancel. For example, if UserCancel() your client processes all the documents in a book, it can call after it processes each document.
  • Page 684 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description fileName string The absolute pathname of the file to open. interactive Specifies whether the FrameMaker product displays messages and warnings to the user. instructs the FrameMaker True product to display messages and warnings.
  • Page 685 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Constants.FE_BadParameter (-43) One of: • tomenu menu have the same values • is not previously defined tomenu • is not a menu tomenu Returns Syntax AddMenu(toMenu, menu, label) Parameters Parameter name Data Type...
  • Page 686 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary MenuExists Description Indicates whether a specified menu exists. The method returns if the menu exists or if the menu does not exist. True False Returns Syntax MenuExists(menu) Parameters Parameter name Data Type Optional Description menu The menu to be checked for existence.
  • Page 687 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description Void Null PrintExportStatus Description Returns Void Syntax PrintExportStatus(p) Parameters Parameter name Data Type Optional Description PropVals ErrorName Description Returns the string corresponding to the value of FA_errno...
  • Page 688 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax PrintErrno(i) Parameters Parameter name Data Type Optional Description NotificationName Description Returns string Syntax NotificationName(i) Parameters Parameter name Data Type Optional Description AllocatePropVals Description Allocates memory for a property list. On success, the method returns a property list (a data structure).The returned...
  • Page 689 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Open Description Opens a document or book. It can also create a new document. allows you to specify a property list telling FrameMaker how to open or create the file and how to deal with Open() error and warning conditions.
  • Page 690 ADOBE FRAMEMAKER SCRIPTING GUIDE 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 call. Open() • Constants.FV_RecoverFileUsed (33) - Recover file was present, and it was used.
  • Page 691 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary FS_OpenNativeError and FA_errno values Possible FS_OpenStatus flags Constants.FE_BadParameter (-43) (file was not • Constants.FV_FileHadStructure(64) - File had FrameMaker features, but current opened) FrameMaker product is not FrameMaker. • Constants.FV_FileAlreadyOpenThisSession (65) - File is already open and script disallowed opening another copy.
  • Page 692 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary FS_OpenNativeError and FA_errno values Possible FS_OpenStatus flags Constants.FE_Canceled (-44) (file was not • Constants.FV_CancelUseRecoverFile (96) - A recover file was present, so the user or the opened) Open() script canceled the Open operation. •...
  • Page 693 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary FS_OpenNativeError and FA_errno values Possible FS_OpenStatus flags • • Constants.FE_Success (0) Constants.FV_LockWasReset (0) - File lock was reset. • • Constants.FE_Canceled (-44) Constants.FV_LockNotReset (1) - File had a lock that was not reset. •...
  • Page 694 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Error Reason Constants.FE_Transport (-1) The user clicked Cancel, or a transport error occurred. Returns Syntax ScrollBox(title, stringslist, _default) Parameters Parameter name Data Type Optional Description title string The title that appears on the dialog box.
  • Page 695 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Parameters Parameter name Data Type Optional Description title string The message that appears in the dialog box. directory The default directory when the dialog box is first displayed. If string you specify an empty string, the last directory used by an ESTK client is used.
  • Page 696 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary does not assign a value to if the user clicks Cancel. PromptMetric() *metricp dialog boxes behave like metric dialog boxes in the user interface.If the user types a number followed PromptMetric() by a string that represents a unit (for example 10pts or 5"), the method converts the number into the equivalent number of metric units.
  • Page 697 ADOBE FRAMEMAKER SCRIPTING GUIDE Function Summary Syntax PromptString(message, stuffVal) Parameters Parameter name Data Type Optional Description message The message that appears in the dialog box. It must be 255 string characters or less.Newline and linefeed characters are ignored. stuffVal string The default value that appears in the input field when the dialog box is first displayed.

This manual is also suitable for:

Framemaker 10

Table of Contents