Class sap.ui.comp.smartfield.SmartFieldModule: sap/ui/comp/smartfield/SmartField

Defines whether the control is visible. A fixed or dynamic value can be provided as an enumeration by referencing another Property within the same EntityType. Whenever the value of the referenced property changes to 0 or greater than 0, the visibility is changed. The property visible of the SmartField control can be used to handle the visibility of the control.

XML Example of OData V4 with Hidden Customer and CompanyCode Properties

   <Property Name="Customer">
     <Annotation Term="com.sap.vocabularies.Common.v1.FieldControl" Path="FieldControlValue" />
   </Property>
   <Property Name="CompanyCode">
     <Annotation Term="com.sap.vocabularies.Common.v1.FieldControl" Path="FieldControlValue" />
   </Property>
   <Property Name="FieldControlValue" type="Edm.Byte" />

For OData v2 the sap:visible annotation on the Property can be used to assign visibility.

   <Property Name="Customer" ... sap:visible="false"/>
   <Property Name="CompanyCode" ... sap:visible="false"/>

Refer OData v4 annotations for details about annotations.

Defines whether the control is read-only. The value can be provided as a fixed or dynamic value of an enumeration by referencing another Property within the same EntityType. Whenever the value of the referenced property changes to 1 or greater than 1, the editability is changed. The editable property of the SmartField control renders the field as editable input. A SmartField is only editable if the corresponding EntityType is at least annotated as com.sap.vocabularies.Common.v1.Updatable.

XML Example of OData V4 with Read-only Customer and CompanyCode Properties

   <Property Name="Customer">
     <Annotation Term="com.sap.vocabularies.Common.v1.FieldControl" Path="FieldControlValue" />
   </Property>
   <Property Name="CompanyCode">
     <Annotation Term="FieldControl" Path="FieldControlValue" />
   </Property>
   <Property Name="com.sap.vocabularies.Common.v1.FieldControlValue" type="Edm.Byte" />

For OData v2 the sap:updatable annotation on the Property can be used to render fields in read-only mode.

   <Property Name="Customer" ... sap:updatable="false"/>
   <Property Name="CompanyCode" ... sap:updatable="false"/>

Refer OData v4 annotations for details about annotations.

Defines whether the control is mandatory. The value can be provided as a fixed or dynamic value of an enumeration by referencing another Property within the same EntityType. Whenever the value of the referenced property changes to 7 or less than 7, the mandatory state is changed. The mandatory property of the SmartField control renders the field as mandatory input. A SmartField can only be mandatory if the corresponding EntityType is at least annotated as com.sap.vocabularies.Common.v1.Updatable.

XML Example of OData V4 with Mandatory Customer and CompanyCode Properties

   <Property Name="Customer">
     <Annotation Term="com.sap.vocabularies.Common.v1.FieldControl" Path="FieldControlValue" />
   </Property>
   <Property Name="CompanyCode">
     <Annotation Term="com.sap.vocabularies.Common.v1.FieldControl" Path="FieldControlValue" />
   </Property>
   <Property Name="FieldControlValue" type="Edm.Byte" />

For OData v2 the sap:field-control annotation on the Property can be used to specify whether the field is mandatory.

   <Property Name="Customer" ... sap:field-control="mandatory"/>
   <Property Name="CompanyCode" ... sap:field-control="mandatory"/>

Refer OData v4 annotations for details about annotations.

Determines that a control must not display the actual value in a field with sensitive data, but replace it with a placeholder, for example, *. Use this annotation for sensitive data.

XML Example of OData V4 with Masked Password property

  <Property Name="Password" />
  <Annotations Target="Password" xmlns="http://docs.oasis-open.org/odata/ns/edm">
    <Annotation Term="com.sap.vocabularies.Common.v1.Masked" />
  </Annotations>

Refer OData v4 annotations for details about annotations.

A short, human-readable text suitable for labels on user interfaces. Renders the value associated with the label annotation of a Property, which can be null.

XML Example of OData V4 with CustomerName as Label for Customer

  <Property Name="Customer">
    <Annotation Term="com.sap.vocabularies.Common.v1.Label" Path="CustomerName" />
  </Property>
  <Property Name="CustomerName" type="Edm.String" />

For OData v2 the sap:label annotation on the Property can be used to assign a label.

   <Property Name="Customer" ... sap:label="Customer Name"/>
   <Property >ame="CompanyCode" ... sap:label="Company Code"/>

Refer OData v4 annotations for details about annotations.

A descriptive text for values of the annotated property. Note: The value must be a dynamic expression when used as metadata annotation.

XML Example of OData V4 Text on CustomerName Property

   <Property Name="Customer">
     <Annotation Term="com.sap.vocabularies.Common.v1.Text" Path="CustomerName" />
   </Property>
   <Property Name="CustomerName" type="Edm.String" />

For OData v2 the sap:text annotation on the Property can be used to assign text.

   <Property Name="Customer" ... sap:text="CustomerName"/>
   <Property Name="CustomerName" type="Edm.String"/>

Refer OData v4 annotations for details about annotations.

Describes the arrangement of a code value and its text. The value can be a fixed or dynamic value of an enumeration by referencing another Property within the same EntityType. The enumeration members can have the following possible values:

• com.sap.vocabularies.UI.v1.TextArrangementType/TextFirst
  The underlying control is represented with the specified description followed by its ID.
• com.sap.vocabularies.UI.v1.TextArrangementType/TextLast
  The underlying control is represented with the specified ID followed by its description.

XML Example of OData V4 with TextArrangement on ProductType

   <Annotations Target="ProductType">
     <Annotation Term="com.sap.vocabularies.UI.v1.TextArrangement" EnumMember="UI.TextArrangementType/TextFirst"/>
   </Annotations>

Refer OData v4 annotations for details about annotations.

Defines a currency code for an amount according to the ISO 4217 standard. ISOCurrency annotation can point to a Property, which can also be null.

XML Example of OData V4 with Price and CurrencyCode as ISOCurrency

   <Property Name="Price">
      <Annotation Term="Org.OData.Measures.V1.ISOCurrency" Path="CurrencyCode" />
   </Property>
   <Property Name="CurrencyCode" type="Edm.String" />

For OData v2 the sap:semantics="currency-code" along with sap:unit annotations on the Property can be used to assign a currency code to the field.

   <Property Name="Price" ... sap:unit="CurrencyCode"/>
   <Property Name="CurrencyCode" ... sap:semantics="currency-code"/>

Refer OData v4 annotations for details about annotations.

The unit of measure for this measured quantity, for example, cm for centimeters. Renders the value associated with the unit annotation of a Property, which can be null.

XML Example of OData V4 with OrderedQuantity and OrderedUnit as Unit

   <Property Name="OrderedQuantity">
      <Annotation Term="Org.OData.Measures.V1.Unit" Path="OrderedUnit" />
   </Property>
   <Property Name="OrderedUnit" type="Edm.String" />

For OData v2 the sap:semantics="unit-of-measure" along with sap:unit annotations on the Property can be used to assign a unit of measure to the field.

   <Property Name="OrderedQuantity" ... sap:unit="OrderedUnit"/>
   <Property Name="OrderedUnit" ... sap:semantics="unit-of-measure"/>

Refer OData v4 annotations for details about annotations.

Defines the number of digits that are to be displayed after the decimal point. This annotation can be applied to a Property.

XML Example of OData V4 with Scaled Price and Weight Properties

   <Property Name="Price">
      <Annotation Term="Org.OData.Measures.V1.Scale" Path="PriceScale" />
   </Property>
   <Property Name="Weight">
      <Annotation Term="Org.OData.Measures.V1.Scale" Path="WeightScale" />
   </Property>
   <Property Name="PriceScale" type="Edm.Byte" />
   <Property Name="WeightScale" type="Edm.Byte" />

For OData v2 the sap:precision annotation on the Property can be used to scale the number of digits to be displayed after the decimal point.

   <Property Name="Price" ... sap:precision="2"/>
   <Property Name="Weight" ... sap:precision="3"/>

Refer OData v4 annotations for details about annotations.

A short, human-readable text suitable for tool tips in user interfaces.

XML Example of OData V4 with Tooltip on CompanyCode Property

   <Property Name="CompanyCode">
     <Annotation Term="com.sap.vocabularies.Common.v1.QuickInfo" Path="CompanyCodeQuickInfo" />
   </Property>
   <Property Name="CompanyQuickInfo" type="Edm.String" />

For OData v2 the sap:quickinfo annotation on the Property can be used to assign information relevant for tool tips of the field.

   <Property Name="CompanyCode" ... sap:quickinfo="Company Code quickinfo"/>

Refer OData v4 annotations for details about annotations.

Properties annotated with this annotation are rendered as multi-line text (for example, text area).

XML Example of OData V4 with Multi-line Text Description Property

   <Property Name="Description" />
   <Annotations Target="Description">
      <Annotation Term="com.sap.vocabularies.UI.v1.MultiLineText" />
   </Annotations>

Refer OData v4 annotations for details about annotations.

Defines whether a string value is capitalized.

XML Example of OData V4 with Capitalized Customer and CompanyCode Properties

   <Annotation Term="com.sap.vocabularies.Common.v1.IsUpperCase">
       <Collection>
          <PropertyPath>Customer</PropertyPath>
          <PropertyPath>CompanyCode</PropertyPath>
       </Collection>
   </Annotation>

For OData v2 the sap:display-format="UpperCase" annotation on the Property can be used to render the text in upper case format.

   <Property Name="Customer" ... sap:display-format="UpperCase"/>
   <Property Name="CompanyCode" ... sap:display-format="UpperCase"/>

Refer OData v4 annotations for details about annotations.

Defines whether an EntitySet can be created.

XML Example of OData V4 with Insertable ProductCollection EntitySet

  <EntitySet Name="ProductCollection">
    <Annotation Term="Org.OData.Capabilities.V1.InsertRestrictions">
      <Record>
        <PropertyValue Property="Insertable" Bool="true" />
      </Record>
    </Annotation>
  </EntitySet>

For OData v2 the sap:creatable annotation on the Property can be used to specify that the field is creatable.

   <Property Name="Customer" ... sap:creatable="true"/>
   <Property Name="CompanyCode" ... sap:creatable="true"/>

Refer OData v4 annotations for details about annotations.

Defines whether a Property can be created. A value for this Property is generated on both insert and update actions.

XML Example of OData V4 with Computed Customer and CompanyCode Properties

   <Annotation Term="Org.OData.Core.V1.Computed">
       <Collection>
          <PropertyPath>Customer</PropertyPath>
          <PropertyPath>CompanyCode</PropertyPath>
       </Collection>
   </Annotation>

For OData v2 the sap:creatable and sap:updatable annotation on the Property can be used to specify whether a value has to be created on insert and update actions.

   <Property Name="Customer" ... sap:creatable="true"/>
   <Property Name="CompanyCode" ... sap:creatable="true"/>

Refer OData v4 annotations for details about annotations.

Defines whether an EntitySet can be updated.

XML Example of OData V4 with Updatable ProductCollection EntitySet

  <EntitySet Name="ProductCollection">
    <Annotation Term="Org.OData.Capabilities.V1.UpdateRestrictions">
      <Record>
        PropertyValue Property="Updatable" Bool="true" />
      </Record>
    </Annotation>
  </EntitySet>

For OData v2 the sap:updatable annotation on the Property can be used to specify whether a field is updatable.

   <Property Name="Customer" ... sap:updatable="true"/>
   <Property Name="CompanyCode" ... sap:updatable="true"/>

Refer OData v4 annotations for details about annotations.

A value for this non-key property can be provided on insert and cannot even be changed on update actions.

XML Example of OData V4 with Immutable Customer and CompanyCode properties

   <Annotation Term="Org.OData.Core.V1.Immutable">
       <Collection>
          <PropertyPath>Customer</PropertyPath>
          <PropertyPath>CompanyCode</PropertyPath>
       </Collection>
   </Annotation>

For OData v2 the sap:updatable and sap:creatable annotation on the Property can be used to avoid changes that can be done on update actions.

   <Property Name="Customer" ... sap:creatable="false"/>
   <Property Name="CompanyCode" ... sap:creatable="false"/>

Refer OData v4 annotations for details about annotations.

Changes to the source properties may have side-effects on the target properties or entities. If neither TargetProperties nor TargetEntities are specified, a change to the source property values may have unforeseeable side-effects. An empty NavigationPropertyPath may be used in TargetEntities to specify that any property of the annotated entity type may be affected. Actions are a special case: here the change trigger is the action invocation, so SourceProperties and SourceEntities have no meaning, only TargetProperties and TargetEntities are relevant. They are addressed via the binding parameter of the action. SideEffects can be associated with the given entity, which can be a complex type, entity type or entity set. In addition to this, SideEffects can also be applied to a PropertyPath or a NavigationPropertyPath of the given entity.

XML Example of OData V4 with Side Effect on CurrencyCode Property

  <Annotation Term="com.sap.vocabularies.Common.v1.SideEffects" Qualifier="ExampleQualifierName">
    <Record>
      <PropertyValue Property="SourceProperties">
        <Collection>
          <PropertyPath>CurrencyCode</PropertyPath>
        </Collection>
      </PropertyValue>
      <PropertyValue Property="TargetProperties">
        <Collection>
          <PropertyPath>CurrencyCode</PropertyPath>
        </Collection>
      </PropertyValue>
      <PropertyValue Property="EffectTypes" EnumMember="ValidationMessage" />
    </Record>
  </Annotation>

Refer OData v4 annotations for details about annotations.

Specifies how to get a list of acceptable values for a property or parameter. Provides the value help dialog and type-ahead function.

XML Example of OData V4 Value List on Category Property

   <Annotation Term="com.sap.vocabularies.Common.v1.ValueList">
     <Record>
       <PropertyValue Property="Label" String="Category" />
       <PropertyValue Property="CollectionPath" String="Category" />
       <PropertyValue Property="SearchSupported" Bool="true" />
       <PropertyValue Property="Parameters">
         <Collection>
           <Record Type="com.sap.vocabularies.Common.v1.ValueListParameterOut">
             <PropertyValue Property="LocalDataProperty" PropertyPath="Category" />
             <PropertyValue Property="ValueListProperty" String="Description" />
           </Record>
           <Record Type="com.sap.vocabularies.Common.v1.ValueListParameterDisplayOnly">
             <PropertyValue Property="ValueListProperty" String="CategoryName" />
           </Record>
         </Collection>
       </PropertyValue>
     </Record>
   </Annotation>

Refer OData v4 annotations for details about annotations.