Custom MDI Tab

Product Availability: ArcFM Viewer for ArcGIS Engine

In ArcFM Viewer, the Data View tabs are part of a MDI tab. The ArcFM Viewer user interface allows the user to easily add tabs to the Data View window (see Using ArcFM Viewer for ArcGIS Engine online help).

This section describes how to make a custom MDI window tab that displays information other than the map data displayed by the Data View tabs or the outage incident information displayed by the Incident tab.

C# Code Sample

C# Developer Sample (Engine)

ArcFM Viewer for ArcGIS Engine: The default transparent color for bitmap icons is magenta (RGB - 255, 0, 255).

The code sample provided in this section offers a MDI window that displays report information rather than a view of the data (see "Dev: New MDI Window" tab in example below).

The .dlls for custom MDI windows must reside in the ArcFM Solution\Bin directory (ArcFM Viewer). They do not require the RegX (or Regasm) utility.

ArcFM Viewer: The layout of MDI windows (both standard and custom) is NOT persisted. If a user opens ArcFM Viewer and modifies the layout of the MDI window(s) (e.g., create windows, re-size, etc.) and then closes the application, the next time it is opened, the MDI window will revert to the default position and size.

Add Custom MDI Tab to the User Interface

You may add a custom MDI window to your application using a Custom Layout XML file.

The following XML is required to add a custom MDI window to the user interface. Each custom MDI window requires a <MdiTab> tag.

XML Snippet	Copy Code
<MdiTabManager orientation="Horizontal" activeTab="DevMDIWindow"> <MdiTabGroups> <MdiTabGroup extent="0" firstDisplayed="" selectedTab=""> <MdiTabs> <MdiTab key="DevMDIWindow"> <MdiWindow type="Miner.DeveloperSamples.Engine.DevMDIWindow, ArcFMViewerEngineMDIWindow" > <CreateData> <Param type="System.String" value="DevMDIWindow" /> </CreateData> </MdiWindow> </MdiTab> </MdiTabs> </MdiTabGroup> </MdiTabGroups> </MdiTabManager>

XML Snippet

Copy Code

<MdiTabManager orientation="Horizontal" activeTab="DevMDIWindow">
 <MdiTabGroups>
  <MdiTabGroup extent="0" firstDisplayed="" selectedTab="">
   <MdiTabs>
    <MdiTab key="DevMDIWindow">
     <MdiWindow type="Miner.DeveloperSamples.Engine.DevMDIWindow, ArcFMViewerEngineMDIWindow" >
       <CreateData>
        <Param type="System.String" value="DevMDIWindow" />
       </CreateData>
     </MdiWindow>
    </MdiTab>
   </MdiTabs>
  </MdiTabGroup>
 </MdiTabGroups>
</MdiTabManager>

The <MdiTabManager> tag (line 1) contains all MDI Windows. If this tag doesn't exist, it must be created. It contains the following attributes:

orientation: Indicates how the MDI window is situated (horizontal or vertical).
activeTab: Indicates which MDI window is activated when the user opens the application. The attribute should contain the Key value for a MDI window.

MDI windows may be divided into groups. While you may employ the <MdiTabGroups> and <MdiTagGroup> tags (lines 2 and 3) to separate the windows into groups, it is much easier to leave them in one group in the XML and then view the MDI window panes in ArcFM Viewer and drag them into groups.

The <MdiTabs> tag (line 4) contains the MDI windows.

Each MDI window requires its own <MdiTab> tag. The highlighted portion of the sample XML above illustrates the XML required to add a custom MDI window. This tag contains the following attribute:

Key: This attribute value in the <MdiTab> tag must match the Value attribute in the <Param> tag. This value must also match the Key value set in the MDI window's code.

Each MDI window also requires its own <MdiWindow> tag (included in the highlighted portion above). This tag contains the following attribute:

Type: This attribute contains the qualified path to the class followed by the assembly name. These two values are separated by a comma.