The OutParameter
element is used in the FieldValueHelp element.
Constructor for a new OutParameter
.
The FieldValueHelp element supports out parameters. The binding to the data is defined in this element.
Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.
new sap.ui.mdc.field.OutParameter(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | ID for the new control, generated automatically if no ID is given |
|
mSettings? | object | Initial settings for the new control |
Name | Type | Default Value | Description |
---|---|---|---|
fixedValue | any | Fixed value which is set on the Note: This property is only used if |
|
mode | sap.ui.mdc.enum.OutParameterMode | Always | Update mode of the |
Name | Type | Default Value | Description |
---|---|---|---|
helpPath | string | Name of the field in the This is needed to define the filter for the corresponding field in the help. Visibility: public |
|
initialValueFilterEmpty | boolean | false | If set, an initial value of Note: This property must not be used for FilterField and if bound to ConditionModel. In this case, a filtering for the empty operator must be defined by the assigned conditions. Note: This property must only be set if the data type used supports a filtering for the empty operator. Note: Do not set this property if an empty string is a valid key for the |
value | any | The value of the in parameter. Here the data of the model can be bound. In the FilterField case this is the ConditionModel. Note: Here we recommend one-way-binding. Visibility: public |
Method | Description |
---|---|
sap.ui.mdc.field.OutParameter.extend |
Creates a new subclass of class sap.ui.mdc.field.OutParameter with name
|
getFixedValue |
Gets current value of property fixedValue. Fixed value which is set on the Note: This property is only used if |
sap.ui.mdc.field.OutParameter.getMetadata |
Returns a metadata object for class sap.ui.mdc.field.OutParameter. |
getMode |
Gets current value of property mode. Update mode of the Default value is |
setFixedValue |
Sets a new value for property fixedValue. Fixed value which is set on the Note: This property is only used if When called with a value of |
setMode |
Sets a new value for property mode. Update mode of the When called with a value of Default value is |
Creates a new subclass of class sap.ui.mdc.field.OutParameter 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.field.InParameter.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 |
Gets current value of property fixedValue.
Fixed value which is set on the OutParameter
element.
Note: This property is only used if helpPath
is not set.
Returns a metadata object for class sap.ui.mdc.field.OutParameter.
Gets current value of property mode.
Update mode of the OutParameter
element.
Default value is Always
.
Sets a new value for property fixedValue.
Fixed value which is set on the OutParameter
element.
Note: This property is only used if helpPath
is not set.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
oFixedValue | any |
New value for property |
Sets a new value for property mode.
Update mode of the OutParameter
element.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is Always
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sMode | sap.ui.mdc.enum.OutParameterMode | Always |
New value for property |