namespace sap.ui.mdc.valuehelp

Control sample: sap.ui.mdc.valuehelp
Visiblity:
Available since: N/A
Module:
Application Component: CA-UI5-MDC

Nodes Overview

Node Description
sap.ui.mdc.valuehelp.Dialog

Container for the sap.ui.mdc.ValueHelp element showing a dialog.

sap.ui.mdc.valuehelp.IDialogContainer

Interface for valuehelp containers

sap.ui.mdc.valuehelp.IDialogContent

Interface for valuehelp containers / contents supporting typeahead functionality

sap.ui.mdc.valuehelp.ITypeaheadContainer

Interface for valuehelp containers

sap.ui.mdc.valuehelp.ITypeaheadContent

Interface for valuehelp containers / contents supporting typeahead functionality

sap.ui.mdc.valuehelp.Popover

Container for the sap.ui.mdc.ValueHelp element showing a popover.

sap.ui.mdc.valuehelp.ValueHelpItem

Item object type.

sap.ui.mdc.valuehelp.base
sap.ui.mdc.valuehelp.content

Methods Overview

Method Description

Internal property to allow to bind the paths used by OutParameters to content

Visibility: hidden _valid boolean true

Internal property to allow to bind the valid state to OK Button or make it available for all content controls

Visibility: hidden conditions object[]

The conditions of the selected items.

Note: This property must only be set by the control the ValueHelp element belongs to, not by the application.

Note: A condition must have the structure of ConditionObject.

Visibility: public delegate object ...see text or source Visibility: public filterValue string empty string

The value by which the help is filtered.

Note: This only takes effect if the ValueHelp elements content supports filtering.

Note: This property must only be set by the control the ValueHelp element belongs to, not by the application.

Visibility: public validateInput boolean true

If this property is set, the user input is validated against the value help. If no entry is found for the user input, an error occurs.

If this property is not set, the user input is still checked against the value help. But if no entry is found, the user input is set to the field if the used data type allows this. (A type parsing error is shown if the user input adheres to the requirements of the used data type.)

Visibility: public

Borrowed Properties

Name Type Default Value Description
delegate object

Path to the Delegate module that provides the required APIs to execute model-specific logic.
Note: Ensure that the related file can be requested (any required library has to be loaded before that).
Do not bind or modify the module. This property can only be configured during control initialization.

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
dialog 0..1 sap.ui.mdc.valuehelp.IDialogContainer

Container that is used and opened if the value help icon of the input field is pressed.

inParameters 0..n sap.ui.mdc.field.InParameter

Sets the in parameters of a field help.

If set, the value help reads the data of these entities in the model and uses it to filter in the value help.

Note: In parameters are only used if the content of the value help supports it

outParameters 0..n sap.ui.mdc.field.OutParameter

Sets the out parameters of a field help.

If set, the fields sets the data of these entities in the model based to the selected values.

Note: Out parameters are only used if the content of the value help supports it

typeahead 0..1 sap.ui.mdc.valuehelp.ITypeaheadContainer

Container that is used and opened in typeahead


Events Overview

Event Description
closed

This event is fired after the field help has been closed.

disconnect

This event is fired when the FieldHelp element is disconnected from a control.

Note: This event must only be handled by the control the FieldHelp element belongs to, not by the application.

navigated

This event is fired after the user navigated in the value help.

select

This event is fired when a value is selected in the field help.

Note: This event must only be handled by the control the FieldHelp element belongs to, not by the application.

switchToValueHelp

This event is fired if the user wants to switch from typeahead to value help.

closed

This event is fired after the field help has been closed.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

disconnect

This event is fired when the FieldHelp element is disconnected from a control.

Note: This event must only be handled by the control the FieldHelp element belongs to, not by the application.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

navigated

This event is fired after the user navigated in the value help.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
bLeaveFocus boolean

True if the focus should be set back to the field.

condition object

Navigated condition.

Note: A condition must have the structure of ConditionObject.

itemId string

ID of the navigated item. (This is needed to set the corresponding aria-attribute)

select

This event is fired when a value is selected in the field help.

Note: This event must only be handled by the control the FieldHelp element belongs to, not by the application.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
conditions object[]

The selected conditions

Note: A condition has the structure of ConditionObject.

add boolean

If set, the selected conditions are added by the listening control, otherwise they replace the existing ones

close boolean

Indicator if the field help is closed while selection

switchToValueHelp

This event is fired if the user wants to switch from typeahead to value help.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

Methods Overview

Method Description
addInParameter

Adds some inParameter to the aggregation inParameters.

addOutParameter

Adds some outParameter to the aggregation outParameters.

attachClosed

Attaches event handler fnFunction to the closed event of this sap.ui.mdc.ValueHelp.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.mdc.ValueHelp itself.

This event is fired after the field help has been closed.

attachDisconnect

Attaches event handler fnFunction to the disconnect event of this sap.ui.mdc.ValueHelp.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.mdc.ValueHelp itself.

This event is fired when the FieldHelp element is disconnected from a control.

Note: This event must only be handled by the control the FieldHelp element belongs to, not by the application.

attachNavigated

Attaches event handler fnFunction to the navigated event of this sap.ui.mdc.ValueHelp.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.mdc.ValueHelp itself.

This event is fired after the user navigated in the value help.

attachSelect

Attaches event handler fnFunction to the select event of this sap.ui.mdc.ValueHelp.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.mdc.ValueHelp itself.

This event is fired when a value is selected in the field help.

Note: This event must only be handled by the control the FieldHelp element belongs to, not by the application.

attachSwitchToValueHelp

Attaches event handler fnFunction to the switchToValueHelp event of this sap.ui.mdc.ValueHelp.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.mdc.ValueHelp itself.

This event is fired if the user wants to switch from typeahead to value help.

close

closes the value help.

Note: This function must only be called by the control the ValueHelp element belongs to, not by the application.

connect

Connects the ValueHelp element to a control.

If the ValueHelp element is used as an association to multiple controls, it has to know the currently active control to open and interact.

If the ValueHelp element is connected to a control, the disconnected event is fired to inform the previously connected control.

Note: This function must only be called by the control the ValueHelp element belongs to, not by the application.

destroyDialog

Destroys the dialog in the aggregation dialog.

destroyInParameters

Destroys all the inParameters in the aggregation inParameters.

destroyOutParameters

Destroys all the outParameters in the aggregation outParameters.

destroyTypeahead

Destroys the typeahead in the aggregation typeahead.

detachClosed

Detaches event handler fnFunction from the closed event of this sap.ui.mdc.ValueHelp.

The passed function and listener object must match the ones used for event registration.

detachDisconnect

Detaches event handler fnFunction from the disconnect event of this sap.ui.mdc.ValueHelp.

The passed function and listener object must match the ones used for event registration.

detachNavigated

Detaches event handler fnFunction from the navigated event of this sap.ui.mdc.ValueHelp.

The passed function and listener object must match the ones used for event registration.

detachSelect

Detaches event handler fnFunction from the select event of this sap.ui.mdc.ValueHelp.

The passed function and listener object must match the ones used for event registration.

detachSwitchToValueHelp

Detaches event handler fnFunction from the switchToValueHelp event of this sap.ui.mdc.ValueHelp.

The passed function and listener object must match the ones used for event registration.

sap.ui.mdc.ValueHelp.extend

Creates a new subclass of class sap.ui.mdc.ValueHelp with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.mdc.Element.extend.

fireClosed

Fires event closed to attached listeners.

fireDisconnect

Fires event disconnect to attached listeners.

fireNavigated

Fires event navigated to attached listeners.

fireSelect

Fires event select to attached listeners.

fireSwitchToValueHelp

Fires event switchToValueHelp to attached listeners.

getAriaAttributes

Returns the aria attributes the field needs from the value help

getConditions

Gets current value of property conditions.

The conditions of the selected items.

Note: This property must only be set by the control the ValueHelp element belongs to, not by the application.

Note: A condition must have the structure of ConditionObject.

Default value is [].

getDelegate

Gets current value of property delegate.

Default value is ...see text or source.

getDialog

Gets content of aggregation dialog.

Container that is used and opened if the value help icon of the input field is pressed.

getFilterValue

Gets current value of property filterValue.

The value by which the help is filtered.

Note: This only takes effect if the ValueHelp elements content supports filtering.

Note: This property must only be set by the control the ValueHelp element belongs to, not by the application.

Default value is empty string.

getIcon

Determines the icon for the value help.

getInParameters

Gets content of aggregation inParameters.

Sets the in parameters of a field help.

If set, the value help reads the data of these entities in the model and uses it to filter in the value help.

Note: In parameters are only used if the content of the value help supports it

getItemForValue

Determines the item (key and description) for a given value.

The value help checks if there is an item with a key or description that fits this value.

Note: This function must only be called by the control the ValuedHelp element belongs to, not by the application.

sap.ui.mdc.ValueHelp.getMetadata

Returns a metadata object for class sap.ui.mdc.ValueHelp.

getOutParameters

Gets content of aggregation outParameters.

Sets the out parameters of a field help.

If set, the fields sets the data of these entities in the model based to the selected values.

Note: Out parameters are only used if the content of the value help supports it

getTypeahead

Gets content of aggregation typeahead.

Container that is used and opened in typeahead

getValidateInput

Gets current value of property validateInput.

If this property is set, the user input is validated against the value help. If no entry is found for the user input, an error occurs.

If this property is not set, the user input is still checked against the value help. But if no entry is found, the user input is set to the field if the used data type allows this. (A type parsing error is shown if the user input adheres to the requirements of the used data type.)

Default value is true.

indexOfInParameter

Checks for the provided sap.ui.mdc.field.InParameter in the aggregation inParameters. and returns its index if found or -1 otherwise.

indexOfOutParameter

Checks for the provided sap.ui.mdc.field.OutParameter in the aggregation outParameters. and returns its index if found or -1 otherwise.

initBeforeOpen

Calls initialization of the ValueHelp before the ValueHelp is really opened. This is called in Typeahead on first letter before the ValueHelp is opened with a delay. So the content can be determined in the delegate coding early.

Note: This function must only be called by the control the ValueHelp element belongs to, not by the application.

insertInParameter

Inserts a inParameter into the aggregation inParameters.

insertOutParameter

Inserts a outParameter into the aggregation outParameters.

isFocusInHelp

Determines if the focus is set in the value help or stays in the calling control.

isOpen

Determines if the value help is open.

Note: This function must only be called by the control the ValueHelp element belongs to, not by the application.

isTypeaheadSupported

Determines if the value help should be opened when something is typed into the field.

Opening the value help must be triggered by the control the ValueHelp element belongs to.

Note: This function must only be called by the control the ValueHelp element belongs to, not by the application.

isValidationSupported

Defines if the value help can be used for input validation.

navigate

Triggers navigation in the value help.

As this could be asyncron as data might be loaded a promise is returned.

Note: This function must only be called by the control the ValueHelp element belongs to, not by the application.

onControlChange

Triggers some logic that must be executed in ValueHelp element if a Change event on the connected control is fired.

This is done if the corresponding control value is changed (not during navigation).

Note: This function must only be called by the control the ValueHelp element belongs to, not by the application.

open

Opens the value help for the control to which the ValueHelp element is connected.

Note: This function must only be called by the control the ValueHelp element belongs to, not by the application.

removeAllInParameters

Removes all the controls from the aggregation inParameters.

Additionally, it unregisters them from the hosting UIArea.

removeAllOutParameters

Removes all the controls from the aggregation outParameters.

Additionally, it unregisters them from the hosting UIArea.

removeFocus

The focus visualization of the field help needs to be removed as the user starts typing into the field.

removeInParameter

Removes a inParameter from the aggregation inParameters.

removeOutParameter

Removes a outParameter from the aggregation outParameters.

setConditions

Sets a new value for property conditions.

The conditions of the selected items.

Note: This property must only be set by the control the ValueHelp element belongs to, not by the application.

Note: A condition must have the structure of ConditionObject.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is [].

setDelegate

Sets a new value for property delegate.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is ...see text or source.

setDialog

Sets the aggregated dialog.

setFilterValue

Sets a new value for property filterValue.

The value by which the help is filtered.

Note: This only takes effect if the ValueHelp elements content supports filtering.

Note: This property must only be set by the control the ValueHelp element belongs to, not by the application.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

setTypeahead

Sets the aggregated typeahead.

setValidateInput

Sets a new value for property validateInput.

If this property is set, the user input is validated against the value help. If no entry is found for the user input, an error occurs.

If this property is not set, the user input is still checked against the value help. But if no entry is found, the user input is set to the field if the used data type allows this. (A type parsing error is shown if the user input adheres to the requirements of the used data type.)

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

shouldOpenOnClick

Determines if the value help should be opened when the user clicks into the connected control.

Opening the value help must be triggered by the control the ValueHelp element belongs to.

Note: This function must only be called by the control the ValueHelp element belongs to, not by the application.

skipOpening

Skips the opening of the value help if it is pending because of loading content.

Note: This function must only be called by the control the ValueHelp element belongs to, not by the application.

toggleOpen

Toggles the open state of the value help.

Note: This function must only be called by the control the ValueHelp element belongs to, not by the application.

valueHelpEnabled

If only typeahead is enabled the field should not show a valuehelp icon or open the valuehelp using F4.

addInParameter

Adds some inParameter to the aggregation inParameters.

Param Type DefaultValue Description
oInParameter sap.ui.mdc.field.InParameter

The inParameter to add; if empty, nothing is inserted

addOutParameter

Adds some outParameter to the aggregation outParameters.

Param Type DefaultValue Description
oOutParameter sap.ui.mdc.field.OutParameter

The outParameter to add; if empty, nothing is inserted

attachClosed

Attaches event handler fnFunction to the closed event of this sap.ui.mdc.ValueHelp.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.mdc.ValueHelp itself.

This event is fired after the field help has been closed.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.mdc.ValueHelp itself

attachDisconnect

Attaches event handler fnFunction to the disconnect event of this sap.ui.mdc.ValueHelp.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.mdc.ValueHelp itself.

This event is fired when the FieldHelp element is disconnected from a control.

Note: This event must only be handled by the control the FieldHelp element belongs to, not by the application.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.mdc.ValueHelp itself

attachNavigated

Attaches event handler fnFunction to the navigated event of this sap.ui.mdc.ValueHelp.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.mdc.ValueHelp itself.

This event is fired after the user navigated in the value help.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.mdc.ValueHelp itself

attachSelect

Attaches event handler fnFunction to the select event of this sap.ui.mdc.ValueHelp.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.mdc.ValueHelp itself.

This event is fired when a value is selected in the field help.

Note: This event must only be handled by the control the FieldHelp element belongs to, not by the application.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.mdc.ValueHelp itself

attachSwitchToValueHelp

Attaches event handler fnFunction to the switchToValueHelp event of this sap.ui.mdc.ValueHelp.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.mdc.ValueHelp itself.

This event is fired if the user wants to switch from typeahead to value help.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.mdc.ValueHelp itself

close

closes the value help.

Note: This function must only be called by the control the ValueHelp element belongs to, not by the application.

connect

Connects the ValueHelp element to a control.

If the ValueHelp element is used as an association to multiple controls, it has to know the currently active control to open and interact.

If the ValueHelp element is connected to a control, the disconnected event is fired to inform the previously connected control.

Note: This function must only be called by the control the ValueHelp element belongs to, not by the application.

Param Type DefaultValue Description
oControl sap.ui.core.Control

Control to which the FieldHelp element is connected to

oConfig object

Configuration object that holds needed data of the connected control

destroyDialog

Destroys the dialog in the aggregation dialog.

destroyInParameters

Destroys all the inParameters in the aggregation inParameters.

destroyOutParameters

Destroys all the outParameters in the aggregation outParameters.

destroyTypeahead

Destroys the typeahead in the aggregation typeahead.

detachClosed

Detaches event handler fnFunction from the closed event of this sap.ui.mdc.ValueHelp.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachDisconnect

Detaches event handler fnFunction from the disconnect event of this sap.ui.mdc.ValueHelp.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachNavigated

Detaches event handler fnFunction from the navigated event of this sap.ui.mdc.ValueHelp.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachSelect

Detaches event handler fnFunction from the select event of this sap.ui.mdc.ValueHelp.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachSwitchToValueHelp

Detaches event handler fnFunction from the switchToValueHelp event of this sap.ui.mdc.ValueHelp.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.mdc.ValueHelp.extend

Creates a new subclass of class sap.ui.mdc.ValueHelp with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.mdc.Element.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

fireClosed

Fires event closed to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

fireDisconnect

Fires event disconnect to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

fireNavigated

Fires event navigated to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

bLeaveFocus boolean

True if the focus should be set back to the field.

condition object

Navigated condition.

Note: A condition must have the structure of ConditionObject.

itemId string

ID of the navigated item. (This is needed to set the corresponding aria-attribute)

fireSelect

Fires event select to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

conditions object[]

The selected conditions

Note: A condition has the structure of ConditionObject.

add boolean

If set, the selected conditions are added by the listening control, otherwise they replace the existing ones

close boolean

Indicator if the field help is closed while selection

fireSwitchToValueHelp

Fires event switchToValueHelp to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

getAriaAttributes

Returns the aria attributes the field needs from the value help

Param Type DefaultValue Description
iMaxConditions int

maximal conditions allowed (as FieldHelp might not be connected to a field)

getConditions

Gets current value of property conditions.

The conditions of the selected items.

Note: This property must only be set by the control the ValueHelp element belongs to, not by the application.

Note: A condition must have the structure of ConditionObject.

Default value is [].

getDelegate

Gets current value of property delegate.

Default value is ...see text or source.

getDialog

Gets content of aggregation dialog.

Container that is used and opened if the value help icon of the input field is pressed.

getFilterValue

Gets current value of property filterValue.

The value by which the help is filtered.

Note: This only takes effect if the ValueHelp elements content supports filtering.

Note: This property must only be set by the control the ValueHelp element belongs to, not by the application.

Default value is empty string.

getIcon

Determines the icon for the value help.

getInParameters

Gets content of aggregation inParameters.

Sets the in parameters of a field help.

If set, the value help reads the data of these entities in the model and uses it to filter in the value help.

Note: In parameters are only used if the content of the value help supports it

getItemForValue

Determines the item (key and description) for a given value.

The value help checks if there is an item with a key or description that fits this value.

Note: This function must only be called by the control the ValuedHelp element belongs to, not by the application.

Param Type DefaultValue Description
oConfig object

Configuration

value any

Value as entered by user

parsedValue any

Value parsed by type to fit the data type of the key

inParameters object

In parameters for the key (as a key must not be unique.)

outParameters object

Out parameters for the key (as a key must not be unique.)

bindingContext sap.ui.model.Context

BindingContext of the checked field. Inside a table the ValueHelp element might be connected to a different row.

checkKeyFirst boolean

If set, the value help checks first if the value fits a key // TODO: not longer needed?

checkKey boolean

If set, the value help checks only if there is an item with the given key. This is set to false if the value cannot be a valid key because of type validation.

checkDescription boolean

If set, the value help checks only if there is an item with the given description. This is set to false if only the key is used in the field.

conditionModel sap.ui.mdc.condition.ConditionModel

ConditionModel, in case of FilterField

conditionModelName string

Name of the ConditionModel, in case of FilterField

caseSensitive boolean

If set, the check is done case sensitive

sap.ui.mdc.ValueHelp.getMetadata

Returns a metadata object for class sap.ui.mdc.ValueHelp.

getOutParameters

Gets content of aggregation outParameters.

Sets the out parameters of a field help.

If set, the fields sets the data of these entities in the model based to the selected values.

Note: Out parameters are only used if the content of the value help supports it

getTypeahead

Gets content of aggregation typeahead.

Container that is used and opened in typeahead

getValidateInput

Gets current value of property validateInput.

If this property is set, the user input is validated against the value help. If no entry is found for the user input, an error occurs.

If this property is not set, the user input is still checked against the value help. But if no entry is found, the user input is set to the field if the used data type allows this. (A type parsing error is shown if the user input adheres to the requirements of the used data type.)

Default value is true.

indexOfInParameter

Checks for the provided sap.ui.mdc.field.InParameter in the aggregation inParameters. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oInParameter sap.ui.mdc.field.InParameter

The inParameter whose index is looked for

indexOfOutParameter

Checks for the provided sap.ui.mdc.field.OutParameter in the aggregation outParameters. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oOutParameter sap.ui.mdc.field.OutParameter

The outParameter whose index is looked for

initBeforeOpen

Calls initialization of the ValueHelp before the ValueHelp is really opened. This is called in Typeahead on first letter before the ValueHelp is opened with a delay. So the content can be determined in the delegate coding early.

Note: This function must only be called by the control the ValueHelp element belongs to, not by the application.

Param Type DefaultValue Description
bTypeahead boolean

Flag that determines whether value help is opened for suggestion or for complex help

insertInParameter

Inserts a inParameter into the aggregation inParameters.

Param Type DefaultValue Description
oInParameter sap.ui.mdc.field.InParameter

The inParameter to insert; if empty, nothing is inserted

iIndex int

The 0-based index the inParameter should be inserted at; for a negative value of iIndex, the inParameter is inserted at position 0; for a value greater than the current size of the aggregation, the inParameter is inserted at the last position

insertOutParameter

Inserts a outParameter into the aggregation outParameters.

Param Type DefaultValue Description
oOutParameter sap.ui.mdc.field.OutParameter

The outParameter to insert; if empty, nothing is inserted

iIndex int

The 0-based index the outParameter should be inserted at; for a negative value of iIndex, the outParameter is inserted at position 0; for a value greater than the current size of the aggregation, the outParameter is inserted at the last position

isFocusInHelp

Determines if the focus is set in the value help or stays in the calling control.

isOpen

Determines if the value help is open.

Note: This function must only be called by the control the ValueHelp element belongs to, not by the application.

isTypeaheadSupported

Determines if the value help should be opened when something is typed into the field.

Opening the value help must be triggered by the control the ValueHelp element belongs to.

Note: This function must only be called by the control the ValueHelp element belongs to, not by the application.

isValidationSupported

Defines if the value help can be used for input validation.

navigate

Triggers navigation in the value help.

As this could be asyncron as data might be loaded a promise is returned.

Note: This function must only be called by the control the ValueHelp element belongs to, not by the application.

Param Type DefaultValue Description
iStep int

Number of steps for navigation (e.g. 1 means next item, -1 means previous item)

onControlChange

Triggers some logic that must be executed in ValueHelp element if a Change event on the connected control is fired.

This is done if the corresponding control value is changed (not during navigation).

Note: This function must only be called by the control the ValueHelp element belongs to, not by the application.

open

Opens the value help for the control to which the ValueHelp element is connected.

Note: This function must only be called by the control the ValueHelp element belongs to, not by the application.

Param Type DefaultValue Description
bTypeahead boolean

Flag that determines whether value help is opened for type-ahead or for complex help

removeAllInParameters

Removes all the controls from the aggregation inParameters.

Additionally, it unregisters them from the hosting UIArea.

removeAllOutParameters

Removes all the controls from the aggregation outParameters.

Additionally, it unregisters them from the hosting UIArea.

removeFocus

The focus visualization of the field help needs to be removed as the user starts typing into the field.

removeInParameter

Removes a inParameter from the aggregation inParameters.

Param Type DefaultValue Description
vInParameter int string sap.ui.mdc.field.InParameter

The inParameter to remove or its index or id

removeOutParameter

Removes a outParameter from the aggregation outParameters.

Param Type DefaultValue Description
vOutParameter int string sap.ui.mdc.field.OutParameter

The outParameter to remove or its index or id

setConditions

Sets a new value for property conditions.

The conditions of the selected items.

Note: This property must only be set by the control the ValueHelp element belongs to, not by the application.

Note: A condition must have the structure of ConditionObject.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is [].

Param Type DefaultValue Description
sConditions object[] []

New value for property conditions

setDelegate

Sets a new value for property delegate.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is ...see text or source.

Param Type DefaultValue Description
oDelegate object ...see text or source

New value for property delegate

setDialog

Sets the aggregated dialog.

Param Type DefaultValue Description
oDialog sap.ui.mdc.valuehelp.IDialogContainer

The dialog to set

setFilterValue

Sets a new value for property filterValue.

The value by which the help is filtered.

Note: This only takes effect if the ValueHelp elements content supports filtering.

Note: This property must only be set by the control the ValueHelp element belongs to, not by the application.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

Param Type DefaultValue Description
sFilterValue string ""

New value for property filterValue

setTypeahead

Sets the aggregated typeahead.

Param Type DefaultValue Description
oTypeahead sap.ui.mdc.valuehelp.ITypeaheadContainer

The typeahead to set

setValidateInput

Sets a new value for property validateInput.

If this property is set, the user input is validated against the value help. If no entry is found for the user input, an error occurs.

If this property is not set, the user input is still checked against the value help. But if no entry is found, the user input is set to the field if the used data type allows this. (A type parsing error is shown if the user input adheres to the requirements of the used data type.)

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Param Type DefaultValue Description
bValidateInput boolean true

New value for property validateInput

shouldOpenOnClick

Determines if the value help should be opened when the user clicks into the connected control.

Opening the value help must be triggered by the control the ValueHelp element belongs to.

Note: This function must only be called by the control the ValueHelp element belongs to, not by the application.

skipOpening

Skips the opening of the value help if it is pending because of loading content.

Note: This function must only be called by the control the ValueHelp element belongs to, not by the application.

toggleOpen

Toggles the open state of the value help.

Note: This function must only be called by the control the ValueHelp element belongs to, not by the application.

Param Type DefaultValue Description
bTypeahead boolean

Flag that determines whether value help is opened for type-ahead or for complex help

valueHelpEnabled

If only typeahead is enabled the field should not show a valuehelp icon or open the valuehelp using F4.