Version: 8.2

diff property

Level: intermediate

note

The functionality is relevant to Classic UI.

The diff property of the client schema contains an array of configuration objects with their properties.

Properties

operation

Operation on elements.

Available values

set	Setsthe schema element to the value determined by the `values` parameter.
merge	Merges the values from the parent, replaced, and replacing schemas. The properties from the `values` parameter of the last descendant override the other values.
remove	Deletes the element from the schema.
move	Moves the element to a different parent element.
insert	Adds the element to the schema.

name

The name of the schema element on which the operation is run.

parentName

The name of the parent schema element where to place the element during the insert operation, or to which to move the element during the move operation.

propertyName

The name of the parent element parameter for the insert operation. Also used in the remove operation when only certain element parameters must be removed rather than the entire element.

index

The index to which to move or add the parameter. Use the parameter with the insert and move operations. If the parameter is not specified, then insert is the last element of the array.

values

An object whose properties to set or combine with the properties of the schema element. Use with set, merge and insert operations.

The Terrasoft.ViewItemType enumeration represents the set of basic elements that can be displayed on the page

Available values (ViewItemType)

GRID_LAYOUT	0	A grid element that includes the placement of other controls.
TAB_PANEL	1	A set of tabs.
DETAIL	2	Detail
MODEL_ITEM	3	View model element.
MODULE	4	Module.
BUTTON	5	Button.
LABEL	6	Caption.
CONTAINER	7	Containers.
MENU	8	Drop-down list.
MENU_ITEM	9	Drop-down list element.
MENU_SEPARATOR	10	Drop-down list separator.
SECTION_VIEWS	11	Section views.
SECTION_VIEW	12	Section view.
GRID	13	List.
SCHEDULE_EDIT	14	Scheduler.
CONTROL_GROUP	15	Element group.
RADIO_GROUP	16	Switcher group.
DESIGN_VIEW	17	Configurable view.
COLOR_BUTTON	18	Color.
IMAGE_TAB_PANEL	19	A set of tabs with icons.
HYPERLINK	20	Hyperlink.
INFORMATION_BUTTON	21	Info button that has a tooltip.
TIP	22	Tooltip.
COMPONENT	23	Component.
PROGRESS_BAR	30	Indicator.

alias

Configuration object.

alias object properties

name	The name of the element to which the new element is connected. Creatio will use this name to locate the elements in the replaced schemas and to connect the elements with the new element. The `name` property of the `diff` revision array element cannot equal the `alias.name` property.
excludeProperties	An property array of the `values` object of the element from the `diff` modification array. The properties will not be applied when building `diff`.
excludeOperations	An array of operations that must not be applied to this element when building the `diff` array of modifications.

Use example

Example that uses the alias object
/* diff array. */
diff: /**SCHEMA_DIFF*/ [
    {
        /* The operation to perform on the element. */
        "operation": "insert",
        /* New name. */
        "name": "NewElementName",
        /* Element value. */
        "values": {
            /* ... */
        },
        /* alias configuration object. */
        "alias": {
            /* The previous name of the element. */
            "name": "OldElementName",
            /* An array of excluded properties. */
            "excludeProperties": "layout", "visible", "bindTo" ],
            /* An array of ignored operations. */
            "excludeOperations": [ "remove", "move", "merge" ]
        }
    },
    /* ... */
]

Properties​

Properties