Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Operations Management Interface

More information about ContentPresenterApp properties

More information about ContentPresenterApp properties

  • Last UpdatedOct 11, 2024
  • 11 minute read

ContentPresenterApp properties can be shown in the Layout or ViewApps editors by placing the ContentPresenterApp on a layout pane. After selecting the app, its properties appear on the Properties page by the functional groups shown in the following table.

Some combinations of property values are invalid. When a configuration error occurs, an error dialog appears when the ViewApp is deployed and starts running. The ContentPresenterApp view port never appears in the layout pane of the running ViewApp. For more information, see ContentPresenterApp property validation.

Filter Properties

Follow Current Context

Determines if the currently selected node will be used as starting point for searching assets at run time.

  • If enabled (default), the asset corresponding to the currently selected node is used the starting point for search.

  • If disabled, the configured Navigation Start Node is used as the starting point for search.

    Note: You must configure Navigation Start Node if this property is disabled.

    Table

    Data Type: Boolean ½ Default Value: True ½ Runtime Property: No

    Scriptable: Yes ½ Bindable: Yes

Content Type

A drop-down list that shows the different types of graphic content that can be shown in the ContentPresenterApp. Any is the default, which displays all graphic content types.

If one or more specific content types are selected, the ContentPresenterApp restricts the display to only those graphic items that have a matching ContentType property value assigned from the Graphic Editor.

Use a comma as the delimiter to separate multiple content types in the Content Type field, for example:
Any,Overview,Detailed,Faceplate

See ContentType property for more information.

Table

Data Type: Enum ½ Default Value: Any ½ Runtime Property: No

Scriptable: Yes ½ Bindable: Yes

Name Contains

Filter to restrict the graphic items shown in the ContentPresenterApp to those graphics whose names match the search string entered as the Name Contains value. * is the default, which shows all graphics.

Asterisk (*) and question mark (?) wildcard characters can be entered as placeholder character replacements in the search string.

Table

Data Type: String ½ Default Value: * ½ Runtime Property: No

Scriptable: Yes ½ Bindable: Yes

Search Child Levels

Determines the depth of the child hierarchy to be traversed for content search. This property is only used if “Child Levels” is selected under Navigation Search Options. Options are:

  • Unconfigured: Navigation search options will function in legacy mode, and the legacy search properties Search Levels and Navigation Search Mode will be be automatically converted to their current equivalents (Search Child Levels and Navigation Search Options).

    Note: Legacy properties are deprecated as of the System Platform 2023 release. Legacy mode and legacy search properties are described below, towards the end of this table.

  • All: Searches all levels of the hierarchy below the currently-selected node.

  • OneLevel: Searches only the level of the hierarchy immediately below the level of the currently-selected node.

  • TwoLevels: Searches the two levels of the hierarchy immediately below the level of the currently-selected node.

    ThreeLevels: Searches the three levels of the hierarchy immediately below the level of the currently-selected node.

    Note: To include the current level of the hierarchy in searches, you must also enable the "Siblings" option in Navigation Search Options.

    Table

    Data Type: Enum ½ Default Value: Unconfigured ½ Runtime Property: No

    Scriptable: Yes ½ Bindable: Yes

Navigation Search Options

Determines which navigation search option(s) is/are enabled. Multiple search options can be selected.

  • Unconfigured: Navigation search options will function in legacy mode, and the legacy search properties Search Levels and Navigation Search Mode will be be automatically converted to their current equivalents (Search Child Levels and Navigation Search Options).

    Note: Legacy properties are deprecated as of the System Platform 2023 release. Legacy mode and legacy search properties are described below, towards the end of this table.

  • StartNode: Search begins from a node, either specified by the Current Asset, or by the navigation path configured in the NavigationStartNode property.

  • Siblings: Search begins from the sibling node of a StartNode and traverses all siblings of the start node.

  • ChildLevels: Searches Child Nodes to the depth specified by the SearchChildLevels property.

    Table

    Data Type: Enum ½ Default Value: Unconfigured ½ Runtime Property: No

    Scriptable: Yes ½ Bindable: Yes

Navigation Start Node

The node in the ViewApp's navigation model to start the search for graphic items to be shown in the ContentPresenterApp. \\Home is the default starting node.

The starting node is always expressed as the navigation item pathway in the form:

\\StartNode\node1\node2\node3

Navigation Search Mode must be set to FixedLocation to enable the Navigation Start Node property.

Navigation Start Node is a bindable/run-time property that can be bound to a data reference, and the value can be changed dynamically at run time. See Navigation Start Node property for more information.

Table

Data Type: String ½ Default Value: \\Home ½ Runtime Property: No

Scriptable: Yes ½ Bindable: Yes

Sort by Alphabetic Order

When selected, the ContentPresenterApp displays graphics in ascending alphabetic order by name.

Table

Data Type: Boolean ½ Default Value: False ½ Runtime Property: No

Scriptable: Yes ½ Bindable: Yes

Layout Properties

Fill

Options to set vertical or horizontal fill order of graphics shown in the ContentPresenterApp. Horizontal fill order is left to right within the view port. Vertical fill order is top to bottom within the view port. Horizontal is the default.

See Layout properties for more information about the fill order of content.

Table

Data Type: Enum ½ Default Value: Horizontal ½ Runtime Property: No

Scriptable: Yes ½ Bindable: Yes

View Mode

Determines the organization of graphic items shown within the viewer port of the ContentPresenterApp.

  • ListContent: Graphic items are shown in the ContentPresenterApp as a continuous sequential list. Based on the value specified for the Fill property, the list is arranged in vertical or horizontal order. The default view mode.

    Scroll bars appear when the graphic list extends beyond the borders of the view port.

  • WrapContent: Graphics are listed in the fill direction until a graphic does not fit within the border of the view port. The graphic then wraps to the next column or row within the view port. Scroll bars appear when the graphic item list extends beyond the view port borders.

  • GridContent: Use of GridContent mode is NOT recommended. This mode has been deprecated, but is retained to support ViewApps developed with an earlier version of the ContentPresenterApp. When specified, graphics wrap in the direction specified by the Fill property. See Updates to the ContentPresenter App for a description of backward compatibility in the ContentPresenterApp when GridContent is selected.

    See Layout properties for more information about other View Mode options.

    Table

    Data Type: Enum ½ Default Value: ListContent ½ Runtime Property: No

    Scriptable: Yes ½ Bindable: Yes

Vertical Alignment

Vertical alignment (Top, Center, Bottom) of the graphic within a cell of the ContentPresenterApp view port.

Table

Data Type: Enum ½ Default Value: Top ½ Runtime Property: No

Scriptable: Yes ½ Bindable: Yes

Horizontal Alignment

Horizontal alignment (Left, Center, Right) of the graphic within a cell of the ContentPresenterApp view port.

Table

Data Type: String ½ Default Value: Left ½ Runtime Property: No

Scriptable: Yes ½ Bindable: Yes

Vertical Alignment

Vertical alignment (Top, Center, Bottom) of the graphic within a cell of the ContentPresenterApp view port.

Table

Data Type: Enum ½ Default Value: Top ½ Runtime Property: No

Scriptable: Yes ½ Bindable: Yes

Padding

Number of pixels as blank space padding on the left, right, top, and bottom of a graphic shown in the ContentPresenterApp. 0,0,0,0 is the default, which does not provide any padding.

See Padding property for more information.

Table

Data Type: Integer Array ½ Default Value: 0,0,0,0 ½ Runtime Property: No

Scriptable: Yes ½ Bindable: Yes

Size Properties

Size Mode

Options to set the size of graphics shown in the ContentPresenterApp by a fixed or scaled size. Scaled is the default size mode.

  • Scaled: Graphic size is scaled to the constraining horizontal or vertical dimension of the containing view port cell while maintaining the aspect ratio of the graphic.

    Cell size is an inverse function of the number of cells specified to appear in the view port. Cell size decreases with an increasing number of rows and columns in the view port. The number of cells shown in a view port is determined by the Display Rows and Display Columns properties.

  • Fixed: The cells shown in the view port are set to a fixed width and height in pixels. Graphic size is determined by its constraining dimension when placed in the fixed fixed width or height of the cell.

    The width and height values of view port cells are specified from the Fixed Width and Fixed Height properties.

    See Details of the Size Mode property for more information.

    Table

    Data Type: Enum ½ Default Value: Scaled ½ Runtime Property: No

    Scriptable: Yes ½ Bindable: Yes

Fixed Width

Number of pixels as the width of a cell within the view port of the ContentPresenterApp. The size of a graphic is restricted by the constraining dimension of a cell while maintaining the graphic's aspect ratio.

The Size Mode property must be set to Fixed to enable the Fixed Width and Fixed Height properties.

Table

Data Type: Integer ½ Default Value: 400 ½ Runtime Property: No

Scriptable: Yes ½ Bindable: Yes

Fixed Height

Number of pixels as the height of a cell within the view port of the ContentPresenterApp.

The Size Mode property must be set to Fixed to enable the Fixed Width and Fixed Height properties.Table

Data Type: Integer ½ Default Value: 300 ½ Runtime Property: No

Scriptable: Yes ½ Bindable: Yes

Display Columns

Number of columns containing graphics shown in a view port. Column numbers are specified as integers.

The ContentPresenterApp view pane includes a horizontal scroll bar to show columns outside of the limit set by the Display Columns property.

See Display Columns property for more information.

Table

Data Type: Integer ½ Default Value: 0 ½ Runtime Property: No

Scriptable: Yes ½ Bindable: Yes

Display Rows

Number of rows containing graphics shown in a Content Presenter view port. Row numbers are specified as integers.

The ContentPresenterApp view port includes a vertical scroll bar to show rows outside of the limit set by the Display Rows property.

See Display Rows property for more information.

Table

Data Type: Integer ½ Default Value: 0 ½ Runtime Property: No

Scriptable: Yes ½ Bindable: Yes

Stretch

When Stretch is enabled, the horizontal/vertical aspect ratio of a graphic changes to fill the available space of the non-constraining dimension within a cell of a Content Presenter view port.

The Display Rows and Display Columns properties must be set to non-zero values to enable the Stretch property.

See Stretch property for more information.

Table

Data Type: Boolean ½ Default Value: False ½ Runtime Property: No

Scriptable: Yes ½ Bindable: Yes

Display Properties

Interactive Content

Boolean value that determines whether graphics shown by the ContentPresenterApp are interactive or not. When Interactive Content is selected, the scripts and animations of selected graphic items from the ContentPresenterApp are enabled.

Both Display properties can be selected simultaneously. In the case when both properties are selected, Trigger Navigation takes precedence and the Interactive Content property value is not honored.

Table

Data Type: Boolean ½ Default Value: False ½ Runtime Property: No

Scriptable: Yes ½ Bindable: Yes

Trigger Navigation

Boolean value that determines whether a selected graphic shown by the ContentPresenterApp can set the focus within the running ViewApp to the navigation item containing the graphic. When the user selects a graphic item shown by the ContentPresenterApp, the current focus of the ViewApp is set to the navigation item containing the graphic.

Both Display properties can be selected simultaneously. In the case when both properties are selected, Trigger Navigation takes precedence and the Interactive Content property value is ignored.

Table

Data Type: Boolean ½ Default Value: False ½ Runtime Property: No

Scriptable: Yes ½ Bindable: Yes

Legacy Properties

Search Levels

This property is deprecated as of the System Platform 2023 release, but is maintained to ensure that existing ViewApps will continue to function as expected, without reconfiguration.

Options to set the number of node levels (1,2,3, All) at and beneath the starting node in the hierarchical ViewApp navigation model to search for graphics shown in the ContentPresenterApp. All is the default, which shows all graphics at the starting node and all nodes beneath it in the navigation model.

See Search Levels property for more information.

Table

Data Type: Enum ½ Default Value: All ½ Runtime Property: No

Scriptable: Yes ½ Bindable: Yes

Navigation Search Mode

This property is deprecated as of the System Platform 2023 release, but is maintained to ensure that existing ViewApps will continue to function as expected, without reconfiguration.

Options to set the boundaries of a search within the node levels of a ViewApp navigation model.

  • FixedLocation: The search starts at the navigation node specified by the Navigation Start Node property and continues within the hierarchy of the navigation model based on the number of navigation node levels set by the Search Levels property.

  • CurrentNav: The search starts from the current selected navigation node of the ViewApp and potentially its children based on the value set for the Search Levels property.

  • ChildrenAlone: The search starts from the child nodes beneath the current selected navigation node and potentially the children of the children if the Search Levels property is set to search Two Levels or Three Levels.

    Table

    Data Type: Enum ½ Default Value: FixedLocation ½ Runtime Property: No

    Scriptable: Yes ½ Bindable: Yes

Appearance Property

Background

Background color of the ContentPresenterApp view port. Select the Background field to show a color picker to set the background color. No color is the default background.

Table

Data Type: Color Picker ½ Default Value: No color ½ Runtime Property: No

Scriptable: Yes ½ Bindable: Yes

TitleResults for “How to create a CRG?”Also Available in