Translation functions

Translation functions deal either directly with translators or with translation results. These functions get information about or run a translator, edit content in a locked region, and specify that the translated source should be used when getting and setting selection offsets.

dom.runTranslator()

Availability

Dreamweaver 3.

Description

This function runs the specified translator on the document. This function is valid only for the active document.

Arguments

 translatorName 

• The translatorName argument is the name of a translator as it appears in the Translation preferences.

Returns

Nothing.

dreamweaver.editLockedRegions()

Availability

Dreamweaver 2.

Description

Depending on the value of the argument, this function makes locked regions editable or non-editable. By default, locked regions are non-editable; if you try to edit a locked region before specifically making it editable with this function, Dreamweaver beeps and does not allow the change.

NOTE

Editing locked regions can have unintended consequences for library items and templates. You should not use this function outside the context of data translators.

Arguments

 bAllowEdits 

• The bAllowEdits argument is a Boolean value: true indicates that edits are allowed; false otherwise. Dreamweaver automatically restores locked regions to their default (non-editable) state when the script that calls this function finishes executing.

Returns

Nothing.

dreamweaver.getTranslatorList()

Availability

Dreamweaver 3.

Description

This function gets a list of the installed translators.

Arguments

None.

Returns

An array of strings where each string represents the name of a translator as it appears in the Translation preferences.

dreamweaver.useTranslatedSource()

Availability

Dreamweaver 2.

Description

This function specifies that the values that dom.nodeToOffsets() and dom.getSelection() return. These are used by dom.offsetsToNode() and dom.setSelection() and should be offsets into the translated source (the HTML that is contained in the DOM after a translator runs), not the untranslated source.

NOTE

This function is relevant only in Property inspector files.

Arguments

 bUseTranslatedSource 

• The bUseTranslatedSource argument is a Boolean value: true if the function uses offsets into the translated source; false if the function uses the untranslated source.

  The default value of the argument is false. Dreamweaver automatically uses the untranslated source for subsequent calls to dw.getSelection(), dw.setSelection(), dw.nodeToOffsets(), and dw.offsetsToNode() when the script that calls dw.useTranslatedSource() finishes executing, if dw.useTranslatedSource() is not explicitly called with an argument of false before then.

Returns

Nothing.