Differences

This shows you the differences between two versions of the page.

--- map_suite_desktop_edition_quick_start_guide [2015/09/06 09:40]
admin [Download the Sample]
+++ map_suite_desktop_edition_quick_start_guide [2017/03/17 02:25] (current)
tgwikiupdate
@@ Line 1: / Line 1: @@
 ====== Map Suite Desktop Edition Quick Start Guide ======
+{{section>upgrade_map_suite_to_10.0}}
 <div msgbox>
@@ Line 15: / Line 17: @@
 ===== Download the Sample =====
-<faicon fa fa-download> {{:File:HelloWorld Desktop(WinForms).zip|Download Sample Code From This Exercise}} //(1.5 MB)//
+<faicon fa fa-download  fa-lg>  {{filehistory:HelloWorld Desktop WinForms.zip|Download Sample Code From This Exercise}} //(1.5 MB)//
 ===== Setting up the Environment =====
 Let's start with a new Windows Forms project in Microsoft Visual Studio (2010 or newer) and call it HelloWorld (see Figure 1). We can create the project with .NET Framework 4.0 or 4.5.
-{{Figure|QSG DesktopEdition Img0001.jpg|Figure 1. Creating a new project in Microsoft Visual Studio.}}
+{{desktopedition:QSG DesktopEdition Img0001.jpg}}
+\\
+//Figure 1. Creating a new project in Microsoft Visual Studio.//
 The project HelloWorld is created in a new solution called HelloWorld. The wizard creates a single Windows Form. Next we need to put a Map control on the Form from our Toolbox. The Map control is located on the Toolbox under Windows Forms (see Figure 2). If you do not see these controls, you will need to add them to your Toolbox manually.
@@ Line 30: / Line 34: @@
 **1.** When you first open Microsoft Visual Studio after installing Map Suite, you may not see the controls in the Toolbox. You will need to follow these steps to add the controls. Hover on Toolbox and right click anywhere on list of controls. You will get a pop-up menu. Choose "Choose Items...".
-{{Figure|QSG DesktopEdition Img02.jpg}}
+{{desktopedition:QSG DesktopEdition Img02.jpg}}
-**2.** A dialogue box to Choose Toolbox Items will appear. You will need to select the .NET Framework Components tab and then click the Browse button. Finally navigate to the <kbd>C:\Program Files (x86)\ThinkGeo\Map Suite 9.0\Map Suite Desktop\Current Version\Managed Assemblies</kbd> folder and select the "DesktopEdition.dll" file.
+**2.** A dialogue box to Choose Toolbox Items will appear. You will need to select the .NET Framework Components tab and then click the Browse button. Finally navigate to the //C:\Program Files (x86)\ThinkGeo\Map Suite 9.0\Map Suite Desktop\Current Version\Managed Assemblies// folder and select the "DesktopEdition.dll" file.
-{{Figure|QSG DesktopEdition Img0003.png}}
+{{desktopedition:QSG DesktopEdition Img03.png}}
 **3.** You should now have the Map Control available in your Toolbox as shown in Figure 2 below.
-{{Figure|QSG DesktopEdition Img04.jpg|Figure 2. The Map Controls under the Toolbox window.}}
+{{desktopedition:QSG DesktopEdition Img04.jpg}}
+\\
+//Figure 2. The Map Controls under the Toolbox window.//
 ==== Adding the Map Control to Your Form ====
-We need to add "MapSuiteCore.dll" to the reference. Right-click the project in solution explorer and select "Add Reference...", navigate to the <kbd>C:\Program Files (x86)\ThinkGeo\Map Suite 9.0\Map Suite Desktop\Current Version\Managed Assemblies</kbd> folder and select "MapSuiteCore.dll".
+We need to add "MapSuiteCore.dll" to the reference. Right-click the project in solution explorer and select "Add Reference...", navigate to the //C:\Program Files (x86)\ThinkGeo\Map Suite 9.0\Map Suite Desktop\Current Version\Managed Assemblies// folder and select "MapSuiteCore.dll".
-{{Figure|QSG DesktopEdition Img0005.jpg}}
+{{desktopedition:QSG DesktopEdition Img0005.jpg}}
-Draw the Map control on the form by clicking on the Map Control object in the Toolbox and then dragging and dropping (using the left mouse button) to the size you desire. You can leave the name of the Map control to <code>winformsMap1</code>. Our map will display in it.
+Draw the Map control on the form by clicking on the Map Control object in the Toolbox and then dragging and dropping (using the left mouse button) to the size you desire. You can leave the name of the Map control to ''winformsMap1''. Our map will display in it.
-{{Figure|QSG DesktopEdition Img0006.jpg}}
+{{desktopedition:QSG DesktopEdition Img06.jpg}}
 Now that we have our "MapSuiteCore.dll" referenced and a Map Control added, we are ready for adding the code.
@@ Line 81: / Line 87: @@
 We have provided the 20 most common scales, from ZoomLevel01 to ZoomLevel20, at which you may want to change the way your data looks. What is scale? Scale indicates how much the given area has been reduced. If a road is 10,000 inches long in the real world and a map depicts this length as 1 inch on the screen, then we say the scale of this map is 1:10,000. Now let's say ZoomLevel02 uses a scale of 1:500 and ZoomLevel03 uses a scale of 1:1200. This means the map with a current scale of 1:1000 matches ZoomLevel03, the ZoomLevel whose scale is the closest to that.
-PresetZoomLevels has a very useful property called <code>ZoomLevel.ApplyUntilZoomLevel</code>, which you can very easily use to extend your ZoomLevels. Let's say you want a particular Style to be visible at ZoomLevel03 through ZoomLevel10. To make that work, we can simply code as follows:
+PresetZoomLevels has a very useful property called ''ZoomLevel.ApplyUntilZoomLevel'', which you can very easily use to extend your ZoomLevels. Let's say you want a particular Style to be visible at ZoomLevel03 through ZoomLevel10. To make that work, we can simply code as follows:
-<source lang="csharp">
+<code csharp>
 worldLayer.ZoomLevelSet.ZoomLevel03.DefaultAreaStyle = AreaStyles.Country1;
 worldLayer.ZoomLevelSet.ZoomLevel03.ApplyUntilZoomLevel = ApplyUntilZoomLevel.Level10;
-</source>
+</code>
 ===== Map Suite Desktop "Hello World" =====
 In creating our "Hello World" sample application, our first step is to set references to the Map Suite Core and Map Suite DesktopEdition workspaces at the very top of our code, as we will use many classes within that. We do this so that we do not have to use the fully qualified name of the Map Suite classes throughout our code. Setting a reference to the Map Suite workspace can be done in the "code-behind" of the Form by selecting the Form and hitting the F7 function key. Set the reference like this:
-<source lang="csharp">
+<code csharp>
 using ThinkGeo.MapSuite.Core;
 using ThinkGeo.MapSuite.DesktopEdition;
-</source>
+</code>
 Now let's look at a code sample to bring this concept to fruition. We'll look at Shapefiles relating to the entire world. In our example, we have one such Shapefile:
-*The borders of every country in the world ("Countries02.shp")
+  * The borders of every country in the world ("Countries02.shp")
 (**NOTE:** The data used in this sample can be found in the attached sample above at "\AppData" folder)
-Our next step is to define and add our Layers. Here is the code to use for our example. All of the following code can be placed in the <code>Form1_Load</code> event of the form.
+Our next step is to define and add our Layers. Here is the code to use for our example. All of the following code can be placed in the ''Form1_Load'' event of the form.
-<source lang="csharp">
+<code csharp>
 private void Form1_Load(object sender, EventArgs e)
     {
-        <nowiki>//</nowiki> Set the Map Unit. The reason for setting it to DecimalDegrees is that is what the shapefile’s unit of measure is inherently in.
+        // Set the Map Unit. The reason for setting it to DecimalDegrees is that is what the shapefile’s unit of measure is inherently in.
         winformsMap1.MapUnit = GeographyUnit.DecimalDegree;
-        <nowiki>//</nowiki> We create a new Layer and pass the path to a Shapefile into its constructor.
+        // We create a new Layer and pass the path to a Shapefile into its constructor.
         ShapeFileFeatureLayer worldLayer = new ShapeFileFeatureLayer(@"../../AppData/Countries02.shp");
-        <nowiki>//</nowiki> Set the worldLayer with a preset Style, as AreaStyles.Country1 has YellowGreen background and black border, our worldLayer will have the same render style.
+        // Set the worldLayer with a preset Style, as AreaStyles.Country1 has YellowGreen background and black border, our worldLayer will have the same render style.
         worldLayer.ZoomLevelSet.ZoomLevel01.DefaultAreaStyle = AreaStyles.Country1;
-        <nowiki>//</nowiki> This setting will apply from ZoonLevel01 to ZoomLevel20, that means we can see the world the same style with ZoomLevel01 all the time no matter how far we zoom out/in.
+        // This setting will apply from ZoonLevel01 to ZoomLevel20, that means we can see the world the same style with ZoomLevel01 all the time no matter how far we zoom out/in.
         worldLayer.ZoomLevelSet.ZoomLevel01.ApplyUntilZoomLevel = ApplyUntilZoomLevel.Level20;
-        <nowiki>//</nowiki> Create a new Layer Overlay to hold the layer we just created
+        // Create a new Layer Overlay to hold the layer we just created
         LayerOverlay layerOverlay = new LayerOverlay();
-        <nowiki>//</nowiki> Add the shapefile layer to the layer overlay
+        // Add the shapefile layer to the layer overlay
         layerOverlay.Layers.Add(worldLayer);
-        <nowiki>//</nowiki> We need to add the layer overlay to Map.
+        // We need to add the layer overlay to Map.
         winformsMap1.Overlays.Add(layerOverlay);
-        <nowiki>//</nowiki> Set a proper extent for the Map.
+        // Set a proper extent for the Map.
         winformsMap1.CurrentExtent = new RectangleShape(0, 78, 30, 26);
-        <nowiki>//</nowiki> We now need to call the Refresh() method of the Map control so that the Map can redraw based on the data that has been provided.
+        // We now need to call the Refresh() method of the Map control so that the Map can redraw based on the data that has been provided.
         winformsMap1.Refresh();
     }
-</source>
+</code>
 If you compile and run what you have now, your map should look like the one below. (see Figure 4).
-{{Figure|QSG DesktopEdition Img08.jpg|Figure 4. A Simple map of Europe.}}
+{{desktopedition:QSG DesktopEdition Img08.jpg}}
+\\
+//Figure 4. A Simple map of Europe.//
 So what has occurred here? We have created a layer and added it to the Map, and the Map has rendered it according to its default style parameters. Also, we have used ZoomLevel to display the map the way we want.
-NOTE: It is important that the <code>MapUnit</code> property of a Map object be set using the <code>GeographyUnit</code> Enumeration. This is because Shapefiles only store binary vector coordinates, which can be in DecimalDegree, feet, meters, etc., and our map has no idea about what the unit of measurement is until we set it. This information is normally found somewhere in the documentation or within the supplemental data file as discussed in the section on Shapefiles.
+NOTE: It is important that the ''MapUnit'' property of a Map object be set using the ''GeographyUnit'' Enumeration. This is because Shapefiles only store binary vector coordinates, which can be in DecimalDegree, feet, meters, etc., and our map has no idea about what the unit of measurement is until we set it. This information is normally found somewhere in the documentation or within the supplemental data file as discussed in the section on Shapefiles.
 ===== Navigating the Map =====
@@ Line 149: / Line 157: @@
 That was an easy start! Now, let's add another Shapefile to the sample so that we will have a total of two layers:
-#The borders of every country in the world ("Countries02.shp")
+  -The borders of every country in the world ("Countries02.shp")
-#The capitals of the world countries ("WorldCapitals.shp")
+  -The capitals of the world countries ("WorldCapitals.shp")
-<source lang="csharp">
+<code csharp>
 private void Form1_Load(object sender, EventArgs e)
     {
@@ Line 162: / Line 170: @@
         ShapeFileFeatureLayer capitalLayer = new ShapeFileFeatureLayer(@"../../AppData/WorldCapitals.shp");
-        <nowiki>//</nowiki> Similarly, we use the presetPointStyle for cities.
+        // Similarly, we use the presetPointStyle for cities.
         capitalLayer.ZoomLevelSet.ZoomLevel01.DefaultPointStyle = PointStyles.Capital3;
-        <nowiki>//</nowiki> This setting also applies from ZoonLevel01 to ZoomLevel20, that means we can see city symbols the same style with ZoomLevel01 all the time.
+        // This setting also applies from ZoonLevel01 to ZoomLevel20, that means we can see city symbols the same style with ZoomLevel01 all the time.
         capitalLayer.ZoomLevelSet.ZoomLevel01.ApplyUntilZoomLevel = ApplyUntilZoomLevel.Level20;
         LayerOverlay layerOverlay = new LayerOverlay();
         layerOverlay.Layers.Add(worldLayer);
-        <nowiki>//</nowiki> We need to add both of the new layers to the Layer OverLay.
+        // We need to add both of the new layers to the Layer OverLay.
         layerOverlay.Layers.Add(capitalLayer);
@@ Line 177: / Line 185: @@
         winformsMap1.Refresh();
     }
-</source>
+</code>
 And the result is as following (Figure 5):
-{{Figure|QSG DesktopEdition Img09.jpg|Figure 5. Europe map with 2 layers.}}
+{{desktopedition:QSG DesktopEdition Img09.jpg}}
+\\
+//Figure 5. Europe map with 2 layers.//
 ===== How to Use GeoTextStyle =====
@@ Line 187: / Line 197: @@
 TextStyle are used to label items on map. As every Shapefile has a relative .dbf file, which includes descriptions for every record, the most common way to use TextStyles is for labeling. For example, WorldCapital Shapefile's corresponding .dbf file contains the field "CITY_NAME". We can use this field to label the cities on our map.
-{{Figure|QSG DesktopEdition Img10.jpg}}
+{{desktopedition:QSG DesktopEdition Img10.jpg}}
 Map Suite has many TextStyles built in, which will help us quickly design attractive labels for the cities on our map. We can just pick the TextStyle we like and use it.
-<source lang="csharp">
+<code csharp>
 private void Form1_Load(object sender, EventArgs e)
     {
@@ Line 201: / Line 211: @@
         ShapeFileFeatureLayer capitalLayer = new ShapeFileFeatureLayer(@"../../AppData/WorldCapitals.shp");
-        <nowiki>//</nowiki> Similarly, we use the presetPointStyle for cities.
+        // Similarly, we use the presetPointStyle for cities.
         capitalLayer.ZoomLevelSet.ZoomLevel01.DefaultPointStyle = PointStyles.Capital3;
-        <nowiki>//</nowiki> This setting also applies from ZoonLevel01 to ZoomLevel20, that means we can see city symbols the same style with ZoomLevel01 all the time.
+        // This setting also applies from ZoonLevel01 to ZoomLevel20, that means we can see city symbols the same style with ZoomLevel01 all the time.
         capitalLayer.ZoomLevelSet.ZoomLevel01.ApplyUntilZoomLevel = ApplyUntilZoomLevel.Level20;
-        <nowiki>//</nowiki> We create a new Layer for labeling the capitals.
+        // We create a new Layer for labeling the capitals.
         ShapeFileFeatureLayer capitalLabelLayer = new ShapeFileFeatureLayer(@"../../AppData/WorldCapitals.shp");
-        <nowiki>//</nowiki> We use the preset TextStyle. Here we passed in the “CITY_NAME”, which is the name of the field we want to label on map.
+        // We use the preset TextStyle. Here we passed in the “CITY_NAME”, which is the name of the field we want to label on map.
         capitalLabelLayer.ZoomLevelSet.ZoomLevel01.DefaultTextStyle = TextStyles.Capital3("CITY_NAME");
         capitalLabelLayer.ZoomLevelSet.ZoomLevel01.ApplyUntilZoomLevel = ApplyUntilZoomLevel.Level20;
-        <nowiki>//</nowiki> As the map is drawn by tiles, it needs to draw on the margin to make sure the text is complete after we joining the tiles together.
+        // As the map is drawn by tiles, it needs to draw on the margin to make sure the text is complete after we joining the tiles together.
-        <nowiki>//</nowiki> Change the number to another one (for example 0) and you can see the difference expecially when panning.
+        // Change the number to another one (for example 0) and you can see the difference expecially when panning.
         capitalLabelLayer.DrawingMarginPercentage = 50;
@@ Line 226: / Line 236: @@
         winformsMap1.Refresh();
     }
-</source>
+</code>
 The result is as following (Figure 6):
-{{Figure|QSG DesktopEdition Img11.jpg|Figure 6. Europe map with TextStyle.}}
+{{desktopedition:QSG DesktopEdition Img11.jpg}}
+\\
+//Figure 6. Europe map with TextStyle.//
 Now that we know how to render text and render symbols, let's define two different ZoomLevels in one single layer, and create our own custom Style and TextStyle.
-<source lang="csharp">
+<code csharp>
 private void Form1_Load(object sender, EventArgs e)
     {
@@ Line 244: / Line 256: @@
         ShapeFileFeatureLayer capitalLayer = new ShapeFileFeatureLayer(@"../../AppData/WorldCapitals.shp");
-        <nowiki>//</nowiki> We can customize our own Style. Here we passed in a color and a size.
+        // We can customize our own Style. Here we passed in a color and a size.
         capitalLayer.ZoomLevelSet.ZoomLevel01.DefaultPointStyle = PointStyles.CreateSimpleCircleStyle(GeoColor.StandardColors.White, 7, GeoColor.StandardColors.Brown);
-        <nowiki>//</nowiki> The Style we set here is available from ZoomLevel01 to ZoomLevel05. That means if we zoom in a bit more, the appearance we set here will not be visible anymore.
+        // The Style we set here is available from ZoomLevel01 to ZoomLevel05. That means if we zoom in a bit more, the appearance we set here will not be visible anymore.
         capitalLayer.ZoomLevelSet.ZoomLevel01.ApplyUntilZoomLevel = ApplyUntilZoomLevel.Level05;
         capitalLayer.ZoomLevelSet.ZoomLevel06.DefaultPointStyle = PointStyles.Capital3;
-        <nowiki>//</nowiki> The Style we set here is available from ZoomLevel06 to ZoomLevel20. That means if we zoom out a bit more, the appearance we set here will not be visible any more.
+        // The Style we set here is available from ZoomLevel06 to ZoomLevel20. That means if we zoom out a bit more, the appearance we set here will not be visible any more.
         capitalLayer.ZoomLevelSet.ZoomLevel06.ApplyUntilZoomLevel = ApplyUntilZoomLevel.Level20;
         ShapeFileFeatureLayer capitalLabelLayer = new ShapeFileFeatureLayer(@"../../AppData/WorldCapitals.shp");
-        <nowiki>//</nowiki> We can customize our own TextStyle. Here we passed in the font, the size, the style and the color.
+        // We can customize our own TextStyle. Here we passed in the font, the size, the style and the color.
         capitalLabelLayer.ZoomLevelSet.ZoomLevel01.DefaultTextStyle = TextStyles.CreateSimpleTextStyle("CITY_NAME", "Arial", 8, DrawingFontStyles.Italic, GeoColor.StandardColors.Black, 3, 3);
-        <nowiki>//</nowiki> The TextStyle we set here is available from ZoomLevel01 to ZoomLevel05.
+        // The TextStyle we set here is available from ZoomLevel01 to ZoomLevel05.
         capitalLabelLayer.ZoomLevelSet.ZoomLevel01.ApplyUntilZoomLevel = ApplyUntilZoomLevel.Level05;
         capitalLabelLayer.ZoomLevelSet.ZoomLevel06.DefaultTextStyle = TextStyles.Capital3("CITY_NAME");
-        <nowiki>//</nowiki> The TextStyle we set here is available from ZoomLevel06 to ZoomLevel20.
+        // The TextStyle we set here is available from ZoomLevel06 to ZoomLevel20.
         capitalLabelLayer.ZoomLevelSet.ZoomLevel06.ApplyUntilZoomLevel = ApplyUntilZoomLevel.Level20;
         capitalLabelLayer.DrawingMarginPercentage = 50;
@@ Line 275: / Line 287: @@
         winformsMap1.Refresh();
     }
-</source>
+</code>
 Can you imagine what the map will look like now? Below is the result. At first it appears like figure 7, and the map changes to figure 8 as you zoom in.
-{{Figure|QSG DesktopEdition Img12.jpg|Figure 7. Europe Map with two ZoomLevels, before Zoom In.}}
+{{desktopedition:QSG DesktopEdition Img12.jpg}}
+\\
+//Figure 7. Europe Map with two ZoomLevels, before Zoom In.//
-{{Figure|QSG DesktopEdition Img13.jpg|Figure 8. Europe Map with two ZoomLevels, after Zoom In.}}
+{{desktopedition:QSG DesktopEdition Img13.jpg}}
+\\
+//Figure 8. Europe Map with two ZoomLevels, after Zoom In.//
 ==== Notes ====
@@ Line 289: / Line 305: @@
 You now know the basics of using the Map Suite Map control and be able to get started adding functionality into your own applications. Let's recap what we have learned about the object relationships and how the pieces of Map Suite work together:
-#It is of the utmost importance that the units (feet, meters, decimal degrees, etc.) be set properly for the Map control based on the data.
+  -It is of the utmost importance that the units (feet, meters, decimal degrees, etc.) be set properly for the Map control based on the data.
-#Shapefiles provide the data used by a Map control to render a map.
+  -Shapefiles provide the data used by a Map control to render a map.
-#A Map is the basic control that contains all of the other objects that are used to tell how the map is to be rendered.
+  -A Map is the basic control that contains all of the other objects that are used to tell how the map is to be rendered.
-#A Map has one-to-many Layers. A Layer correlates one-to-one with a shape file (.shp).
+  -A Map has one-to-many Layers. A Layer correlates one-to-one with a shape file (.shp).
-#A Layer can have one-to-many ZoomLevels. ZoomLevels help to define ranges (upper and lower) of when a Layer should be shown or hidden.
+  -A Layer can have one-to-many ZoomLevels. ZoomLevels help to define ranges (upper and lower) of when a Layer should be shown or hidden.
-<br>
-{{Filelink}}[[:File:HelloWorld Desktop(WinForms).zip|Download Sample Code From This Exercise]] //(1.5 MB)//
+<faicon fa fa-download  fa-lg>  {{filehistory:HelloWorld Desktop_WinForms.zip|Download Sample Code From This Exercise}} //(1.5 MB)//
-[[Category:Map Suite Desktop Edition]] [[Category:Desktop GIS]] [[Category:Winforms]] [[Category:GIS]] [[Category:.NET]]

User Tools

Site Tools

Differences

Page Tools