Common Custom controls

How to use

If the sample has associated data, you will find that the sample's zip file includes a "data" folder alongside the language folders. However, you will need to update the sample to point to the location of the data once you have extracted all the files.

1. Verify that the Web Application Developer Framework (ADF) for the .NET Framework is installed and functioning properly. For information on installing and configuring the Web ADF, consult the installation guide.
2. In Windows Explorer, navigate to <ArcGIS Developer Kit install location>\Samples\ServerNET\Common_CustomControls.
3. Start Microsoft Visual Studio 2008 or 2010 and open the Common_CustomControls_<language><vs_version> solution (for example, Common_CustomControls_CSharp2008.sln) located in <unzipped location\Common_CustomControls_<language>. The <vs_version> references the Visual Studio version of the solution, either 2008 or 2010.
4. In Solution Explorer, right-click the CustomControlsWebSite file system Web site and select Set as StartUp Project.
5. Right-click the .aspx page that you're interested in and select Set As Start Page.
6. Add the ADFCompositeControl and ADFWebPart projects as references to the CustomControlsWebSite if necessary.
7. Open AddWebPartOnClick.aspx.cs and set the appropriate properties for MapWebPart and MapGridViewWebPart as follows: Define the data source type, location, and resource (map service) name for MapWebPart. The custom MapIdentify code and tool in MapWebPart will execute successfully but will not generate results. They are provided for instruction only. Add functionality to the tool if desired. Default properties are set in the constructor for MapWebPart and MapGridViewWebPart and use sample data provided by serverapps.esri.com and ArcGIS Online. To use the default properties, proceed to step 10. To change the properties of MapWebPart, proceed to step 8. To change the properties of MapGridViewWebPart, proceed to step 9.
8. Define the data source type, location, and resource (map service) name. The custom MapIdentify code and tool in MapWebPart will execute successfully but will not generate results. They are provided for instruction only. Add functionality to the tool if desired.
9. Define the data source type, location, and resource name for an ArcGIS Server non-cached map service. Ensure the map service contains a point feature layer to be used to display graphics in the map and attributes in the GridView. Set the DataLayerName property to the name of the point feature layer. To filter and alias the field names in the point feature layer, which will be listed in the GridView, define a fields collection and set the DisplayFields property. MapGridViewWebPart contains a map resource that references the ArcGIS Online StreetMap service as a base layer. The non-cached map service is projected on the fly to the projection of the StreetMap service. A Geometry service is also used to project the default extent of the non-cached map service into the projection of the StreetMap service, and is then used to set the extent of the Map control. Set the GeometryServiceUrl property to an available ArcGIS Server Geometry service.
10. Open DesignComposite.aspx and set the appropriate properties on the MapToolTocControl in the markup. Define the data source type, location, and resource (map service) name. The custom MapIdentify code and tool in the MapToolTocControl will execute successfully but will not generate results. They are provided for instruction only. Add functionality to the tool if desired.
11. Open WebUserControl.ascx in Design view and add a map resource. The code behind the User control contains a block of code to set buddy properties at the initialization phase of the control.
12. In Windows Explorer, navigate to the App_Data\Personalization_Data folder in CustomControlsWebSite. Open the properties on the folder and provide read and write access to the user account under which the Web application will be running. If running as a file system Web site, integrated authentication is used by default.

1. Start the Web application. Since it's a file system Web site, an ASP.NET Development server will start or an existing server instance will be used. Access to the site is limited to the local machine.
2. In AddWebPartOnClick.aspx, click the Add MapWebPart or MapGridViewWebPart button. The respective Web Part control is added to the page. Multiple controls can be added in the same session. The MapWebPart control provides an interactive Map, Toolbar, and Toc. The MapGridViewWebPart control provides an interactive Map, GridView, and point graphic features in the Map (MapTips). The GridView contains attributes for the point features displayed in the Map. On hover of a data row, the respective point graphic feature in the map is highlighted. On click of a data row, the Map zooms to the respective graphic feature. Only graphic features in the Map extent are listed in the GridView. Click the Remove Web Parts button to remove all parts from the page. A text file containing encrypted data is generated in the App_Data\Personalization_Data folder. The text is used to store the authenticated user's personalized information.
3. Optionally, interact with the Map, TOC, and Toolbar in the custom composite control on the DesignComposite.aspx page. This page illustrates that the Web ADF controls function as expected when contained in a composite control.
4. Optionally, interact with the Map, TOC, and Toolbar in the custom Web user control on the DesignTimeUserControl.aspx page. This page illustrates that the Web ADF controls function as expected in a user control.

Additional information