Home » Adobe Manuals » Computer Software » Adobe 65030365 » Manual Viewer

Adobe 65030365 Scripting Guide - Page 596

Returns

UPC - 883919170923

Add to My Manuals
Save this manual to your list of manuals

Page 596 highlights

ADOBE FRAMEMAKER SCRIPTING GUIDE 588 Function Summary FrameMaker menubar Menu bar for documents (quick menus) Menu bar for documents (custom menus) Menu bar for books (complete menus) Menu bar for books (quick menus) Structure menu bar (structured product interface only) Pop-up menu for documents (complete menus; UNIX only) Pop-up menu for documents (quick menus; UNIX only) View-only menu bar View-only pop-up menu (UNIX only) Menubar string !QuickMakerMainMenu !CustomMakerMainMenu !BookMainMenu !QuickBookMainMenu !StructureViewMainMenu !MakerPopup !QuickMakerPopup !ViewOnlyMainMenu !ViewerPopup Note: Your menu appears only on the menu bar you specify. For example, if you only add a menu to the !MakerMainMenu menu bar, the menu will not appear if the user switches to quick menus. For your menu to appear after the user has switched to quick menus, you must also add it to !QuickMakerMainMenu. If you call DefineAndAddMenu() and specify the name of a menu that is already defined in the user's menu configuration files, FrameMaker gives precedence to the definition in the configuration files. If the configuration files assign a label to the menu, FrameMaker uses it instead of the one you specify. If the menu is already on a menu or menu bar, FrameMaker ignores the menu that you specify and leaves the menu where it is. The following table lists the types of menus you can add a menu to and how FrameMaker implements the added menu. Type of menu or menu bar How FrameMaker implements the you are adding a menu to added menu Menu bar Pull-down menu Pull-down menu Pull-right menu Pop-up menu Pull-right menu Pull-right menu Pull-right menu FrameMaker product adds the menu At the right of the menu bar. At the bottom of the pull-down menu. At the bottom of the pop-up menu. At the bottom of the pull-right menu. The method returns the menu, on success. On failure, the method returns one of the following values to FA_errno: Error Constants.FE_WrongProduct (-60) Constants.FE_NotMenu (-72) Constants.FE_BadOperation (-27) Constants.FE_BadParameter (-43) Constants.FE_SystemError (-42) Reason Current FrameMaker product does not support this operation or fmbatch is running. The specified menu does not exist. Parameters specified an invalid operation. The specified parameter has an invalid value. System Error Returns Menu Last updated 9/26/2011

Section	Page
Contents	4
Chapter 1: Overview	9
About this document	9
Naming conventions	9
Typographic conventions	9
Scripting support in FrameMaker	10
Development and debugging tools in ExtendScript toolkit	10
ExtendScript capabilities	10
Creating Scripts	11
Accessing ESTK	11
Connect ESTK to FrameMaker	11
To write, edit, and run scripts	11
Using script library	12
Using object model viewer	13
ExtendScript use cases	13
Chapter 2: Sample ESTK scripts	14
Adding text to a document and enabling change bar	14
Changing the table properties in a document	14
Chapter 3: Differences between scripts and FDK	16
Naming differences between scripts and FDK	16
Notifications	19
Menus and Commands	20
Chapter 4: Object Reference	23
AFrame	23
AFrame methods	27
Arc	27
Arc methods	30
AttrCondExpr	30
AttrCondExpr methods	30
Attribute	30
Attribute methods	31
AttributeDef	31
AttributeDef methods	32
AttributeDefs	32
AttributeDefs methods	32
AttributeEx	33
Attributes	33
Attributes methods	33
AttributesEx	33
AttributesEx methods	33
BodyPage	34
BodyPage methods	34
Book	35
Book methods	43
BookComponent	44
BookComponent methods	53
Cell	53
Cell methods	55
CharFmt	55
CharFmt methods	58
Color	59
Color methods	60
CombinedFont	60
CombinedFont methods	60
CombinedFontDefn	61
CombinedFontDefn methods	61
CombinedFonts	61
CombinedFonts methods	61
Command	62
Command methods	65
CompareRet	66
CompareRet methods	66
CondFmt	66
CondFmt methods	67
Constants	67
Doc	229
Doc methods	263
Element	264
Element methods	268
ElementCatalogEntries	269
ElementCatalogEntries methods	269
ElementCatalogEntry	269
ElementCatalogEntry methods	269
ElementDef	269
ElementDef methods	271
ElementLoc	271
ElementLoc methods	271
ElementRange	272
ElementRange methods	272
Ellipse	272
Ellipse methods	274
FCodes	275
FilterArgs	335
FilterArgs methods	335
Flow	335
Flow methods	336
FmtChangeList	336
FmtChangeList methods	341
FmtRule	342
FmtRule methods	342
FmtRuleClause	342
FmtRuleClause methods	343
Fn	343
Fn methods	344
Font	344
Font methods	344
Fonts	344
Fonts methods	345
Group	345
Group methods	347
HiddenPage	347
HiddenPage methods	347
Inset	348
Inset methods	350
Ints	351
Ints methods	351
Line	351
Line methods	353
Marker	353
Marker methods	354
MarkerType	354
MarkerType methods	354
MasterPage	354
MasterPage methods	354
Math	355
Math methods	357
Menu	358
Menu methods	358
MenuItemSeparator	358
MenuItemSeparator methods	359
Metrics	359
Metrics methods	359
Pgf	359
Pgf methods	364
PgfFmt	365
PgfFmt methods	370
Point	370
Point methods	370
Points	370
Points methods	370
Polygon	371
Polygon methods	373
Polyline	373
Polyline methods	376
PropIdent	376
PropIdent methods	376
PropVal	376
PropVal methods	376
PropVals	377
PropVals methods	377
Rectangle	377
Rectangle methods	379
RefPage	380
RefPage methods	380
RoundRect	380
RoundRect methods	382
Row	383
Row methods	384
Rubi	384
Rubi methods	384
RulingFmt	385
RulingFmt methods	385
Strings	385
Strings methods	385
SubCol	385
SubCol methods	386
Tab	387
Tab methods	387
Tabs	387
Tabs methods	387
Tbl	388
Tbl methods	391
TblFmt	391
TblFmt methods	393
TextFrame	393
TextFrame methods	396
TextItem	397
TextItems	399
TextItems methods	399
TextLine	400
TextLine methods	403
TextLoc	403
TextLoc methods	403
TextRange	403
TextRange methods	403
TiApiClient	404
TiApiClient methods	404
TiFlow	405
TiFlow methods	406
TiText	406
TiText methods	407
TiTextTable	407
TiTextTable methods	408
TypedVal	408
TypedVals	408
TypedVals methods	409
UBytes	409
UBytes methods	409
UInts	409
UInts methods	409
UnanchoredFrame	409
UnanchoredFrame methods	412
Var	412
Var methods	412
VarFmt	413
VarFmt methods	413
XRef	414
XRef methods	415
XRefFmt	415
XRefFmt methods	415
app	415
app methods	419
Chapter 5: Function Summary	420
AFrame	420
Delete	420
GetProps	420
SetProps	421
ObjectValid	422
Arc	423
Delete	423
GetProps	423
SetProps	423
ObjectValid	424
AttrCondExpr	424
ApplyAttributeExpression	424
GetProps	424
SetProps	424
ObjectValid	425
Attribute	425
Attribute	425
AttributeDef	426
AttributeDef	426
AttributeDefs	427
concat	427
pop	427
push	428
Attributes	428
concat	428
pop	429
push	429
AttributesEx	429
concat	429
pop	430
push	430
BodyPage	430
Delete	430
GetProps	431
SetProps	431
ObjectValid	431
ApplyPageLayout	432
Book	432
Compare	432
NewBookComponentInHierarchy	433
SilentPrintDoc	434
SimpleGenerate	434
SimpleImportFormats	435
SimpleImportElementDefs	436
GetUniqueObject	437
Close	438
SimpleSave	438
NewSeriesObject	440
NewSeriesBookComponent	440
NewBookComponentOfTypeInHierarchy	441
Save	441
UpdateBook	443
Import	446
GetProps	456
SetProps	456
ObjectValid	456
BookComponent	457
Delete	457
MoveComponent	457
GetProps	457
SetProps	458
ObjectValid	458
Cell	458
StraddleCells	458
UnStraddleCells	459
GetText	460
GetProps	463
SetProps	464
ObjectValid	464
CharFmt	464
Delete	464
GetProps	465
SetProps	465
ObjectValid	465
Color	466
Delete	466
GetProps	466
SetProps	466
ObjectValid	467
CombinedFont	467
CombinedFont	467
CombinedFontDefn	468
CombinedFamilyFonts	468
Delete	468
GetProps	468
SetProps	469
ObjectValid	469
CombinedFonts	469
concat	469
pop	470
push	470
Command	470
Delete	470
GetProps	471
SetProps	471
ObjectValid	471
Delete	472
CompareRet	472
CompareRet	472
CondFmt	473
Delete	473
GetProps	473
SetProps	473
ObjectValid	474
Doc	474
AddText	474
CenterOnText	475
Clear	475
ClearAllChangebars	476
Compare	477
Copy	478
Cut	479
DeleteText	480
DemoteElement	480
GetTextForRange	481
GetTextForRange2	484
GetTextProps	485
GetTextPropVal	486
GetTextVal	487
HypertextCommand	488
MergeIntoFirst	488
MergeIntoLast	489
NewTable	489
Paste	490
PromoteElement	492
QuickSelect	492
Redisplay	493
Reformat	493
Rehyphenate	494
ResetEqnSettings	494
ResetReferenceFrames	495
RestartPgfNumbering	495
ScrollToText	495
SetTextProps	496
SetTextPropVal	497
SetTextVal	498
SilentPrintDoc	499
SimpleImportFormats	500
SplitElement	501
TextLocToElementLoc	502
UnWrapElement	502
UpdateXRefs	503
SimpleImportElementDefs	503
GetUniqueObject	504
Close	505
SimpleSave	506
NewGraphicObject	507
NewArc	508
NewEllipse	508
NewFlow	509
NewGroup	509
NewInset	510
NewLine	510
NewMath	511
NewPolyline	511
NewPolygon	511
NewRectangle	512
NewRoundRect	512
NewTextFrame	513
NewTextLine	513
NewUnanchoredFrame	514
NewAnchoredFormattedObject	514
NewAnchoredFormattedVar	515
NewAnchoredFormattedXRef	515
NewAnchoredFormattedTbl	516
NewAnchoredObject	516
NewAnchoredAFrame	517
NewAnchoredFn	518
NewAnchoredMarker	518
NewAnchoredTiApiClient	518
NewAnchoredTbl	519
NewSeriesObject	519
NewSeriesBodyPage	520
NewSeriesPgf	520
GetNamedObject	521
GetNamedAttrCondExpr	522
GetNamedCharFmt	522
GetNamedColor	523
GetNamedCombinedFontDefn	523
GetNamedCondFmt	524
GetNamedElementDef	524
GetNamedFmtChangeList	524
GetNamedMasterPage	525
GetNamedPgfFmt	525
GetNamedRefPage	526
GetNamedRulingFmt	526
GetNamedTblFmt	526
GetNamedUnanchoredFrame	527
GetNamedVarFmt	527
GetNamedXRefFmt	528
GetNamedMarkerType	528
NewNamedObject	528
NewNamedAttrCondExpr	530
NewNamedCharFmt	530
NewNamedCombinedFontDefn	530
NewNamedColor	531
NewNamedCondFmt	531
NewNamedElementDef	532
NewNamedFmtChangeList	532
NewNamedMasterPage	532
NewNamedPgfFmt	533
NewNamedRefPage	533
NewNamedRulingFmt	534
NewNamedTblFmt	534
NewNamedVarFmt	534
NewNamedXRefFmt	535
NewNamedMarkerType	535
DeleteUnusedFmts	536
DeleteUnusedCharFmt	536
DeleteUnusedPgfFmt	536
DeleteUnusedTblFmt	537
Find	537
SetElementRange	540
ElementLocToTextLoc	541
UpdateVariables	541
TrackChangesAcceptAll	542
TrackChangesRejectAll	542
UpdateXRef	543
Save	543
Import	544
AddNewBuildExpr	544
DeleteBuildExpr	545
SetActiveBuildExpr	546
GetActiveBuildExpr	546
GetBuildExpr	546
GetBuildExprCatalog	547
GetProps	547
SetProps	548
ObjectValid	548
Element	548
GetAttributes	548
Delete	549
GetText	549
GetProps	550
SetProps	550
ObjectValid	550
ElementCatalogEntries	551
concat	551
pop	551
push	552
ElementCatalogEntry	552
ElementCatalogEntry	552
ElementDef	553
NewTextFmtRules	553
NewObjectFmtRules	553
NewPrefixRules	554
NewSuffixRules	554
NewFirstPgfRules	555
NewLastPgfRules	556
ElementDefIsText	556
NewElement	557
NewElementInHierarchy	558
WrapElement	559
GetAttributeDefs	559
Delete	560
GetProps	560
SetProps	561
ObjectValid	561
ElementLoc	561
ElementLoc	561
ElementRange	562
ElementRange	562
Ellipse	562
Delete	562
GetProps	563
SetProps	563
ObjectValid	563
FilterArgs	564
FilterArgs	564
Flow	564
Delete	564
GetText	565
GetProps	565
SetProps	565
ObjectValid	566
FmtChangeList	566
Delete	566
GetProps	566
SetProps	567
ObjectValid	567
FmtRule	567
NewFmtRuleClauses	567
Delete	568
GetProps	568
SetProps	568
ObjectValid	569
FmtRuleClause	569
NewSubFmtRule	569
NewFmtChangeList	570
Delete	570
GetProps	571
SetProps	571
ObjectValid	571
Fn	572
Delete	572
GetText	572
GetProps	572

Match case Limit results 1 per page

588

ADOBE FRAMEMAKER SCRIPTING GUIDE

Function Summary

Last updated 9/26/2011

Note:

Your menu appears only on the menu bar you specify. For example, if you only add a menu to the

!MakerMainMenu

menu bar, the menu will not appear if the user switches to quick menus. For your menu to appear after the user has

switched to quick menus, you must also add it to

!QuickMakerMainMenu

If you call

DefineAndAddMenu()

and specify the name of a menu that is already defined in the user’s menu

configuration files, FrameMaker gives precedence to the definition in the configuration files.

If the configuration files assign a label to the menu, FrameMaker uses it instead of the one you specify. If the menu is

already on a menu or menu bar, FrameMaker ignores the menu that you specify and leaves the menu where it is.

The following table lists the types of menus you can add a menu to and how FrameMaker implements the added menu.

The method returns the menu, on success.

On failure, the method returns one of the following values to

FA_errno

Returns

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; UNIX only)

!MakerPopup

Pop-up menu for documents (quick menus; UNIX only)

!QuickMakerPopup

View-only menu bar

!ViewOnlyMainMenu

View-only pop-up menu (UNIX only)

!ViewerPopup

Type of menu or menu bar

you are adding a menu to

How FrameMaker implements the

added menu

FrameMaker product adds the menu

Menu bar

Pull-down menu

At the right of the menu bar.

Pull-down menu

Pull-right menu

At the bottom of the pull-down menu.

Pop-up menu

Pull-right menu

At the bottom of the pop-up menu.

Pull-right menu

At the bottom of the pull-right menu.

Error

Reason

Constants.FE_WrongProduct (-60)

Current FrameMaker product does not support this operation or

fmbatch

is running.

Constants.FE_NotMenu (-72)

The specified menu does not exist.

Constants.FE_BadOperation (-27)

Parameters specified an invalid operation.

Constants.FE_BadParameter (-43)

The specified parameter has an invalid value.

Constants.FE_SystemError (-42)

System Error

FrameMaker menubar

Menubar string