Detail Screen

A detail screen definition displays a single instance of an object, transaction, or fetch on the Agentry Client. The properties of the definition instance are displayed in fields, a child definition to the detail screen. Definable behaviors of a detail screen are predominantly controlled by the screen’s child field and button definitions, which can include read-only or read-write values within the fields, as well as numerous field type behaviors. Detail screens for transactions and fetches do not have the child definition button.

The detail screen definition contains attributes for the screen's caption, enabling and disabling the screen, and the initial focus of the screen. The detail screen is separated into multiple rows and columns, based on the definition. These row and column positions are used to specify the location of fields on the screen.

The values of the definition instance displayed by the detail screen are exposed to the user via the field definitions.

Detail Screen Child Definitions

  • Detail Screen Fields: A detail screen field defines field controls for display on a detail screen to display data to and capture data from the Agentry Client user.
  • Buttons: A button definition defines a button control to be displayed for the screen that will execute an action or display a menu when selected. Detail screens only have button definitions when the parent screen set is defined to display an object.

Detail Screen Attributes

General Settings
  • Name: Internal name for the screen definition. This value must be unique among all screen definitions within the same parent screen set, regardless of screen type.
  • Caption: Labels the tab on the Agentry Client for the detail screen when a part of an object screen set. For transaction a fetch screen sets, the detail screen caption text is displayed in the title bar of the window on the Agentry Client. This value may be set to a rule. This rule is evaluated in the context of the definition instance being displayed, and is expected to return a string value.
  • Screen Icon: This is a reference to an image definition within the application. This image is used as the icon displayed for this screen in tabs.
  • Enable Rule: References a rule definition evaluated in the context of the definition displayed by the parent screen set and expected to return a Boolean value. When the return is false, the screen will be disabled and will not be displayed to the user.
  • Rows: Sets how many rows the screen will contain. This attribute is used to divide the screen into rows, which are referenced by the field definitions to determine the position of each field on the screen. The default settings will vary depending on the platform using the screen. The grid created by the Rows and Columns attributes is not displayed on the screen at run time, but is visible in the Agentry Editor for development purposes.
  • Columns: Sets how many columns the screen will contain. This attribute is used to divide the screen into columns, which are referenced by the field definitions to determine the position of each field on the screen. The default settings will vary depending on the platform using the screen. The grid created by the Rows and Columns attributes is not displayed on the at run time, but is visible in the Agentry Editor for development purposes.s
  • Initial Focus: Sets the field to be the initial focus when the screen is first displayed on the Agentry Client. This attribute requires that fields have been defined for the detail screen.
Detail Screen Style Attributes
  • Screen: The style to apply to the screen as a whole. This will affect all portions of the screen not displaying a field or button.
  • Fields: The style to apply to all fields displayed on the screen.
  • Focused Fields: The style to apply to the field that currently has the focus.
  • Hyperlinks: The style to apply to any labels define to be hyperlinks.
  • Buttons: The style to apply to all buttons on the screen.
  • Focused Buttons: The style to apply to the button that currently has the focus.
Images Attributes
  • Screen Background Image: This attribute allows for the selection of an image definition within the application which is displayed as the background image for the detail screen. This behavior is currently only supported on detail screens used by iOS and Android platforms.
  • Fit to Screen (Lock Aspect Ratio): This attribute specifies that the image should be resized to fit within the viewable area of the screen. The aspect ratio of the original image is maintained. This attribute is mutually exclusive from Fit to Screen (Stretch) and Crop to Screen.
  • Fit to Screen (Stretch): This attribute specifies that the image is to be resized to fit within the viewable area of the screen. The aspect ratio of the original image is not maintained and the image will always fill the entire viewable area of the screen. This attribute is mutually exclusive from Fit to Screen (Lock Aspect Ratio) and Crop to Screen.
  • Crop to Screen: This attribute specifies that the image is to be cropped to fit within the viewable area of the screen. Images larger than the viewable area of the screen will not be fully displayed if this attribute is selected. This attribute is mutually exclusive from Fit to Screen (Lock Aspect Ratio) and Fit to Screen (Stretch).
  • Background Image Position: This attribute specifies the position of the image within the viewable area of the screen. There are nine radio buttons displayed for this attribute, each corresponding to the position of the image on the screen both vertically and horizontally.
  • Field Opacity - Fields Cover Images: This attribute sets the opacity of the image displayed on the screen. If selected, fields on the detail screen will always be displayed on top of the background image. If not selected, the image will overlay the fields on the screen.
Parent topic: Module-Level User Interface Definitions Overview