ScriptDefinitionCreate Method

Spotfire 14.3 API Reference
Creates a new instance of the ScriptDefinition class. A ScriptDefinition object created by this method will not be trusted for all users until it is saved by a member of the ScriptAuthor group. Once created, the ScriptDefinition object defines the script, but it will not be stored in the document until it is added to the ScriptManager, by calling AddScriptDefinition(ScriptDefinition), or by using the returned ScriptDefinition object to create a new HtmlTextAreaScript and calling Add(HtmlTextAreaScript) on an Scripts instance.

Namespace:  Spotfire.Dxp.Application.Scripting
Assembly:  Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
Copy
public static ScriptDefinition Create(
	string name,
	string description,
	string scriptCode,
	ScriptLanguage language,
	ScriptParameterCollection parameters,
	bool wrapInTransaction
)

Parameters

name
Type: SystemString
The name of the script
description
Type: SystemString
The description of the script
scriptCode
Type: SystemString
The code of the script
language
Type: Spotfire.Dxp.Application.ScriptingScriptLanguage
The ScriptLanguage used by the script
parameters
Type: Spotfire.Dxp.Application.ScriptingScriptParameterCollection
The ScriptParameterCollection containing the definitions of the script parameters
wrapInTransaction
Type: SystemBoolean
Set this to true if this script should be wrapped in a transaction. Only has an effect if the Script Language is IronPython

Return Value

Type: ScriptDefinition
A newly created ScriptDefinition object.
Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0
See Also

Reference

ScriptDefinition Class
Spotfire.Dxp.Application.Scripting Namespace