ASP.NET 3.5 and above only

Obout.Ajax.UI Controls - HTML Editor - Client side

Obout.Ajax.UI.HTMLEditor.PopupHolder class

 Inheritance Hierarchy

It is a client-side representation of the server-side Obout.Ajax.UI.HTMLEditor.PopupHolder class.
Note Note
To get or set property values for client API properties, you must call property accessor methods that are named with the get_ and set_ prefixes. For example, to get or set a value for a property such as popupsZIndex, you call the get_popupsZIndex or set_popupsZIndex methods:
var popupHolderObject = $find("<%= popupHolder1.ClientID %>");
var _popupsZIndex = popupHolderObject.get_popupsZIndex();
...
popupHolderObject.set_popupsZIndex(20000);

Properties

Name Description
propertydraggablePopups boolean. Gets or sets a value indicating whether the popups in this holder are draggable.
Default true.
propertyelement string. Gets the DOM element that the current Control instance is associated with. (Inherited from Sys.UI.Control.)
propertyid string. Gets the identifier for the current Control object. The default is the id value of the associated Sys.UI.DomElement object. (Inherited from Sys.UI.Control.)
propertykeepPaternity boolean. Gets or sets a value indicating whether to keep paternity (this holder) of popups on open.
Default false.
propertypopups object. Gets an array of popup descriptors contianing in this holder.
propertypopupsZIndex number. Gets or sets the starting z-index for all popups in this holder.
Default 10000.
propertyprogressImageID string. Gets the ID of the 'wait' image element .
propertyretainPopupPosition boolean. Gets or sets a value indicating whether to retain popup's position before its closing and restore it when you reopen the popup. If this property is set to false, then popups will be positioned to the center of the screen on each opening.
This behavior applies to all popups that belong to this PopupHolder control.
Default true.

Popup descriptor

Field name Description
propertyclassName Class name of the popup (e.g. 'Obout.Ajax.UI.HTMLEditor.Popups.LinkProperties').
propertyclientID ID of the popup component, empty if the popup is not loaded yet.

Methods

Name Description
propertyopenPopupsCount() Returns the number of opened popups in this holder.

Example:

var popupHolderObject = $find("<%= popupHolder1.ClientID %>");
alert(popupHolderObject.openPopupsCount());
propertyfindPopup(className) Returns a popup descriptor by popup's class name.

Example:

var popupHolderObject = $find("<%= popupHolder1.ClientID %>");
var found = popupHolderObject.findPopup("Obout.Ajax.UI.HTMLEditor.Popups.LinkProperties");

if (found.clientID.length > 0 && $find(found.clientID)) {
    alert("LinkProperties popup is loaded");
}
Note Note
To add or remove handler functions for client API events, you must call methods that are named with the add_ and remove_ prefixes. For example, to add or remove a handler function for an event such as popupStateChanged, you call the add_popupStateChanged or remove_popupStateChanged methods:
function popupStateChangedHandler(sender, args) {
}
...
var popupHolderObject = $find("<%= popupHolder1.ClientID %>");
popupHolderObject.add_popupStateChanged(popupStateChangedHandler);
...
popupHolderObject.remove_popupStateChanged(popupStateChangedHandler);

Events

Name Description
propertypopupStateChanged Raised when has been changed a state of any popup in this holder.
Event's argument has type Obout.Ajax.UI.HTMLEditor.PopupStateArgs.

See online example.

"The tree control is fantastic! Keep up the great coding and service!!"

Michael L. Richman
VP, Development InteHealth Incorporated

Random testimonial   All testimonials