Object Class Form Page (COOATTREDIT@1.1:FormPage)

Object Class Hierarchy

COOSYSTEM@1.1:Object > COOSYSTEM@1.1:ComponentObject > COOATTREDIT@1.1:FormPage

An object of the class FormPage ("Editor Page") defines a page of an edit form which is used by the Property Editor and the Search. Only the items of the page that belong to the object class the page is used for, and that are visible and readable are displayed on the page. Besides each item is displayed once, even if it is an element of several pages. An object of this class stores information like the title and the small icon of the page, the displayed items, the display items filter, the change notification callback and the help context of the page.

Additional Information

Abstract: false
Base Class: COOSYSTEM@1.1:ComponentObject
Compound: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL

Properties

ReferenceName
COOATTREDIT@1.1:formpagedescriptionDescription
COOATTREDIT@1.1:formpageisposterDisplay as Form Header
COOATTREDIT@1.1:formpageisposterwidgetDisplay as Poster Widget
COOATTREDIT@1.1:formpageitemactionDisplay Items Filter
COOATTREDIT@1.1:formpageitemsDisplay Items
COOATTREDIT@1.1:formpagelabelPage Title
COOATTREDIT@1.1:formpagelabeldisplayeffectexprExpression for Computing the Display Effect of the Page Title
COOATTREDIT@1.1:formpagelabelfonteffectexprExpression for Computing the Font Effect of the Page Title
COOATTREDIT@1.1:formpagelayoutLayout
COOATTREDIT@1.1:formpagemiconSymbol of Page
COOATTREDIT@1.1:formpagepositionForm Page Position
COOATTREDIT@1.1:formpagevisibleexprExpression for Computing the Visibility
COOATTREDIT@1.1:formpagewidgetdimensionWidget Dimension
COOATTREDIT@1.1:formpagewidgethidecountHide Count on Widget
COOATTREDIT@1.1:formpagewidgettaskWidget Task
COOSYSTEM@1.1:explanationsExplanation Texts
COOSYSTEM@1.1:mlnameMultilingual Name

Actions

ReferenceName
COOATTREDIT@1.1:SetPageItems
FSCCONFIG@1.1001:EvaluateGenericSymbolGet
FSCUSERFORMS@1.1001:Cleanup
FSCUSERFORMS@1.1001:ObjectCommittedPostWrapper

Properties

COOATTREDIT@1.1:formpagedescription (Description)

The multi-lingual string property formpagedescription provides additional hints and instructions to the user if these are necessary for filling out the data or for finishing the use case.
If COOATTREDIT@1.1:formpagedescription is not set, the property FSCVAPP@1.1001:description of the dialog (FSCVAPP@1.1001:ApplicationView) is used.
Placeholders (like "This will delete all versions of \"<~cooobj.objname ~>\" and cannot be undone!") can be used in this property.

Additional Information

Type: COOSYSTEM@1.1:LanguageStringList
Multiple Values (Overrides Type): true
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOATTREDIT@1.1:formpageisposter (Display as Form Header)

Additional Information

Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Obsolete: true
Changeable in Installed Component: true


[top]

COOATTREDIT@1.1:formpageisposterwidget (Display as Poster Widget)

Additional Information

Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOATTREDIT@1.1:formpageitemaction (Display Items Filter)

The property formpageitemaction ("Display Items Filter") stores the method used as the display items filter. This method can change the item list of the page.

Additional Information

Search for Allowed Classes Only: true
Type: COOSYSTEM@1.1:OBJECT
Changeable: true
Visible: true
Must Be Defined: false
Possible Object Class: COOSYSTEM@1.1:Action
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOATTREDIT@1.1:formpageitems (Display Items)

The property formpageitems ("Display Items") stores the list of items that are displayed with this editor page.

Additional Information

Type: COOATTREDIT@1.1:PageItemList
Multiple Values (Overrides Type): true
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Action Called Before Property Is Saved: COOSYSTEM@1.1:AttrCompContentSet
Changeable in Installed Component: true


[top]

COOATTREDIT@1.1:formpagelabel (Page Title)

The multi-lingual string property formpagelabel stores the tab name of the page on multi-page dialogs.
On a single page dialog it stores a heading for the dialog. In the heading you should prompt the user to execute something (e.g. "Choose the versions you want to delete."), ask a question (e.g. "Which version of "My Doc" do you want to view?"), or describe the action in more detail. If possible the heading should fit into one line but it must differ from the title. You may include the name of the object into the heading.
Place holders (like "Which version of \"<~cooobj.objname~>\" do you want to view?") can be used in this property.
Note: The heading is not shown if it is empty, on confirm dialogs and if it has the same value as the title (see: COOATTREDIT@1.1:formcaption).

Additional Information

Type: COOSYSTEM@1.1:LanguageStringList
Multiple Values (Overrides Type): true
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOATTREDIT@1.1:formpagelabeldisplayeffectexpr (Expression for Computing the Display Effect of the Page Title)

Expression for computing the font effect for the label of the form page. ::root contains the object the expression is evaluated for. ::root is identical to cooobj.
::isvalue contains true if the form is used for displaying values (edit mode or read-only mode) opposed to query mode (see FSCVAPP@1.1001:valuetype in FSCVAPP@1.1001:ApplicationView).
::isedit contains true if the form is in edit mode opposed to read-only mode (see FSCVAPP@1.1001:edittype in FSCVAPP@1.1001:ApplicationView). ::isedit is only valid if ::isvalue is true.
::iseditcommon contains true if the form is used to edit common properties of multiple objects. ::iseditcommon is only valid if ::isvalue is true. In this case ::root/cooobj refer to the first object of the selection.
::isdashboard contains true if the page is displayed in a dashboard.
::issingleattribute contains true if the page is displayed in single attribute mode, i. e. when all other properties of a form page are hidden.
::container contains the form object respectively the formpage object.
::context contains the view action which is used to determine the form. Typical view actions are:

Additional Information

Changeable in Installed Component: true
Action Called Before Property Is Saved: COOSYSTEM@1.1:AttrExprCheckSet
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:STRINGLIST
Parameter Passing: PARSCOPE_GLOBALSCOPEWITHDICTIONARY
Maximum Length: 254
Changeable: true
Must Be Defined: false
Visible: true


[top]

COOATTREDIT@1.1:formpagelabelfonteffectexpr (Expression for Computing the Font Effect of the Page Title)

Expression for computing the font effect for the label of the form page. ::root contains the object the expression is evaluated for. ::root is identical to cooobj.
::isvalue contains true if the form is used for displaying values (edit mode or read-only mode) opposed to query mode (see FSCVAPP@1.1001:valuetype in FSCVAPP@1.1001:ApplicationView).
::isedit contains true if the form is in edit mode opposed to read-only mode (see FSCVAPP@1.1001:edittype in FSCVAPP@1.1001:ApplicationView). ::isedit is only valid if ::isvalue is true.
::iseditcommon contains true if the form is used to edit common properties of multiple objects. ::iseditcommon is only valid if ::isvalue is true. In this case ::root/cooobj refer to the first object of the selection.
::isdashboard contains true if the page is displayed in a dashboard.
::issingleattribute contains true if the page is displayed in single attribute mode, i. e. when all other properties of a form page are hidden.
::container contains the form object respectively the formpage object.
::context contains the view action which is used to determine the form. Typical view actions are:

Additional Information

Changeable in Installed Component: true
Action Called Before Property Is Saved: COOSYSTEM@1.1:AttrExprCheckSet
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:STRINGLIST
Parameter Passing: PARSCOPE_GLOBALSCOPEWITHDICTIONARY
Maximum Length: 254
Changeable: true
Must Be Defined: false
Visible: true


[top]

COOATTREDIT@1.1:formpagelayout (Layout)

Additional Information

Type: COOSYSTEM@1.1:CONTENT
Changeable: true
File Extension: xml
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: false


[top]

COOATTREDIT@1.1:formpagemicon (Symbol of Page)

The property formpagemicon ("Icon of Page") stores the small icon of the page.

Additional Information

Search for Allowed Classes Only: true
Type: COOSYSTEM@1.1:OBJECT
Changeable: true
Visible: true
Must Be Defined: false
Possible Object Class: COOSYSTEM@1.1:ComponentObject
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOATTREDIT@1.1:formpageposition (Form Page Position)

Defines whether the form page is displayed as form header (POS_TOP) or footer (POS_BOTTOM).

Additional Information

Type: COOATTREDIT@1.1:Position
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOATTREDIT@1.1:formpagevisibleexpr (Expression for Computing the Visibility)

Expression for computing the visibility of the form page.
::root contains the object the expression is evaluated for. ::root is identical to cooobj.
::isvalue contains true if the form is used for displaying values (edit mode or read-only mode) opposed to query mode (see FSCVAPP@1.1001:valuetype in FSCVAPP@1.1001:ApplicationView).
::isedit contains true if the form is in edit mode opposed to read-only mode (see FSCVAPP@1.1001:edittype in FSCVAPP@1.1001:ApplicationView). ::isedit is only valid if ::isvalue is true.
::iseditcommon contains true if the form is used to edit common properties of multiple objects. ::iseditcommon is only valid if ::isvalue is true. In this case ::root/cooobj refer to the first object of the selection.
::isdashboard and ::iscalcwidget are used to determine whether a dashboard will be visible or not:
First, the expression is called to determine if the page should be displayed in the dashboard.
In that case the global scope contains these values:
::isdashboard == false
::iscalcwidget == true
After that, the pages for the dashboard widgets itself are calculated:
::isdashboard == true
::iscalcwidget == true
When the page is displayed in explore mode, the global scope contains:
::isdashboard == false
::iscalcwidget == false
::iscalccelledit contains true if the expression is evaluated to determine the page for editing in a cell (F2).
::issingleattribute contains true if the expression is evaluated to determine whether the page in displayed in single attribute mode, i. e. when all other properties of a form page are hidden. Single attribute mode is used to edit a value like an aggregate or a list in a form initialized by editing in a cell (F2) or when showing a zoomed list by selecting "Show detail" on an overview page.
::container contains the form object respectively the formpage object.
::context contains the view action which is used to determine the form. Typical view actions are:

Additional Information

Multiple Values (Overrides Type): false
Changeable in Installed Component: true
Action Called Before Property Is Saved: COOSYSTEM@1.1:AttrExprCheckSet
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:STRINGLIST
Parameter Passing: PARSCOPE_GLOBALSCOPEWITHDICTIONARY
Result Type: COOSYSTEM@1.1:BOOLEAN
Maximum Length: 254
Changeable: true
Must Be Defined: false
Visible: true


[top]

COOATTREDIT@1.1:formpagewidgetdimension (Widget Dimension)

The property formpagewidgetdimension defines the dimension of the formpage, when it is displayed in a widget inside a dashboard.

Additional Information

Type: COOATTREDIT@1.1:WidgetDimension
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOATTREDIT@1.1:formpagewidgethidecount (Hide Count on Widget)

The property formpagewidgethidecount forces to hide the number of entries in large widgets.

Additional Information

Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOATTREDIT@1.1:formpagewidgettask (Widget Task)

The property formpagewidgettask defines a task which is used to overwrite the "View" branch action in the widget header. So it is possible to view a custom object. To do this it, is recommended to implement a direct menu usecase with "TRANSACTION_NEW". To switch to the custom object the "NavigateTo" event can be used. If a "NavigateTo" call is used, it is not allowed to display additional dialogs in this application, because the stack cannot be reconstructed for further calls inside the widget. If it is absolutely necessary to trigger a GUI next to the NavigateTo when clicking on the widget, this can be done by calling an application running in a new window.

Additional Information

Search for Allowed Classes Only: true
Type: COOSYSTEM@1.1:OBJECT
Changeable: true
Visible: true
Must Be Defined: false
Possible Object Class: COOSYSTEM@1.1:ComponentObject
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

COOSYSTEM@1.1:explanations (Explanation Texts)

Additional Information

Type: COOSYSTEM@1.1:ExplanationTextList
Multiple Values (Overrides Type): true
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Action Called Before Property Is Saved: COOSYSTEM@1.1:AttrCompContentSet
Changeable in Installed Component: true


[top]

COOSYSTEM@1.1:mlname (Multilingual Name)

Stores the multilingual name of the object. It stores one name for each supported language.

Additional Information

Changeable in Installed Component: true
Action to Get Display String of Property: COOSYSTEM@1.1:AttrGetDisp
Action Called Before Property Is Saved: COOSYSTEM@1.1:AttrObjNameBuildSet
Multiple Values (Overrides Type): true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:LanguageStringList
Secured: true
Changeable: true
Must Be Defined: false
Visible: true


[top]

Actions

COOATTREDIT@1.1:SetPageItems

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCCONFIG@1.1001:EvaluateGenericSymbolGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCUSERFORMS@1.1001:Cleanup

Deletes all objects assigned with an object referenced in a user form.
ParameterTypeIn/OutOptionalDescription
formCOOSYSTEM@1.1:OBJECTintrue the form is used to restore the original reference based on the form reference and the id for attributes and types
releaseCOOSYSTEM@1.1:BOOLEANintrue true to cleanup the object for released user forms

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCUSERFORMS@1.1001:ObjectCommittedPostWrapper

Extends prerequisite of software component.
ParameterTypeIn/OutOptionalDescription
attrlistCOOSYSTEM@1.1:OBJECTLISTinfalse
changedatCOOSYSTEM@1.1:DATETIMEinfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]