ASP.NET 3.5 and above only

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

Obout.Ajax.UI.HTMLEditor.ToolbarButton.ToggleButton class

 Inheritance Hierarchy

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

Base class for all toggle image buttons in Obout.Ajax.UI.HTMLEditor.ToolbarButton namespace that are shown in design mode .

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 = buttonObject.get_id();

Properties

Name Description
propertyactiveModes ActiveModeType array. Gets an array of edit modes when this button is visible. (Inherited from CommonButton.)
Always returns an array with one item Obout.Ajax.UI.HTMLEditor.ActiveModeType.Design.
propertybuttonName string. Gets the name of the button. (Inherited from CommonButton.)
propertydesignPanel object. Gets the DesignPanel object currently associated with the button. (Inherited from DesignModeImageButton.)
propertyeditPanel object. Gets the EditPanel object currently associated with the button. (Inherited from CommonButton.)
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.)
propertypreservePlace boolean. Gets a value indicating whether to preserve buttons' space when it is invisible. (Inherited from CommonButton.)
Default false.
propertytoolTip string. Gets the tooltip of the button. (Inherited from CommonButton.)

Methods

Name Description
propertycallMethod() This method is called on the button clicked.
This method can be overridden in the derived class for the custom button. (Inherited from DesignModeImageButton.)

Returns true if this method has been executed successfully, otherwise false.

NoteNote
Don't call this method directly.
propertycanBeShown() Returns true if this button can be shown at this moment, otherwise false. (Inherited from CommonButton.)
propertycheckState() This method is called on each toolbar update (some operation is done, cursor moved, etc.).
This method can be overridden in the derived class for the custom toggle button.

Returns true if the button should have 'active' style (), or false if the button should have 'normal' style ().

NoteNote
Don't call this method directly.
propertyhideButton() Makes the button invisible. (Inherited from CommonButton.)
propertyisDisplayed() Returns true if this button is visible now, otherwise false. (Inherited from CommonButton.)
propertyisImage() Returns true if this button is an 'image' button, otherwise false. (Inherited from CommonButton.)
Always returns true here.
propertyshowButton() Makes the button visible. (Inherited from CommonButton.)

Example of JavaScript code (embedded) for a toggle button

Obout.Ajax.UI.HTMLEditor.ToolbarButton.AnchorsToggle = function(element) {
  Obout.Ajax.UI.HTMLEditor.ToolbarButton.AnchorsToggle.initializeBase(this, [element]);
}

Obout.Ajax.UI.HTMLEditor.ToolbarButton.AnchorsToggle.prototype = {
  callMethod: function() {
      if (!Obout.Ajax.UI.HTMLEditor.ToolbarButton.AnchorsToggle.callBaseMethod(this, "callMethod")) {
          return false;
      }
      var editor = this.get_designPanel();
      var editPanel = this.get_editPanel();
      editPanel.set_showAnchors(!editPanel.get_showAnchors())
      Obout.Ajax.UI.HTMLEditor.operateAnchors(editor, editor.get_doc(), !editPanel.get_showAnchors());
      editPanel.updateToolbar();
  },

  checkState: function() {
      if (!Obout.Ajax.UI.HTMLEditor.ToolbarButton.AnchorsToggle.callBaseMethod(this, "checkState")) {
          return false;
      }
      return this.get_editPanel().get_showAnchors()
  }
}

Obout.Ajax.UI.HTMLEditor.ToolbarButton.AnchorsToggle.registerClass(
                            "Obout.Ajax.UI.HTMLEditor.ToolbarButton.AnchorsToggle",
                            Obout.Ajax.UI.HTMLEditor.ToolbarButton.ToggleButton);

"I am writing to express my admiration of your Grid control. My firm and I reckon it as very helpful and really exceptional. Moreover, I am impressed by your individual support. The respond is very fast, which is a unique feature. "

Ivo Panov
Geryon DZZD

Random testimonial   All testimonials

Products Downloads