ASP.NET 3.5 and above only

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

Obout.Ajax.UI.HTMLEditor.Popups.OkCancelPopup class

 Inheritance Hierarchy

It is a client-side representation of the server-side Obout.Ajax.UI.HTMLEditor.Popups.OkCancelPopup class.

Base class for all popups in Obout.Ajax.UI.HTMLEditor.Popups namespace that have "OK" and "Cancel" buttons in the bottom.

Note Note
To get property values for client API properties, you must call property accessor method that is named with the get_ prefix. For example, to get a value for a property such as id, you call the get_id method:
var _id = popupObject.get_id();

Properties

Name Description
propertyadditionalCss string. Gets comma separated paths of additional CSS files for this popup. (Inherited from Popup.)
propertyattached boolean. Gets a value indicating whether the popup is 'attached' to a button called this popup. (Inherited from Popup.)
propertyautoClose boolean. Gets a value indicating whether the popup is closed on click outside it. (Inherited from Popup.)
Always false.
propertyautoDimensions boolean. Gets a value indicating whether the size of the popup is determining automatically. (Inherited from Popup.)
Always true.
propertycssPath string. Gets the main style file path. (Inherited from Popup.)
propertydesignPanel object. Gets the DesignPanel object if the popup is used in context of EditPanel and in Design mode, otherwise - null. (Inherited from Popup.)
propertyeditPanel object. Gets the EditPanel object if the popup is used in context of EditPanel, otherwise - null. (Inherited from Popup.)
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.)
propertyinitialContent string. Gets the popup's HTML content. (Inherited from Popup.)
propertypopupHolder object. Gets the associated Popup Holder object. (Inherited from Popup.)
propertyposition object. Gets or sets the coordinates of the popup position. (Inherited from Popup.)
The position object has the following fields:
  • left - left position in pixels;
  • top - top position in pixels.

Example:

var position = popup.get_position();
// move it 100px to right down
popup.set_position({ left: (position.left + 100), top: (position.top + 100) });

Methods

Name Description
propertycancel(contentWindow) This method is called on popup canceled. (Inherited from Popup.)
contentWindow of the popup's iframe is passed as parameter.
This method can be overridden in the derived class.

Example from the Obout.Ajax.UI.HTMLEditor.Popups.GalleryManager class code:

cancel: function(contentWindow) {
  Obout.Ajax.UI.HTMLEditor.Popups.GalleryManager.callBaseMethod
        (this, "cancel", [contentWindow]);
  this._removeEvents();
},

NoteNote
Don't call this method directly.
propertycancelCheck(contentWindow) This method is called before the popup canceled. (Inherited from Popup.)
contentWindow of the popup's iframe is passed as parameter.
If this method returns true, the popup will be closed and cancel method will be called. Otherwise it will not be closed. By default it returns true.
This method can be overridden in the derived class.

Example:

cancelCheck: function(contentWindow) {
  var retval =
    CustomPopups.MyPopup.callBaseMethod
                   (this, "cancelCheck", [contentWindow]);
  if (retval) {
      retval = this._myCheckCancel();
  }
  return retval;
},

NoteNote
Don't call this method directly.
propertygetDocument() Gets the document element of the popup's iframe. (Inherited from Popup.)
propertymoveToCenter() Moves the popup to the center of the visible area of the document. (Inherited from Popup.)
propertyok(contentWindow) This method is called on popup accepted ("OK" button clicked).
contentWindow of the popup's iframe is passed as parameter.
This method can be overridden in the derived class.

Example from the Obout.Ajax.UI.HTMLEditor.Popups.GalleryManager class code:

ok: function(contentWindow) {
  Obout.Ajax.UI.HTMLEditor.Popups.GalleryManager.callBaseMethod
        (this, "ok", [contentWindow]);
  this._removeEvents();
},

NoteNote
Don't call this method directly.
propertyokCheck(contentWindow) This method is called before the popup accepted ("OK" button clicked).
contentWindow of the popup's iframe is passed as parameter.
If this method returns true, the popup will be closed and ok method will be called. Otherwise it will not be closed. By default it returns true.
This method can be overridden in the derived class.

Example from the Obout.Ajax.UI.HTMLEditor.Popups.LinkProperties class code:

okCheck: function(contentWindow) {
  var urlField = contentWindow.popupMediator.getField("url");

  if (urlField != null) {
      var url = urlField.value;
      if (url == "" || (url.length >= 3 &&
          url.substr(url.length - 3, 3) == "://")) {
          contentWindow.alert(this.get_emptyUrlMessage());
          contentWindow.setTimeout(function() {
              try { urlField.focus(); } catch (e) { }
          }, 0);
          return false;
     }
     return true;
  }
  return false;
},

NoteNote
Don't call this method directly.
propertypreOpen(contentWindow) This method is called before popup is opened. (Inherited from Popup.)
contentWindow of the popup's iframe is passed as parameter.
This method can be overridden in the derived class.

Example:

preOpen: function(contentWindow) {
  this._preparePopup(contentWindow);
},

NoteNote
Don't call this method directly.

Events

Name Description
propertybeforeHidden Raised before the popup is hidden. (Inherited from Popup.)
Event's argument has type Sys.EventArgs.Empty.
propertybeforeShown Raised before the popup is shown. (Inherited from Popup.)
Event's argument has type Sys.EventArgs.Empty.
propertyhidden Raised after the popup is hidden. (Inherited from Popup.)
Event's argument has type Sys.EventArgs.Empty.
propertyshown Raised after the popup is shown. (Inherited from Popup.)
Event's argument has type Sys.EventArgs.Empty.

"I just bought your controls and I must say they are great! I used them during college and I recommended them to my company."

Damian Lobalzo

Random testimonial   All testimonials

Products Downloads