Difference between revisions of "DOMObject"

From Virtual World Web Wiki
Jump to: navigation, search
(Documentation for the DOMObject class)
(Documentation for the DOMObject class)
Line 2: Line 2:
 
===Properties===
 
===Properties===
 
:{{CSharp|bool Accessable}}
 
:{{CSharp|bool Accessable}}
 +
 
:{{CSharp|DOMAttributeCache AttributeCache}}
 
:{{CSharp|DOMAttributeCache AttributeCache}}
 +
 
:{{CSharp|DOMAttributeSet Attributes}}
 
:{{CSharp|DOMAttributeSet Attributes}}
 +
 
:{{CSharp|Nullable<Guid> BaseTypeID}}
 
:{{CSharp|Nullable<Guid> BaseTypeID}}
 +
 
:{{CSharp|DOMObjectCollection Children}}
 
:{{CSharp|DOMObjectCollection Children}}
 +
 
:{{CSharp|string Class}}
 
:{{CSharp|string Class}}
 +
 
:{{CSharp|ReferenceContract Contract}}
 
:{{CSharp|ReferenceContract Contract}}
 +
 
:{{CSharp|DOMDocument Document}}
 
:{{CSharp|DOMDocument Document}}
 +
 
:{{CSharp|bool Enabled}}
 
:{{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|Nullable<Guid> InstanceIndex}}
 +
 
:{{CSharp|DOMObject InstanceRoot}}
 
:{{CSharp|DOMObject InstanceRoot}}
 +
 
:{{CSharp|Nullable<Guid> InstanceTypeID}}
 
:{{CSharp|Nullable<Guid> InstanceTypeID}}
 +
 
:{{CSharp|bool IsInReference}}
 
:{{CSharp|bool IsInReference}}
 +
 
:{{CSharp|bool IsInstanceRoot}}
 
:{{CSharp|bool IsInstanceRoot}}
 +
 
:{{CSharp|bool IsTemplateRoot}}
 
:{{CSharp|bool IsTemplateRoot}}
 +
 
:{{CSharp|bool IsTopLevelReference}}
 
:{{CSharp|bool IsTopLevelReference}}
 +
 
:{{CSharp|bool IsTypeRoot}}
 
:{{CSharp|bool IsTypeRoot}}
 +
 
:{{CSharp|Guid MergeID}}
 
:{{CSharp|Guid MergeID}}
 +
 
:{{CSharp|bool MergeLocked}}
 
:{{CSharp|bool MergeLocked}}
 +
 
:{{CSharp|Guid NodeID}}
 
:{{CSharp|Guid NodeID}}
 +
 
:{{CSharp|string NodePath}}
 
:{{CSharp|string NodePath}}
 
::Gets a path which can be used to locate a specific node in the DOM using the FindNode method
 
::Gets a path which can be used to locate a specific node in the DOM using the FindNode method
 
:{{CSharp|IEnumerable<DOMAttribute> ObjectAttributes}}
 
:{{CSharp|IEnumerable<DOMAttribute> ObjectAttributes}}
 +
 
:{{CSharp|DOMObject Parent}}
 
:{{CSharp|DOMObject Parent}}
 +
 
:{{CSharp|DOMPropertyCollection Properties}}
 
:{{CSharp|DOMPropertyCollection Properties}}
 +
 
:{{CSharp|DOMProtectionFlags ProtectionFlags}}
 
:{{CSharp|DOMProtectionFlags ProtectionFlags}}
 +
 
:{{CSharp|Guid RecordID}}
 
:{{CSharp|Guid RecordID}}
 
::The ID used to uniquely identify an object. RecordIDs are generated when a new DOMObject is created.
 
::The ID used to uniquely identify an object. RecordIDs are generated when a new DOMObject is created.
 
:{{CSharp|DOMDocument RootDocument}}
 
:{{CSharp|DOMDocument RootDocument}}
 +
 
:{{CSharp|DateTime ServerTime}}
 
:{{CSharp|DateTime ServerTime}}
 +
 
:{{CSharp|List<string> SystemPropertyNames}}
 
:{{CSharp|List<string> SystemPropertyNames}}
 +
 
:{{CSharp|Object Tag}}
 
:{{CSharp|Object Tag}}
 +
 
:{{CSharp|Guid TemplateID}}
 
:{{CSharp|Guid TemplateID}}
 +
 
:{{CSharp|DOMObject TemplateRoot}}
 
:{{CSharp|DOMObject TemplateRoot}}
 +
 
:{{CSharp|bool Temporary}}
 
:{{CSharp|bool Temporary}}
 +
 
:{{CSharp|string Title}}
 
:{{CSharp|string Title}}
 +
 
:{{CSharp|bool Transient}}
 
:{{CSharp|bool Transient}}
 +
 
:{{CSharp|Guid TypeID}}
 
:{{CSharp|Guid TypeID}}
 +
 
:{{CSharp|Nullable<Guid> TypeIndex}}
 
:{{CSharp|Nullable<Guid> TypeIndex}}
 +
 
:{{CSharp|int TypeNodeID}}
 
:{{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 Validated}}
 +
 
:{{CSharp|bool Viewable}}
 
:{{CSharp|bool Viewable}}
 +
 
:{{CSharp|bool Visible}}
 
:{{CSharp|bool Visible}}
 +
 
===Events===
 
===Events===
 
:{{CSharp|ChildBeforeAdd(EventHandler<DOMUpdateChildAdd>)}}
 
:{{CSharp|ChildBeforeAdd(EventHandler<DOMUpdateChildAdd>)}}
 +
 
:{{CSharp|ChildBeforeRemove(EventHandler<DOMUpdateChildRemove>)}}
 
:{{CSharp|ChildBeforeRemove(EventHandler<DOMUpdateChildRemove>)}}
 +
 
:{{CSharp|Updated(EventHandler<DOMUpdateEventArgs>)}}
 
:{{CSharp|Updated(EventHandler<DOMUpdateEventArgs>)}}
 +
 
===Methods===
 
===Methods===
−
:{{CSharp|void add_ChildBeforeAdd(EventHandler<DOMUpdateChildAdd> value)}}
 
−
:{{CSharp|void add_ChildBeforeRemove(EventHandler<DOMUpdateChildRemove> value)}}
 
−
:{{CSharp|void add_Updated(EventHandler<DOMUpdateEventArgs> value)}}
 
 
:{{CSharp|void AddClass(string className)}}
 
:{{CSharp|void AddClass(string className)}}
 +
 
:{{CSharp|void BeginMergeUpdate()}}
 
:{{CSharp|void BeginMergeUpdate()}}
 +
 
:{{CSharp|void BeginUpdate()}}
 
:{{CSharp|void BeginUpdate()}}
 +
 
:{{CSharp|bool CheckChild(DOMObject child)}}
 
:{{CSharp|bool CheckChild(DOMObject child)}}
 +
 
:{{CSharp|bool CheckParent(DOMObject parent)}}
 
:{{CSharp|bool CheckParent(DOMObject parent)}}
 +
 
:{{CSharp|void ClearChildren()}}
 
:{{CSharp|void ClearChildren()}}
 +
 
:{{CSharp|DOMObject Clone()}}
 
:{{CSharp|DOMObject Clone()}}
 
::Gets a deep clone of the current object
 
::Gets a deep clone of the current object
 
:{{CSharp|bool Contains<T>(T value, DOMSearchLevel applyTo)}}
 
:{{CSharp|bool Contains<T>(T value, DOMSearchLevel applyTo)}}
 +
 
:{{CSharp|bool Contains(Func<DOMObject, bool> predicate, DOMSearchLevel applyTo)}}
 
:{{CSharp|bool Contains(Func<DOMObject, bool> predicate, DOMSearchLevel applyTo)}}
 +
 
:{{CSharp|bool Contains<T>(Func<T, bool> predicate, DOMSearchLevel applyTo)}}
 
:{{CSharp|bool Contains<T>(Func<T, bool> predicate, DOMSearchLevel applyTo)}}
 +
 
:{{CSharp|bool ContainsTypeReference(Guid typeID)}}
 
:{{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()}}
 
:{{CSharp|DOMObject Detach()}}
 
::Detaches the node from its parent and resets the childrens ID's
 
::Detaches the node from its parent and resets the childrens ID's
 
:{{CSharp|bool DiscoverTemplate(Guid templateID)}}
 
:{{CSharp|bool DiscoverTemplate(Guid templateID)}}
 +
 
:{{CSharp|bool DiscoverType(Guid typeID)}}
 
:{{CSharp|bool DiscoverType(Guid typeID)}}
 +
 
:{{CSharp|void EndMergeUpdate()}}
 
:{{CSharp|void EndMergeUpdate()}}
 +
 
:{{CSharp|void EndUpdate()}}
 
:{{CSharp|void EndUpdate()}}
 +
 
:{{CSharp|bool Equals(DOMObject other)}}
 
:{{CSharp|bool Equals(DOMObject other)}}
 +
 
:{{CSharp|bool Equals(DOMObject x, DOMObject y)}}
 
:{{CSharp|bool Equals(DOMObject x, DOMObject y)}}
 +
 
:{{CSharp|DOMObject FindNode(string nodepath, Nullable<Guid> templateID)}}
 
:{{CSharp|DOMObject FindNode(string nodepath, Nullable<Guid> templateID)}}
 
::Gets the node that matches the object type node path (Example: 40/23)
 
::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)}}
 +
 
:{{CSharp|DOMObject First(Func<DOMObject, bool> predicate, DOMSearchLevel applyTo)}}
 
:{{CSharp|DOMObject First(Func<DOMObject, bool> predicate, DOMSearchLevel applyTo)}}
 +
 
:{{CSharp|T First<T>(Func<T, bool> predicate, DOMSearchLevel applyTo)}}
 
:{{CSharp|T First<T>(Func<T, bool> predicate, DOMSearchLevel applyTo)}}
 +
 
:{{CSharp|DOMObject FirstOrDefault(DOMSearchLevel applyTo)}}
 
:{{CSharp|DOMObject FirstOrDefault(DOMSearchLevel applyTo)}}
 +
 
:{{CSharp|T FirstOrDefault<T>(DOMSearchLevel applyTo)}}
 
:{{CSharp|T FirstOrDefault<T>(DOMSearchLevel applyTo)}}
 +
 
:{{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<KeyValuePair<Guid, DOMObject>> GetAttributeKeys()}}
 
:{{CSharp|IEnumerable<KeyValuePair<Guid, DOMObject>> GetAttributeKeys()}}
 +
 
:{{CSharp|TResult GetAttributeValue<TResult>(string attributeName, string propertyName)}}
 
:{{CSharp|TResult GetAttributeValue<TResult>(string attributeName, string propertyName)}}
 +
 
:{{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|Nullable<Guid> GetNodeIndex(DOMObject baseNode)}}
 
:{{CSharp|Nullable<Guid> GetNodeIndex(DOMObject baseNode)}}
 +
 
:{{CSharp|Guid GetNodeIndex2(DOMObject baseNode, int depth)}}
 
:{{CSharp|Guid GetNodeIndex2(DOMObject baseNode, int depth)}}
 +
 
:{{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|bool HasClass(string className)}}
 
:{{CSharp|bool HasClass(string className)}}
 +
 
:{{CSharp|bool MatchesSelector(string selector)}}
 
:{{CSharp|bool MatchesSelector(string selector)}}
 +
 
:{{CSharp|void MergeFrom(DOMObject source, bool restore, DOMDiffOperations type)}}
 
:{{CSharp|void MergeFrom(DOMObject source, bool restore, DOMDiffOperations type)}}
 +
 
:{{CSharp|void MergeFromWithTracking(DOMObject source, bool restore)}}
 
:{{CSharp|void MergeFromWithTracking(DOMObject source, bool restore)}}
 +
 
:{{CSharp|IEnumerable<T> OfType<T>(DOMSearchLevel applyTo)}}
 
:{{CSharp|IEnumerable<T> OfType<T>(DOMSearchLevel applyTo)}}
 +
 
:{{CSharp|T ParentOfType<T>()}}
 
:{{CSharp|T ParentOfType<T>()}}
 +
 
:{{CSharp|DOMObject QuerySelector(string selector)}}
 
:{{CSharp|DOMObject QuerySelector(string selector)}}
 +
 
:{{CSharp|IEnumerable<DOMObject> QuerySelectorAll(string selector)}}
 
:{{CSharp|IEnumerable<DOMObject> QuerySelectorAll(string selector)}}
 +
 
:{{CSharp|void ReID()}}
 
:{{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|void RemoveClass(string className)}}
 +
 
:{{CSharp|int RemoveLocalProperties(Func<string, bool> keySelector)}}
 
:{{CSharp|int RemoveLocalProperties(Func<string, bool> keySelector)}}
 +
 
:{{CSharp|Object RemoveLocalProperty(string key)}}
 
:{{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 SetLocalProperty(string key, Object value)}}
 +
 
:{{CSharp|void ToggleClass(string className)}}
 
:{{CSharp|void ToggleClass(string className)}}
 +
 
:{{CSharp|string ToString()}}
 
:{{CSharp|string ToString()}}
 +
 
:{{CSharp|bool TryGetLocalProperty<T>(string key, out T result)}}
 
:{{CSharp|bool TryGetLocalProperty<T>(string key, out T result)}}
 +
 
:{{CSharp|IEnumerable<DOMObject> Where(Func<DOMObject, bool> predicate, DOMSearchLevel applyTo)}}
 
:{{CSharp|IEnumerable<DOMObject> Where(Func<DOMObject, bool> predicate, DOMSearchLevel applyTo)}}
 +
 
:{{CSharp|IEnumerable<T> Where<T>(Func<T, bool> predicate, DOMSearchLevel applyTo)}}
 
:{{CSharp|IEnumerable<T> Where<T>(Func<T, bool> predicate, DOMSearchLevel applyTo)}}

Revision as of 13:32, 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 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 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)
Retrieved from "http://wiki.virtualworldweb.com/index.php?title=DOMObject&oldid=2469"