DefinitelyTyped

Index

Modules

Interfaces

Classes

Functions

Functions

$addHandler(element: DomElement, eventName: string, handler: Function, autoRemove?: boolean)

Parameters

  • element: DomElement
  • eventName: string
  • handler: Function
  • autoRemove?: boolean optional

$addHandlers(element: DomElement, events: any, handlerOwner?: any, autoRemove?: boolean)

Provides a shortcut to the addHandlers method of the Sys.UI.DomEvent class. This member is static and can be invoked without creating an instance of the class.

see

{@link http://msdn.microsoft.com/en-us/library/bb384012(v=vs.100).aspx}

Parameters

  • element: DomElement

    The DOM element that exposes the event.

  • events: any

    A dictionary of events and their handlers.

  • handlerOwner?: any optional

    (Optional) The object instance that is the context for the delegates that should be created from the handlers.

  • autoRemove?: boolean optional

    (Optional) A boolean value that determines whether the handler should be removed automatically when the element is disposed.

$clearHandlers(element: DomElement)

Provides a shortcut to the clearHandlers method of the Sys.UI.DomEvent class. This member is static and can be invoked without creating an instance of the class. For details about the method that this shortcut represents, see Sys.UI.DomEvent clearHandlers Method.

see

{@link http://msdn.microsoft.com/en-us/library/bb310959(v=vs.100).aspx}

Parameters

$create(type: Type, properties?: any, events?: any, references?: any, element?: HTMLElement): Component

Creates and initializes a component of the specified type. This method is static and can be called without creating an instance of the class.

see

{@link http://msdn.microsoft.com/en-us/library/bb397487(v=vs.100).aspx}

Parameters

  • type: Type
          The type of the component to create.
    
  • properties?: any optional
          (Optional) A JSON object that describes the properties and their values.
    
  • events?: any optional
          (Optional) A JSON object that describes the events and their handlers.
    
  • references?: any optional
          (Optional) A JSON object that describes the properties that are references to other components.
    
  • element?: HTMLElement optional
          (Optional) The DOM element that the component should be attached to.
    

Returns

Component

A new instance of a component that uses the specified parameters.

$find(id: string, parent?: Component): Component

Returns the specified Component object. This member is static and can be invoked without creating an instance of the class.

see

{@link http://msdn.microsoft.com/en-us/library/bb397441(v=vs.100).aspx}

Parameters

  • id: string

    A string that contains the ID of the component to find.

  • parent?: Component optional

    (Optional) The component or element that contains the component to find.

Returns

Component

A Component object that contains the component requested by ID, if found; otherwise, null.

$find(id: string, parent?: HTMLElement): Component

Returns the specified Component object. This member is static and can be invoked without creating an instance of the class.

see

{@link http://msdn.microsoft.com/en-us/library/bb397441(v=vs.100).aspx}

Parameters

  • id: string

    A string that contains the ID of the component to find.

  • parent?: HTMLElement optional

    (Optional) The component or element that contains the component to find.

Returns

Component

A Component object that contains the component requested by ID, if found; otherwise, null.

$get(id: string): any

Provides a shortcut to the getElementById method of the Sys.UI.DomElement class. This member is static and can be invoked without creating an instance of the class.

see

{@link http://msdn.microsoft.com/en-us/library/bb397717(v=vs.100).aspx}

Parameters

  • id: string
          The ID of the DOM element to find.
    

Returns

any

The Sys.UI.DomElement

$get(id: string, element?: HTMLElement): HTMLElement

Parameters

  • id: string
  • element?: HTMLElement optional

Returns

HTMLElement

$get(id: string, element?: DomElement): DomElement

Parameters

Returns

DomElement

$removeHandler(element: any, eventName: string, handler: Function)

Provides a shortcut to the removeHandler method of the Sys.UI.DomEvent class. This member is static and can be invoked without creating an instance of the class.

see

{@link http://msdn.microsoft.com/en-us/library/bb397510(v=vs.100).aspx}

Parameters

  • element: any

    The DOM element that exposes the event.

  • eventName: string

    The name of the DOM event.

  • handler: Function

    The event handler to remove.

$removeHandler(element: HTMLElement, eventName: string, handler: Function)

Parameters

  • element: HTMLElement
  • eventName: string
  • handler: Function

$removeHandler(element: DomElement, eventName: string, handler: Function)

Parameters

  • element: DomElement
  • eventName: string
  • handler: Function