%ZEN.Component.csMenuItem
deprecated class %ZEN.Component.csMenuItem extends %ZEN.Component.group
%ZEN.Component.csMenuItemProperty Inventory
Method Inventory
Parameters
parameter INCLUDEFILES = zenCSLM.js,zenMenus.js;
Inherited description: CSV list of additional include files (either .js or .css) that
should be included when this component is used on a page.
By default, the file extension (.js or .css) is used to determine whether an item in the list is a script include or a style include. You can override this behavior by adding the terms "script:" or "style:" to the beginning of the file name or names. This prefix is not used as part of the include filename.
By default, the file extension (.js or .css) is used to determine whether an item in the list is a script include or a style include. You can override this behavior by adding the terms "script:" or "style:" to the beginning of the file name or names. This prefix is not used as part of the include filename.
Properties
property altCaption as %ZEN.Datatype.string;
If defined, alternate label for a toggled menu pick
Property methods: altCaptionDisplayToLogical(), altCaptionGet(), altCaptionIsValid(), altCaptionLogicalToDisplay(), altCaptionLogicalToOdbc(), altCaptionNormalize(), altCaptionSet()
property altIcon as %ZEN.Datatype.uri;
URI of alternate image to display under toggled conditions.
Property methods: altIconDisplayToLogical(), altIconGet(), altIconIsValid(), altIconLogicalToDisplay(), altIconLogicalToOdbc(), altIconNormalize(), altIconSet()
property altKey as %ZEN.Datatype.string;
If defined, global keyboard shortcut to invoke alternate behavior
Property methods: altKeyDisplayToLogical(), altKeyGet(), altKeyIsValid(), altKeyLogicalToDisplay(), altKeyLogicalToOdbc(), altKeyNormalize(), altKeySet()
label normally associated with the menu pick
Property methods: captionDisplayToLogical(), captionGet(), captionIsValid(), captionLogicalToDisplay(), captionLogicalToOdbc(), captionNormalize(), captionSet()
property contextKey as %ZEN.Datatype.string;
If defined, keystroke of caption to invoke functionality when
menu is active
Property methods: contextKeyDisplayToLogical(), contextKeyGet(), contextKeyIsValid(), contextKeyLogicalToDisplay(), contextKeyLogicalToOdbc(), contextKeyNormalize(), contextKeySet()
property icon as %ZEN.Datatype.uri;
URI of image to display under normal conditions.
Property methods: iconDisplayToLogical(), iconGet(), iconIsValid(), iconLogicalToDisplay(), iconLogicalToOdbc(), iconNormalize(), iconSet()
property iconDisabled as %ZEN.Datatype.uri;
URI of image to display when option is grayed-out.
Property methods: iconDisabledDisplayToLogical(), iconDisabledGet(), iconDisabledIsValid(), iconDisabledLogicalToDisplay(), iconDisabledLogicalToOdbc(), iconDisabledNormalize(), iconDisabledSet()
property key as %ZEN.Datatype.string;
If defined, global keyboard shortcut to simulate a mouse click
Property methods: keyDisplayToLogical(), keyGet(), keyIsValid(), keyLogicalToDisplay(), keyLogicalToOdbc(), keyNormalize(), keySet()
property onclick as %ZEN.Datatype.eventHandler;
onclick event handler:
This event is fired when the mouse is clicked on the csMenuItem or
when the key or altKey shortcuts have been typed
Property methods: onclickDisplayToLogical(), onclickGet(), onclickIsValid(), onclickLogicalToDisplay(), onclickLogicalToOdbc(), onclickNormalize(), onclickSet()
property toggleMode as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If defined, a flag to indicate that a checkmark (instead of an alternate
caption) should be used to indicate a toggled state of the menu pick
Property methods: toggleModeDisplayToLogical(), toggleModeGet(), toggleModeIsValid(), toggleModeLogicalToDisplay(), toggleModeLogicalToOdbc(), toggleModeLogicalToXSD(), toggleModeNormalize(), toggleModeSet(), toggleModeXSDToLogical()
property toggleState as %ZEN.Datatype.integer [ InitialExpression = 0 ];
If toggleMode is true or an alternate caption has been defined, this flag
is used to indicate the current state of the menu pick. A value of zero
indicates the base state (no check mark visible, primary caption in use).
A value of 1 indicates that either a check mark is visible or the alternate
caption is currently being displayed. This attribute may also be used
to set the initial state of the menu pick.
Property methods: toggleStateDisplayToLogical(), toggleStateGet(), toggleStateIsValid(), toggleStateLogicalToDisplay(), toggleStateLogicalToOdbc(), toggleStateNormalize(), toggleStateSet()
Methods
method %DrawHTML()
Inherited description: Static HTML display method: draw the BODY of this component
as HTML.
Subclasses implement this in order to render the static HTML contents of a component.
Subclasses implement this in order to render the static HTML contents of a component.
clientmethod initializeClientSideProjection() [ Language = javascript ]
Unpack the short form of the widget as dished up by the web server
in to the full DOM subtree used in the browser
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
Inherited Members
Inherited Properties
- %condition
- %import
- %includeFiles
- %page
- %resource
- align
- aux
- cellAlign
- cellSize
- cellStyle
- cellVAlign
- children
- composite
- containerStyle
- disabled
- dragEnabled
- dropEnabled
- enclosingClass
- enclosingStyle
- error
- groupClass
- groupStyle
- height
- hidden
- hint
- hintClass
- hintStyle
- id
- index
- label
- labelClass
- labelDisabledClass
- labelPosition
- labelStyle
- layout
- name
- onafterdrag
- onbeforedrag
- ondrag
- ondrop
- onhide
- onrefresh
- onshow
- onupdate
- parent
- showLabel
- slice
- title
- tuple
- valign
- visible
- width
- window
Inherited Methods
- %AddChild()
- %AddChildAfter()
- %AddChildBefore()
- %AddToSaveSet()
- %Attr()
- %BindExport()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %DrawComponentHTML()
- %DrawJSStrings()
- %EnclosingDivId()
- %Eval()
- %EvalC()
- %Extends()
- %ForceClientRender()
- %GetChildIndex()
- %GetEventHandlers()
- %GetParameter()
- %GetXMLName()
- %IsA()
- %IsModified()
- %MakeId()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OnAddToPageAfter()
- %OnAddToPageBefore()
- %OnDrawEnclosingDiv()
- %OnDrawObjectProperties()
- %OnMutateChildren()
- %OnObjectSynch()
- %OnZENDeserialize()
- %OriginalNamespace()
- %PackageName()
- %QuoteValue()
- %QuoteValueL10N()
- %RemoveChild()
- %RemoveChildren()
- %RemoveFromSaveSet()
- %Self()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- addChild()
- addChildAfter()
- addChildBefore()
- childrenMutated()
- dragFinishHandler()
- dragHandler()
- dragNotifyHandler()
- dragStartHandler()
- dropHandler()
- dropStartHandler()
- exposeComponent()
- findElement()
- fireOnUpdateEvent()
- getChildIndex()
- getEnclosingDiv()
- getHidden()
- getHintElement()
- getLabelElement()
- getProperty()
- getSettings()
- getType()
- invokeSuper()
- isOfType()
- makeId()
- onCreate()
- onDelete()
- onDisplayHandler()
- onEndModalHandler()
- onPopupAction()
- onRefreshContents()
- onSerialize()
- onStartModalHandler()
- ondisabledHandler()
- onunloadHandler()
- onupdateHandler()
- refreshContents()
- removeChild()
- render()
- renderContents()
- renderSVG()
- setHidden()
- setOverlayMode()
- setPropertyAll()
- startProgressBar()
- stopProgressBar()