menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class CSharpScriptEngine - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class CSharpScriptEngine

    Summary description for CSharpScriptEngine.

    Inheritance
    System.Object
    CSharpScriptEngine
    Implements
    Microsoft.Vsa.IVsaEngine
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Syncfusion.Scripting
    Assembly: Syncfusion.Scripting.Base.dll
    Syntax
    public class CSharpScriptEngine : IVsaEngine

    Constructors

    CSharpScriptEngine()

    Declaration
    public CSharpScriptEngine()

    Properties

    Assembly

    Gets a compiled assembly

    Declaration
    public virtual Assembly Assembly { get; }
    Property Value
    Type
    System.Reflection.Assembly

    Evidence

    NOT IMPLEMENTED

    Declaration
    public virtual Evidence Evidence { get; set; }
    Property Value
    Type
    System.Security.Policy.Evidence

    GenerateDebugInfo

    NOT IMPLEMENTED

    Declaration
    public virtual bool GenerateDebugInfo { get; set; }
    Property Value
    Type
    System.Boolean

    IsCompiled

    Gets a Boolean value that signifies whether a script engine has successfully compiled the current source state

    Declaration
    public virtual bool IsCompiled { get; }
    Property Value
    Type
    System.Boolean

    IsDirty

    NOT IMPLEMENTED

    Declaration
    public virtual bool IsDirty { get; }
    Property Value
    Type
    System.Boolean

    IsRunning

    Gets a Boolean value that reports whether the script engine is currently in run mode

    Declaration
    public virtual bool IsRunning { get; }
    Property Value
    Type
    System.Boolean

    Items

    Declaration
    public virtual IVsaItems Items { get; }
    Property Value
    Type
    Microsoft.Vsa.IVsaItems

    Language

    Gets the nonlocalized name of the programming language supported by the script engine

    Declaration
    public virtual string Language { get; }
    Property Value
    Type
    System.String

    LCID

    NOT IMPLEMENTED

    Declaration
    public virtual int LCID { get; set; }
    Property Value
    Type
    System.Int32

    Name

    Sets or gets the display name of the script engine that is used primarily for identifying individual script engines to users in a hosted environment

    Declaration
    public virtual string Name { get; set; }
    Property Value
    Type
    System.String

    RootMoniker

    Sets or gets a script engine's root moniker.

    Declaration
    public virtual string RootMoniker { get; set; }
    Property Value
    Type
    System.String

    RootNamespace

    Sets or gets the root namespace used by the script engine

    Declaration
    public virtual string RootNamespace { get; set; }
    Property Value
    Type
    System.String

    Site

    Sets or gets the host-implemented IVsaSite object that is used by the script engine to communicate with the host

    Declaration
    public virtual IVsaSite Site { get; set; }
    Property Value
    Type
    Microsoft.Vsa.IVsaSite

    Version

    NOT IMPLEMENTED

    Declaration
    public virtual string Version { get; }
    Property Value
    Type
    System.String

    Methods

    Close()

    Closes the script engine and releases all resources. If the script engine is currently running, the IVsaEngine.Reset method is called first.

    Declaration
    public virtual void Close()

    Compile()

    Causes the script engine to compile the existing source state

    Declaration
    public virtual bool Compile()
    Returns
    Type
    System.Boolean

    GetOption(String)

    Gets implementation-specific options for a script engine.

    Declaration
    public virtual object GetOption(string name)
    Parameters
    Type Name Description
    System.String name
    Returns
    Type
    System.Object

    InitNew()

    NOT IMPLEMENTED

    Declaration
    public virtual void InitNew()

    IsValidIdentifier(String)

    Checks whether the supplied identifier is valid for the script engine.

    Declaration
    public virtual bool IsValidIdentifier(string identifier)
    Parameters
    Type Name Description
    System.String identifier
    Returns
    Type
    System.Boolean

    LoadSourceState(IVsaPersistSite)

    NOT IMPLEMENTED

    Declaration
    public virtual void LoadSourceState(IVsaPersistSite site)
    Parameters
    Type Name Description
    Microsoft.Vsa.IVsaPersistSite site

    Reset()

    Declaration
    public virtual void Reset()

    RevokeCache()

    NOT IMPLEMENTED

    Declaration
    public virtual void RevokeCache()

    Run()

    Initiates execution of compiled code in the script engine and binds all event handlers.

    Declaration
    public virtual void Run()

    SaveCompiledState(out Byte[], out Byte[])

    Saves the compiled state of the script engine; optionally, it also saves debugging information

    Declaration
    public virtual void SaveCompiledState(out byte[] pe, out byte[] pdb)
    Parameters
    Type Name Description
    System.Byte[] pe
    System.Byte[] pdb

    SaveSourceState(IVsaPersistSite)

    NOT IMPLEMENTED

    Declaration
    public virtual void SaveSourceState(IVsaPersistSite site)
    Parameters
    Type Name Description
    Microsoft.Vsa.IVsaPersistSite site

    SetOption(String, Object)

    Checks whether the supplied identifier is valid for the script engine

    Declaration
    public virtual void SetOption(string name, object value)
    Parameters
    Type Name Description
    System.String name
    System.Object value

    Implements

    Microsoft.Vsa.IVsaEngine
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved