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).

Caché & Ensemble 2018.1.5 > Class Reference > ENSLIB namespace > %ZEN.Component.locatorBar


class %ZEN.Component.locatorBar extends %ZEN.Component.component

This component displays a locator bar; a set of links displayed along the top of a page to indicate where the page is located within the application.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property OnDrawBar as %ZEN.Datatype.delegator (FORMALSPEC = "seed:%ZEN.Datatype.string", RETURNTYPE = "%Status");
Optional. Name of Server-side callback method that will inject additional content into the center of the locator bar.
If defined, this callback is invoked on the server when this component is drawn. It provides HTML content by using &html or by using the WRITE command.
This must be the name of a server-only method in the page class that contains this component.
Property methods: OnDrawBarDisplayToLogical(), OnDrawBarGet(), OnDrawBarIsValid(), OnDrawBarLogicalToDisplay(), OnDrawBarLogicalToOdbc(), OnDrawBarNormalize(), OnDrawBarSet()
Optional. Name of Server-side callback method that returns an array of quick links. The array is of the form:
If provided, these are displayed in a dropdown list at the edge of the locator bar.
This must be the name of a server-only method in the page class that contains this view component.
Property methods: OnGetQuickLinksDisplayToLogical(), OnGetQuickLinksGet(), OnGetQuickLinksIsValid(), OnGetQuickLinksLogicalToDisplay(), OnGetQuickLinksLogicalToOdbc(), OnGetQuickLinksNormalize(), OnGetQuickLinksSet()
List of link objects.
Each object specifies a link displayed in the locator bar.
Property methods: linksBuildValueArray(), linksCollectionToDisplay(), linksCollectionToOdbc(), linksDisplayToCollection(), linksGet(), linksGetObject(), linksGetObjectId(), linksGetSwizzled(), linksIsValid(), linksOdbcToCollection(), linksSet(), linksSetObject(), linksSetObjectId()
property seed as %ZEN.Datatype.string (ZENEXPRESSION = 1);
Optional. User-defined seed value. This is an optional parameter that is passed on to the OnDrawBar() callback method.
Property methods: seedDisplayToLogical(), seedGet(), seedIsValid(), seedLogicalToDisplay(), seedLogicalToOdbc(), seedNormalize(), seedSet()

Methods (Including Private)

method %DrawHTML()
Static HTML display method
clientmethod onupdateHandler() [ Language = javascript ]
This client method, if present, is fired when the object is updated from the server.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)