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 > %SYS namespace > %ZEN.Portal.assistedText

%ZEN.Portal.assistedText

class %ZEN.Portal.assistedText extends %ZEN.Component.control

Property Inventory

Method Inventory

Parameters

parameter DEFAULTCONTROLCLASS = assistedText;
Inherited description: The default css class used for the main element within this control. This is overridden by subclasses.
parameter INCLUDEFILES = zenCSLM.js;
Comma-separated list of additional JS include files for the page.

Properties

property OnUpdateDataServer as %ZEN.Datatype.delegator (FORMALSPEC = "pBase:%String", RETURNTYPE = "%String");
This property has been deprecated. Please use onUpdateDataClient instead.
Property methods: OnUpdateDataServerDisplayToLogical(), OnUpdateDataServerGet(), OnUpdateDataServerIsValid(), OnUpdateDataServerLogicalToDisplay(), OnUpdateDataServerLogicalToOdbc(), OnUpdateDataServerNormalize(), OnUpdateDataServerSet()
property controlType as %ZEN.Datatype.string [ InitialExpression = "custom" ];
Specify the type of the control, it accepts 3 formats: classname - use build in assist for classname property: - use build in assist for property names with the top level context class being custom - this is default, the control calls onUpdateDataClient to populate the selector control
Property methods: controlTypeDisplayToLogical(), controlTypeGet(), controlTypeIsValid(), controlTypeLogicalToDisplay(), controlTypeLogicalToOdbc(), controlTypeNormalize(), controlTypeSet()
property controlWidth as %ZEN.Datatype.string;
This property is obsolete. Please use controlStyle to set width The width of the control, must end in a unit, i.e. 100px or 30%
Property methods: controlWidthDisplayToLogical(), controlWidthGet(), controlWidthIsValid(), controlWidthLogicalToDisplay(), controlWidthLogicalToOdbc(), controlWidthNormalize(), controlWidthSet()
property hideGhost as %ZEN.Datatype.boolean;
This property is obsolete. We do not display ghost text anymore.
Property methods: hideGhostDisplayToLogical(), hideGhostGet(), hideGhostIsValid(), hideGhostLogicalToDisplay(), hideGhostLogicalToOdbc(), hideGhostLogicalToXSD(), hideGhostNormalize(), hideGhostSet(), hideGhostXSDToLogical()
property isSuggestedDataComplete as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
When isSuggestedDataComplete is false, it indicates the string list returned by update data callbacks are partial strings and they are to be appended to the original base string to be used as suggested text. When isSuggestedDataComplete is true, it indicates the string list returned by update data callbacks are complete strings and they do not need to be appended to the original base string. When controlType is either classname or property, isSuggestedDataComplete is ignored. It is assumed to be false.
Property methods: isSuggestedDataCompleteDisplayToLogical(), isSuggestedDataCompleteGet(), isSuggestedDataCompleteIsValid(), isSuggestedDataCompleteLogicalToDisplay(), isSuggestedDataCompleteLogicalToOdbc(), isSuggestedDataCompleteLogicalToXSD(), isSuggestedDataCompleteNormalize(), isSuggestedDataCompleteSet(), isSuggestedDataCompleteXSDToLogical()
property listSize as %ZEN.Datatype.integer (MINVAL = 0) [ InitialExpression = 5 ];
The size (number of lines) of the drop-down area for this assistedText control.
Property methods: listSizeDisplayToLogical(), listSizeGet(), listSizeIsValid(), listSizeLogicalToDisplay(), listSizeLogicalToOdbc(), listSizeNormalize(), listSizeSet()
property onUpdateDataClient as %ZEN.Datatype.eventHandler;
When controlType is custom, this is the client method to call to get data to populate the selector control The format of this attribute is "zenPage.(base);" The client method takes one argument that is the base text. The base text is either empty string or it ends with the trigger character. The return value is a single-character delimited list with the delimiter character as the first character.
Property methods: onUpdateDataClientDisplayToLogical(), onUpdateDataClientGet(), onUpdateDataClientIsValid(), onUpdateDataClientLogicalToDisplay(), onUpdateDataClientLogicalToOdbc(), onUpdateDataClientNormalize(), onUpdateDataClientSet()
property placeholder as %ZEN.Datatype.string;
The placeholder attribute specifies a short hint that describes the expected value of an input field (e.g. a sample value or a short description of the expected format). The hint is displayed in the input field when it is empty.
Property methods: placeholderDisplayToLogical(), placeholderGet(), placeholderIsValid(), placeholderLogicalToDisplay(), placeholderLogicalToOdbc(), placeholderNormalize(), placeholderSet()
property triggerChars as %ZEN.Datatype.string [ InitialExpression = "." ];
list of characters that triggers the calls to update data. When controlType is either classname or property, triggerChars is ignored. It is assumed to be the dot character.
Property methods: triggerCharsDisplayToLogical(), triggerCharsGet(), triggerCharsIsValid(), triggerCharsLogicalToDisplay(), triggerCharsLogicalToOdbc(), triggerCharsNormalize(), triggerCharsSet()

Methods

method %DrawHTML()
Draw content of control.
classmethod ServerGetClassPackageList(pBase As %String) as %String [ ZenMethod ]
classmethod ServerGetPropertyList(pBase As %String, pClassname As %String) as %String [ ZenMethod ]
clientmethod controlClicked() [ Language = javascript ]
clientmethod controlGotFocus() [ Language = javascript ]
clientmethod controlKeyPressed(event) [ Language = javascript ]
clientmethod controlOnBlur(event) [ Language = javascript ]
clientmethod deferredComboUpdate() [ Language = javascript ]
clientmethod deferredEscapeAction() [ Language = javascript ]
clientmethod deferredLostFocus() [ Language = javascript ]
clientmethod deferredSaveCurrentTextValue(keyCode) [ Language = javascript ]
clientmethod doAction(skipModifiedCheck) [ Language = javascript ]
clientmethod getSelection(ctrl) [ Language = javascript ]
clientmethod onCreate() [ Language = javascript ]
client-side initialization for this object.
clientmethod selectorChanged() [ Language = javascript ]
clientmethod selectorDblClicked() [ Language = javascript ]
clientmethod selectorGotFocus() [ Language = javascript ]
clientmethod setComboOptions(combo, options, insertBlank) [ Language = javascript ]
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
clientmethod setSelection(ctrl, pos1, pos2) [ Language = javascript ]
clientmethod setSelectorStyle() [ Language = javascript ]
clientmethod updateData(base) [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

Feedback