Syncfusion.Scripting.Base
Summary description for AssemblyDescriptor.
Type-safe collection for AssemblyDescriptor objects.
Summary description for CSharpScriptEngine.
Name of the global class for accessing to global objects.
Whitespace keyword.
Open brace keyword.
Close brace keyword.
Source of global class for accerssing global objects.
Source of global class for accerssing global objects.
String for adding global variables.
NOT IMPLEMENTED
Saves the compiled state of the script engine;
optionally, it also saves debugging information
Gets implementation-specific options for a script engine.
NOT IMPLEMENTED
NOT IMPLEMENTED
Closes the script engine and releases all resources.
If the script engine is currently running,
the IVsaEngine.Reset method is called first.
Causes the script engine to compile the existing source state
NOT IMPLEMENTED
Initiates execution of compiled code in the script engine
and binds all event handlers.
Checks whether the supplied identifier is valid for the script engine.
Checks whether the supplied identifier is valid for the script engine
NOT IMPLEMENTED
Sets or gets the root namespace used by the script engine
Gets a Boolean value that signifies whether a script engine
has successfully compiled the current source state
Sets or gets a script engine's root moniker.
NOT IMPLEMENTED
Gets a compiled assembly
NOT IMPLEMENTED
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
NOT IMPLEMENTED
Gets a Boolean value that reports whether
the script engine is currently in run mode
NOT IMPLEMENTED
Gets the nonlocalized name of the
programming language supported by the script engine
Sets or gets the host-implemented IVsaSite object
that is used by the script engine to communicate with the host
Summary description for CSharpCodeItem.
Implements an interface for all items added to the CSharpVsaEngine,
including code items, reference items, and global items.
It defines generic properties and methods that apply to all item types
recognized by the engine.
The reference to script engine.
The name of item.
Disable default constructor
Construct a CSharpVsaItem given a script engine
Construct a CSharpVsaItem given a script engine and item name
Gets implementation-specific options for a script engine
The name of the option to retrieve
Returns the value of the specified option
Sets implementation-specific options for a script engine.
The name of the option to set.
A new value for the option.
Gets the specified object's type, as determined by the IVsaItems.CreateItem method.
Gets or sets the item name.
Returns a value indicating whether the current
in-memory representation of the item differs from the persisted representation.
Summary description for CSharpVsaError.
Default constructor
Describes global objects added to the script engine.
The value indicating whether the members of the global object
should be made available to the script engine.
The type of the global item.
Construct a CSharpVsaGlobalItem given a script engine and item name.
Gets the type of the global item.
Sets a value indicating whether the members of the
global object should be made available to the script engine.
Sets the type of the global item.
Gets the specified object's type,
as determined by the IVsaItems.CreateItem method.
Implements an interface for a collection of IVsaItem objects,
which can be addressed either by name or by index.
Keeps the name-to-index hashtable for searched item by name.
Keeps the vsa items.
Reference to script enginew
Construct a CSharpVsaItems given a script engine.
Removes an item from the collection.
Overloaded. Removes an item from the collection by item name.
Creates a new instance of one of the IVsaItem types,
as defined in the VsaItemType enumeration.
The name to associate with the new item
The type of item created, as defined in the VsaItemType enumeration
The optional flag to specify the initial content of a Code item.
Returns a reference to the IVsaItem object created
Gets the VsaItems enumerator.
Checks if contains item with specified name.
Item name.
tru if item exists or false if not
Gets an item from the collection by its index value.
Gets an item from the collection by its name.
Gets the number of items in the specified collection.
Describes a reference added to the script engine.
Construct a CSharpVsaReferenceItem given a script engine and item name
Gets or sets the name of the referenced assembly.
Gets the specified object's type, as determined by the IVsaItems.CreateItem method.
Languages supported by the scripting subsystem.
Visual Basic .NET script engine
JScript .NET script engine
C# .NET script engine
Encapsulates the source code, references, and global instances of a script.
A script consists of source code, assembly references, global instances, and
event sources. A script also has a name associated with it.
Default name of the script.
Default namespace for the script.
Delimiter for moniker value constructing.
Class keyword.
Class keyword definition for Visual Basic.NET.
Class keyword definition for JScript.NET.
Class keyword defintion for CSharp.
Place holder for class name.
Class header for CSharp.
Class footer for CSharp.
Class header for Visual Basic Net.
Class footer for Visual Basic Net.
Class header for Java Script Net.
Class footer for Java Script Net.
Namespace keyword.
Whitespace keyword.
Open brace keyword.
Close brace keyword.
List of assemblies attached automatically to engine on execution
Delimiters between class keyword and name of the class.
Default constructor
Construct a script with the given source code.
Source code to assign to the script
Serialization constructor for script objects.
Serialization state information
Streaming context information
Loads the contents of the specified file into the script.
Name of file containing the script source
Loads the given stream into the script.
Stream containing the script source
Saves the script source text into the specified file.
Name of file to save source into
Adds the specified assembly reference to the script.
The AssemblyDescriptor representing the assembly.
true if successfully added; false if the assembly reference already exists
in the script
Determines if the script contains the specified assembly reference.
The AssemblyDescriptor representing the assembly.
true if script contains a reference to the assembly; otherwise false
Adds an event source to the script.
Name of event source to add
Type of event source as a string
true if added successfully; false if it already exists
Indicates if the specified event source exists in the script.
Name of global instance to search for
Adds a global instance to the script.
Name of global instance to add
Type of global instance as a string
true if added successfully; false if it already exists
Indicates if the specified global instance exists in the script.
Name of global instance to search for
Load assembly references required by the script into the given
scripting engine.
Script engine to load
Load the event sources required by the script into the given
scripting engine code item.
Code module contained by a scripting engine
Load the global instances required by the script into the given
scripting engine.
Scripting engine to load.
Loads the event sources required by the script as global objects. Used by languages that do not support implicit event-binding.
Scripting engine to load.
Called when the script is changed.
Raises when source text has been changed.
Checks if variable with such name can be added as Event Source.
Name of variable.
TRUE - if can be added, FALSE - otherwise.
Changes rootmoniker according to Name or RootNamespace changing.
Sets name of the script according to class name in the source text.
Text source of the script.
If language is C#, also defines Root namespace.
Defines name of the class from soure text.
Source text of the script.
If language is C#, defines root namespace.
Source text.
TRUE - if namespace recognized and defined or nothing
namespace is clear, FALSE - if namespace is needed to add
to source text.
Indicates if rootmoniker property was changed by user.
Indicates parse source text of the script and set name of
the script according to class name or not.
Name of the script.
Name of the script must be the same as name of the class in the script source.
Names of assemblies referenced by the script.
Names of global instances declared by the script.
Names of event sources referenced by the script.
Source code for the script.
Root moniker for the script.
The moniker, or root moniker, is the unique name by which
a script engine is identified.
However, an engine may throw a RootMonikerInUse
exception if it detects that the moniker you are attempting to assign
it is already assigned to another script engine.
The root moniker cannot exceed 256 characters in length.
By default this property is constructed from RootNamespace and
Name property. If you use several scripts on the same host,
be sure that RootNamespace or Name properties are different.
Root namespace for declarations in the script.
Script language that the source code is written in.
The starting method that will be called when the script is run.
If this property is null, then no method is called when the script
is started. It is null by default.
The ScriptStartCall method is invoked right after the script is started.
The ScriptStopCall method is invoked just before the script is stopped.
Flag indicating if firing of events is enabled.
Gets or sets if parsing of source text and assigning of Name property
by class name is required or not.
Fired when the script is changed.
Describe the property type for showing in ScriptObjectBrowser
The common type property
Property is a collection
Property is a item of collection
Attribute alow to specify which element of class accessable for Script
engine edit control can be show in model tree.
storage of IsVisible property
storage of property property
storage of name property
storage of type property
Disabel default constructor for end-user
Main constructor for our own use
True - element of class is visible to ScriptEditControl, otherwise False
Using this constructor for mark "Item" class
Type property - must be equal PropertyType.Item
Name of property that using for showing name of Item.
Using this constructor for mark "Colleciton" property
Indicated whether class property is visible
Indicated way for show property.
Readonly
Gets the name of property that using for showing name of Item.
Readonly
Static Constructor
Signature for script event handlers.
Encapsulates arguments for VSA error events.
Signature for VSA error event handlers.
Encapsulates a script, script site, and script engine as a single component.
This class provides a convenient wrapper around a script, script site, and
script engine. It can be added to a form using the toolbox and configured
using the property editor.
The ScriptingManager creates the
and objects by calling the virtual
and
methods,
respectively. These methods can be overriden in derived ScriptingManager
classes in order to create custom Script and ScriptSite objects. After
creating the ScriptSite and Script, the ScriptingManager attaches these
objects to the
and properties,
respectively. Another way to attach a custom ScriptSite or Script to the
ScriptingManager is to pass them to one of the overloaded constructors.
The is
created by the
based on the value of the
property.
The
method is used to load the script source code. Once the script is
loaded, the
method can be called to compile the script.
method can be called to compile the script.
Default constructor
Construct a ScriptingManager given a script site.
Script site to attach
Construct a ScriptingManager given a script.
Script to attach
Construct a ScriptingManager given a script site and a script.
Script site to attach
Script to attach
Loads the contents of the specified file into the script.
Name of file containing the script source
Loads the given stream into the script.
Stream containing the script source
Compiles the script loaded in the ScriptEngine.
true if successful; otherwise false
The
method is called if an error occurs during compilation.
Runs the script that is compiled in the ScriptEngine.
The script must be loaded and compiled before this method is called.
An error occurs if the ScriptEngine is already running.
Removes the script engine from the running state and disconnects
automatically bound event handlers.
Closes the script engine and releases all resources. If the script engine
is currently running, the IVsaEngine.Reset method is called first.
Removes all event sources, global instances, and compiled code from the site.
Registers and event source with the site.
Name of the event source
Event source object
Registers a global instance with the site.
Name of the global instance
Global instance object
Invokes the specified method in the script.
Name of method to invoke
Return value of the method
This method throws an InvalidOperationException if the ScriptEngine
or Script is null. The ScriptEngine must be running to call this
method.
Initializes the ScriptingManager
This method calls the
and
methods and attaches the ScriptSite and Script to the ScriptingManager.
If the ScriptingManager already has a ScriptSite attached, then a new
one is not created. The same is true of the Script.
Creates a new instance of the ScriptEngine and loads the script into it.
true if successful; otherwise false
Creates the to attach to
the ScriptingManager.
object
Creates the to attach to
the ScriptingManager.
object
Called when an error occurs during compilation.
Event arguments
Called when the script changes.
Event arguments
For testing.
The ScriptEngine compiles and executes the script.
Each language uses a different ScriptEngine. The
creates the
appropriate ScriptEngine for a given language. New or alternate
ScriptEngines can be registered with the
.
Script to load into the.
.
The ScriptSite provides for host-implemented callbacks, describes interaction between
the engine and the host's object model, and allows the reporting of compilation errors.
Indicates if the script has been loaded and compiled in the script engine.
Indicates if the script engine is currently running the script.
Indicates if the script needs to be compiled.
Sets the root folder where non-system assemblies are located.
Fired when an error occurs during compilation.
Fired when the script changes
Encapsulates the name and type of an object in a script.
Default constructor.
Copy constructor
Construct a script object given a name and type.
Name of object
Type of object as a string
Serialization constructor for script objects.
Serialization state information
Streaming context information
Name of object.
Type of object as a string.
Type-safe collection for ScriptObject objects.
Provides the script engine with access to objects referenced by the
script.
A ScriptSite contains objects that are used as global variables and event
sources by the script. The objects must be registered by the hosting
application before the script is compiled and executed by the script
engine. Objects are registered using the
and
methods. The script engine accesses the objects using the
and
methods.
The ScriptSite also contains the compiled state of the script. The
compiled state is the compiled byte-code and debug information used by
the script engine during execution. The compiled state can be put into
the ScriptSite by calling the
method and
passing it the script engine after the script has been compiled. The
compiled state can be accessed by calling the
method.
Default constructor.
Removes all event sources, global instances, and compiled code from the site.
Registers and event source with the site.
Name of the event source
Event source object
Registers a global instance with the site.
Name of the global instance
Global instance object
Clears out the compiled state of the script.
Attaches the compiled state of the given script engine to the site.
Script engine that contains compiled state
Gets a reference to an event source previously added to a script engine using
the IVsaCodeItem.AddEventSource method.
Gets a reference to a global item, such as the host-provided application object.
Notifies the host about events generated by the .NET script engine.
Notifies the host about how to respond to compiler errors encountered
by the script engine.
Gets the compiled state of a script engine, and, optionally,
associated debugging information.
Called when an error occurs during compilation.
Fired when an error occurs during compilation.
Default constructor.
Removes all event sources, global instances, and compiled code from the site.
Registers and event source with the site.
Name of the event source
Event source object
Registers a global instance with the site.
Name of the global instance
Global instance object
Gets a reference to an event source previously added to a script engine using
the IVsaCodeItem.AddEventSource method.
Gets a reference to a global item, such as the host-provided application object.
Class help to simply version switching
Current version of library controls
Culture for all controls
Public key for all controls
Version of current library with culture and public key
Designer library version with culture and public key