CefV8Value MethodsXilium.CefGlue

[This is preliminary documentation and is subject to change.]

The CefV8Value type exposes the following members.
Methods

  NameDescription
Public methodAdjustExternallyAllocatedMemory
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.
Public methodClearException
Clears the last exception and returns true on success.
Public methodStatic memberCreateArray
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.
Public methodStatic memberCreateBool
Create a new CefV8Value object of type bool.
Public methodStatic memberCreateDate
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.
Public methodStatic memberCreateDouble
Create a new CefV8Value object of type double.
Public methodStatic memberCreateFunction
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.
Public methodStatic memberCreateInt
Create a new CefV8Value object of type int.
Public methodStatic memberCreateNull
Create a new CefV8Value object of type null.
Public methodStatic memberCreateObject
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.
Public methodStatic memberCreateString
Create a new CefV8Value object of type string.
Public methodStatic memberCreateUInt
Create a new CefV8Value object of type unsigned int.
Public methodStatic memberCreateUndefined
Create a new CefV8Value object of type undefined.
Public methodDeleteValue(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.
Public methodDeleteValue(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.
Public methodDispose
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Public methodExecuteFunction
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.
Public methodExecuteFunctionWithContext
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.
Protected methodFinalize (Overrides OnlineObject Finalize .)
Public methodGetArrayLength
ARRAY METHODS - These methods are only available on arrays. Returns the number of elements in the array.
Public methodGetBoolValue
Return a bool value. The underlying data will be converted to if necessary.
Public methodGetDateValue
Return a Date value. The underlying data will be converted to if necessary.
Public methodGetDoubleValue
Return a double value. The underlying data will be converted to if necessary.
Public methodGetException
Returns the exception resulting from the last method call. This attribute exists only in the scope of the current CEF value object.
Public methodGetExternallyAllocatedMemory
Returns the amount of externally allocated memory registered for the object.
Public methodGetFunctionHandler
Returns the function handler or NULL if not a CEF-created function.
Public methodGetFunctionName
FUNCTION METHODS - These methods are only available on functions. Returns the function name.
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodGetIntValue
Return an int value. The underlying data will be converted to if necessary.
Public methodGetKeys
Read the keys for the object's values into the specified vector. Integer- based keys will also be returned as strings.
Public methodGetStringValue
Return a string value. The underlying data will be converted to if necessary.
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodGetUIntValue
Return an unisgned int value. The underlying data will be converted to if necessary.
Public methodGetUserData
Returns the user data, if any, assigned to this object.
Public methodGetValue(Int32)
Returns the value with the specified identifier on success. Returns NULL if this method is called incorrectly or an exception is thrown.
Public methodGetValue(String)
Returns the value with the specified identifier on success. Returns NULL if this method is called incorrectly or an exception is thrown.
Public methodHasValue(Int32)
Returns true if the object has a value with the specified identifier.
Public methodHasValue(String)
Returns true if the object has a value with the specified identifier.
Public methodIsSame
Returns true if this object is pointing to the same handle as |that| object.
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodSetRethrowExceptions
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.
Public methodSetUserData
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.
Public methodSetValue(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.
Public methodSetValue(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.
Public methodSetValue(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.
Public methodOnlineToString
Returns a OnlineString that represents the current OnlineObject.
(Inherited from OnlineObject.)
Public methodTryGetKeys
Read the keys for the object's values into the specified vector. Integer- based keys will also be returned as strings.
Public methodWillRethrowExceptions
Returns true if this object will re-throw future exceptions. This attribute exists only in the scope of the current CEF value object.
Back to Top
See Also