2022.2

Stringcontainingthemessage(thesourcetext).
context
Themessage'scontext(optional).Acontextmaybespecifiedwhencreatingatranslationentry.Spe-
cifyingacontextmakesitpossibletotranslateacertaintextindifferentways.
Example
Thefollowinglineofcodegetsthetranslationofthestring"Submit"thatwasregisteredwiththecontext
"button".
var str = translate( "Submit", "button" );
Control Script API
ThetablebelowliststheobjectsthatarethemostimportantinControlScripts.Clickthroughtothe
objecttofindadescriptionandsamplescripts.
See"ControlScripts"onpage838forinformationaboutthiskindofscripts,howtoinsertthemand
whatyoucandowiththem.
Other objects that are available to Control Scripts
Thelistbelowisn'texhaustive:mostoftheobjectslistedintheDesignerAPI(see"StandardScriptAPI"
onpage1169)arealsoavailableinControlScripts.NotallofthoseobjectscanbeusedinControl
Scripts,however.ThisisbecauseControlScriptsdifferfromtemplatescripts(see"WhatControl
Scriptsare"onpage838).Forexample,thequery()functioncan'tbeusedinaControlScript
becauseitrequiresaccesstotheDOMwhichaControlScriptdoesn'thave.
Object Usage
channel(see
"Channel"on
page1294)
Thechannelforwhichoutputisgenerated.Thisisregisteredinthemergeobject:merge.channel.Notethatthechanneldoesn't
changewhentheoutputconsistsofdifferentcontexts.Whengeneratingemail,forexample,thechannelisEMAIL,evenwhenmer-
gingthePrintcontexttoattachittotheemail.
"context"on
page1299
Objectthatcontainsonecontextanditssections.Itisaccessedthroughthetemplateobject:merge.template.contexts.To
getaccesstoonecontext,youhavetospecifytheContextType(see"ContextType"onpage1295),forexample:var printCon-
text = merge.template.contexts.PRINT;.
Throughthemergeobjectyoucanfindoutwhichcontextiscurrentlybeingmerged:merge.context.
"masterpage"on
page1274
ThemasterpageobjectisusedtosetaMasterPage'sheaderandfooterortoreplaceitsentireHTMLbody.
"merge"on
page1313
Themergeobjectgivesaccesstothetemplatewithallofitscontextsandsections.
Page 1271