Chapter 3: Differences Between Scripts And Fdk; Naming Differences Between Scripts And Fdk - Adobe 65030365 - FrameMaker - PC Manual

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.
This chapter documents the differences between using scripts and using FDK.

Naming differences between scripts and FDK

FDK
Every FDK object is identified by an object ID.
Every property in FDK starts with FP_
For example, FP_CharTag .
Every API in FDK starts with
F_APImethodname
Every object in FDK starts with FO_
For example, FO_DOC .
Every structure in FDK starts with F_ and ends with a
T.
For example, F_AttributeT.
FDK uses data types such as
StrngT
, for numbers.
IntT UintT
The following examples clearly highlight the differences between scripts and the FDK.
Example 1:
Scripts
Every script entity is identified as an object.
. Properties are used directly, in scripts. Remove the
properties in scripts.
For example, FP_CharTag
Every property has its own data type. The properties can either be read-only or read-
write.
Note: All FDK properties can be used in FrameMaker scripts.
. Methods are used directly in scripts. Remove the
in scripts.
For example, F_ApiSplitElement becomes just
. Use objects directly in scripts. Remove the
For example, FO_DOC
Note: FDK object
script object is readily available for all FrameMaker scripts to use.
app
Structures are used directly in scripts. Remove the F_ prefix and the ending 'T' before
using the structures in scripts.
For example, F_AttributeT in FDK becomes just Attribute in scripts.
Some FDK structures contain other FDK structures within themselves. In a script, the
structures within a structure are treated as an object data type.
See the F_TextRangeT
for strings and Scripts map the FDK data types as follows:
is mapped to Javascript
StringT
and
IntT UinT
ObjHandleT is mapped to Javascript
Last updated 9/26/2011
FP_
in FDK becomes just CharTag
F_API
SplitElement
FO_ prefix before using the objects in scripts.
in FDK becomes just DOC in scripts.
is mapped to
FO_Session
structure in Example 3 below.
.
String
are mapped to Javascript .
Number
Object .
prefix before using the
in scripts.
prefix before using the methods
in scripts.
and not to . This
app Session
8