User Tools

Site Tools


thinkgeo.mapsuite.portablecore.featuresourcecolumn

Differences

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

Link to this comparison view

Next revision
Previous revision
thinkgeo.mapsuite.portablecore.featuresourcecolumn [2015/08/20 03:08]
127.0.0.1 external edit
thinkgeo.mapsuite.portablecore.featuresourcecolumn [2017/03/16 21:59] (current)
Line 1: Line 1:
-====== ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn ======+====== ThinkGeo.MapSuite.Core.FeatureSourceColumn ======
  
 +{{section>​upgrade_map_suite_to_10.0}}
  
- 
-<!-- Class --> 
 This class represents a column contained within a FeatureSource. This class represents a column contained within a FeatureSource.
-=== Remarks === 
-A FeatureSource is typically represented by a number of InternalFeatures and their column data. This column represents the characteristics of that data. 
 ===== Inheritance Hierarchy ===== ===== Inheritance Hierarchy =====
-*System.Object +  ​*System.Object 
-**[[ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn]] +    ***ThinkGeo.MapSuite.Core.FeatureSourceColumn** 
-***[[ThinkGeo.MapSuite.PortableCore.DbfColumn]] +      ​*[[ThinkGeo.MapSuite.Core.DbfColumn]]
-***[[ThinkGeo.MapSuite.PortableCore.TabDbfColumn]]+
 ===== Members Summary ===== ===== Members Summary =====
 ==== Public Constructors ==== ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} FeatureSourceColumn() ​**
-{{wiki:​PublicMethod.gif|Public Method}}[[#FeatureSourceColumn()|FeatureSourceColumn]] ​  ​| ​   |    | This is the constructor to create a FeatureSourceColumn. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​FeatureSourceColumn(String)|FeatureSourceColumn]] ​  | String ​  ​| ​   | This is the constructor to create a FeatureSourceColumn. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​FeatureSourceColumn(String,​ String, Int32)|FeatureSourceColumn]] ​  | String, String, Int32   ​| ​   | This is the constructor to create a FeatureSourceColumn. ​  |+
  
-==== Protected Constructors ​==== +  * //This is the constructor to create a FeatureSourceColumn.//​ 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^+== Remarks ​== 
 +  * //This constructor is the default, but should not be used.// 
 +== Parameters ​== 
 +<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} FeatureSourceColumn(String) **
  
 +  * //This is the constructor to create a FeatureSourceColumn.//​
 +== Remarks ==
 +  * //This is the constructor that should be used.//
 +== Parameters ==
 +  * //​columnName//​
 +    * Type:String
 +    * Description:​This parameter represents the name of the column.
 +
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} FeatureSourceColumn(String,​String,​Int32) **
 +
 +  * //This is the constructor to create a FeatureSourceColumn.//​
 +== Remarks ==
 +  * //This is the constructor that should be used.//
 +== Parameters ==
 +  * //​columnName//​
 +    * Type:String
 +    * Description:​This parameter represents the name of the column.
 +
 +  * //​typeName//​
 +    * Type:String
 +    * Description:​This parameter represents the type name of the column.
 +
 +  * //​maxLength//​
 +    * Type:Int32
 +    * Description:​This parameter represents the maximum length of the column.
 +
 +<div newline></​div>​
 +==== Protected Constructors ====
 ==== Public Methods ==== ==== 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(overriden) ​  | Returns column name of FeatureSourceColumn ​  |+
  
-==== Protected Methods ==== +  * //Returns column name of FeatureSourceColumn//​ 
-^ 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 name of the column. ​  | +  * Description:Returns ​column name of FeatureSourceColumn
-| {{wiki:PublicProperty.gif|Public Property}}[[#​MaxLength|MaxLength]] ​  | Int32   ​| ​   | This property returns the maximum length of the column.   | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​TypeName|TypeName]] ​  | String ​  ​| ​   | This property returns the type name of the column. ​  |+
  
-==== 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 == 
-==== FeatureSourceColumn() ==== +  ​Type:Boolean 
-This is the constructor to create a FeatureSourceColumn. +  Description:N/A
-=== Overloads === +
-This overload creates a FeatureSourceColumn that is empty. +
-=== Remarks === +
-This constructor is the default, but should not be used. +
-=== Parameters === +
-^  Name ^  ​Type ​ ​Description ​^+
  
-[[#Public Constructors|Go Back]] +== Parameters == 
-==== FeatureSourceColumn(String) ==== +  ​* //obj// 
-This is the constructor to create a FeatureSourceColumn. +    * Type:Object 
-=== Overloads === +    * Description:N/A
-This overload creates a FeatureSourceColumn by specifying the column'​s name only. +
-=== Remarks === +
-This is the constructor that should be used. +
-=== Parameters ​=== +
-^  Name ^  ​Type ​^  ​Description ​+
-| columnName ​  | String<​!-- System.String --> ​  | This parameter represents the name of the column. ​  |+
  
-[[#Public Constructors|Go Back]] +<div newline></div
-==== FeatureSourceColumn(String,​ String, Int32) ==== +** {{wiki:​PublicMethod.gif|}} GetHashCode() **
-This is the constructor to create a FeatureSourceColumn. +
-=== Overloads === +
-This overload creates a FeatureSourceColumn by specifying the column'​s name, type and max length. +
-=== Remarks === +
-This is the constructor that should be used. +
-=== Parameters === +
-^  Name ^  Type ^  Description ^ +
-| columnName ​  | String<!-- System.String --  | This parameter represents the name of the column. ​  | +
-| typeName ​  | String<!-- System.String --  | This parameter represents the type name of the column. ​  | +
-| maxLength ​  | Int32<​!-- System.Int32 --> ​  | This parameter represents the maximum length of the column. ​  |+
  
-[[#Public Constructors|Go Back]] +  * //N/A// 
-===== Protected Constructors ===== +== Remarks ​== 
-===== Public Methods ===== +  * //N/A//
-==== Equals(Object) ==== +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Boolean<​!-- System.Boolean --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​ ​Description ​+  ​Type:Int32 
-| obj   | Object<​!-- System.Object --> ​  ​| ​   |+  Description:N/A
  
-<!-- System.Object --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +<div newline></​div>​ 
-==== GetHashCode() ​==== +** {{wiki:​PublicMethod.gif|}} GetType() **
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Int32<​!-- System.Int32 --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //N/A//
  
-<!-- System.Object --> +== Return Value == 
-[[#Public Methods|Go Back]] +  * Type:Type 
-==== GetType() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type Description ​+
-| Type<!-- System.Type --> ​  ​| ​   |+
  
-=== Parameters === +== Parameters ​== 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +==== Protected Methods ==== 
 +** {{wiki:​ProtectedMethod.gif|}} Finalize() **
  
-<!-- System.Object --> +  * //N/A// 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-==== ToString() ==== +  * //N/A//
-Returns column name of FeatureSourceColumn +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| String<​!-- System.String --> ​  | Returns column name of FeatureSourceColumn ​  |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​ ​Description ​^+  ​Type:Void 
 +  Description:N/A
  
-<!-- System.Object(overriden) --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +<div newline></​div>​ 
-===== Protected Methods ===== +** {{wiki:​ProtectedMethod.gif|}} MemberwiseClone() **
-==== Finalize() ==== +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //N/A//
  
-<!-- System.Object --> +== Return Value == 
-[[#​Protected Methods|Go Back]] +  ​* ​Type:Object 
-==== MemberwiseClone() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type Description ​+
-| Object<​!-- System.Object --> ​  ​| ​   |+
  
-=== Parameters === +== Parameters ​== 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +==== Public Properties ==== 
 +** {{wiki:​PublicProperty.gif|}} ColumnName **
  
-<!-- System.Object --> +  * //This property returns the name of the column.// 
-[[#​Protected Methods|Go Back]] +== Remarks == 
-===== Public Properties ===== +  * //None// 
-==== ColumnName ==== +== Return Value == 
-This property returns the name of the column. +  ​* ​Type:String
-=== Return Value === +
-^ Return ​Type +
-String<!-- System.String --> ​  |+
  
-<!-- ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn --> +** {{wiki:​PublicProperty.gif|}} TypeName **
-[[#Public Properties|Go Back]] +
-==== MaxLength ==== +
-This property returns the maximum length of the column. +
-=== Remarks === +
-The maximum length is user defined and not in any way enforced in our default FeatureSource implementation. It is mainly for display purposes or when dealing with a known Feature Source type. +
-=== Return Value === +
-^ Return Type ^ +
-| Int32<​!-- System.Int32 --> ​  |+
  
-<!-- ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn --> +  * //This property returns the type name of the column.// 
-[[#Public Properties|Go Back]] +== Remarks == 
-==== TypeName ==== +  * //This property is freeform and the type name is not tied to anything. It is wise to try and use familiar type names such as string, integer, date, etc., although it may not fit every different type of FeatureSource. We suggest thar you avoid using this property unless you know the types beforehand or simply want them for display purposes.// 
-This property returns the type name of the column. +== Return Value == 
-=== Remarks ​=== +  ​* ​Type:String
-This property is freeform and the type name is not tied to anything. It is wise to try and use familiar type names such as string, integer, date, etc., although it may not fit every different type of FeatureSource. We suggest thar you avoid using this property unless you know the types beforehand or simply want them for display purposes. +
-=== Return Value === +
-^ Return ​Type +
-String<!-- System.String --> ​  |+
  
-<!-- ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn --> +** {{wiki:​PublicProperty.gif|}} MaxLength ** 
-[[#Public Properties|Go Back]] + 
-===== Protected Properties ​===== +  * //This property returns the maximum length of the column.// 
-===== Public Events ====+== Remarks == 
-__NOTOC__ +  * //The maximum length is user defined and not in any way enforced in our default FeatureSource implementation. It is mainly for display purposes or when dealing with a known Feature Source type.// 
-[[Category:​MapSuitePortableCore]] +== Return Value == 
-[[Category:​ThinkGeo.MapSuite.PortableCore]] +  * Type:​Int32 
-[[Category:​UpdateDocumentation]]+ 
 +==== Protected Properties ==== 
 +==== Public Events ====
  
thinkgeo.mapsuite.portablecore.featuresourcecolumn.1440040132.txt.gz · Last modified: 2015/09/21 08:07 (external edit)