4.1.6.1 Predefined variables

Using Field-Map predefined variables

There are a number of predefined variables available in Field-Map which make Field-Map scripting more convenient an effective. Some of them have fixed names and some have derived names.

Predefined variables with fixed names:

	DisableEvents	The "DisableEvents" variable is used to prevent circular dependency in scripts. For more information, see the Disabling events chapter.
	Project	The "Project" variable represents the currently opened Field-Map project. For more information, see the Accessing Field-Map data within a script chapter.
	ProjectDir	The "ProjectDir" variable holds the path to the project folder as a string.
	ProjectName	The "ProjectName" is a string variable containing the name of the currently opened project.
	ScriptResult	The "ScriptResult" variable is used in On-Validate scripts. See the On-Validate scripts chapter to learn more.
	SystemDir	The "SystemDir" variable holds the path to the system folder as a string.
	UserDir	The "UserDir" variable holds the path to the user folder as a string.
	ValidationFailedMessageText	The string to be displayed in the warning message box if ScriptResult is set to "0", i.e. if the newly added value is recognized to be invalid.

Predefined variables with derived names:

There is an automatically created variable for each Field-Map layer named the same as the corresponding layer. For more information, see the Accessing Field-Map data within a script chapter.