User Tools

Site Tools

Trace:
thinkgeo.mapsuite.mvcedition.mvccontrolbase

Differences

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

Link to this comparison view

Next revision 		Previous revision
thinkgeo.mapsuite.mvcedition.mvccontrolbase [2015/08/20 03:08]
127.0.0.1 external edit 		thinkgeo.mapsuite.mvcedition.mvccontrolbase [2017/03/16 21:59] (current)
Line 1: Line 1:
 ====== ThinkGeo.MapSuite.MvcEdition.MvcControlBase ====== ====== ThinkGeo.MapSuite.MvcEdition.MvcControlBase ======
  
 +{{section>​upgrade_map_suite_to_10.0}}
  
- 
-<!-- Class --> 
 This class defines the base abstract class for creating MVC control. This class defines the base abstract class for creating MVC control.
 ===== Inheritance Hierarchy ===== ===== Inheritance Hierarchy =====
-*System.Object +  ​*System.Object 
-**[[ThinkGeo.MapSuite.MvcEdition.MvcControlBase]] +    ***ThinkGeo.MapSuite.MvcEdition.MvcControlBase** 
-***[[ThinkGeo.MapSuite.MvcEdition.Map]]+      ​*[[ThinkGeo.MapSuite.MvcEdition.Map]]
 ===== Members Summary ===== ===== Members Summary =====
 ==== Public Constructors ==== ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
- 
 ==== Protected Constructors ==== ==== Protected Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​ProtectedMethod.gif|}} MvcControlBase() ​** 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#MvcControlBase()|MvcControlBase]] ​  ​| ​   |    | Initializes a new instance of the MvcControlBase class. ​  | + 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#MvcControlBase(String)|MvcControlBase]] ​  | String ​  ​| ​   | Initializes a new instance of the MvcControlBase class. ​  |+Initializes a new instance of the MvcControlBase class. 
 +== Remarks == 
 +N/A 
 +== Parameters == 
 +<div newline></​div>​ 
 +** {{wiki:​ProtectedMethod.gif|}} MvcControlBase(String) ​** 
 + 
 +Initializes a new instance of the MvcControlBase class. 
 +== Remarks == 
 +N/A 
 +== Parameters == 
 +  * //name// 
 +    * Type:​String 
 +    * Description:​The unique identifier name of the control.
  
 +<div newline></​div>​
 ==== Public Methods ==== ==== Public Methods ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} Fill(String) ​**
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​Equals(Object)|Equals]] ​  | Object ​  | Object ​  ​| ​   | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#Fill(String)|Fill]] ​  | String ​  ​| ​   | Fill an instance according to the input entity string ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​Fill(String,​ String)|Fill]] ​  | String, String ​  ​| ​   | Fill an instance based on the input model name according to the input entity string ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetHashCode()|GetHashCode]] ​  ​| ​   | Object ​  ​| ​   | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetType()|GetType]] ​  ​| ​   | Object ​  ​| ​   | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ToString(String)|ToString]] ​  | String ​  ​| ​   | Convert current object based on mode name to an entity string. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ToString()|ToString]] ​  ​| ​   | Object(overriden) ​  ​| ​   |+
  
 +Fill an instance according to the input entity string
 +== Remarks ==
 +N/A
 +
 +== Return Value ==
 +  * Type:Void
 +  * Description:​N/​A
 +
 +== Parameters ==
 +  * //​entityString//​
 +    * Type:String
 +    * Description:​the inpu entity string.
 +
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} Fill(String,​String) **
 +
 +Fill an instance based on the input model name according to the input entity string
 +== Remarks ==
 +N/A
 +
 +== Return Value ==
 +  * Type:Void
 +  * Description:​N/​A
 +
 +== Parameters ==
 +  * //​modelName//​
 +    * Type:String
 +    * Description:​the input model name
 +
 +  * //​entityString//​
 +    * Type:String
 +    * Description:​the input entity string
 +
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} ToString(String) **
 +
 +Convert current object based on mode name to an entity string.
 +== Remarks ==
 +N/A
 +
 +== Return Value ==
 +  * Type:String
 +  * Description:​an entity string
 +
 +== Parameters ==
 +  * //​modelName//​
 +    * Type:String
 +    * Description:​model name
 +
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} ToString() **
 +
 +N/A
 +== Remarks ==
 +N/A
 +
 +== Return Value ==
 +  * Type:String
 +  * Description:​N/​A
 +
 +== Parameters ==
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} Equals(Object) **
 +
 +N/A
 +== Remarks ==
 +N/A
 +
 +== Return Value ==
 +  * Type:​Boolean
 +  * Description:​N/​A
 +
 +== Parameters ==
 +  * //obj//
 +    * Type:Object
 +    * Description:​N/​A
 +
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} GetHashCode() **
 +
 +N/A
 +== Remarks ==
 +N/A
 +
 +== Return Value ==
 +  * Type:Int32
 +  * Description:​N/​A
 +
 +== Parameters ==
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} GetType() **
 +
 +N/A
 +== Remarks ==
 +N/A
 +
 +== Return Value ==
 +  * Type:Type
 +  * Description:​N/​A
 +
 +== Parameters ==
 +<div newline></​div>​
 ==== Protected Methods ==== ==== Protected Methods ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​ProtectedMethod.gif|}} ​LoadState() **
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] ​  ​| ​   | Object ​  ​| ​   | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​MemberwiseClone()|MemberwiseClone]] ​  ​| ​   | Object ​  ​| ​   |+
  
-==== Public Properties ==== +Restores ​the control ​information ​from a persistent object ​the was saved by the SaveState method. 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ +== Remarks == 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​ClientScriptBlocks|ClientScriptBlocks]] ​  | Dictionary<​String,​String> ​  ​| ​   | Gets the client script blocks which will be registered to the page.   | +N/A
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​ClientScriptFileNames|ClientScriptFileNames]] ​  | Dictionary<​String,​String> ​  ​| ​   | Gets the client script files which will be registered to the page.   | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Height|Height]] ​  | Unit   ​| ​   | Gets or sets the height of the control.   | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​HtmlAttributes|HtmlAttributes]] ​  | Dictionary<​String,​String> ​  ​| ​   | Gets the customized html attributes of the control. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Id|Id]] ​  | String ​  ​| ​   | Gets the client id of the control, it will be calculated ​from Name property. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Name|Name]] ​  | String ​  ​| ​   | Gets the unique identifier name of the control.   | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​StyleSheetFileNames|StyleSheetFileNames]] ​  | Collection<​String> ​  ​| ​   | Gets the css files which will be wrote to the client html.   | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​ViewContext|ViewContext]] ​  | ViewContext ​  ​| ​   | Gets the ViewContext of the page which includes the control. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Visible|Visible]] ​  | Boolean ​  ​| ​   | Gets or sets the visibility of the control. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Width|Width]] ​  | Unit   ​| ​   | Gets or sets the width of the control. ​  |+
  
-==== Protected Properties ==== +== Return Value == 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ +  * Type:Void 
-| {{wiki:ProtectedProperty.gif|Protected Property}}[[#​ClientScriptManager|ClientScriptManager]] ​  | [[ThinkGeo.MapSuite.MvcEdition.MvcClientScriptManager|MvcClientScriptManager]] ​  ​| ​   | Gets the object which is used for managing, registering the client scripts. ​  | +  * Description:N/A
-| {{wiki:ProtectedProperty.gif|Protected Property}}[[#​ClientStyleSheetManager|ClientStyleSheetManager]] ​  | [[ThinkGeo.MapSuite.MvcEdition.MvcClientStyleSheetManager|MvcClientStyleSheetManager]] ​  ​| ​   | Gets the object which is used for managing, registering the css files used by the control. ​  |+
  
-==== Public Events ==== +== Parameters ​== 
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^+<div newline></​div>​ 
 +** {{wiki:​ProtectedMethod.gif|}} PreRender() **
  
-===== Public Constructors ===== +Does the preparation before sending the Mvc control to the provided HtmlWriter ​of the ViewContext. 
-===== Protected Constructors ===== +== Remarks ​== 
-==== MvcControlBase() ==== +This method notifies the Mvc control to perform any necessary prerendering steps prior to rendering content and save state.
-Initializes a new instance ​of the MvcControlBase class. +
-=== Parameters === +
-^  Name ^  Type ^  Description ^+
  
-[[#​Protected Constructors|Go Back]] +== Return Value == 
-==== MvcControlBase(String) ​==== +  ​* Type:Void 
-Initializes a new instance of the MvcControlBase class. +  * Description:N/A
-=== Parameters === +
-^  Name ^  ​Type ​^  ​Description ​^ +
-| name   | String<​!-- System.String --> ​  | The unique identifier name of the control. ​  |+
  
-[[#​Protected Constructors|Go Back]] +== Parameters ​== 
-===== Public Methods ===== +<div newline></​div>​ 
-==== Equals(Object) ==== +** {{wiki:​ProtectedMethod.gif|}} Render(HtmlTextWriter) **
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Boolean<​!-- System.Boolean --> ​  ​| ​   ​|+
  
-=== Parameters ​=== +Sends the Mvc control content to a provided HtmlTextWriter object, which wirtes the content to be rendered on the client. 
-^  Name ^  Type ^  Description ^ +== Remarks ​== 
-| obj   | Object<​!-- System.Object --> ​  ​| ​   |+When developing a custom server control, you can override this method to generate conteol for a page.
  
-<!-- System.Object --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:Void 
-==== Fill(String) ==== +  * Description:N/A
-Fill an instance according to the input entity string +
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters ​=== +== Parameters == 
-^  Name ^  ​Type ​^  ​Description ​^ +  ​* //​htmlTextWriter//​ 
-| entityString ​  | String<​!-- System.String --> ​  ​| ​the inpu entity string.   |+    * Type:​HtmlTextWriter 
 +    * Description:The HtmlTextWriter object that receives ​the Mvc control content.
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MvcControlBase --> +<div newline></​div> 
-[[#Public Methods|Go Back]] +** {{wiki:​ProtectedMethod.gif|}} SaveState() **
-==== Fill(String, String) ==== +
-Fill an instance based on the input model name according to the input entity string +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +Saves any necessary information of the Mvc control, which will be used in some other places. 
-^  Name ^  Type ^  Description ^ +== Remarks ​== 
-| modelName ​  | String<​!-- System.String --> ​  | the input model name   | +N/A
-| entityString ​  | String<​!-- System.String --> ​  | the input entity string ​  |+
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MvcControlBase --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:Void 
-==== GetHashCode() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| Int32<​!-- System.Int32 --> ​  ​| ​   |+
  
-=== Parameters === +== Parameters == 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +** {{wiki:​ProtectedMethod.gif|}} Finalize() **
  
-<!-- System.Object --> +N/A 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-==== GetType() ==== +N/A
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Type<!-- System.Type --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* Type:Void 
 +  * Description:N/A
  
-<!-- System.Object --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +<div newline></​div>​ 
-==== ToString(String) ​==== +** {{wiki:​ProtectedMethod.gif|}} MemberwiseClone() **
-Convert current object based on mode name to an entity string. +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| String<​!-- System.String --> ​  | an entity string ​  |+
  
-=== Parameters ​=== +N/A 
-^  Name ^  Type ^  Description ^ +== Remarks ​== 
-| modelName ​  | String<​!-- System.String --> ​  | model name   |+N/A
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MvcControlBase --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:Object 
-==== ToString() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| String<​!-- System.String --> ​  ​| ​   |+
  
-=== Parameters === +== Parameters ​== 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +==== Public Properties ==== 
 +** {{wiki:​PublicProperty.gif|}} Id **
  
-<!-- System.Object(overriden) --> +Gets the client id of the control, it will be calculated from Name property. 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-===== Protected Methods ===== +N/A 
-==== Finalize() ==== +== Return Value == 
-=== Return Value === +  ​* ​Type:String
-^ Return ​Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +** {{wiki:​PublicProperty.gif|}} ​Name **
-^  ​Name ^  Type ^  Description ^+
  
-<!-- System.Object --> +Gets the unique identifier name of the control. 
-[[#​Protected Methods|Go Back]] +== Remarks ​== 
-==== MemberwiseClone() ==== +N/A 
-=== Return Value === +== Return Value == 
-^ Return ​Type ^ Description ^ +  ​* ​Type:String
-| Object<​!-- System.Object --> ​  ​| ​   |+
  
-=== Parameters === +** {{wiki:​PublicProperty.gif|}} Width **
-^  Name ^  Type ^  Description ^+
  
-<!-- System.Object --> +Gets or sets the width of the control. 
-[[#​Protected Methods|Go Back]] +== Remarks ​== 
-===== Public Properties ===== +N/A 
-==== ClientScriptBlocks ==== +== Return Value == 
-Gets the client script blocks which will be registered to the page. +  ​* ​Type:Unit
-=== Return Value === +
-^ Return ​Type ^ +
-| Dictionary<​String,​String><​!-- System.Collections.Generic.Dictionary{System.String,​System.String} --> ​  |+
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MvcControlBase --> +** {{wiki:​PublicProperty.gif|}} Height **
-[[#Public Properties|Go Back]] +
-==== ClientScriptFileNames ==== +
-Gets the client script files which will be registered to the page. +
-=== Return Value === +
-^ Return Type ^ +
-| Dictionary<​String,​String><​!-- System.Collections.Generic.Dictionary{System.String,​System.String} --> ​  |+
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MvcControlBase --> 
-[[#Public Properties|Go Back]] 
-==== Height ==== 
 Gets or sets the height of the control. Gets or sets the height of the control.
-=== Return Value === +== Remarks == 
-^ Return Type ^ +N/A 
-| Unit<!-- System.Web.UI.WebControls.Unit --> ​  |+== Return Value == 
 +  * Type:Unit 
 + 
 +** {{wiki:​PublicProperty.gif|}} Visible ** 
 + 
 +Gets or sets the visibility of the control. 
 +== Remarks ​== 
 +N/A 
 +== Return ​Value == 
 +  * Type:Boolean 
 + 
 +** {{wiki:​PublicProperty.gif|}} HtmlAttributes **
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MvcControlBase --> 
-[[#Public Properties|Go Back]] 
-==== HtmlAttributes ==== 
 Gets the customized html attributes of the control. Gets the customized html attributes of the control.
-=== Return Value === +== Remarks == 
-^ Return ​Type ^ +N/A 
-| Dictionary<​String,​String>​<!-- System.Collections.Generic.Dictionary{System.String,​System.String} --> ​  |+== Return Value == 
 +  ​* ​Type:Dictionary<​String,​String>​
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MvcControlBase --> +** {{wiki:​PublicProperty.gif|}} ClientScriptFileNames **
-[[#Public Properties|Go Back]] +
-==== Id ==== +
-Gets the client id of the control, it will be calculated from Name property. +
-=== Return Value === +
-^ Return Type ^ +
-| String<​!-- System.String --> ​  |+
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MvcControlBase --> +Gets the client script files which will be registered to the page. 
-[[#Public Properties|Go Back]] +== Remarks ​== 
-==== Name ==== +N/A 
-Gets the unique identifier name of the control. +== Return Value == 
-=== Return Value === +  * Type:​Dictionary<​String,​String>​ 
-^ Return ​Type ^ + 
-| String<!-- System.String ​-->   ​|+** {{wiki:​PublicProperty.gif|}} ClientScriptBlocks ** 
 + 
 +Gets the client script blocks which will be registered to the page. 
 +== Remarks == 
 +N/A 
 +== Return Value == 
 +  ​* ​Type:Dictionary<String,String> 
 + 
 +** {{wiki:​PublicProperty.gif|}} StyleSheetFileNames **
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MvcControlBase --> 
-[[#Public Properties|Go Back]] 
-==== StyleSheetFileNames ==== 
 Gets the css files which will be wrote to the client html. Gets the css files which will be wrote to the client html.
-=== Return Value === +== Remarks == 
-^ Return ​Type ^ +N/A 
-| Collection<​String>​<!-- System.Collections.ObjectModel.Collection{System.String} --> ​  |+== Return Value == 
 +  ​* ​Type:Collection<​String>​ 
 + 
 +** {{wiki:​PublicProperty.gif|}} ViewContext **
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MvcControlBase --> 
-[[#Public Properties|Go Back]] 
-==== ViewContext ==== 
 Gets the ViewContext of the page which includes the control. Gets the ViewContext of the page which includes the control.
-=== Return Value === +== Remarks == 
-^ Return ​Type ^ +N/A 
-| ViewContext<​!-- System.Web.Mvc.ViewContext ​--> ​  |+== Return Value == 
 +  ​* ​Type:ViewContext
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MvcControlBase --> +==== Protected Properties ​==== 
-[[#Public Properties|Go Back]] +** {{wiki:​ProtectedProperty.gif|}} ClientScriptManager **
-==== Visible ​==== +
-Gets or sets the visibility of the control. +
-=== Return Value === +
-^ Return Type ^ +
-| Boolean<​!-- System.Boolean --> ​  |+
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MvcControlBase --> 
-[[#Public Properties|Go Back]] 
-==== Width ==== 
-Gets or sets the width of the control. 
-=== Return Value === 
-^ Return Type ^ 
-| Unit<!-- System.Web.UI.WebControls.Unit --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.MvcControlBase --> 
-[[#Public Properties|Go Back]] 
-===== Protected Properties ===== 
-==== ClientScriptManager ==== 
 Gets the object which is used for managing, registering the client scripts. Gets the object which is used for managing, registering the client scripts.
-=== Return Value === +== Remarks == 
-^ Return ​Type ^ +N/A 
-| [[ThinkGeo.MapSuite.MvcEdition.MvcClientScriptManager|MvcClientScriptManager]]<!-- ThinkGeo.MapSuite.MvcEdition.MvcClientScriptManager --> ​  |+== Return Value == 
 +  ​* ​Type:[[ThinkGeo.MapSuite.MvcEdition.MvcClientScriptManager|MvcClientScriptManager]] 
 + 
 +** {{wiki:​ProtectedProperty.gif|}} ClientStyleSheetManager **
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MvcControlBase --> 
-[[#​Protected Properties|Go Back]] 
-==== ClientStyleSheetManager ==== 
 Gets the object which is used for managing, registering the css files used by the control. Gets the object which is used for managing, registering the css files used by the control.
-=== Return Value === +== Remarks == 
-^ Return ​Type ^ +N/A 
-| [[ThinkGeo.MapSuite.MvcEdition.MvcClientStyleSheetManager|MvcClientStyleSheetManager]]<!-- ThinkGeo.MapSuite.MvcEdition.MvcClientStyleSheetManager --> ​  |+== Return Value == 
 +  ​* ​Type:[[ThinkGeo.MapSuite.MvcEdition.MvcClientStyleSheetManager|MvcClientStyleSheetManager]]
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MvcControlBase --> +==== Public Events ====
-[[#​Protected Properties|Go Back]] +
-===== Public Events ===== +
-__NOTOC__ +
-[[Category:​MvcEdition]] +
-[[Category:​ThinkGeo.MapSuite.MvcEdition]] +
-[[Category:​UpdateDocumentation]]+
  
thinkgeo.mapsuite.mvcedition.mvccontrolbase.1440040131.txt.gz · Last modified: 2015/09/21 03:35 (external edit)

Page Tools