[This is preliminary documentation and is subject to change.]
The CefV8Value type exposes the following members.Methods
Name | Description | |
---|---|---|
AdjustExternallyAllocatedMemory |
Adjusts the amount of registered external memory for the object. Used to
give V8 an indication of the amount of externally allocated memory that is
kept alive by JavaScript objects. V8 uses this information to decide when
to perform global garbage collection. Each CefV8Value tracks the amount of
external memory associated with it and automatically decreases the global
total by the appropriate amount on its destruction. |change_in_bytes|
specifies the number of bytes to adjust by. This method returns the number
of bytes associated with the object after the adjustment. This method can
only be called on user created objects.
| |
ClearException |
Clears the last exception and returns true on success.
| |
CreateArray |
Create a new CefV8Value object of type array with the specified |length|.
If |length| is negative the returned array will have length 0. This method
should only be called from within the scope of a CefV8ContextHandler,
CefV8Handler or CefV8Accessor callback, or in combination with calling
Enter() and Exit() on a stored CefV8Context reference.
| |
CreateBool |
Create a new CefV8Value object of type bool.
| |
CreateDate |
Create a new CefV8Value object of type Date. This method should only be
called from within the scope of a CefV8ContextHandler, CefV8Handler or
CefV8Accessor callback, or in combination with calling Enter() and Exit()
on a stored CefV8Context reference.
| |
CreateDouble |
Create a new CefV8Value object of type double.
| |
CreateFunction |
Create a new CefV8Value object of type function. This method should only be
called from within the scope of a CefV8ContextHandler, CefV8Handler or
CefV8Accessor callback, or in combination with calling Enter() and Exit()
on a stored CefV8Context reference.
| |
CreateInt |
Create a new CefV8Value object of type int.
| |
CreateNull |
Create a new CefV8Value object of type null.
| |
CreateObject |
Create a new CefV8Value object of type object with optional accessor. This
method should only be called from within the scope of a
CefV8ContextHandler, CefV8Handler or CefV8Accessor callback, or in
combination with calling Enter() and Exit() on a stored CefV8Context
reference.
| |
CreateString |
Create a new CefV8Value object of type string.
| |
CreateUInt |
Create a new CefV8Value object of type unsigned int.
| |
CreateUndefined |
Create a new CefV8Value object of type undefined.
| |
DeleteValue(Int32) |
Deletes the value with the specified identifier and returns true on
success. Returns false if this method is called incorrectly, deletion fails
or an exception is thrown. For read-only and don't-delete values this
method will return true even though deletion failed.
| |
DeleteValue(String) |
Deletes the value with the specified identifier and returns true on
success. Returns false if this method is called incorrectly or an exception
is thrown. For read-only and don't-delete values this method will return
true even though deletion failed.
| |
Dispose | Releases all resources used by the CefV8Value | |
Equals | (Inherited from Object.) | |
ExecuteFunction |
Execute the function using the current V8 context. This method should only
be called from within the scope of a CefV8Handler or CefV8Accessor
callback, or in combination with calling Enter() and Exit() on a stored
CefV8Context reference. |object| is the receiver ('this' object) of the
function. If |object| is empty the current context's global object will be
used. |arguments| is the list of arguments that will be passed to the
function. Returns the function return value on success. Returns NULL if
this method is called incorrectly or an exception is thrown.
| |
ExecuteFunctionWithContext |
Execute the function using the specified V8 context. |object| is the
receiver ('this' object) of the function. If |object| is empty the
specified context's global object will be used. |arguments| is the list of
arguments that will be passed to the function. Returns the function return
value on success. Returns NULL if this method is called incorrectly or an
exception is thrown.
| |
Finalize | (Overrides Object Finalize .) | |
GetArrayLength |
ARRAY METHODS - These methods are only available on arrays.
Returns the number of elements in the array.
| |
GetBoolValue |
Return a bool value. The underlying data will be converted to if
necessary.
| |
GetDateValue |
Return a Date value. The underlying data will be converted to if
necessary.
| |
GetDoubleValue |
Return a double value. The underlying data will be converted to if
necessary.
| |
GetException |
Returns the exception resulting from the last method call. This attribute
exists only in the scope of the current CEF value object.
| |
GetExternallyAllocatedMemory |
Returns the amount of externally allocated memory registered for the
object.
| |
GetFunctionHandler |
Returns the function handler or NULL if not a CEF-created function.
| |
GetFunctionName |
FUNCTION METHODS - These methods are only available on functions.
Returns the function name.
| |
GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
GetIntValue |
Return an int value. The underlying data will be converted to if
necessary.
| |
GetKeys |
Read the keys for the object's values into the specified vector. Integer-
based keys will also be returned as strings.
| |
GetStringValue |
Return a string value. The underlying data will be converted to if
necessary.
| |
GetType |
Gets the Type of the current instance.
(Inherited from Object.) | |
GetUIntValue |
Return an unisgned int value. The underlying data will be converted to if
necessary.
| |
GetUserData |
Returns the user data, if any, assigned to this object.
| |
GetValue(Int32) |
Returns the value with the specified identifier on success. Returns NULL
if this method is called incorrectly or an exception is thrown.
| |
GetValue(String) |
Returns the value with the specified identifier on success. Returns NULL
if this method is called incorrectly or an exception is thrown.
| |
HasValue(Int32) |
Returns true if the object has a value with the specified identifier.
| |
HasValue(String) |
Returns true if the object has a value with the specified identifier.
| |
IsSame |
Returns true if this object is pointing to the same handle as |that|
object.
| |
MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
SetRethrowExceptions |
Set whether this object will re-throw future exceptions. By default
exceptions are not re-thrown. If a exception is re-thrown the current
context should not be accessed again until after the exception has been
caught and not re-thrown. Returns true on success. This attribute exists
only in the scope of the current CEF value object.
| |
SetUserData |
Sets the user data for this object and returns true on success. Returns
false if this method is called incorrectly. This method can only be called
on user created objects.
| |
SetValue(Int32, CefV8Value) |
Associates a value with the specified identifier and returns true on
success. Returns false if this method is called incorrectly or an exception
is thrown. For read-only values this method will return true even though
assignment failed.
| |
SetValue(String, CefV8AccessControl, CefV8PropertyAttribute) |
Registers an identifier and returns true on success. Access to the
identifier will be forwarded to the CefV8Accessor instance passed to
CefV8Value::CreateObject(). Returns false if this method is called
incorrectly or an exception is thrown. For read-only values this method
will return true even though assignment failed.
| |
SetValue(String, CefV8Value, CefV8PropertyAttribute) |
Associates a value with the specified identifier and returns true on
success. Returns false if this method is called incorrectly or an exception
is thrown. For read-only values this method will return true even though
assignment failed.
| |
ToString | (Inherited from Object.) | |
TryGetKeys |
Read the keys for the object's values into the specified vector. Integer-
based keys will also be returned as strings.
| |
WillRethrowExceptions |
Returns true if this object will re-throw future exceptions. This attribute
exists only in the scope of the current CEF value object.
|
Properties
Name | Description | |
---|---|---|
HasException |
Returns true if the last method call resulted in an exception. This
attribute exists only in the scope of the current CEF value object.
| |
IsArray |
True if the value type is array.
| |
IsBool |
True if the value type is bool.
| |
IsDate |
True if the value type is Date.
| |
IsDouble |
True if the value type is double.
| |
IsFunction |
True if the value type is function.
| |
IsInt |
True if the value type is int.
| |
IsNull |
True if the value type is null.
| |
IsObject |
True if the value type is object.
| |
IsString |
True if the value type is string.
| |
IsUInt |
True if the value type is unsigned int.
| |
IsUndefined |
True if the value type is undefined.
| |
IsUserCreated |
OBJECT METHODS - These methods are only available on objects. Arrays and
functions are also objects. String- and integer-based keys can be used
interchangably with the framework converting between them as necessary.
Returns true if this is a user created object.
| |
IsValid |
Returns true if the underlying handle is valid and it can be accessed on
the current thread. Do not call any other methods if this method returns
false.
|
See Also