RMLElement
Summary
RmlUi element based on the RML reference page
Remarks
Danger
All calls made within this class MUST be performed on the Master Thread. See Threads.RunLater on how to safely call this from an asynchronous thread. Failure to comply with this can cause catastrophical failures as the engine is not designed for this.
Definition
Namespace: SDT4.Managed.UI.RML
Assembly: SDT4.Managed.UI.dll
class RMLElement
Inheritance:
Object ➔ RMLElement
Implements:
IDisposable
Fields
| Name | Type | Description |
|---|---|---|
Properties
| Name | Type | Description |
|---|---|---|
public get; Attributes |
RMLNamedNodeMap | |
public get; Style |
Object | An object representing the declarations of an element’s style attributes. Returns RCSSStyleDeclaration |
public get; set; ID |
String | |
public get; set; ClassName |
String | |
public get; set; InnerRML |
String | |
public get; set; InnerText |
String? | |
public get; set; Value |
RMLVariant | |
public get; OwnerDocument |
RMLDocument | |
public get; PreviousSibling |
RMLElement | |
public get; NextSibling |
RMLElement | |
public get; ParentNode |
RMLElement | |
public get; ChildNodes |
RMLElement[] | |
public get; FirstChild |
RMLElement | |
public get; LastChild |
RMLElement | |
public get; ClassList |
RMLClassTokenList | |
public get; ClientHeight |
Single | |
public get; ClientLeft |
Single | |
public get; ClientTop |
Single | |
public get; ClientWidth |
Single | |
public get; OffsetHeight |
Single | |
public get; OffsetLeft |
Single | |
public get; OffsetTop |
Single | |
public get; OffsetWidth |
Single | |
public get; OffsetParent |
RMLElement |
Methods
public Void Blur()
public Void Focus(Boolean focusVisible)
Parameters:
focusVisible(Boolean):
public Void Click()
public RMLElement? Closest(String selector)
Summary: Retrieve the first ancestor element matching the provided RCSS selector(s).
Parameters:
selector(String):
Returns:
public Void DispatchEvent(String event)
Summary: Dispatch an event to this node in the DOM.
Parameters:
event(String):
public Void AddEventListener(String type, RMLEventListener listener, Boolean useCapture)
Summary: Register an event handler to a specific event type on the element.
Parameters:
-
type(String): Event type (same string name as javascript) -
listener(RMLEventListener): Delegate function to be called -
useCapture(Boolean):
public Void AddEventListener(RMLEventID type, RMLEventListener listener, Boolean useCapture)
Summary: Register an event handler to a specific event type on the element.
Parameters:
-
type(RMLEventID): Event type -
listener(RMLEventListener): Delegate function to be called -
useCapture(Boolean):
public Void RemoveEventListener(String type, RMLEventListener listener, Boolean useCapture)
Summary: Removes an event handler from a specific event type if it was registered.
Parameters:
-
type(String): Event type (same string name as javascript) -
listener(RMLEventListener): Exact delegate object that was added as a listener -
useCapture(Boolean):
public Void RemoveEventListener(RMLEventID type, RMLEventListener listener, Boolean useCapture)
Summary: Removes an event handler from a specific event type if it was registered.
Parameters:
-
type(RMLEventID): Event type -
listener(RMLEventListener): Exact delegate object that was added as a listener -
useCapture(Boolean):
public Void AppendChild(RMLElement element)
Summary: Insert a node as the last child node of this element. The newly parented node must first be detached from its existing parent.
Parameters:
element(RMLElement):
public RMLElement RemoveChild(RMLElement element)
Summary: Removes a child node from the current element.
Parameters:
element(RMLElement):
Returns:
- RMLElement: Element that has been removed. If this element is not reassigned nor kept alive, it will be destroyed.
public RMLElement? GetElementById(String id)
Summary: Returns an element by its id.
Parameters:
id(String):
Returns:
public RMLElement[] GetElementsByClassName(String names)
Summary: Retrieve a set of all descendant elements with a particular class set.
Parameters:
names(String):
Returns:
public RMLElement[] GetElementsByTagName(String name)
Summary: Retrieve a set of all descendant elements with a particular tag name.
Parameters:
name(String):
Returns:
public RMLElement? QuerySelector(String selectors)
Summary: Retrieve the first descendant element matching the provided RCSS selector(s).
Parameters:
selectors(String):
Returns:
public RMLElement[] QuerySelectorAll(String selectors)
Summary: Retrieve a set of all descendant elements matching the provided RCSS selector(s).
Parameters:
selectors(String):
Returns:
public virtual Boolean Equals(Object? obj)
Parameters:
obj(Object?):
Returns:
public virtual Int32 GetHashCode()
Returns:
public virtual String ToString()
Returns:
protected virtual Void Dispose(Boolean disposing)
Parameters:
disposing(Boolean):