Click or drag to resize

Document Class

A class representing a document which cannot be altered
Inheritance Hierarchy

Namespace:  Couchbase.Lite
Assembly:  Couchbase.Lite (in Couchbase.Lite.dll) Version: 2.1.0-b0232
Syntax
C#
public class Document : IDictionaryObject, IDictionaryFragment, 
	IEnumerable<KeyValuePair<string, Object>>, IEnumerable, 
	IDisposable

The Document type exposes the following members.

Properties
  NameDescription
Public propertyCount
Gets the number of entries in this dictionary
Public propertyId
Gets this document's unique ID
Public propertyItem
Gets the value of the given key, or lack thereof, wrapped inside of a IFragment
Public propertyKeys
Gets all the keys held by this dictionary
Public propertySequence
Gets the sequence of this document (a unique incrementing number identifying its status in a database)
Top
Methods
  NameDescription
Public methodContains
Checks if a given key is present in the dictionary
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Overrides ObjectEquals(Object).)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetArray
Gets the value of a given key as an IArray
Public methodGetBlob
Gets the value of a given key as a Blob
Public methodGetBoolean
Gets the value of a given key as a Boolean
Public methodGetDate
Gets the value of a given key as a DateTimeOffset
Public methodGetDictionary
Gets the value of a given key as a readonly dictionary
Public methodGetDouble
Gets the value of a given key as a Double
Public methodGetEnumerator
Returns an enumerator that iterates through the collection.
Public methodGetFloat
Gets the value of a given key as a Single
Public methodGetHashCode
Serves as the default hash function.
(Overrides ObjectGetHashCode.)
Public methodGetInt
Gets the value of a given key as an Int32
Public methodGetLong
Gets the value of a given key as an Int64
Public methodGetString
Gets the value of a given key as a String
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
Gets the value of a given key as an untyped object
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToDictionary
Public methodToMutable
Creates a mutable version of a document (i.e. one that can be edited)
Public methodToString
Returns a string that represents the current object.
(Overrides ObjectToString.)
Top
Fields
  NameDescription
Protected field_dict
The backing dictionary for this document
Top
See Also