Difference between revisions of "DOMObject"
From Virtual World Web Wiki
(Documentation for the DOMObject class) |
(Documentation for the DOMObject class) |
||
Line 1: | Line 1: | ||
The base class for all DOM node types | The base class for all DOM node types | ||
===Properties=== | ===Properties=== | ||
− | :{{CSharp| | + | :{{CSharp|bool Accessable}} |
− | :: | + | :{{CSharp|DOMAttributeCache AttributeCache}} |
− | :{{CSharp|string | + | :{{CSharp|DOMAttributeSet Attributes}} |
− | :: | + | :{{CSharp|Nullable<Guid> BaseTypeID}} |
+ | :{{CSharp|DOMObjectCollection Children}} | ||
+ | :{{CSharp|string Class}} | ||
+ | :{{CSharp|ReferenceContract Contract}} | ||
+ | :{{CSharp|DOMDocument Document}} | ||
+ | :{{CSharp|bool Enabled}} | ||
:{{CSharp|long ID}} | :{{CSharp|long ID}} | ||
::The unique ID of this object in the view. DOM node IDs can change if a node is moved between view documents or removed from a document in which case this property will return zero. DOM node IDs are allocated by the RootDocument in a view | ::The unique ID of this object in the view. DOM node IDs can change if a node is moved between view documents or removed from a document in which case this property will return zero. DOM node IDs are allocated by the RootDocument in a view | ||
+ | :{{CSharp|Nullable<Guid> InstanceIndex}} | ||
+ | :{{CSharp|DOMObject InstanceRoot}} | ||
+ | :{{CSharp|Nullable<Guid> InstanceTypeID}} | ||
+ | :{{CSharp|bool IsInReference}} | ||
+ | :{{CSharp|bool IsInstanceRoot}} | ||
+ | :{{CSharp|bool IsTemplateRoot}} | ||
+ | :{{CSharp|bool IsTopLevelReference}} | ||
+ | :{{CSharp|bool IsTypeRoot}} | ||
:{{CSharp|Guid MergeID}} | :{{CSharp|Guid MergeID}} | ||
− | :{{CSharp| | + | :{{CSharp|bool MergeLocked}} |
− | :{{CSharp| | + | :{{CSharp|Guid NodeID}} |
− | :{{CSharp| | + | :{{CSharp|string NodePath}} |
− | :{{CSharp| | + | ::Gets a path which can be used to locate a specific node in the DOM using the FindNode method |
+ | :{{CSharp|IEnumerable<DOMAttribute> ObjectAttributes}} | ||
:{{CSharp|DOMObject Parent}} | :{{CSharp|DOMObject Parent}} | ||
− | :{{CSharp| | + | :{{CSharp|DOMPropertyCollection Properties}} |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
:{{CSharp|DOMProtectionFlags ProtectionFlags}} | :{{CSharp|DOMProtectionFlags ProtectionFlags}} | ||
− | :{{CSharp| | + | :{{CSharp|Guid RecordID}} |
− | : | + | ::The ID used to uniquely identify an object. RecordIDs are generated when a new DOMObject is created. |
− | :{{CSharp| | + | :{{CSharp|DOMDocument RootDocument}} |
:{{CSharp|DateTime ServerTime}} | :{{CSharp|DateTime ServerTime}} | ||
− | |||
− | |||
:{{CSharp|List<string> SystemPropertyNames}} | :{{CSharp|List<string> SystemPropertyNames}} | ||
− | :{{CSharp| | + | :{{CSharp|Object Tag}} |
− | :{{CSharp| | + | :{{CSharp|Guid TemplateID}} |
+ | :{{CSharp|DOMObject TemplateRoot}} | ||
+ | :{{CSharp|bool Temporary}} | ||
:{{CSharp|string Title}} | :{{CSharp|string Title}} | ||
− | :{{CSharp|bool | + | :{{CSharp|bool Transient}} |
− | :{{CSharp| | + | :{{CSharp|Guid TypeID}} |
− | :{{CSharp| | + | :{{CSharp|Nullable<Guid> TypeIndex}} |
+ | :{{CSharp|int TypeNodeID}} | ||
:{{CSharp|bool TypeReference}} | :{{CSharp|bool TypeReference}} | ||
:{{CSharp|Boolean[] TypeReferenceReload}} | :{{CSharp|Boolean[] TypeReferenceReload}} | ||
:{{CSharp|DOMObject TypeRoot}} | :{{CSharp|DOMObject TypeRoot}} | ||
− | + | :{{CSharp|bool Validated}} | |
− | :{{CSharp|bool | + | :{{CSharp|bool Viewable}} |
− | + | :{{CSharp|bool Visible}} | |
− | :{{CSharp|bool | + | |
− | :{{CSharp|bool | + | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
===Events=== | ===Events=== | ||
+ | :{{CSharp|ChildBeforeAdd(EventHandler<DOMUpdateChildAdd>)}} | ||
+ | :{{CSharp|ChildBeforeRemove(EventHandler<DOMUpdateChildRemove>)}} | ||
:{{CSharp|Updated(EventHandler<DOMUpdateEventArgs>)}} | :{{CSharp|Updated(EventHandler<DOMUpdateEventArgs>)}} | ||
− | |||
− | |||
===Methods=== | ===Methods=== | ||
− | :{{CSharp| | + | :{{CSharp|void add_ChildBeforeAdd(EventHandler<DOMUpdateChildAdd> value)}} |
− | + | :{{CSharp|void add_ChildBeforeRemove(EventHandler<DOMUpdateChildRemove> value)}} | |
− | :{{CSharp| | + | :{{CSharp|void add_Updated(EventHandler<DOMUpdateEventArgs> value)}} |
− | + | ||
− | :{{CSharp| | + | |
− | + | ||
:{{CSharp|void AddClass(string className)}} | :{{CSharp|void AddClass(string className)}} | ||
− | :{{CSharp|void | + | :{{CSharp|void BeginMergeUpdate()}} |
− | :{{CSharp|void | + | :{{CSharp|void BeginUpdate()}} |
− | :{{CSharp|bool | + | :{{CSharp|bool CheckChild(DOMObject child)}} |
+ | :{{CSharp|bool CheckParent(DOMObject parent)}} | ||
+ | :{{CSharp|void ClearChildren()}} | ||
+ | :{{CSharp|DOMObject Clone()}} | ||
+ | ::Gets a deep clone of the current object | ||
+ | :{{CSharp|bool Contains<T>(T value, DOMSearchLevel applyTo)}} | ||
+ | :{{CSharp|bool Contains(Func<DOMObject, bool> predicate, DOMSearchLevel applyTo)}} | ||
+ | :{{CSharp|bool Contains<T>(Func<T, bool> predicate, DOMSearchLevel applyTo)}} | ||
+ | :{{CSharp|bool ContainsTypeReference(Guid typeID)}} | ||
:{{CSharp|int Count<T>()}} | :{{CSharp|int Count<T>()}} | ||
:{{CSharp|int Count<T>(DOMSearchLevel applyTo)}} | :{{CSharp|int Count<T>(DOMSearchLevel applyTo)}} | ||
:{{CSharp|int Count<T>(Func<T, bool> predicate, DOMSearchLevel applyTo)}} | :{{CSharp|int Count<T>(Func<T, bool> predicate, DOMSearchLevel applyTo)}} | ||
:{{CSharp|int Count(Func<DOMObject, bool> predicate, DOMSearchLevel applyTo)}} | :{{CSharp|int Count(Func<DOMObject, bool> predicate, DOMSearchLevel applyTo)}} | ||
+ | :{{CSharp|DOMObject Detach()}} | ||
+ | ::Detaches the node from its parent and resets the childrens ID's | ||
+ | :{{CSharp|bool DiscoverTemplate(Guid templateID)}} | ||
+ | :{{CSharp|bool DiscoverType(Guid typeID)}} | ||
+ | :{{CSharp|void EndMergeUpdate()}} | ||
+ | :{{CSharp|void EndUpdate()}} | ||
+ | :{{CSharp|bool Equals(DOMObject other)}} | ||
+ | :{{CSharp|bool Equals(DOMObject x, DOMObject y)}} | ||
+ | :{{CSharp|DOMObject FindNode(string nodepath, Nullable<Guid> templateID)}} | ||
+ | ::Gets the node that matches the object type node path (Example: 40/23) | ||
:{{CSharp|DOMObject First(DOMSearchLevel applyTo)}} | :{{CSharp|DOMObject First(DOMSearchLevel applyTo)}} | ||
:{{CSharp|T First<T>(DOMSearchLevel applyTo)}} | :{{CSharp|T First<T>(DOMSearchLevel applyTo)}} | ||
Line 76: | Line 91: | ||
:{{CSharp|DOMObject FirstOrDefault(Func<DOMObject, bool> predicate, DOMSearchLevel applyTo)}} | :{{CSharp|DOMObject FirstOrDefault(Func<DOMObject, bool> predicate, DOMSearchLevel applyTo)}} | ||
:{{CSharp|T FirstOrDefault<T>(Func<T, bool> predicate, DOMSearchLevel applyTo)}} | :{{CSharp|T FirstOrDefault<T>(Func<T, bool> predicate, DOMSearchLevel applyTo)}} | ||
− | |||
− | |||
− | |||
:{{CSharp|void ForEach(Func<DOMObject, bool> predicate, Action<DOMObject> action, DOMSearchLevel applyTo)}} | :{{CSharp|void ForEach(Func<DOMObject, bool> predicate, Action<DOMObject> action, DOMSearchLevel applyTo)}} | ||
:{{CSharp|void ForEach<T>(Func<T, bool> predicate, Action<T> action, DOMSearchLevel applyTo)}} | :{{CSharp|void ForEach<T>(Func<T, bool> predicate, Action<T> action, DOMSearchLevel applyTo)}} | ||
− | :{{CSharp|IEnumerable< | + | :{{CSharp|IEnumerable<KeyValuePair<Guid, DOMObject>> GetAttributeKeys()}} |
− | + | :{{CSharp|TResult GetAttributeValue<TResult>(string attributeName, string propertyName)}} | |
− | :{{CSharp| | + | |
− | + | ||
− | + | ||
:{{CSharp|int GetHashCode(DOMObject obj)}} | :{{CSharp|int GetHashCode(DOMObject obj)}} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
:{{CSharp|T GetLocalProperty<T>(string key, Func<T> defaultSelector)}} | :{{CSharp|T GetLocalProperty<T>(string key, Func<T> defaultSelector)}} | ||
− | :{{CSharp| | + | :{{CSharp|Nullable<Guid> GetNodeIndex(DOMObject baseNode)}} |
− | + | :{{CSharp|Guid GetNodeIndex2(DOMObject baseNode, int depth)}} | |
− | + | ||
− | :{{CSharp| | + | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
:{{CSharp|IEnumerable<string> GetPropertiesWithAttribute(string attributeName)}} | :{{CSharp|IEnumerable<string> GetPropertiesWithAttribute(string attributeName)}} | ||
:{{CSharp|bool HasAttribute(string attributeName, string propertyName)}} | :{{CSharp|bool HasAttribute(string attributeName, string propertyName)}} | ||
− | :{{CSharp| | + | :{{CSharp|bool HasClass(string className)}} |
− | :{{CSharp|void | + | :{{CSharp|bool MatchesSelector(string selector)}} |
− | :{{CSharp|void | + | :{{CSharp|void MergeFrom(DOMObject source, bool restore, DOMDiffOperations type)}} |
− | :{{CSharp|void | + | :{{CSharp|void MergeFromWithTracking(DOMObject source, bool restore)}} |
− | :{{CSharp|void | + | :{{CSharp|IEnumerable<T> OfType<T>(DOMSearchLevel applyTo)}} |
+ | :{{CSharp|T ParentOfType<T>()}} | ||
+ | :{{CSharp|DOMObject QuerySelector(string selector)}} | ||
+ | :{{CSharp|IEnumerable<DOMObject> QuerySelectorAll(string selector)}} | ||
+ | :{{CSharp|void ReID()}} | ||
+ | :{{CSharp|void remove_ChildBeforeAdd(EventHandler<DOMUpdateChildAdd> value)}} | ||
+ | :{{CSharp|void remove_ChildBeforeRemove(EventHandler<DOMUpdateChildRemove> value)}} | ||
+ | :{{CSharp|void remove_Updated(EventHandler<DOMUpdateEventArgs> value)}} | ||
+ | :{{CSharp|void RemoveClass(string className)}} | ||
+ | :{{CSharp|int RemoveLocalProperties(Func<string, bool> keySelector)}} | ||
+ | :{{CSharp|Object RemoveLocalProperty(string key)}} | ||
:{{CSharp|void ResetTypeID(Guid typeID)}} | :{{CSharp|void ResetTypeID(Guid typeID)}} | ||
− | |||
− | |||
:{{CSharp|void Revalidate(Func<DOMObject, bool> validationCallback)}} | :{{CSharp|void Revalidate(Func<DOMObject, bool> validationCallback)}} | ||
+ | :{{CSharp|void SetLocalProperty(string key, Object value)}} | ||
+ | :{{CSharp|void ToggleClass(string className)}} | ||
:{{CSharp|string ToString()}} | :{{CSharp|string ToString()}} | ||
− | :{{CSharp| | + | :{{CSharp|bool TryGetLocalProperty<T>(string key, out T result)}} |
− | :{{CSharp| | + | :{{CSharp|IEnumerable<DOMObject> Where(Func<DOMObject, bool> predicate, DOMSearchLevel applyTo)}} |
− | + | :{{CSharp|IEnumerable<T> Where<T>(Func<T, bool> predicate, DOMSearchLevel applyTo)}} | |
− | + | ||
− | + | ||
− | :{{CSharp| | + | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + |
Revision as of 13:29, 11 October 2016
The base class for all DOM node types
Properties
- bool Accessable
- DOMAttributeCache AttributeCache
- DOMAttributeSet Attributes
- Nullable<Guid> BaseTypeID
- DOMObjectCollection Children
- string Class
- ReferenceContract Contract
- DOMDocument Document
- bool Enabled
- long ID
- The unique ID of this object in the view. DOM node IDs can change if a node is moved between view documents or removed from a document in which case this property will return zero. DOM node IDs are allocated by the RootDocument in a view
- Nullable<Guid> InstanceIndex
- DOMObject InstanceRoot
- Nullable<Guid> InstanceTypeID
- bool IsInReference
- bool IsInstanceRoot
- bool IsTemplateRoot
- bool IsTopLevelReference
- bool IsTypeRoot
- Guid MergeID
- bool MergeLocked
- Guid NodeID
- string NodePath
- Gets a path which can be used to locate a specific node in the DOM using the FindNode method
- IEnumerable<DOMAttribute> ObjectAttributes
- DOMObject Parent
- DOMPropertyCollection Properties
- DOMProtectionFlags ProtectionFlags
- Guid RecordID
- The ID used to uniquely identify an object. RecordIDs are generated when a new DOMObject is created.
- DOMDocument RootDocument
- DateTime ServerTime
- List<string> SystemPropertyNames
- Object Tag
- Guid TemplateID
- DOMObject TemplateRoot
- bool Temporary
- string Title
- bool Transient
- Guid TypeID
- Nullable<Guid> TypeIndex
- int TypeNodeID
- bool TypeReference
- Boolean[] TypeReferenceReload
- DOMObject TypeRoot
- bool Validated
- bool Viewable
- bool Visible
Events
- ChildBeforeAdd(EventHandler<DOMUpdateChildAdd>)
- ChildBeforeRemove(EventHandler<DOMUpdateChildRemove>)
- Updated(EventHandler<DOMUpdateEventArgs>)
Methods
- void add_ChildBeforeAdd(EventHandler<DOMUpdateChildAdd> value)
- void add_ChildBeforeRemove(EventHandler<DOMUpdateChildRemove> value)
- void add_Updated(EventHandler<DOMUpdateEventArgs> value)
- void AddClass(string className)
- void BeginMergeUpdate()
- void BeginUpdate()
- bool CheckChild(DOMObject child)
- bool CheckParent(DOMObject parent)
- void ClearChildren()
- DOMObject Clone()
- Gets a deep clone of the current object
- bool Contains<T>(T value, DOMSearchLevel applyTo)
- bool Contains(Func<DOMObject, bool> predicate, DOMSearchLevel applyTo)
- bool Contains<T>(Func<T, bool> predicate, DOMSearchLevel applyTo)
- bool ContainsTypeReference(Guid typeID)
- int Count<T>()
- int Count<T>(DOMSearchLevel applyTo)
- int Count<T>(Func<T, bool> predicate, DOMSearchLevel applyTo)
- int Count(Func<DOMObject, bool> predicate, DOMSearchLevel applyTo)
- DOMObject Detach()
- Detaches the node from its parent and resets the childrens ID's
- bool DiscoverTemplate(Guid templateID)
- bool DiscoverType(Guid typeID)
- void EndMergeUpdate()
- void EndUpdate()
- bool Equals(DOMObject other)
- bool Equals(DOMObject x, DOMObject y)
- DOMObject FindNode(string nodepath, Nullable<Guid> templateID)
- Gets the node that matches the object type node path (Example: 40/23)
- DOMObject First(DOMSearchLevel applyTo)
- T First<T>(DOMSearchLevel applyTo)
- DOMObject First(Func<DOMObject, bool> predicate, DOMSearchLevel applyTo)
- T First<T>(Func<T, bool> predicate, DOMSearchLevel applyTo)
- DOMObject FirstOrDefault(DOMSearchLevel applyTo)
- T FirstOrDefault<T>(DOMSearchLevel applyTo)
- DOMObject FirstOrDefault(Func<DOMObject, bool> predicate, DOMSearchLevel applyTo)
- T FirstOrDefault<T>(Func<T, bool> predicate, DOMSearchLevel applyTo)
- void ForEach(Func<DOMObject, bool> predicate, Action<DOMObject> action, DOMSearchLevel applyTo)
- void ForEach<T>(Func<T, bool> predicate, Action<T> action, DOMSearchLevel applyTo)
- IEnumerable<KeyValuePair<Guid, DOMObject>> GetAttributeKeys()
- TResult GetAttributeValue<TResult>(string attributeName, string propertyName)
- int GetHashCode(DOMObject obj)
- T GetLocalProperty<T>(string key, Func<T> defaultSelector)
- Nullable<Guid> GetNodeIndex(DOMObject baseNode)
- Guid GetNodeIndex2(DOMObject baseNode, int depth)
- IEnumerable<string> GetPropertiesWithAttribute(string attributeName)
- bool HasAttribute(string attributeName, string propertyName)
- bool HasClass(string className)
- bool MatchesSelector(string selector)
- void MergeFrom(DOMObject source, bool restore, DOMDiffOperations type)
- void MergeFromWithTracking(DOMObject source, bool restore)
- IEnumerable<T> OfType<T>(DOMSearchLevel applyTo)
- T ParentOfType<T>()
- DOMObject QuerySelector(string selector)
- IEnumerable<DOMObject> QuerySelectorAll(string selector)
- void ReID()
- void remove_ChildBeforeAdd(EventHandler<DOMUpdateChildAdd> value)
- void remove_ChildBeforeRemove(EventHandler<DOMUpdateChildRemove> value)
- void remove_Updated(EventHandler<DOMUpdateEventArgs> value)
- void RemoveClass(string className)
- int RemoveLocalProperties(Func<string, bool> keySelector)
- Object RemoveLocalProperty(string key)
- void ResetTypeID(Guid typeID)
- void Revalidate(Func<DOMObject, bool> validationCallback)
- void SetLocalProperty(string key, Object value)
- void ToggleClass(string className)
- string ToString()
- bool TryGetLocalProperty<T>(string key, out T result)
- IEnumerable<DOMObject> Where(Func<DOMObject, bool> predicate, DOMSearchLevel applyTo)
- IEnumerable<T> Where<T>(Func<T, bool> predicate, DOMSearchLevel applyTo)