DotSpatial.Modeling.Forms
ProjectionElement
A modular component that can be inherited to retrieve parameters for functions.
The group box for this element
Creates a blank dialog element
Fires whenever the
Called to fire the click event for this element
A mouse event args thingy
Occurs when the dialong element is clicked
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Required designer variable
Required method for Designer support - do not modify
the contents of this method with the code editor.
Fires when the inactive areas around the controls are clicked on the element.
Gets or sets the group box that surrounds the element contents
Gets or sets the status label
Gets or sets the tool tip text to display when the mouse hovers over the light status
Gets the current status the input
Gets or sets the Parameter that the element represents
Creates a new instance of ProjectionElement
Gets or sets the Parameter that the element represents
Used to create arrays of data sets with an associated name to be passed into Tools to populate their dialog boxes
Creates an instance of a simple object that holds a name and a dataset
The name of the DataSet in this object
The IDataSet in this object
Returns the Name
The name of the DataSet in this object
The IDataSet in this object
A strongly-typed resource class, for looking up localized strings, etc.
Returns the cached ResourceManager instance used by this class.
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
Defines the way a tool interfaces with the toolbox
The parameters array should be populated with default values here
Fires when one of the paramters value has beend changed, usually when a user changes a input or output parameters value, this can be used to populate other parameters default values.
Once the parameters have been configured the Execute command can be called, it returns true if succesful
A cancel progress handler that used to indicate how much of the tool is done
Returns the name of the tool
A UniqueName Identifying this Tool, if another tool with the same UniqueName exists this tool will not be loaded. The is persisted by the model builder in saved files.
Returns the category of tool that the ITool should be added to
Returns the Version of the tool
Returns the Author of the tool's name
Returns a brief description displayed when the user hovers over the tool in the toolbox
Gets or Sets the input paramater array
Gets or Sets the output paramater array
32x32 Bitmap - The Large icon that will appears in the Tool Dialog Next to the tools name
Image displayed in the help area when no input field is selected
Help text to be displayed when no input field is selected
Returns the address of the tools help web page in HTTP://... format. Return a empty string to hide the help hyperlink.
A strongly-typed resource class, for looking up localized strings, etc.
Returns the cached ResourceManager instance used by this class.
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
Looks up a localized string similar to There are no setting for the default Tool Provider. It scans the same folders the ToolManager scans for Tool Providers.
Looks up a localized string similar to Default Tool Provider Settings.
Looks up a localized string similar to Press the button to specify an Extent.
Looks up a localized string similar to No feature set is specified..
Looks up a localized string similar to The feature set is valid..
Looks up a localized string similar to Selected features.
Looks up a localized string similar to The feature set selected was the incorrect type..
Looks up a localized string similar to Input.
Looks up a localized string similar to The value is invalid, it must be a decimal between %min and %max.
Looks up a localized string similar to The value is invalid, it must be an integer between %min and %max.
Looks up a localized string similar to Output.
Looks up a localized string similar to The parameter is invalid.
Looks up a localized string similar to The parameter is valid.
Boolean Parameters returned by an ITool allows the tool to specify default value
This is the base class for the parameter array to be passed into a ITool
Call this when the parameter's value is changed
Populates the parameter with default values
This method returns the dialog component that should be used to visualise INPUT to this parameter
This method returns the dialog component that should be used to visualise OUTPUT to this parameter
This returns a duplicate of this object.
Returns a shallow copy of the Parameter class
A new Parameters class that is a shallow copy of the original parameters class
Fires when the parameter's value is changed
Specify if a graphic should be added to the model to represent the parameter
Used to identify this parameter in the modeler, it will be set automatically by the modeler
Gets true if the parameter contains a value and false if none has been specified
Gets or sets the value of the parameter
The name of that parameter that shows up in auto generated forms
Gets the type of data used in this parameter
Gets or Sets the help image that will appear beside the parameter element when it is clicked
Gets or Sets the help text that will appear beside the parameter element when it is clicked
Creates a new Boolean parameter
The name of the parameter
The text to appear adjacent to the checkBox
Creates a new Boolean parameter
The name of the parameter
The text to appear adjacent to the checkBox
The default value
This method returns the dialog component that should be used to visualise INPUT to this parameter
This method returns the dialog component that should be used to visualise OUTPUT to this parameter
Specifies the value of the parameter (This is also the default value for input)
Gets or sets the text that appears beside the check box in a Tool Dialog
DateTime Parameters returned by an ITool allows the tool to specify default value
Creates a new string parameter
The name of the parameter
Creates a new string parameter
The name of the parameter
The default value
This method returns the dialog component that should be used to visualise INPUT to this parameter
This method returns the dialog component that should be used to visualise OUTPUT to this parameter
Specifies the value of the parameter (This is also the default value for input)
Double Parameter returned by an ITool allows the tool to specify a range and default value
Creates a new double parameter
The name of the parameter
Creates a new double parameter
The name of the parameter
The default value
Creates a new double parameter
The name of the parameter
The default value
The minimum value
The maximum value
This method returns the dialog component that should be used to visualise INPUT to this parameter
This method returns the dialog component that should be used to visualise OUTPUT to this parameter
Specifies the value of the parameter (This is also the default value for input)
The minimum range for the parameter Default: -1.79769313486232e308
The maximum range for the paramater Default: 1.79769313486232e308
ProjectionParam
Creates a new instance of ProjectionParam with the specified name
and a default projection of WGS1984
Creates a new instance of an Extent Param with the specified name
and the specified projection as the default projection that will
appear if no changes are made.
This method returns the dialog component that should be used to visualize INPUT to this parameter
This method returns the dialog component that should be used to visualize OUTPUT to this parameter
Gets or sets a value indicating whether the extent should be modified to show the MapExtent
before being shown in the tool dialog.
Specifies the value of the parameter (This is also the default value for input)
Raster parameter allows ITools to specify that they require a Raster data set as input
Creates a new Feature Set Parameter
The name of the parameter
Generates a default instance of the data type so that tools have something to write too
This method returns the dialog component that should be used to visualise INPUT to this parameter
This method returns the dialog component that should be used to visualise OUTPUT to this parameter
Specifies the value of the parameter (This is also the default value for input)
A File access parameter
Creates a new Feature Set Parameter
The name of the parameter
The string dialog filter to use.
Creates a new Feature Set Parameter
The name of the parameter
Creates a new Feature Set Parameter
The name of the parameter
A TextFile
Generates a default instance of the data type so that tools have something to write too
This method returns the dialog component that should be used to visualize INPUT to this parameter
This method returns the dialog component that should be used to visualize OUTPUT to this parameter
Gets or sets the filter expression to limit extensions that can be used for this FileParam.
Specifies the value of the parameter (This is also the default value for input)
Index Parameters returned by an ITool allows the tool to select the index for given Featureset indexs.
Creates a new Index parameter
The name of the parameter
This method returns the dialog component that should be used to visualise INPUT to this parameter
The featureset used to populate the query generator
Specifies the value of the parameter (This will give the result featureset that user want handle.)
Int Parameters returned by an ITool allows the tool to specify a range and default value
Creates a new integer parameter
The name of the parameter
Creates a new integer parameter
The name of the parameter
The default value
Creates a new integer parameter
The name of the parameter
The default value
The minimum value
The maximum value
This method returns the dialog component that should be used to visualise INPUT to this parameter
This method returns the dialog component that should be used to visualise OUTPUT to this parameter
The minimum range for the parameter Default: -2, 147, 483, 648
The maximum range for the paramater Default: 2, 147, 483, 648
Specifies the value to use by default must be between the min and max
Line Feature Parameter past back from a ITool to the toolbox manager
Creates a new Line Feature Set parameter
The name of the parameter
Generates a default instance of the data type so that tools have something to write too
This method returns the dialog component that should be used to visualise INPUT to this parameter
This method returns the dialog component that should be used to visualise OUTPUT to this parameter
Specifies the value of the parameter (This is also the default value for input)
List of strings parameter returned by an ITool allows the tool to specify a list of values and a default
Creates a new list parameter
The name of the parameter
Creates a new list parameter
The name of the parameter
The list of string values to poluate the combo box
Creates a new list parameter
The name of the parameter
The list of string values to poluate the combo box
The default item in the list
This method returns the dialog component that should be used to visualise INPUT to this parameter
This method returns the dialog component that should be used to visualise OUTPUT to this parameter
Gets or sets the index of the list
Gets or sets the list of items in the valuelist
EventHandler delegate for the tool parameter when a value is changed.
Point Feature Set Parameters past back from a ITool to the toolbox manager
Creates a new Line Feature Set parameter
The name of the parameter
Generates a default instance of the data type so that tools have something to write too
This method returns the dialog component that should be used to visualise INPUT to this parameter
This method returns the dialog component that should be used to visualise OUTPUT to this parameter
Specifies the value of the parameter (This is also the default value for input)
Polygon Feature Set Parameters past back from a ITool to the toolbox manager
Creates a new Polygon Feature Set parameter
The name of the parameter
Generates a default instance of the data type so that tools have something to write too
This method returns the dialog component that should be used to visualise INPUT to this parameter
This method returns the dialog component that should be used to visualise OUTPUT to this parameter
Specifies the value of the parameter (This is also the default value for input)
ProjectionParam
Creates a new instance of ProjectionParam with the specified name
and a default projection of WGS1984
Creates a new instance of a Projection Param with the specified name
and the specified projection as the default projection that will
appear if no changes are made.
This method returns the dialog component that should be used to visualise INPUT to this parameter
This method returns the dialog component that should be used to visualise OUTPUT to this parameter
Specifies the value of the parameter (This is also the default value for input)
Raster parameter allows ITools to specify that they require a Raster data set as input
Creates a new Raster parameter
The name of the parameter
This method returns the dialog component that should be used to visualise INPUT to this parameter
This method returns the dialog component that should be used to visualise OUTPUT to this parameter
Creates a new blank raster
Specifies the value of the parameter (This is also the default value for input)
Defines whether or not to add the parameter to the model
Always add the parameter to the model
Show the parameter in the model
Don't show the parameter in the model
String Parameters returned by an ITool allows the tool to specify a default value
Creates a new string parameter
The name of the parameter
Creates a new string parameter
The name of the parameter
The default value
This method returns the dialog component that should be used to visualise INPUT to this parameter
This method returns the dialog component that should be used to visualise OUTPUT to this parameter
Specifies the value of the parameter (This is also the default value for input)
Defines the data types which can be parameters for a ITool
Defines a parameter of type Int which takes a max/min and default value
Defines a parameter of type Double which takes a max/min and default value
Defines a parameter which specifies a raster
Defines a parameter which specifies a Feature Set
Defines a parameter which specifies a Point Feature Set
Defines a parameter which specifies a Line Feature Set
Defines a parameter which specifies a Polygon Feature Set
Defines a parameter which specifies a string
Defines a parameter which specifies a boolean value
Defines a parameter that is presented by a comboBox in the form
An element for true/false values
Creates an instance of the dialog
The parameter this element represents
Updates the status lights
This changes the color of the light and the tooltip of the light based on the status of the checkbox
When the check box it clicked this event fires
Gets or sets the Parameter that the element represents
Creates an instance of the dialog
The parameter this element represents
Gets or sets the Parameter that the element represents
An element for DialogSpacing
Creates an instance of a dialogspacerelement
Gets or sets the text of the spacer
Gets the current status the input
An element for doubles
Creates an instance of the dialog
The parameter this element represents
Refreshes status lights or other content
This changes the color of the light and the tooltip of the light based on the status of the text in the box
Checks if text contains a value double
The text to text
Returns true if it is a valid double
When the text box is clicked this event fires
Gets or sets the Parameter that the element represents
Indicates the allowed values for the status of the element, illustrated by the light
Indicates that no value has been set for this yet.
Indicates that the element parameter is ok and won't halt.
Indicates that the element value will cause an error.
Feature Set element
Creates an instance of the dialog
The parameter this element represents
An array of available data
updates the param if something's been changed
This fires when the selected value in the combo box is changed
Adds a new entry to the drop down list from data provider
Feature Set element out
Creates an instance of the dialog
The parameter this element represents
An array of available data
/// A modular component that can be inherited to retrieve parameters for functions.
Create a new instant.
When the text box is clicked this event fires
Gets or sets the Parameter that the element represents
an element for integers
Creates an instance of the dialog
The parameter this element represents
Updates the status lights
This changes the color of the light and the tooltip of the light based on the status of the text in the box
Checks if text contains a value integer
The text to text
Returns true if it is a valid integer
When the text box is clicked this event fires
Gets or sets the Parameter that the element represents
Creates an instance of the dialog
The parameter this element represents
An array of available data
updates the param if something's been changed
This fires when the selected value in the combo box is changed
Adds a new entry to the drop down list from data provider
Creates an instance of the dialog
The parameter this element represents
An array of available data
Creates an instance of the dialog
The parameter this element represents
This changes the color of the light and the tooltip of the light based on the status of the text in the box
When the control is clicked this event fires
Gets or sets the Parameter that the element represents
Open File Element
Create an instance of the dialog
Creates an instance of the dialog
The parameter this element represents
An array of available data
updates the param if something's been changed
Required method for Designer support - do not modify
the contents of this method with the code editor.
Creates an instance of the dialog
The parameter this element represents
An array of available data
updates the param if something's been changed
This fires when the selected value in the combo box is changed
Adds a new entry to the drop down list from data provider
Creates an instance of the dialog
The parameter this element represents
An array of available data
Creates an instance of the dialog
The parameter this element represents
An array of available data
updates the param if something's been changed
This fires when the selected value in the combo box is changed
Adds a new entry to the drop down list from data provider
Creates an instance of the dialog
The parameter this element represents
An array of available data
ProjectionElement
Creates a new instance of ProjectionElement
Gets or sets the Parameter that the element represents
Creates an instance of the dialog
The parameter this element represents
An array of available data
updates the param if something's been changed
This changes the color of the light and the tooltip of the light based on the status of the text in the box
Adds a new entry to the drop down list from data provider
Creates an instance of the dialog
The parameter this element represents
An array of available data
Save File Element
Creates an instance of the dialog
The parameter this element represents
An array of available data
Required method for Designer support - do not modify
the contents of this method with the code editor.
Creates an instance of the dialog
The parameter this element represents
This changes the color of the light and the tooltip of the light based on the status of the text in the box
When the text box is clicked this event fires
Gets or sets the Parameter that the element represents
A class from which Tools may be derived. Implments mundane parts of ITool for Assembly based tools.
Once the parameters have been configured the Execute command can be called, it returns true if succesful
A cancel progress handler that used to indicate how much of the tool is done
The parameters array should be populated with default values here
Fires when one of the paramters value has beend changed, usually when a user changes a input or output parameters value, this can be used to populate other parameters default values.
Author of the plugin.
Returns the category of tool that the ITool should be added to
Short description of the plugin.
Image displayed in the help area when no input field is selected
Returns the address of the tools help web page in HTTP://... format. Returns null if no URL has been specified.
32x32 Bitmap - The Large icon that will appears in the Tool Dialog Next to the tools name
Gets or Sets the input paramater array
Name of the plugin.
Gets or Sets the output paramater array
Returns a brief description displayed when the user hovers over the tool in the toolbox
A generic form that works with the various dialog elements in order to create a fully working process.
The constructor for the ToolDialog
The ITool to create the dialog box for
The list of available DataSets available
Creates a new instance of the tool dialog with map extent.
The constructor for the ToolDialog
The ITool to create the dialog box for
A list of all model elements
This adds the Elements to the form incrementally lower down
The element to add
When one of the DialogElements is clicked this event fires to populate the help
The constructor for the ToolDialog
The ITool to create the dialog box for
Fires when a parameter is changed
This adds a Bitmap to the help section.
The text to appear in the help box.
The title to appear in the help box.
The bitmap to appear at the bottom of the help box.
Adds Elements to the dialog based on what input Parameter the ITool contains
Adds Elements to the dialog based on what output Parameter the ITool contains
When the user clicks Cancel
When the user clicks OK
When the hyperlink is clicked this event fires.
If the user clicks out side of one of the tool elements
When the size of the help panel changes this event fires to move stuff around.
Disposes of the resources (other than memory) used by the .
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Returns a list of IDataSet that are available in the ToolDialog excluding any of its own outputs.
Gets the status of the tool
An arrow
Defines the base class for all model components
Creates an instance of the model Element
A list of all the elements in the model
This returns a duplicate of this object.
Returns a shallow copy of the Parameter class
A new Parameters class that is a shallow copy of the original parameters class
Darkens the component slightly
Darkens if true returns to normal if false
Repaints the form with cool background and stuff
The graphics object to paint to, the element will be drawn to 0, 0
This does nothing in the base class but child classes may override it
Returns true if the point is in the extents rectangle of the element
A point to test, assuming 0, 0 is the top left corner of the shapes drawing rectangle
Calculates if a point is within the shape that defines the element
A point to test in the virtual modeling plane
Returns true if the element intersect the rectangle from the parent class
The rectangle to test must be in the virtual modeling coordinant plane
Returns true if a point is in a rectangle
When a double click is caught by the parent class call this method
Creates a rounded corner rectangle from a regular rectangel
Returns true if this model element is downstram of the potentialUpstream element
Returns a list of all model elements that are direct parents of this element
Returns true if this model element is downstream of the potentialUpstream element
Returns a list of all model elements that are direct children of this element
Gets a list of all elements in the model
Returns 1 if the object is not highlighted less than 1 if it is highlighted
Gets or sets the text that is drawn on the element
Gets or sets the font used to draw the text on the element
Gets or Sets the shape of the model component
Gets or set the base color of the shapes gradient
Gets a rectangle representing the element, top left corner being the location of the parent form of the element
Gets or sets the width of the element
Gets or sets the shape of the element
Gets or sets the location of the element in the parent form
Creates an instance of an ArrowElement
The element the arrow starts at
the element the arrow ends at
A list of all the elements in the model
Updates the dimentions
Repaints the form with cool background and stuff
The graphics object to paint to, the element will be drawn to 0, 0
Calculates if a point is within the shape that defines the element
A point to test in the virtual modeling plane
Returns true if the element intersect the rectangle from the parent class
The rectangle to test must be in the virtual modeling coordinant plane
Gets or sets the destination Element
Gets or sets the source element
the point in the arrows coordinants we draw from
the point in the arrows coordinants we stop drawing from
A default element
Creates an instance of the Data Element
A list of all the elements in the model
Does nothing
Element for Data
Creates an instance of the Data Element
One of Brian's Parameter classes
A list of all the elements in the model
When the user doulbe clicks on a tool call this method
Gets the dataType of the DataElement
Gets or sets the Data set that this element represents
Definitions for the shapes that components can have in the modeler
Defines the Model Component as a Rectangle
Defines the Model Component as a Triangle
Defines the Model Component as a Ellipse
Defines an Arrow
Used internally to decided if a tool has executed, is done, or finished in error
The tool has not been run yet
The tool is currently executing
The tool finished running succesfully
The tool returned an error when executing
A Menu strip that is part of Brian's toolbox
Creates a new instance of hte ModelerMenuStrip
Required designer variable.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Required method for Designer support - do not modify
the contents of this method with the code editor.
the basic element for tools
Creates an instance of the tool element
The tool that the tool element represents
A list of all the elements in the model
Updates the status indicator
Draws the status light on the background of the DataElement
When the user doulbe clicks on a tool call this method
Gets or sets the status of the tools execution, used when the modeler runs the model.
Gets the ITool this element represents
Gets or sets the list of Elements presently available in the Modeler
Gets the current status of the tool
This class is used to enable linking of tools
that work with File parameters
Text File constructor
Creates a new instance of the TextFile class
the associated file name
To string
The file name associated with this text file
A form which shows the progress of a tool
Creates an instance of the Tool Progress forms and hands over an array of tools which will then be executed
The number of tools that are going to be executed
Handles the progress method necessary to implement IProgress
This a message with no percentage information..this is ignored
The integer percentage from 0 to 100 that is used to control the progress bar
The actual complete message to show..this is also ignored
This method should be called when the process has been completed
Required designer variable.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Required method for Designer support - do not modify
the contents of this method with the code editor.
Gets or sets the number of tools that have been succesfully executed
Returns true if the cancel button was pressed