Skip to content

Latest commit

 

History

History
78 lines (50 loc) · 2.83 KB

Use_Stable_IDs_79e910e.md

File metadata and controls

78 lines (50 loc) · 2.83 KB
loio
79e910e6a0d949c7acb051b33170bebc

view on: demo kit nightly build | demo kit latest release

Use Stable IDs

If you keep the IDs of controls, elements, and components stable, you can be sure that other OpenUI5 features will be able to identify them correctly during processing.

Background

OpenUI5 generates IDs for controls, elements, or components dynamically if you don't set them yourself. This sounds convenient, but might lead to problems when the corresponding elements are processed later on by other OpenUI5 features. So it's a good idea to use stable IDs instead of dynamic IDs.

How to Make IDs Stable

For this, you use the id property or attribute of the respective element. For a list of the elements for which you can set stable ID, see the related link below.

Here's an example of an XML view without stable IDs:

<mvc:View
	xmlns="sap.m"
	xmlns:mvc="sap.ui.core.mvc">
	<Page>
		<content>
			<Table>
			</Table>
		</content>
	</Page>
</mvc:View>

At runtime, the Page and the Table would get dynamically generated IDs like __page0 and __table0. However, these generated IDs can change whenever the control structure of the app changes.

If you define stable IDs for the two controls in the example above, it could look like this:

<mvc:View
	xmlns="sap.m"
	xmlns:mvc="sap.ui.core.mvc">
	<Page id="page">
		<content>
			<Table id="table">
			</Table>
		</content>
	</Page>
</mvc:View>

The controls will now always be identified by these IDs.

In the case of views, the sequence of instantiation also plays a role: If there are two views with unstable IDs in the app, they get the generated IDs __view0 and __view1 depending on the order the views are opened. This makes it impossible to correctly identify them when they are processed by other features.

Tip:

You should choose a semantic name for your IDs that makes it easier for you to identify them later.

For more information about naming restrictions, some testing options to check for unstable IDs, as well as the features that require stable IDs, see the related link below.

Related Information

Stable IDs: All You Need to Know