Differences

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

--- thinkgeo.mapsuite.core.customcolumnfetcheventargs [2015/08/20 03:08]
127.0.0.1 external edit
+++ thinkgeo.mapsuite.core.customcolumnfetcheventargs [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.Core.CustomColumnFetchEventArgs ======
+{{section>upgrade_map_suite_to_10.0}}
-<!-- Class -->
 This class represents the parameters passed in through the CustomFieldFetch event.
-=== Remarks ===
-CustomColumnFetch Event Background
-This event is used primarily when you have data relating to a particular feature or set of features that is not within source of the data. For example, you may have a shape file of the world whose .dbf component describes the area and population of each country. Additionally, in an outside SQL Server table, you may also have data about the countries, and it is this data that you wish to use for determining how you want to color each country.
-To integrate this SQL data, you simply create a file name that does not exist in the .dbf file. Whenever Map Suite is queried to return records that specifically require this field, the FeatureSource will raise this event and allow you the developer to supply the data. In this way, you can query the SQL table and store the data in some sort of collection, and then when the event is raised, simply supply that data.
-As this is an event, it will raise for each feature and field combination requested. This means that the event can be raised quite often, and we suggest that you cache the data you wish to supply in memory. We recommend against sending out a new SQL query each time this event is raised. Image that you are supplementing two columns and your query returns 2,000 rows. This means that if you requested those fields, the event would be raised 4,000 times.
 ===== Inheritance Hierarchy =====
-*System.Object
+  *System.Object
-**System.EventArgs
+    *System.EventArgs
-***[[ThinkGeo.MapSuite.Core.CustomColumnFetchEventArgs]]
+      ***ThinkGeo.MapSuite.Core.CustomColumnFetchEventArgs**
 ===== Members Summary =====
 ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} CustomColumnFetchEventArgs(String,String) **
-| {{wiki:PublicMethod.gif|Public Method}}[[#CustomColumnFetchEventArgs(String, String)|CustomColumnFetchEventArgs]]   | String, String   |    | This is the constructor that allows you to create the event arguments.   |
+  * //This is the constructor that allows you to create the event arguments.//
+== Remarks ==
+  * //None//
+== Parameters ==
+  * //columnName//
+    * Type:String
+    * Description:The column name you need data for.
+  * //id//
+    * Type:String
+    * Description:The Id of the feature you need data for.
+<div newline></div>
 ==== Protected Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
 ==== Public Methods ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} ToString() **
-| {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]]   | Object   | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]]   |    | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]]   |    | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]]   |    | Object   |    |
-==== Protected Methods ====
+  * //N/A//
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+== Remarks ==
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]]   |    | Object   |    |
+  * //N/A//
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]]   |    | Object   |    |
-==== Public Properties ====
+== Return Value ==
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+  * Type:String
-| {{wiki:PublicProperty.gif|Public Property}}[[#ColumnName|ColumnName]]   | String   |    | This property returns the column name that you need to return data for.   |
+  * Description:N/A
-| {{wiki:PublicProperty.gif|Public Property}}[[#ColumnValue|ColumnValue]]   | String   |    | This parameter returns the field decimalDegreesValue that the event is seeking. It is intended to be set in the event.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#Id|Id]]   | String   |    | This property returns the Id that you need to return data for.   |
-==== Protected Properties ====
+== Parameters ==
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} Equals(Object) **
-==== Public Events ====
+  * //N/A//
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^
+== Remarks ==
+  * //N/A//
-===== Public Constructors =====
+== Return Value ==
-==== CustomColumnFetchEventArgs(String, String) ====
+  * Type:Boolean
-This is the constructor that allows you to create the event arguments.
+  * Description:N/A
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-| columnName   | String<!-- System.String -->   | The column name you need data for.   |
-| id   | String<!-- System.String -->   | The Id of the feature you need data for.   |
-[[#Public Constructors|Go Back]]
+== Parameters ==
-===== Protected Constructors =====
+  * //obj//
-===== Public Methods =====
+    * Type:Object
-==== Equals(Object) ====
+    * Description:N/A
-=== Return Value ===
-^ Return Type ^ Description ^
-| Boolean<!-- System.Boolean -->   |    |
-=== Parameters ===
+<div newline></div>
-^  Name ^  Type ^  Description ^
+** {{wiki:PublicMethod.gif|}} GetHashCode() **
-| obj   | Object<!-- System.Object -->   |    |
-<!-- System.Object -->
+  * //N/A//
-[[#Public Methods|Go Back]]
+== Remarks ==
-==== GetHashCode() ====
+  * //N/A//
-=== Return Value ===
-^ Return Type ^ Description ^
-| Int32<!-- System.Int32 -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Int32
+  * Description:N/A
-<!-- System.Object -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+<div newline></div>
-==== GetType() ====
+** {{wiki:PublicMethod.gif|}} GetType() **
-=== Return Value ===
-^ Return Type ^ Description ^
-| Type<!-- System.Type -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
+  * //N/A//
-<!-- System.Object -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Type
-==== ToString() ====
+  * Description:N/A
-=== Return Value ===
-^ Return Type ^ Description ^
-| String<!-- System.String -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
+==== Protected Methods ====
+** {{wiki:ProtectedMethod.gif|}} Finalize() **
-<!-- System.Object -->
+  * //N/A//
-[[#Public Methods|Go Back]]
+== Remarks ==
-===== Protected Methods =====
+  * //N/A//
-==== Finalize() ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Void
+  * Description:N/A
-<!-- System.Object -->
+== Parameters ==
-[[#Protected Methods|Go Back]]
+<div newline></div>
-==== MemberwiseClone() ====
+** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
-=== Return Value ===
-^ Return Type ^ Description ^
-| Object<!-- System.Object -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
+  * //N/A//
-<!-- System.Object -->
+== Return Value ==
-[[#Protected Methods|Go Back]]
+  * Type:Object
-===== Public Properties =====
+  * Description:N/A
-==== ColumnName ====
-This property returns the column name that you need to return data for.
-=== Remarks ===
-You will need to look up the Id in your external data source and find this column's data.
-CustomColumnFetch Event Background
+== Parameters ==
+<div newline></div>
+==== Public Properties ====
+** {{wiki:PublicProperty.gif|}} ColumnName **
-This event is used primarily when you have data relating to a particular feature or set of features that is not within source of the data. For example, you may have a shape file of the world whose .dbf component describes the area and population of each country. Additionally, in an outside SQL Server table, you may also have data about the countries, and it is this data that you wish to use for determining how you want to color each country.
+This property returns the column name that you need to return data for.
+== Remarks ==
-To integrate this SQL data, you simply create a file name that does not exist in the .dbf file. Whenever Map Suite is queried to return records that specifically require this field, the FeatureSource will raise this event and allow you the developer to supply the data. In this way, you can query the SQL table and store the data in some sort of collection, and then when the event is raised, simply supply that data.
+You will need to look up the Id in your external data source and find this column's data. CustomColumnFetch Event Background This event is used primarily when you have data relating to a particular feature or set of features that is not within source of the data. For example, you may have a shape file of the world whose .dbf component describes the area and population of each country. Additionally, in an outside SQL Server table, you may also have data about the countries, and it is this data that you wish to use for determining how you want to color each country. To integrate this SQL data, you simply create a file name that does not exist in the .dbf file.  Whenever Map Suite is queried to return records that specifically require this field, the FeatureSource will raise this event and allow you the developer to supply the data. In this way, you can query the SQL table and store the data in some sort of collection, and then when the event is raised, simply supply that data. As this is an event, it will raise for each feature and field combination requested. This means that the event can be raised quite often, and we suggest that you cache the data you wish to supply in memory. We recommend against sending out a new SQL query each time this event is raised. Image that you are supplementing two columns and your query returns 2,000 rows. This means that if you requested those fields, the event would be raised 4,000 times.
+== Return Value ==
-As this is an event, it will raise for each feature and field combination requested. This means that the event can be raised quite often, and we suggest that you cache the data you wish to supply in memory. We recommend against sending out a new SQL query each time this event is raised. Image that you are supplementing two columns and your query returns 2,000 rows. This means that if you requested those fields, the event would be raised 4,000 times.
+  * Type:String
-=== Return Value ===
-^ Return Type ^
-| String<!-- System.String -->   |
-<!-- ThinkGeo.MapSuite.Core.CustomColumnFetchEventArgs -->
-[[#Public Properties|Go Back]]
-==== ColumnValue ====
-This parameter returns the field decimalDegreesValue that the event is seeking. It is intended to be set in the event.
-=== Remarks ===
-When you lookup the Id and FieldName, you should set this property with the data from your external data source.
-CustomColumnFetch Event Background
-It is used primarily when you have data relating to a particular feature or set of features that is not within source of the data. For example, you may have a shape file of the world whose .dbf component describes the area and population of each country. Additionally, in an outside SQL Server table, you may also have data about the countries, and it is this data that you wish to use for determining how you want to color each country.
-To integrate this SQL data, you simply create a file name that does not exist in the .dbf file. Whenever Map Suite is queried to return records that specifically require this field, the FeatureSource will raise this event and allow you the developer to supply the data. In this way, you can query the SQL table and store the data in some sort of collection, and then when the event is raised, simply supply that data.
-As this is an event, it will raise for each feature and field combination requested. This means that the event can be raised quite often, and we suggest that you cache the data you wish to supply in memory. We recommend against sending out a new SQL query each time this event is raised. Image that you are supplementing two columns and your query returns 2,000 rows. This means that if you requested those fields, the event would be raised 4,000 times.
+** {{wiki:PublicProperty.gif|}} Id **
-=== Return Value ===
-^ Return Type ^
-| String<!-- System.String -->   |
-<!-- ThinkGeo.MapSuite.Core.CustomColumnFetchEventArgs -->
-[[#Public Properties|Go Back]]
-==== Id ====
 This property returns the Id that you need to return data for.
-=== Remarks ===
+== Remarks ==
-You will need to look up the Id in your external data source and find this field's data.
+You will need to look up the Id in your external data source and find this field's data. CustomColumnFetch Event Background It is used primarily when you have data relating to a particular feature or set of features that is not within source of the data. For example, you may have a shape file of the world whose .dbf component describes the area and population of each country. Additionally, in an outside SQL Server table, you may also have data about the countries, and it is this data that you wish to use for determining how you want to color each country. To integrate this SQL data, you simply create a file name that does not exist in the .dbf file.  Whenever Map Suite is queried to return records that specifically require this field, the FeatureSource will raise this event and allow you the developer to supply the data. In this way, you can query the SQL table and store the data in some sort of collection, and then when the event is raised, simply supply that data. As this is an event, it will raise for each feature and field combination requested. This means that the event can be raised quite often, and we suggest that you cache the data you wish to supply in memory. We recommend against sending out a new SQL query each time this event is raised. Image that you are supplementing two columns and your query returns 2,000 rows. This means that if you requested those fields, the event would be raised 4,000 times.
+== Return Value ==
+  * Type:String
-CustomColumnFetch Event Background
+** {{wiki:PublicProperty.gif|}} ColumnValue **
-It is used primarily when you have data relating to a particular feature or set of features that is not within source of the data. For example, you may have a shape file of the world whose .dbf component describes the area and population of each country. Additionally, in an outside SQL Server table, you may also have data about the countries, and it is this data that you wish to use for determining how you want to color each country.
+This parameter returns the field decimalDegreesValue that the event is seeking. It is intended to be set in the event.
+== Remarks ==
+When you lookup the Id and FieldName, you should set this property with the data from your external data source. CustomColumnFetch Event Background It is used primarily when you have data relating to a particular feature or set of features that is not within source of the data. For example, you may have a shape file of the world whose .dbf component describes the area and population of each country. Additionally, in an outside SQL Server table, you may also have data about the countries, and it is this data that you wish to use for determining how you want to color each country. To integrate this SQL data, you simply create a file name that does not exist in the .dbf file.  Whenever Map Suite is queried to return records that specifically require this field, the FeatureSource will raise this event and allow you the developer to supply the data. In this way, you can query the SQL table and store the data in some sort of collection, and then when the event is raised, simply supply that data. As this is an event, it will raise for each feature and field combination requested. This means that the event can be raised quite often, and we suggest that you cache the data you wish to supply in memory. We recommend against sending out a new SQL query each time this event is raised. Image that you are supplementing two columns and your query returns 2,000 rows. This means that if you requested those fields, the event would be raised 4,000 times.
+== Return Value ==
+  * Type:String
-To integrate this SQL data, you simply create a file name that does not exist in the .dbf file. Whenever Map Suite is queried to return records that specifically require this field, the FeatureSource will raise this event and allow you the developer to supply the data. In this way, you can query the SQL table and store the data in some sort of collection, and then when the event is raised, simply supply that data.
+==== Protected Properties ====
+==== Public Events ====
-As this is an event, it will raise for each feature and field combination requested. This means that the event can be raised quite often, and we suggest that you cache the data you wish to supply in memory. We recommend against sending out a new SQL query each time this event is raised. Image that you are supplementing two columns and your query returns 2,000 rows. This means that if you requested those fields, the event would be raised 4,000 times.
-=== Return Value ===
-^ Return Type ^
-| String<!-- System.String -->   |
-<!-- ThinkGeo.MapSuite.Core.CustomColumnFetchEventArgs -->
-[[#Public Properties|Go Back]]
-===== Protected Properties =====
-===== Public Events =====
-__NOTOC__
-[[Category:MapSuiteCore]]
-[[Category:ThinkGeo.MapSuite.Core]]
-[[Category:UpdateDocumentation]]

User Tools

Site Tools

Differences

Page Tools