BalloonPopup - DevExpress/AjaxControlToolkit GitHub Wiki
demo)
BalloonPopupExtender (The BalloonPopupExtender control displays a popup which can contain any content.
Properties
Name | Description |
---|---|
BalloonPopupControlID | The ID of the control to display |
BalloonSize | Optional setting specifying the size of balloon popup. (Small, Medium and Large). Default value is Small |
BalloonStyle | Optional setting specifying the theme of balloon popup. Default value is Rectangle |
CustomClassName | This is required if user choose BalloonStyle to Custom. This specifies the name of the css class for the custom theme |
CustomCssUrl | This is required if user choose BalloonStyle to Custom. This specifies the url of custom css which will display custom theme |
DisplayOnClick | Optional setting specifying whether to display balloon popup on the client onClick event. Default value is true |
DisplayOnFocus | Optional setting specifying whether to display balloon popup on the client onFocus event. Default value is false |
DisplayOnMouseOver | Optional setting specifying whether to display balloon popup on the client onMouseOver event. Default value is false |
ExtenderControlID | Extender control ID |
OffsetX | Optional X (horizontal) offset for the popup window (relative to the target control). Default value is 0 |
OffsetY | Optional Y (vertical) offset for the popup window (relative to the target control). Default value is 0 |
OnHide | The OnHide animation will be played each time the popup is hidden |
OnShow | The OnShow animation will be played each time the popup is displayed. The popup will be positioned correctly but hidden Remarks: The animation can use to display the popup along with any other visual effects |
Position | Optional setting specifying where the popup should be positioned relative to the target control Remarks: (TopRight, TopLeft, BottomRight, BottomLeft, Auto) Default value is Auto |
ScrollBars | Optional setting specifying whether to display scrollbar if contents are overflowing. Default value is Auto |
UseShadow | Optional setting specifying whether to display shadow of balloon popup or not |
Client properties
Name | Description |
---|---|
balloonPopopControlID | The ID of the control to display |
balloonPopupPosition | Optional setting specifying where the popup should be positioned relative to the target control. Default value is Auto |
balloonPopupStyle | Optional setting specifying the theme of balloon popup. Default value is Rectangle |
balloonSize | Optional setting specifying the size of balloon popup. Default value is Small |
customClassName | This is required if user choose BalloonStyle to Custom. This specifies the name of the css class for the custom theme |
displayOnClick | Optional setting specifying whether to display balloon popup on the client onClick event. Default value is true |
displayOnFocus | Optional setting specifying whether to display balloon popup on the client onFocus event. Default value is false |
displayOnMouseOver | Optional setting specifying whether to display balloon popup on the client onMouseOver event. Default value is false |
extenderControlID | Extender control ID |
offsetX | Optional X (horizontal) offset for the popup window (relative to the target control) |
offsetY | Optional Y (horizontal) offset for the popup window (relative to the target control) |
onHide | Generic OnHide Animation's JSON definition |
onShow | Generic OnShow Animation's JSON definition |
onShowBehavior | Generic OnShow Animation's behavior |
popupVisible | Whether popup is visible. Default value is false |
scrollBars | Optional setting specifying whether to display scrollbar if contents are overflowing. Default value is Auto |
useShadow | Optional setting specifying whether to display shadow of balloon popup or not. Default value is true |
Client methods
Name | Description |
---|---|
hidePopup() | Hides the popup |
onHide() | Play the OnHide animation |
onHideBehavior() | Generic OnHide Animation's behavior |
onShow() | Play the OnShow animation |
pageHeight() | Calculates container height |
pageWidth() | Calculates container width |
posLeft() | Calculates popup left offset |
posTop() | Calculates popup top offset |
showPopup() | Shows the popup |
Client events
Name | Description |
---|---|
hidden | Fires when popup is hidden |
hiding | Fires when popup is hiding |
showing | Fires when popup is showing |
shown | Fires when popup is shown |
Client properties
balloonPopopControlID
The ID of the control to display
Getter name: get_balloonPopupControlID()Setter name: set_balloonPopupControlID(value)
balloonPopupPosition
Optional setting specifying where the popup should be positioned relative to the target control. Default value is Auto
Getter name: get_balloonPopupPosition()Setter name: set_balloonPopupPosition(value)
balloonPopupStyle
Optional setting specifying the theme of balloon popup. Default value is Rectangle
Getter name: get_balloonPopupStyle()Setter name: set_balloonPopupStyle(value)
offsetX
Optional X (horizontal) offset for the popup window (relative to the target control)
Getter name: get_offsetX()Setter name: set_offsetX(value)
offsetY
Optional Y (horizontal) offset for the popup window (relative to the target control)
Getter name: get_offsetY()Setter name: set_offsetY(value)
extenderControlID
Extender control ID
Getter name: get_extenderControlID()Setter name: set_extenderControlID(value)
displayOnMouseOver
Optional setting specifying whether to display balloon popup on the client onMouseOver event. Default value is false
Getter name: get_displayOnMouseOver()Setter name: set_displayOnMouseOver(value)
displayOnFocus
Optional setting specifying whether to display balloon popup on the client onFocus event. Default value is false
Getter name: get_displayOnFocus()Setter name: set_displayOnFocus(value)
displayOnClick
Optional setting specifying whether to display balloon popup on the client onClick event. Default value is true
Getter name: get_displayOnClick()Setter name: set_displayOnClick(value)
balloonSize
Optional setting specifying the size of balloon popup. Default value is Small
Getter name: get_balloonSize()Setter name: set_balloonSize(value)
useShadow
Optional setting specifying whether to display shadow of balloon popup or not. Default value is true
Getter name: get_useShadow()Setter name: set_useShadow(value)
scrollBars
Optional setting specifying whether to display scrollbar if contents are overflowing. Default value is Auto
Getter name: get_scrollBars()Setter name: set_scrollBars(value)
popupVisible
Whether popup is visible. Default value is false
Getter name: get_popupVisible()
onShow
Generic OnShow Animation's JSON definition
Getter name: get_onShow()Setter name: set_onShow(value)
onShowBehavior
Generic OnShow Animation's behavior
Getter name: get_onShowBehavior()
onHide
Generic OnHide Animation's JSON definition
Getter name: get_onHide()Setter name: set_onHide(value)
customClassName
This is required if user choose BalloonStyle to Custom. This specifies the name of the css class for the custom theme
Getter name: get_customClassName()Setter name: set_customClassName(value)
Client methods
showPopup()
Shows the popup
hidePopup()
Hides the popup
onShow()
Play the OnShow animation
onHideBehavior()
Generic OnHide Animation's behavior
onHide()
Play the OnHide animation
posTop()
Calculates popup top offset
posLeft()
Calculates popup left offset
pageHeight()
Calculates container height
pageWidth()
Calculates container width
Client events
showing
Fires when popup is showing
Add event handler method: add_showing(handler)Remove event handler method: remove_showing(handler)Raise event method: raise_showing()
shown
Fires when popup is shown
Add event handler method: add_shown(handler)Remove event handler method: remove_shown(handler)Raise event method: raise_shown()
hiding
Fires when popup is hiding
Add event handler method: add_hiding(handler)Remove event handler method: remove_hiding(handler)Raise event method: raise_hiding()
hidden
Fires when popup is hidden
Add event handler method: add_hidden(handler)Remove event handler method: remove_hidden(handler)Raise event method: raise_hidden()