Click or drag to resize
CfxDictionaryValue Class

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

Structure representing a dictionary value. Can be used on any process and thread.
Inheritance Hierarchy
SystemObject
  ChromiumCfxObject
    ChromiumCfxBase
      ChromiumCfxLibraryBase
        ChromiumCfxDictionaryValue

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

The CfxDictionaryValue type exposes the following members.

Properties
  NameDescription
Public propertyIsOwned
Returns true (1) if this object is currently owned by another object.
Public propertyIsReadOnly
Returns true (1) if the values of this object are read-only. Some APIs may expose read-only objects.
Public propertyIsValid
Returns true (1) if this object is valid. This object may become invalid if the underlying data is owned by another object (e.g. list or dictionary) and that other object is then modified or destroyed. Do not call any other functions if this function returns false (0).
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 propertySize
Returns the number of values.
Top
Methods
  NameDescription
Public methodClear
Removes all values. Returns true (1) on success.
Public methodCopy
Returns a writable copy of this object. If |excludeNullChildren| is true (1) any NULL dictionaries or lists will be excluded from the copy.
Public methodStatic memberCreate
Creates a new object that is not owned by any other object.
Public methodGetBinary
Returns the value at the specified key as type binary. The returned value will reference existing data.
Public methodGetBool
Returns the value at the specified key as type bool.
Public methodGetDictionary
Returns the value at the specified key as type dictionary. The returned value will reference existing data and modifications to the value will modify this object.
Public methodGetDouble
Returns the value at the specified key as type double.
Public methodGetInt
Returns the value at the specified key as type int.
Public methodGetKeys
Reads all keys for this dictionary into the specified vector.
Public methodGetList
Returns the value at the specified key as type list. The returned value will reference existing data and modifications to the value will modify this object.
Public methodGetString
Returns the value at the specified key as type string.
Public methodGetType
Returns the value type for the specified key.
Public methodGetValue
Returns the value at the specified key. For simple types the returned value will copy existing data and modifications to the value will not modify this object. For complex types (binary, dictionary and list) the returned value will reference existing data and modifications to the value will modify this object.
Public methodHasKey
Returns true (1) if the current dictionary has a value for the given key.
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 methodRemove
Removes the value at the specified key. Returns true (1) is the value was removed successfully.
Public methodSetBinary
Sets the value at the specified key as type binary. Returns true (1) if the value was set successfully. If |value| is currently owned by another object then the value will be copied and the |value| reference will not change. Otherwise, ownership will be transferred to this object and the |value| reference will be invalidated.
Public methodSetBool
Sets the value at the specified key as type bool. Returns true (1) if the value was set successfully.
Public methodSetDictionary
Sets the value at the specified key as type dict. Returns true (1) if the value was set successfully. If |value| is currently owned by another object then the value will be copied and the |value| reference will not change. Otherwise, ownership will be transferred to this object and the |value| reference will be invalidated.
Public methodSetDouble
Sets the value at the specified key as type double. Returns true (1) if the value was set successfully.
Public methodSetInt
Sets the value at the specified key as type int. Returns true (1) if the value was set successfully.
Public methodSetList
Sets the value at the specified key as type list. Returns true (1) if the value was set successfully. If |value| is currently owned by another object then the value will be copied and the |value| reference will not change. Otherwise, ownership will be transferred to this object and the |value| reference will be invalidated.
Public methodSetNull
Sets the value at the specified key as type null. Returns true (1) if the value was set successfully.
Public methodSetString
Sets the value at the specified key as type string. Returns true (1) if the value was set successfully.
Public methodSetValue
Sets the value at the specified key. Returns true (1) if the value was set successfully. If |value| represents simple data then the underlying data will be copied and modifications to |value| will not modify this object. If |value| represents complex data (binary, dictionary or list) then the underlying data will be referenced and modifications to |value| will modify this object.
Top
Remarks
See also the original CEF documentation in cef/include/capi/cef_values_capi.h.
See Also