Interface IScriptLanguage

Namespace: Phoenix.ComponentPlugInSDK.Models
Assembly: Phoenix.ComponentPlugInSDK.dll

Defines a scripting language to use whose syntax can be highlighted in the AvalonEdit text editor.

public interface IScriptLanguage

Properties

DefaultText

The default text shown when the language is selected and the user has not changed the script.

DisplayName

The name to display in the UI.

FilenameExtension

The filename extension to use in the PACZ, including the dot.

NamedVariableDisplayName

The display name to use for the named variable field.

NamedVariableToken

The label to use for the named variable in the 'Variable Text Editor' Must be alphanumeric with no spaces or special characters.

SyntaxName

The name of the scripting language as needed to be loaded by the AvalonEdit text editor.

UsesNamedVariable

If the Script uses 'Named Variables' These are user specified names that differ from the name of the CAM variable.

Methods

GetHighlightNames(IEnumerable)

Gets a list of names to highlight from an enumerable of variables. Note: the highlighter uses Regex matching. Each item is matched as a regex word and special characters need to be escaped. To highlight "obj.value", include "obj.value" in the returned list.

GetScriptFilename()

Gets the filename to use for the script within a pacz.