Class ScriptEditControl

Script Engine control. Support writing multi-language script.

Inheritance

System.Object

ScriptEditControl

Namespace: Syncfusion.Scripting.Design

Assembly: Syncfusion.Scripting.Windows.dll

Syntax

public class ScriptEditControl : UserControl

Constructors

ScriptEditControl()

Default constructor

Declaration

public ScriptEditControl()

Fields

assemblyDirectives

Declaration

protected string assemblyDirectives

Field Value

Type
System.String

bExternalCompile

Declaration

protected bool bExternalCompile

Field Value

Type
System.Boolean

bExternalRun

Declaration

protected bool bExternalRun

Field Value

Type
System.Boolean

bPendingSave

Declaration

protected bool bPendingSave

Field Value

Type
System.Boolean

globalCode

Declaration

protected string globalCode

Field Value

Type
System.String

nameSpaceDefine

Declaration

protected string nameSpaceDefine

Field Value

Type
System.String

scriptManager

Declaration

protected ScriptingManager scriptManager

Field Value

Type
ScriptingManager

strScriptStart

Declaration

protected string strScriptStart

Field Value

Type
System.String

strScriptStop

Declaration

protected string strScriptStop

Field Value

Type
System.String

Properties

AssemblyReferences

Declaration

public string[] AssemblyReferences { get; }

Property Value

Type
System.String[]

BaseClass

Declaration

public Type BaseClass { get; }

Property Value

Type
System.Type

EnableExternalCompile

Indicates if the ScriptingManager is being used for external compilation of the script.

Declaration

public bool EnableExternalCompile { get; set; }

Property Value

Type
System.Boolean

EnableExternalRun

Declaration

public bool EnableExternalRun { get; set; }

Property Value

Type
System.Boolean

EntryPoint

Declaration

public string EntryPoint { get; set; }

Property Value

Type
System.String

PendingSave

Declaration

public bool PendingSave { get; }

Property Value

Type
System.Boolean

RootMoniker

Declaration

public string RootMoniker { get; set; }

Property Value

Type
System.String

RootNamespace

Declaration

public string RootNamespace { get; set; }

Property Value

Type
System.String

Script

Declaration

public Script Script { get; set; }

Property Value

Type
Script

ScriptingManager

Declaration

public ScriptingManager ScriptingManager { get; set; }

Property Value

Type
ScriptingManager

ScriptLanguage

Declaration

public ScriptLanguages ScriptLanguage { get; set; }

Property Value

Type
ScriptLanguages

ScriptName

Declaration

public string ScriptName { get; set; }

Property Value

Type
System.String

ScriptText

Gets or sets script source code.

Declaration

public string ScriptText { get; set; }

Property Value

Type
System.String

SelectedItem

Declaration

public ScriptObject SelectedItem { get; set; }

Property Value

Type
ScriptObject

Methods

AddAssemblyReference(String)

Adds the assembly to the list of referenced assemblies.

Declaration

public void AddAssemblyReference(string assembly)

Parameters

Type	Name	Description
System.String	assembly	New assembly to reference.

Exceptions

Type	Condition
System.ArgumentException	When assembly is null.

AddScriptableObject(ScriptObject)

Declaration

public void AddScriptableObject(ScriptObject scriptableitem)

Parameters

Type	Name	Description
ScriptObject	scriptableitem

ClearAssemblyReferences()

Declaration

public void ClearAssemblyReferences()

CompileScript()

Declaration

public bool CompileScript()

Returns

Type
System.Boolean

Dispose(Boolean)

Clean up any resources being used.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

GetFileDialogFilter(ScriptLanguages)

Declaration

protected virtual string GetFileDialogFilter(ScriptLanguages language)

Parameters

Type	Name	Description
ScriptLanguages	language

Returns

Type
System.String

InitializeScriptEditor(Script)

Loads the data from the script into the editor.

Declaration

public virtual void InitializeScriptEditor(Script script)

Parameters

Type	Name	Description
Script	script	Script to load into the editor

InitializeScriptEditor(ScriptingManager)

Declaration

public void InitializeScriptEditor(ScriptingManager scriptmanager)

Parameters

Type	Name	Description
ScriptingManager	scriptmanager

New()

Declaration

public void New()

ObjectBrowser_NodeDoubleClick(Object, NodeDoubleClickEventArgs)

Declaration

public void ObjectBrowser_NodeDoubleClick(object sender, NodeDoubleClickEventArgs e)

Parameters

Type	Name	Description
System.Object	sender
NodeDoubleClickEventArgs	e

OnLanguageChange(ScriptLanguages)

Declaration

protected virtual void OnLanguageChange(ScriptLanguages language)

Parameters

Type	Name	Description
ScriptLanguages	language

OnScriptChange()

Declaration

protected virtual void OnScriptChange()

OpenFile()

Declaration

public void OpenFile()

RemoveScriptableObject(ScriptObject)

Declaration

public void RemoveScriptableObject(ScriptObject scriptableitem)

Parameters

Type	Name	Description
ScriptObject	scriptableitem

RunScript()

Declaration

public void RunScript()

SaveToFile()

Declaration

public void SaveToFile()

scriptingManager_CompileError(Object, VsaErrorEventArgs)

Declaration

protected void scriptingManager_CompileError(object sender, VsaErrorEventArgs eventargs)

Parameters

Type	Name	Description
System.Object	sender
VsaErrorEventArgs	eventargs

SetCompileButtonsState()

Declaration

protected void SetCompileButtonsState()

StopScript()

Declaration

public void StopScript()

UpdateScript(Script)

Updates the script object with the current values in the editor.

Declaration

public void UpdateScript(Script script)

Parameters

Type	Name	Description
Script	script	Script to update

Events

ScriptChanged

Send when script is changed.

Declaration

public event EventHandler ScriptChanged

Event Type

Type
System.EventHandler