C# Class MsieJavaScriptEngine.JsRt.Ie.IeJsValue

“IE” JavaScript value

The JavaScript value is one of the following types of values: Undefined, Null, Boolean, String, Number, or Object.

Mostra file Open project: Taritsyn/MsieJavaScriptEngine Class Usage Examples

Public Methods

Method	Description
AddRef ( ) : uint	Adds a reference to the object This only needs to be called on objects that are not going to be stored somewhere on the stack. Calling AddRef ensures that the JavaScript object the value refers to will not be freed until Release is called
CallFunction ( ) : IeJsValue	Invokes a function Requires an active script context.
ConstructObject ( ) : IeJsValue	Invokes a function as a constructor Requires an active script context.
ConvertToBoolean ( ) : IeJsValue	Converts a value to `Boolean` using regular JavaScript semantics Requires an active script context.
ConvertToNumber ( ) : IeJsValue	Converts a value to `Number` using regular JavaScript semantics Requires an active script context.
ConvertToObject ( ) : IeJsValue	Converts a value to `Object` using regular JavaScript semantics Requires an active script context.
ConvertToString ( ) : IeJsValue	Converts a value to `String` using regular JavaScript semantics Requires an active script context.
CreateArray ( uint length ) : IeJsValue	Creates a JavaScript array object Requires an active script context
CreateError ( IeJsValue message ) : IeJsValue	Creates a new JavaScript error object Requires an active script context.
CreateExternalObject ( IntPtr data, JsObjectFinalizeCallback finalizer ) : IeJsValue	Creates a new `Object` that stores some external data Requires an active script context.
CreateFunction ( IeJsNativeFunction function ) : IeJsValue	Creates a new JavaScript function Requires an active script context.
CreateFunction ( IeJsNativeFunction function, IntPtr callbackData ) : IeJsValue	Creates a new JavaScript function Requires an active script context.
CreateObject ( ) : IeJsValue	Creates a new `Object` Requires an active script context.
CreateRangeError ( IeJsValue message ) : IeJsValue	Creates a new JavaScript RangeError error object Requires an active script context.
CreateReferenceError ( IeJsValue message ) : IeJsValue	Creates a new JavaScript ReferenceError error object Requires an active script context.
CreateSyntaxError ( IeJsValue message ) : IeJsValue	Creates a new JavaScript SyntaxError error object Requires an active script context.
CreateTypeError ( IeJsValue message ) : IeJsValue	Creates a new JavaScript TypeError error object Requires an active script context.
CreateUriError ( IeJsValue message ) : IeJsValue	Creates a new JavaScript URIError error object Requires an active script context.
DefineProperty ( IeJsPropertyId propertyId, IeJsValue propertyDescriptor ) : bool	Defines a new object's own property from a property descriptor Requires an active script context.
DeleteIndexedProperty ( IeJsValue index ) : void	Deletes a value at the specified index of an object Requires an active script context.
DeleteProperty ( IeJsPropertyId propertyId, bool useStrictRules ) : IeJsValue	Deletes a object's property Requires an active script context.
Equals ( IeJsValue other ) : bool	Compare two JavaScript values for equality This function is equivalent to the "==" operator in JavaScript. Requires an active script context.
FromBoolean ( bool value ) : IeJsValue	Creates a `Boolean` value from a `bool` value Requires an active script context.
FromDouble ( double value ) : IeJsValue	Creates a `Number` value from a `double` value Requires an active script context.
FromInt32 ( int value ) : IeJsValue	Creates a `Number` value from a `int` value Requires an active script context.
FromObject ( object value ) : IeJsValue	Creates a JavaScript value that is a projection of the passed in object Requires an active script context.
FromString ( string value ) : IeJsValue	Creates a `String` value from a string pointer Requires an active script context.
GetIndexedProperty ( IeJsValue index ) : IeJsValue	Retrieve a value at the specified index of an object Requires an active script context.
GetOwnPropertyDescriptor ( IeJsPropertyId propertyId ) : IeJsValue	Gets a property descriptor for an object's own property Requires an active script context.
GetOwnPropertyNames ( ) : IeJsValue	Gets a list of all properties on the object Requires an active script context.
GetProperty ( IeJsPropertyId id ) : IeJsValue	Gets a object's property Requires an active script context.
HasIndexedProperty ( IeJsValue index ) : bool	Test if an object has a value at the specified index Requires an active script context.
HasProperty ( IeJsPropertyId propertyId ) : bool	Determines whether an object has a property Requires an active script context.
PreventExtension ( ) : void	Sets a object to not be extensible Requires an active script context.
Release ( ) : uint	Releases a reference to the object Removes a reference that was created by AddRef.
SetIndexedProperty ( IeJsValue index, IeJsValue value ) : void	Set a value at the specified index of an object Requires an active script context.
SetProperty ( IeJsPropertyId id, IeJsValue value, bool useStrictRules ) : void	Sets a object's property Requires an active script context.
StrictEquals ( IeJsValue other ) : bool	Compare two JavaScript values for strict equality This function is equivalent to the "===" operator in JavaScript. Requires an active script context.
ToBoolean ( ) : bool	Retrieves a `bool` value of a `Boolean` value Requires an active script context.
ToDouble ( ) : double	Retrieves a `double` value of a `Number` value This function retrieves the value of a Number value. It will fail with `InvalidArgument` if the type of the value is not `Number`. Requires an active script context.
ToObject ( ) : object	Retrieves a object representation of an `Object` value Requires an active script context.
ToString ( ) : string	Retrieves a string pointer of a `String` value This function retrieves the string pointer of a `String` value. It will fail with `InvalidArgument` if the type of the value is not `String`. Requires an active script context.

Private Methods

Method	Description
IeJsValue ( IntPtr reference ) : System	Initializes a new instance of the IeJsValue struct

Method Details

AddRef() public method

Adds a reference to the object

This only needs to be called on objects that are not going to be stored somewhere on the stack. Calling AddRef ensures that the JavaScript object the value refers to will not be freed until Release is called

public AddRef ( ) : uint
return	uint

CallFunction() public method

Invokes a function

Requires an active script context.

public CallFunction ( ) : IeJsValue
return	IeJsValue

ConstructObject() public method

Invokes a function as a constructor

Requires an active script context.

public ConstructObject ( ) : IeJsValue
return	IeJsValue

ConvertToBoolean() public method

Converts a value to Boolean using regular JavaScript semantics

Requires an active script context.

public ConvertToBoolean ( ) : IeJsValue
return	IeJsValue

ConvertToNumber() public method

Converts a value to Number using regular JavaScript semantics

Requires an active script context.

public ConvertToNumber ( ) : IeJsValue
return	IeJsValue

ConvertToObject() public method

Converts a value to Object using regular JavaScript semantics

Requires an active script context.

public ConvertToObject ( ) : IeJsValue
return	IeJsValue

ConvertToString() public method

Converts a value to String using regular JavaScript semantics

Requires an active script context.

public ConvertToString ( ) : IeJsValue
return	IeJsValue

CreateArray() public static method

Creates a JavaScript array object

Requires an active script context

public static CreateArray ( uint length ) : IeJsValue
length	uint	The initial length of the array
return	IeJsValue

CreateError() public static method

Creates a new JavaScript error object

Requires an active script context.

public static CreateError ( IeJsValue message ) : IeJsValue
message	IeJsValue	Message for the error object
return	IeJsValue

CreateExternalObject() public static method

Creates a new Object that stores some external data

Requires an active script context.

public static CreateExternalObject ( IntPtr data, JsObjectFinalizeCallback finalizer ) : IeJsValue
data	System.IntPtr	External data that the object will represent. May be null.
finalizer	JsObjectFinalizeCallback	A callback for when the object is finalized. May be null.
return	IeJsValue

CreateFunction() public static method

Creates a new JavaScript function

Requires an active script context.

public static CreateFunction ( IeJsNativeFunction function ) : IeJsValue
function	IeJsNativeFunction	The method to call when the function is invoked
return	IeJsValue

CreateFunction() public static method

Creates a new JavaScript function

Requires an active script context.

public static CreateFunction ( IeJsNativeFunction function, IntPtr callbackData ) : IeJsValue
function	IeJsNativeFunction	The method to call when the function is invoked
callbackData	System.IntPtr	Data to be provided to all function callbacks
return	IeJsValue

CreateObject() public static method

Creates a new Object

Requires an active script context.

public static CreateObject ( ) : IeJsValue
return	IeJsValue

CreateRangeError() public static method

Creates a new JavaScript RangeError error object

Requires an active script context.

public static CreateRangeError ( IeJsValue message ) : IeJsValue
message	IeJsValue	Message for the error object
return	IeJsValue

CreateReferenceError() public static method

Creates a new JavaScript ReferenceError error object

Requires an active script context.

public static CreateReferenceError ( IeJsValue message ) : IeJsValue
message	IeJsValue	Message for the error object
return	IeJsValue

CreateSyntaxError() public static method

Creates a new JavaScript SyntaxError error object

Requires an active script context.

public static CreateSyntaxError ( IeJsValue message ) : IeJsValue
message	IeJsValue	Message for the error object
return	IeJsValue

CreateTypeError() public static method

Creates a new JavaScript TypeError error object

Requires an active script context.

public static CreateTypeError ( IeJsValue message ) : IeJsValue
message	IeJsValue	Message for the error object
return	IeJsValue

CreateUriError() public static method

Creates a new JavaScript URIError error object

Requires an active script context.

public static CreateUriError ( IeJsValue message ) : IeJsValue
message	IeJsValue	Message for the error object
return	IeJsValue

DefineProperty() public method

Defines a new object's own property from a property descriptor

Requires an active script context.

public DefineProperty ( IeJsPropertyId propertyId, IeJsValue propertyDescriptor ) : bool
propertyId	IeJsPropertyId	The ID of the property
propertyDescriptor	IeJsValue	The property descriptor
return	bool

DeleteIndexedProperty() public method

Deletes a value at the specified index of an object

Requires an active script context.

public DeleteIndexedProperty ( IeJsValue index ) : void
index	IeJsValue	The index to delete
return	void

DeleteProperty() public method

Deletes a object's property

Requires an active script context.

public DeleteProperty ( IeJsPropertyId propertyId, bool useStrictRules ) : IeJsValue
propertyId	IeJsPropertyId	The ID of the property
useStrictRules	bool	The property set should follow strict mode rules
return	IeJsValue

Equals() public method

Compare two JavaScript values for equality

This function is equivalent to the "==" operator in JavaScript.

Requires an active script context.

public Equals ( IeJsValue other ) : bool
other	IeJsValue	The object to compare
return	bool

FromBoolean() public static method

Creates a Boolean value from a bool value

Requires an active script context.

public static FromBoolean ( bool value ) : IeJsValue
value	bool	The value to be converted
return	IeJsValue

FromDouble() public static method

Creates a Number value from a double value

Requires an active script context.

public static FromDouble ( double value ) : IeJsValue
value	double	The value to be converted
return	IeJsValue

FromInt32() public static method

Creates a Number value from a int value

Requires an active script context.

public static FromInt32 ( int value ) : IeJsValue
value	int	The value to be converted
return	IeJsValue

FromObject() public static method

Creates a JavaScript value that is a projection of the passed in object

Requires an active script context.

public static FromObject ( object value ) : IeJsValue
value	object	The object to be projected
return	IeJsValue

FromString() public static method

Creates a String value from a string pointer

Requires an active script context.

public static FromString ( string value ) : IeJsValue
value	string	The string to convert to a String value
return	IeJsValue

GetIndexedProperty() public method

Retrieve a value at the specified index of an object

Requires an active script context.

public GetIndexedProperty ( IeJsValue index ) : IeJsValue
index	IeJsValue	The index to retrieve
return	IeJsValue

GetOwnPropertyDescriptor() public method

Gets a property descriptor for an object's own property

Requires an active script context.

public GetOwnPropertyDescriptor ( IeJsPropertyId propertyId ) : IeJsValue
propertyId	IeJsPropertyId	The ID of the property
return	IeJsValue

GetOwnPropertyNames() public method

Gets a list of all properties on the object

Requires an active script context.

public GetOwnPropertyNames ( ) : IeJsValue
return	IeJsValue

GetProperty() public method

Gets a object's property

Requires an active script context.

public GetProperty ( IeJsPropertyId id ) : IeJsValue
id	IeJsPropertyId	The ID of the property
return	IeJsValue

HasIndexedProperty() public method

Test if an object has a value at the specified index

Requires an active script context.

public HasIndexedProperty ( IeJsValue index ) : bool
index	IeJsValue	The index to test
return	bool

HasProperty() public method

Determines whether an object has a property

Requires an active script context.

public HasProperty ( IeJsPropertyId propertyId ) : bool
propertyId	IeJsPropertyId	The ID of the property
return	bool

PreventExtension() public method

Sets a object to not be extensible

Requires an active script context.

public PreventExtension ( ) : void
return	void

Release() public method

Releases a reference to the object

Removes a reference that was created by AddRef.

public Release ( ) : uint
return	uint

SetIndexedProperty() public method

Set a value at the specified index of an object

Requires an active script context.

public SetIndexedProperty ( IeJsValue index, IeJsValue value ) : void
index	IeJsValue	The index to set
value	IeJsValue	The value to set
return	void

SetProperty() public method

Sets a object's property

Requires an active script context.

public SetProperty ( IeJsPropertyId id, IeJsValue value, bool useStrictRules ) : void
id	IeJsPropertyId	The ID of the property
value	IeJsValue	The new value of the property
useStrictRules	bool	The property set should follow strict mode rules
return	void

StrictEquals() public method

Compare two JavaScript values for strict equality

This function is equivalent to the "===" operator in JavaScript.

Requires an active script context.

public StrictEquals ( IeJsValue other ) : bool
other	IeJsValue	The object to compare
return	bool

ToBoolean() public method

Retrieves a bool value of a Boolean value

Requires an active script context.

public ToBoolean ( ) : bool
return	bool

ToDouble() public method

Retrieves a double value of a Number value

This function retrieves the value of a Number value. It will fail with InvalidArgument if the type of the value is not Number.

Requires an active script context.

public ToDouble ( ) : double
return	double

ToObject() public method

Retrieves a object representation of an Object value

Requires an active script context.

public ToObject ( ) : object
return	object

ToString() public method

Retrieves a string pointer of a String value

This function retrieves the string pointer of a String value. It will fail with InvalidArgument if the type of the value is not String.

Requires an active script context.

public ToString ( ) : string
return	string