Implementing Customizations

Product Availability: ArcFM Viewer for ArcGIS Engine, Responder

Some ArcFM Solution applications utilize the Application Framework to determine what elements are included in the user interface and where each element is displayed. When a user launches one of these applications, the Application Framework looks for custom layout files and uses the information to create the user interface. For example, if you create a custom toolbar and wish to display it in the user interface, it must be added to a custom layout file. A sample copy of a Custom Layout file is installed here: Program Files\Miner and Miner\ArcFM Solution\Bin\Xml\Sample.custom.layout. Use this file in conjunction with the Application Framework documentation to create your own Custom Layout file and customize your user interface.

NOTE: DO NOT add customizations to the read-only custom layout files installed in the ArcFM Solution\Bin\Addons directory or those installed in ArcGIS\Bin\Responder\Addons. These files may be overwritten in future releases and your customizations lost.

XML Code Sample

Distribute:
ArcFM Engine

Sample Files:
Sample.custom.layout
Miner.layout.xsd

The following Application Framework customizations are discussed in this section:

Implement a Customization

Once you have developed a customization (e.g., MDI tab or command), it must be added to a custom layout file that is distributed to all users who require to access your customization. Customizations may be added to a custom layout file (e.g., ArcFMViewer.custom.layout, Responder.custom.layout) which the Application Framework uses to display the user interface. Some ArcFM Engine customizations can be added using the ArcFM Engine Administrator. Creating this custom layout file and using the ArcFM Engine Administrator for distributing customizations is discussed on the distribute customization pages (ArcFM Engine). The XML code sample in this section illustrates how a custom layout file might look. Each of the Application Framework customization sections discuss how the element should be added to the custom XML file.

Remove Functionality

If you wish to remove an element from the user interface (e.g., toolbar, command, etc.), you may do so using the Custom Layout XML file. Create a <RemoveObjects> tag and in it place a <RemoveObject> tag for each element you wish to remove. The <RemoveObject> tag requires ObjectType and Key values. The example below depicts how your custom layout file may look if it contains ONLY remove objects. The MainWindow tags, although empty, are still required.

ObjectType: Indicates the type of object being removed: command, commandbar, MDIWindow, DockWindow.
Key: Corresponds to the "Key" value on the object being removed.

Remove Objects
Copy Code
<?xml version="1.0" encoding="utf-8"?>
<LayoutData xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" layoutFormat="2" 
lockLayout="false" noSaveMdiWindows="true">
<MainWindow left="110" top="145" width="1050" height="722">
</MainWindow>
<RemoveObjects>
<RemoveObject objectType="Command" key="IdentifyTool" />
</RemoveObjects>
</LayoutData>
ArcFM Viewer: To get the key values of existing ArcFM tools, refer to the Sample.ArcFMViewer.exe.layout file installed in ArcFM Solution\Bin\Xml.

Responder: To get the key values of existing Responder tools, refer to the Sample.Miner.Responder.Explorer.exe.layout file installed in Program Files\Miner and Miner\Responder\Client\Xml. If you want to modify tools in Archive Explorer refer to Sample.Miner.Responder.ArchiveExplorer.exe.layout for key values. These files are installed in the same directory.

Validating XML

When you have finished creating and updating your Custom Layout file, you may use the XSD file provided with the installation to verify that your XML is accurate. Apply the Miner.layout.xsd to your Custom Layout file for verification. With ArcFM Viewer for ArcGIS Engine, this file is installed here: ArcFM Solution\Bin\Xml. With Responder, this file is installed here: Responder\Client\Xml.