EntityView properties
Version:
The following table describes the properties of an EntityView, as defined in the EntityView model:
| Property | Description |
|---|---|
Name | Logical name of the view (string). |
DisplayName | Localized name of the view (string). |
EntityId | Most views are centered on a particular underlying CommerceEntity. This EntityId represents the ID of that Commerce Entity (string). |
EntityVersion | The version of the entity that the view corresponds to. |
Action | Represents an action to be performed. In some cases, EntityViews are retrieved, modified, and then submitted back as an action. This provides a task-based API for the Business User tooling (string). |
ItemId | In some cases, an EntityView represents a single row among many in a list view. In the case where another level of ID is needed to further target a particular row, ItemId is used for this (string). |
Properties | A list of ViewProperty objects. This represents individual properties that will display in the view. The Business Tool has generic functionality to create a display based on the properties of the View (list |
ChildViews | Views are progressively built up as a main view and a set of child views, allowing for more complex displays. |
SelectedChildView | The child view to act upon. |
DisplayRank | Allows you to influence the order of child views in a composite view. Lower display ranks result in higher display position in the composite view. All EntityViews default to a rank of 500. |
UiHint | A UiHint is intended to be a design-agnostic hint to the front-end on how to display the view. Used to render the view in a specific way. The view can be displayed as a flat list of properties, or it can designate that underlying child views represent a list to be displayed using a listing metaphor. |
Icon | Allows an icon to be associated with a view. |
If you have suggestions for improving this article, let us know!