FrameScript - Konventionen

Präfixe für Formular-Steuerelemente

FrameScript 3.0+ FrameMaker 5 / 6 / 7 Windows
Steuerelementtyp   Präfix       Beispiel
EForm frm frmMain
EAnimateCtrl ani aniVideo
EButton cmd; btn cmdOK; btnOK
ECheckBox chk chkCloseForm
EDateTimeCtrl dtc dtcSelectDate
EDropDownBox cbo; ddb cboFormats; ddbFormats
EEdit edt; txt edtName, txtName
EGroupBox grp; fra grpOptions, fraOptions
EImageBox img imgSymbol
ELabel lbl lblFolder
EListBox lst lstFormats
EMEdit med medInfo
EProgressBar prg prgCopyFile
ERadioButton rad; rbn radAsCopy; rbnAsCopy
ERectCtrl rct rctFrame
ERichEdit rtf; red rtfAbout; redAbout
EScrollBar vsb / hsb vsbPicture / hsbPicture
ETreeCtrl tre; tvw treProperties; tvwProperties
EMenu mnu mnuMain
EMenuBar bar barFile
EMenuItem itm itmFileOpen
EMenuSeparator sep sep01

Präfixe für den Gültigkeitsbereich von Variablen

FrameScript 2.0+ FrameMaker 5 / 6 / 7 Windows
Gültigkeitsbereich   Präfix       Beispiel
Global gv gv_objCurrDoc
Lokal lv lv_nCount
Parameter pv pv_objDoc

Lokal:   Variablen müssen mit dem Schlüsselwort 'Local' deklariert werden.
Parameter:   Parameter-Variablen sind immer lokal.

Der Unterstrich nach dem Päfix ist nicht zwingend erforderlich. Er verbessert jedoch die Lesbarkeit des Variablennamens.

Präfixe für den Datentyp von Variablen

FrameScript 2.0+ FrameMaker 5 / 6 / 7 Windows
Datentyp Präfix Beispiel
Attribute att attCommentsSuffix
AttributeDef adef adefCommentsSuffix
Boolean bln blnIsFound
ElementLoc eloc elocBegin
ElementRange eran eranChilds
Integer int intColor
LibVar lib libUtils
Metric met metRuler
Object obj objDocument
Point pt ptStart
Property prop propStatus
Real rea reaLength
Real real reaLength
ScriptVar scr scrInit
String str strPath
SubVar sub subGetOpenDoc
Tab tab tabFirst
TextItem txt txtTextItem
TextLoc tloc tlocBegin
TextRange tran tranSelection