2022 April Release

Class FSCVAPP@1.1001:ApplicationView Permanent link for this heading

Class Hierarchy

Object > ComponentObject > ApplicationView

Objects of the class ApplicationView ("Application View") describe a user interface element.

Each application view may contain a multilingual name and a more detailed description. These elements may contain patterns, which are substituted by parameter values.

Each application view can specify a view ("View"), which describes the set of data fields presented to the user.

Each application view should specify a list of links ("Branches"). Each branch describes its presentation, function and associated data field. When the user chooses a branch, the associtated statements are executed. Branches are the primary means to model control flow based on user input.

The natural purpose of an application view is to present data to the user. This data can be either editable or read only ("Type of Edit"). The data presented my contain actual data or a query expression to search for data ("Type of Value"). The presented data my be automatically loaded ("Automatic load") and stored ("Automatic Store) by following a root value ("Parameter Name") or it may be loaded and stored by variables or parameters.

If all the data presented to the user is derived from one root object ("Parameter Name") automatic locking may be convenient ("Automatic Lock").

Each data field is displayed in a generic way. If the generic representation is not sufficient, a specific server side control can be used ("Display Controls").

If the application view is marked to catch errors ("Catch errors"), all errors that occurre during the processing of branches of an application view are caught and displayed in the application view.

Additional information about the presentation may be specified ("Display Hints"). Display hints may apply to a specific data field.

Additional Information

Properties Permanent link for this heading

Type

Property

Name

boolean

autoload

Automatic Load

boolean

autolock

Automatic Lock

boolean

autostore

Automatic Store

Branch[]

branches

Branches

Action

branchesfilter

Branch Filter

boolean

catcherrors

Catch Errors

ControlEvent[]

controlevents

Control Events

LanguageStringList[]

description

Description

string

directoryname

Directory Name

Control[]

displaycontrols

Presentations

Hint[]

displayhints

Display Hints

EditType

edittype

Application View Type

content

enterexpr

Prepare Code

string

enterexprtext

Prepare Code (Expression)

Step[]

entersteps

Prepare Statements

ExplanationTextList[]

explanations

Explanation Texts

Application

maximizedsmartapp

Maximized SmartApp

LanguageStringList[]

mlname

Multilingual Name

OverlaySize

overlaysize

Overlay Size

PageMode

pagemode

View Page as

string[]

targetexpr

Parameter Name (Expression)

string

targetname

Parameter Name

TaskPane[]

taskpanes

Task Panes

ValueType

valuetype

Type of Value

ComponentObject

view

View

string[]

viewexpr

View (Expression)

Actions Permanent link for this heading

Return Type

Signature

string

AttrApplyToGetDisp(
  AttributeDefinition attrdef,
  out retval string string,
  optional any value,
  optional Language language,
  optional AttributeDefinition[] attrdeflist,
  optional integer flags,
  optional integer index)

void

Explain(
  object[] attrpath,
  ref Explanation[] explanations)

void

ExplainBranch(
  Branch[] branchobj,
  ref Explanation[] explanations)

void

ExploreNode(
  interface context,
  object dispatcher,
  object node,
  out dictionary[] children,
  optional boolean compoundonly,
  optional SortMode sortmode,
  optional boolean setversions,
  optional dictionary parameters,
  optional dictionary parametersex,
  out object filter)

void

ProcessStep(
  dictionary parameters,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot,
  integer pathdepth,
  EnterType entertype,
  ref LeaveType leavetype,
  Step[] step,
  interface context,
  integer scopedept)