Search.../

Button

A text button or an icon button.

Properties

Store values associated with an object

  • collapsed

    Indicates if the element is collapsed or expanded.

  • enabled

    Indicates if the element is enabled or disabled.

  • global

    Indicates if an element appears on all pages or only on the current page.

  • hidden

    Indicates if the element is visible or hidden.

  • id

    Gets the element's ID.

  • isVisible

    Indicates if the element is actually visible.

  • label

    Sets or gets the label of a text button.

  • link

    Sets or gets the button's link.

  • parent

    Gets the element's parent element.

  • rendered

    Indicates if an element is currently in the DOM structure.

  • style

    Gets an object containing information about the button's styles.

  • target

    Sets or gets the target of the element's link.

  • type

    Gets the element's type.

Functions

Perform actions on an object

  • collapse( )

    Collapses the element and sets its collapsed property to true.

  • disable( )

    Disables the element and sets its enabled property to false.

  • enable( )

    Enables the element and sets its enabled property to true.

  • expand( )

    Expands the element and sets its collapsed property to false.

  • hide( )

    Hides the element and sets its hidden property to true, using an effect if specified.

  • onClick( )

    Adds an event handler that runs when the element is clicked.

  • onDblClick( )

    Adds an event handler that runs when the element is double-clicked.

  • onMouseIn( )

    Adds an event handler that runs when the mouse pointer is moved onto the element. Deprecation note: The $w parameter of event handlers is being deprecated. To ...

  • onMouseOut( )

    Adds an event handler that runs when the mouse pointer is moved off of the element. Deprecation note: The $w parameter of event handlers is being deprecated. ...

  • onViewportEnter( )

    Adds an event handler that runs when an element is displayed in the viewable part of the current window.

  • onViewportLeave( )

    Adds an event handler that runs when an element is no longer displayed in the viewable part of the current window.

  • scrollTo( )

    Scrolls the page to the top of the element using an animation.

  • show( )

    Shows the element and sets its hidden property to false, using an effect if specified.