ASP.NET 3.5 and above only
Obout.Ajax.UI Controls - HTML Editor - Client side
Obout.Ajax.UI.HTMLEditor.ContextMenu.DesignModeItem class
Inheritance Hierarchy
It is a client-side representation of the server-side
Obout.Ajax.UI.HTMLEditor.ContextMenu.DesignModeItem
class.
Base class for all items in Obout.Ajax.UI.HTMLEditor.ContextMenu namespace.
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 = itemObject.get_id(); |
Properties
| Name |
Description |
activeModes
|
ActiveModeType array.
Gets an array of edit modes when this button is visible.
(Inherited from ToolbarButton.CommonButton.)
Here the array contains one object only: Obout.Ajax.UI.HTMLEditor.ActiveModeType.Design .
|
attributeName
|
string. Gets the comma separated attribute names for DOM elements with tag names from the tagName list for which this item will be visible.
The item will be visible when an attribute with a name from this list will be equal to associated value from the attributeValue list.
|
attributeValue
|
strings. Gets the comma separated values for the attribute set in attributeName
|
buttonName
|
string. Gets the name of the button.
(Inherited from ToolbarButton.CommonButton.)
|
element
|
string. Gets the DOM element that the current Control instance is associated with.
(Inherited from Sys.UI.Control.)
|
id
|
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.)
|
popupHolder
|
object. Gets the associated Popup Holder object
if relatedPopup is set.
|
preservePlace
|
boolean. Gets a value indicating whether to preserve buttons' space when it is invisible.
(Inherited from ToolbarButton.CommonButton.)
Default false.
|
relatedPopup
|
Popups.Popup object.
Gets the associated popup, null if not set.
|
relatedPopupClassName
|
string.
Gets the class name of the associated popup, empty value if not set.
|
tagName
|
string. Gets the comma separated tag names of DOM elements for which this item will be visible.
|
toolTip
|
string. Gets the tooltip of the button.
(Inherited from ToolbarButton.CommonButton.)
|
| Name |
Description |
canBeShown()
|
Returns true if this button can be shown at this moment, otherwise false.
(Inherited from ToolbarButton.CommonButton.)
|
checkElement(retval, el)
|
You can override this function for your custom context menu item for additional checking - whether to show this item.
Returns true if it should be shown, otherwise false.
Parameters;
retval - previously calculated "Return value" (false).
el - DOM element on which the context menu item should be shown.
|
hideButton()
|
Makes the button invisible.
(Inherited from ToolbarButton.CommonButton.)
|
isDisplayed()
|
Returns true if this button is visible now, otherwise false.
(Inherited from ToolbarButton.CommonButton.)
|
isImage()
|
Returns false here.
(Inherited from ToolbarButton.CommonButton.)
|
showButton()
|
Makes the button visible.
(Inherited from ToolbarButton.CommonButton.)
|
shouldBeEnabled()
|
You can override this function for your custom context menu item for additional checking - whether to enable this item.
Returns true if it should be enabled, otherwise false.
|