Represents a document which can be stored and retrieved from the space.
A document is a collection of properties (which are name-value pairs) associated with a type.
A property name is a string. A property value can be of any type, but it is usually either a scalar
(e.g. int, String, Date, etc.), a set of properties IDictionary<(Of <(<'TKey, TValue>)>)>,
or an array/collection or scalars or maps.
Documents of the same type can have different properties, which provides more dynamic schema than concrete types.
SpaceTypeDescriptorBuilderISpaceTypeDescriptor
Declaration Syntax
C# | Visual Basic | Visual C++ | J# |
[SerializableAttribute] public class SpaceDocument
<SerializableAttribute> _ Public Class SpaceDocument
[SerializableAttribute] public ref class SpaceDocument
/** @attribute SerializableAttribute */ public class SpaceDocument
Members
All Members | Constructors | Methods | Properties | ||
Icon | Member | Description |
---|---|---|
SpaceDocument(String) |
Creates a space document of the specified type.
| |
SpaceDocument(String, IDictionary<(Of <<'(String, Object>)>>)) |
Creates a space document of the specified type with the specified properties.
Using this constructor with given properties introduce the overhead of copying the given properties
to the inner document properties | |
ContainsProperty(String) |
Returns true if this document contains the specified property.
| |
Equals(Object) |
Determines whether the specified Object is equal to the current Object.
(Overrides Object.Equals(Object).) | |
Finalize()()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
GetHashCode()()()() |
Serves as a hash function for a particular type.
(Overrides Object.GetHashCode()()()().) | |
GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) | |
Item[([( String])]) |
Gets or sets the value of the specified property.
| |
MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
Properties |
Gets all the properties and their values of the dictionary. The result is a readonly dictionary.
| |
RemoveProperty(String) |
Removes the property from the document (if it exists).
| |
ToString()()()() |
Returns a String that represents the current Object.
(Overrides Object.ToString()()()().) | |
Transient |
Gets or sets the document's transient state.
| |
TypeName |
Gets the type name.
| |
Version |
Gets or sets the document's version.
|
Inheritance Hierarchy
Object | |
SpaceDocument |