This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %CSP.Util.MenuItem

%CSP.Util.MenuItem

serial class %CSP.Util.MenuItem extends %Library.SerialObject, %XML.Adaptor

This class is used internally by Caché. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Defines an item within a Menu for a CSP Menu page.

Property Inventory

Method Inventory

Properties

property Caption as %String (MAXLEN = 100, XMLNAME = "caption", XMLPROJECTION = "attribute");
Value to display for menu item
Property methods: CaptionDisplayToLogical(), CaptionGet(), CaptionIsValid(), CaptionLogicalToDisplay(), CaptionLogicalToOdbc(), CaptionNormalize(), CaptionSet()
property Condition as %String (MAXLEN = 255, XMLNAME = "condition", XMLPROJECTION = "attribute");
(Optional) A COS expression that must evaluate true in order to use this link
Property methods: ConditionDisplayToLogical(), ConditionGet(), ConditionIsValid(), ConditionLogicalToDisplay(), ConditionLogicalToOdbc(), ConditionNormalize(), ConditionSet()
property HREF as %String (MAXLEN = 100, XMLNAME = "link", XMLPROJECTION = "attribute");
URL to go to when menu item is chosen
Property methods: HREFDisplayToLogical(), HREFGet(), HREFIsValid(), HREFLogicalToDisplay(), HREFLogicalToOdbc(), HREFNormalize(), HREFSet()
property Help as %String (MAXLEN = 400, XMLNAME = "help", XMLPROJECTION = "attribute");
Help to display for menu item
Property methods: HelpDisplayToLogical(), HelpGet(), HelpIsValid(), HelpLogicalToDisplay(), HelpLogicalToOdbc(), HelpNormalize(), HelpSet()
property Resource as %String (MAXLEN = 100, XMLNAME = "resource", XMLPROJECTION = "attribute");
(Optional) Resource required in order to use this link
Property methods: ResourceDisplayToLogical(), ResourceGet(), ResourceIsValid(), ResourceLogicalToDisplay(), ResourceLogicalToOdbc(), ResourceNormalize(), ResourceSet()
property Type as %String (VALUELIST = ",link,popup", XMLNAME = "type", XMLPROJECTION = "attribute");
What type of action to perform:
link: link to another page (default).
popup: launch a popup window.
Property methods: TypeDisplayToLogical(), TypeGet(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()

Methods

method GenerateCode() as %String
Utility method to generate code for this object

Inherited Members

Inherited Methods