Using the Object Properties Window

The Object Properties Window (OPW) is a modeless window providing a way of displaying all the data / properties for a single network object in a more structured way. By default, the data is divided up into entirely customisable groups showing data of similar type. Some data is common to more than one type of object.

Note: Object properties and results are not editable in the Object Properties Window.

Accessing the Object Properties Window

The OPW can be accessed from the GeoPlan Window, the Network Object / Results Grid Windows and the Long Section Window .

You can also access the OPW by selecting Properties from the Window menu.

Customising the Object Properties Window

It is possible to customise the OPW using the Configuration () menu located on its toolbar. This menu has two options:

• Layout - which allows you to customise the properties layout for a particular object/result type displayed in the property editor. You can customise the grouping of properties.
  Note: It is not possible to add a new property item. The properties are system properties and cannot be edited.

  When you view an object's properties, for example by selecting the object on the GeoPlan using the Properties () tool, the properties will be displayed according to the last layout that was used for displaying that type of object.

  Layouts may be local layouts or database layouts:

  • Local layouts are the layouts of the OPW which have been customised and saved locally to a user's machine. Local layouts include any changes that a user may have made when customising the window layout. When a local layout is saved, it overwrites the previous version of the local layout for that object type. These layouts are only available to the user who saved them on that particular machine. However, it is possible to share local layouts between users as you can export the layout for a particular object or result, or for all objects or results in the current network to an XML file, which can then be imported by another user. See the section, Importing and exporting layouts to XML files, for details
  • Database layouts consist of the OPW layouts, including any that have been customised, which are stored as a property of the database, allowing other users to access them. There can be more than one database layout for the same type of object. Database layouts are managed using the Manage Layout dialog.

See the section Customising the layout for information about customising layouts.

• Options - which displays the Object Properties Window Settings dialog that allows you to customise the look and feel of the OPW. You can show or hide flags, have the properties shown in groups or not and specify whether or not you want results properties to be displayed (if available). You can also specify settings for copying objects.

Customising the layout

The layout of the OPW can be modified using any of the following toolbar options:

• Configuration MenuLayoutEdit. Displays the layout for the current object type in the OPW, ready for editing.
• Configuration MenuLayoutOpen. This option involves an additional step to the previous option, which allows you to select the object type of your choice (therefore, you do not necessarily have to choose the same object type as the object whose properties are currently being shown in the OPW). Once this selection is made in the Open Layout Table dialog, the corresponding layout is displayed in the OPW.
• Configuration MenuLayoutManage layouts. This option displays the Manage Layout dialog which enables you to load an existing database layout or delete a layout. See the Managing Layouts section for further information about using this dialog.

Using any of the above options, fields (properties) and groups can be moved. Groups can also be added, renamed or deleted.

If in Properties view (i.e. when viewing the properties of a real object, as opposed to viewing the layout for a particular object type, which represents the Layout view) you are still able to manipulate and save the layout. However, editing is restricted and groups CANNOT be added, moved or deleted.

Note: In both Properties and Layout view, groups cannot be moved if they are closed (collapsed).

To customise the layout:

• Make any desired edits in the OPW.
• Select the:
  • Configuration MenuLayoutSave locally option to save a local copy of the layout. Note that when you save a local layout it overwrites the previous version of the layout for that object type.

Managing layouts

The Manage Layout dialog allows you to:

Load a layout

To load an existing layout:

1. Select the LayoutManage layouts option from the Configuration menu.

   The Manage Layout dialog is displayed. In this dialog:

2. Select the name of the database layout you want to load from the Layout list box.
   A Factory default database layout available for selection in the Layout list box. This layout consists of unmodified layouts or factory settings for all objects in the database.

   Note: Loading a Factory default will reset all local layouts back to their factory settings. Saved database layouts are not reset.

   Tip: If you want to load a factory default layout for a particular object type, cancel this operation, and use the LayoutReset option instead. See the Resetting Layouts section below.
3. Click Load.

   If you have chosen to load the factory default layouts, a message similar to the following one is displayed:

   

   Click OK to load the factory default layouts or Cancel to cancel the load operation.

   If you have chosen to load a database layout, the dialog closes, and the property sheet for the object, whose properties you are currently viewing, will be displayed in the OPW according to the selected layout.

   Note: Although you may have loaded a database layout, it is treated as a local layout until any changes you make to it are saved to the database.

Delete a layout

To delete a database layout

1. Select the LayoutManage layouts option from the Configuration menu.

   The Manage Layout dialog is displayed. In this dialog:

2. Select the name of the layout you want to delete from the Layout list, and its name will be displayed in the Selected layout box.
   Note: You cannot delete the Factory default layout.
3. Click Delete.

   The following message is displayed:

   

   Click OK to delete the layout from the database or Cancel to cancel the operation.

   Note: The delete operation may be permissioned and only made available to Database Owners. In that case, a message similar to the one below will be displayed.

   

4. Click OK to confirm the deletion and close the dialog.

Tip: Using to close the window will cancel the delete operation.

Resetting layouts

It is possible to reset the user-defined local property layout for the currently selected object. To do so:

1. Select the Configuration MenuLayoutReset Object type (where Object type is the name of the currently selected type of object) from the Object Properties Window Toolbar, and a message similar to the one shown below is displayed:

   

2. Select Yes to reset the layout of the object properties to its factory default.

Tip: You can also use the Manage Layout dialog to load the factory defaults for all objects. This effectively resets the local property layouts for all objects back to their factory defaults. The properties for any selected object will be displayed according to its default layout until saved as a local layout or an existing database layout is loaded.

Importing and exporting layouts to XML files

Local layouts for property sheets, including group names, group order, property order, node button state (i.e., expanded/collapsed), can be exported to or imported from XML files. This provides a way to share layouts between users. You can choose to export the layout of the object or result currently displayed in the Object Property Window, or the layouts of all objects or results in the current network. If a local layout has not been customised, the default layout is exported.

When importing layouts from an XML file, any local layouts for applicable objects or results in the current network will be overwritten with the layout from the XML file. If the XML file does not contain a layout for an object or result in the current network, the existing local layout is used for displaying the properties.

To export a layout to an XML file

1. Ensure that the Object Property Window displays the layout of an object or result that is to be exported.
2. Select the LayoutExport to XML option from the Configuration menu.
   Any unsaved layout changes are saved locally and a standard Windows Save As window is displayed. In this window:

   • Navigate to the folder where you want to store the exported layout file.
   • Specify a name for the XML file.
   • Click Save.

   A message is displayed asking if you want to export property sheets layouts for all objects to the XML file.

3. Click:
   • No, to only export the layout for the object or result currently displayed in the Object Property Window.
   • Yes, to export the layouts for all objects and result objects in the current network.

   The applicable layouts are exported.

To import a layout from an XML file

1. Ensure that the Object Property Window displays the layout of an object or result, which is contained in the XML file that is to be imported, and that it is for the relevant InfoWorks or SWMM network.
2. Select the LayoutImport from XML option from the Configuration menu.

   A standard Windows Open window is displayed. In this window:

   • Navigate to the folder where the XML file is located.
   • Select the appropriate XML file.
   • Click Open.

   The applicable layouts are imported.

   Note: A message may be displayed if the format of the XML file is invalid or if you are trying to import the layout for:

   • A result object when the property sheet for an object is displayed in Object Property Window.
   • An object when the property sheet for a results object is displayed in Object Property Window.
   • A SWMM object when the layout for an InfoWorks object is displayed in Object Property Window.
   • An InfoWorks object when the layout for a SWMM object is displayed in Object Property Window.

Context menu

Option	Description
Close	Closes the OPW for the current object.
Close all	Closes all instances of the OPW.
Refresh	Refreshes the current OPW view.
Copy object	Copies the selected object. This can then be pasted into a text editor and saved as CSV which can then be opened in Microsoft Excel. Copy settings are configurable from the Object Properties Window Settings dialog.
Copy	Copies the selected property value.
Show groups	Allows to toggle between showing and hiding property groups. If groups are currently being shown, the option has a tick in front of it. Tip: If you have specified for the groups to be hidden, (see Object Properties Window Settings dialog for more details), this option will not be visible on the context menu.
Show validation errors	Allows to toggle between showing and hiding validation errors. If validation errors are currently being shown, the option has a tick in front of it. Tip: If you have specified for the validation error column to be hidden, (see Object Properties Window Settings dialog for more details), this option will not be visible on the context menu.
Open all groups	Opens (expands) all groups, displaying all properties contained in each group, in the OPW.
Closes all groups	Closes (collapses) all groups. All properties which comprise each group are no longer visible in the OPW.
Move row up	Moves selected row up.
Move row down	Moves selected row down.
Add group	Only enabled if groups are shown and in Layout view. (i.e. when viewing the layout for a particular object type). Adds a new group.
Delete group	Only enabled if groups are shown and in Layout view. Deletes a selected group.
Rename group	Only enabled if groups are shown and in Layout view. Renames a selected group.

Depending on which item is clicked on, or which view of the OPW is displayed (network object properties, results properties or object type layout), some of the options may be disabled.