Class CSharpVsaItem

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.

Inheritance

System.Object

CSharpVsaItem

CSharpVsaCodeItem

CSharpVsaGlobalItem

CSharpVsaReferenceItem

Implements

Microsoft.Vsa.IVsaItem

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 abstract class CSharpVsaItem : IVsaItem

Constructors

CSharpVsaItem(CSharpScriptEngine)

Construct a CSharpVsaItem given a script engine

Declaration

protected CSharpVsaItem(CSharpScriptEngine engine)

Parameters

Type	Name	Description
CSharpScriptEngine	engine

CSharpVsaItem(CSharpScriptEngine, String)

Construct a CSharpVsaItem given a script engine and item name

Declaration

protected CSharpVsaItem(CSharpScriptEngine engine, string name)

Parameters

Type	Name	Description
CSharpScriptEngine	engine
System.String	name

Fields

m_engine

The reference to script engine.

Declaration

protected CSharpScriptEngine m_engine

Field Value

Type
CSharpScriptEngine

m_name

The name of item.

Declaration

protected string m_name

Field Value

Type
System.String

Properties

IsDirty

Returns a value indicating whether the current in-memory representation of the item differs from the persisted representation.

Declaration

public bool IsDirty { get; }

Property Value

Type
System.Boolean

ItemType

Gets the specified object's type, as determined by the IVsaItems.CreateItem method.

Declaration

public abstract VsaItemType ItemType { get; }

Property Value

Type
Microsoft.Vsa.VsaItemType

Name

Gets or sets the item name.

Declaration

public string Name { get; set; }

Property Value

Type
System.String

Methods

GetOption(String)

Gets implementation-specific options for a script engine

Declaration

public virtual object GetOption(string name)

Parameters

Type	Name	Description
System.String	name	The name of the option to retrieve

Returns

Type	Description
System.Object	Returns the value of the specified option

SetOption(String, Object)

Sets implementation-specific options for a script engine.

Declaration

public virtual void SetOption(string name, object value)

Parameters

Type	Name	Description
System.String	name	The name of the option to set.
System.Object	value	A new value for the option.

Implements

Microsoft.Vsa.IVsaItem