Renderable Commands

This type of commands generate html tags as rendering result.

Note

The Renderable Commands inherit from CommandBase.

general structure of renderable command
1
2
3
4
5
6
7
8
<basis datamembername="db.user-info" >
   <layout>...</layout>
   <face>...</face>
   <replace>...</replace>
   <divider>...</divider>
   <incomplete>...</incomplete>
   <else-layout>...</else-layout>
</basis>

Attributes

datamembername string required [##-notation

Determine data source name that serve to get source data for use in rendering process. For more information see Data Binding

Tags

layout optional single

Determine output structure of rendering result and add extra tag to beginning or end of generated html tags. Only one layout tag Allowed and default value is @child. For more information see Renderable/Tags/Layout. For example see Use Simple Layout.

face required multi

Determine template for rendering process. At last one face tag required. For more information see Renderable/Tags/Face. For example see Use Simple Face.

replace optional multi

Use this tag add functionality for format some section in face rendering result. Multi replace tag Allowed and default value is null. For more information see Renderable/Tags/Replace. For example see Use Replace.

divider optional single

The divider tag use for determine delimiter content between two data row rendering result. Only one divider tag Allowed and default value is null. For more information see Renderable/Tags/Divider. For example see Use Divider.

incomplete optional single

The incomplete tag use for determine empty cell template when rendering result in some command like view that generate rows with data present as cells like view-card template. Only one incomplete tag Allowed and default value is null. For more information see Renderable/Tags/Incomplete For example see Use Incomplete Tag.

else-layout optional single

The else-layout tag use for determine no-data template when rendering result don’t generate result. Only one else-layout tag Allowed and default value is null. For more information see Renderable/Tags/Else-Layout. For example see Use Else-Layout Tag.

Note

For see more Information about [##-notation,see [-Sharp-Sharp-Notation

Remarks

In renderable command rendering process for create output consist of some steps.

In first step, data source determined by datamembername attribute load from Context. If data not exist, rendering process wait until data loaded in Context.

In next step for each data item (object or row) in data source (collection or table) preferred face selected by checking face related attributes like filter. Order of selecting face is from up to down in order that face declared in command. So in case of two face that pass data item checking, first of them is selected for rendering.

In next step, data injection process run and data item apply to face template using @ Notation.

Note

For more information about face rendering process, see Renderable/Tags/Face.

In next step if replace tags exist and active in face, apply to rendering result and add extra formatting to command output.

Next step use divider and incomplete tags for format output for grid base result.

If generated result til now is empty, else-layout use for generate result.