Class IxDOMUtils

Utilities for accessing elements in the Document Object Model (DOM).

Hierarchy

IxDOMUtils

Index

Methods

children closestParent getElement getGuid getHtml getUp hasUp setUp

Methods

`Static` children

children(el, selector): NodeListOf<Element>
Replacement for $().children.
Parameters
- el: HTMLElement
- selector: string
Returns NodeListOf<Element>

`Static` closestParent

closestParent(el, selector, includeSelf?): null | HTMLElement
Replacement for $().closest.
Parameters
- el: HTMLElement
- selector: string
- Optional includeSelf: boolean
Returns null | HTMLElement

`Static` getElement

getElement(key, settings?): JQuery<HTMLElement>
Try to get the elements for the given key.
Parameters
- key: string | HTMLElement | JQuery<HTMLElement>
- settings: HTMLElement | Partial<GetHtmlContextSettings> = ...
Returns JQuery<HTMLElement>

`Static` getGuid

getGuid(element): undefined | string
Get the GUID of the control.
Parameters
- element: HTMLElement | JQuery<HTMLElement>
Returns undefined | string

`Static` getHtml

getHtml(key, settings?): null | HTMLElement
Get a HTML element via ID or GUID from a specific context (defaults to document).
Parameters
- key: string
- Optional settings: HTMLElement | GetHtmlContextSettings
Returns null | HTMLElement

`Static` getUp

getUp(key, settings?): null | UpControlLike
Returns the UpObject.
Parameters
- key: string | HTMLElement
  
  An element Guid, id or HTMLElement.
- settings: Partial<GetUpSettings> = ...
Returns null | UpControlLike
The UpControl like object for the first HTML element.

`Static` hasUp

hasUp(key, settings?): boolean
Checks whether an UpObject is linked to the element.
Parameters
- key: string | HTMLElement
  
  An element GUID, ID or HTMLElement.
- settings: Partial<GetUpSettings> = ...
Returns boolean

`Static` setUp

setUp(element, ctrlInfoGuid?, up?): any
Set and returns the UpObject or null.
Parameters
- element: HTMLElement
- Optional ctrlInfoGuid: string
  
  Control info GUID, default is current element GUID.
- Optional up: any
Returns any