Click or drag to resize
CfxValue Class

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

Structure that wraps other data value types. Complex types (binary, dictionary and list) will be referenced but not owned by this object. Can be used on any process and thread.
Inheritance Hierarchy
SystemObject
  ChromiumCfxObject
    ChromiumCfxBase
      ChromiumCfxLibraryBase
        ChromiumCfxValue

Namespace: Chromium
Assembly: ChromiumFX (in ChromiumFX.dll)
Syntax
public class CfxValue : CfxLibraryBase

The CfxValue type exposes the following members.

Properties
  NameDescription
Public propertyBinary
Returns the underlying value as type binary. The returned reference may become invalid if the value is owned by another object or if ownership is transferred to another object in the future. To maintain a reference to the value after assigning ownership to a dictionary or list pass this object to the set_value() function instead of passing the returned reference to set_binary().
Public propertyBool
Returns the underlying value as type bool.
Public propertyDictionary
Returns the underlying value as type dictionary. The returned reference may become invalid if the value is owned by another object or if ownership is transferred to another object in the future. To maintain a reference to the value after assigning ownership to a dictionary or list pass this object to the set_value() function instead of passing the returned reference to set_dictionary().
Public propertyDouble
Returns the underlying value as type double.
Public propertyInt
Returns the underlying value as type int.
Public propertyIsOwned
Returns true (1) if the underlying data is owned by another object.
Public propertyIsReadOnly
Returns true (1) if the underlying data is read-only. Some APIs may expose read-only objects.
Public propertyIsValid
Returns true (1) if the underlying data is valid. This will always be true (1) for simple types. For complex types (binary, dictionary and list) the underlying data may become invalid if owned by another object (e.g. list or dictionary) and that other object is then modified or destroyed. This value object can be re-used by calling Set*() even if the underlying data is invalid.
Public propertyList
Returns the underlying value as type list. The returned reference may become invalid if the value is owned by another object or if ownership is transferred to another object in the future. To maintain a reference to the value after assigning ownership to a dictionary or list pass this object to the set_value() function instead of passing the returned reference to set_list().
Public propertyNativePtr
Provides access to the underlying native cef struct. This is a refcounted library struct derived from cef_base_t. Add a ref in order to keep it alive when this managed object go out of scope.
(Inherited from CfxLibraryBase.)
Public propertyString
Returns the underlying value as type string.
Public propertyType
Returns the underlying value type.
Top
Methods
  NameDescription
Public methodCopy
Returns a copy of this object. The underlying data will also be copied.
Public methodStatic memberCreate
Creates a new object.
Public methodIsEqual
Returns true (1) if this object and |that| object have an equivalent underlying value but are not necessarily the same object.
Public methodIsSame
Returns true (1) if this object and |that| object have the same underlying data. If true (1) modifications to this object will also affect |that| object and vice-versa.
Public methodSetBinary
Sets the underlying value as type binary. Returns true (1) if the value was set successfully. This object keeps a reference to |value| and ownership of the underlying data remains unchanged.
Public methodSetBool
Sets the underlying value as type bool. Returns true (1) if the value was set successfully.
Public methodSetDictionary
Sets the underlying value as type dict. Returns true (1) if the value was set successfully. This object keeps a reference to |value| and ownership of the underlying data remains unchanged.
Public methodSetDouble
Sets the underlying value as type double. Returns true (1) if the value was set successfully.
Public methodSetInt
Sets the underlying value as type int. Returns true (1) if the value was set successfully.
Public methodSetList
Sets the underlying value as type list. Returns true (1) if the value was set successfully. This object keeps a reference to |value| and ownership of the underlying data remains unchanged.
Public methodSetNull
Sets the underlying value as type null. Returns true (1) if the value was set successfully.
Public methodSetString
Sets the underlying value as type string. Returns true (1) if the value was set successfully.
Top
Remarks
See also the original CEF documentation in cef/include/capi/cef_values_capi.h.
See Also