DotSpatial.Compatibility AppInfo AppInfo The name of the main application. The default directory for file dialogs The icon to be displayed as the default form icon The path to the help file to be displayed from the Help menu. Whether or not to show a welcome screen (overriding the Splash Screen) The image to be displayed on the splash screen. How long the splash screen should be displayed The URL to be displayed on the Help->About dialog. Whether to display a splash screen on starting the application The name of the plugin responsible for displaying a custom welcome screen in response to the WELCOME_SCREEN message. The name of the main application. The default directory for file dialogs The icon to be displayed as the default form icon The path to the help file to be displayed from the Help menu. Whether or not to show a welcome screen (overriding the Splash Screen) The image to be displayed on the splash screen. How long the splash screen should be displayed The URL to be displayed on the Help->About dialog. Whether to display a splash screen on starting the application The name of the plugin responsible for displaying a custom welcome screen in response to the WELCOME_SCREEN message. Location of a click event within the legend. The user clicked outside of any group or layer. The user clicked on a layer. The user clicked on a group. CursorModes No built in behavior Left click to Pan Select Left click to zoom in Right click to zoom in HJustification The item is centered The item is justified to the left The item is justified to the right Object given back when a ComboBox is added to the Toolbar. Returns a collection of items Gets/Sets the cursor Gets/Sets the description for the control (used when the user customizes the Toolbar) Gets/Sets the style of the combo box Gets/Sets the enabled state of the ComboBoxItem Gets the name of the ComboBoxItem object Gets/Sets the zero based index of the selected item Gets/Sets the selected object Gets/Sets the selected item text Gets/Sets the length of the highlighted text Gets/Sets the start index of the highlighted text Gets/Sets the text for this object Gets/Sets the tooltip text for the control Gets/Sets the width of the control This interface is used to access the list of shapes that were found during an Identify function call. Returns the number of shapes that were identified. Returns the shape index of an identified that is stored at the position specified by the Index parameter. The draw interface is used to add custom drawing to the DotSpatial view. Clears all custom drawing on the specified drawing layer. Handle of the drawing layer to clear. Clearing a single drawing (using the drawing handle) is faster than clearing all drawings. Clears all custom drawings on all drawing layers. Clearing a single drawing (using the drawing handle) is faster than clearing all drawings. Draws a circle on the current drawing layer. X coordinate of the center of the circle. Y coordinate of the center of the circle. Radius of the circle in pixels. Color to use when drawing the circle. Specifies whether or not the circle is drawn filled. Draws a line on the current drawing layer. First x coordinate. First y coordinate. Second x coordinate. Second y coordinate. Width of the line in pixels Color to draw the line with. Draws a point on the current drawing layer. X coordinate. Y coordinate. Size of the point in pixels. Color to draw the point with. Draws a polygon on the current drawing layer. Array of x points for the polygon. Array of y points for the polygon. Color to draw the polygon with. Specifies whether or not to fill the polygon. The points in a polygon should be defined in a clockwise order and have no crossing lines if they are to be filled. The first and last point should be the same. Creates a new drawing layer. Specifies whether to use screen coordinates or projected map coordinates. Returns a drawing handle. You should save this handle if you wish to clear this drawing later. The concept of drawing layers is only partially implemented in this version of the MapWinGIS, which is used by the DotSpatial. There is only one active drawing layer, which is the most recently created one. There is no way to access any other drawing layers other than the current one. Specifies whether or not to use double buffering. Double buffering makes the drawing of the custom drawings smoother (not flickering). It is recommended that you use double buffering. IdentifiedLayers is used to access the list of layers that contained any information gathered during an Identify function call. Returns the number of layers that had information from the Identify function call. Returns an IdentifiedShapes object containing inforamtion about shapes that were identified during the Identify function call. Layer Adds a label to this layer. The text of the label. The color of the label text. X position in projected map units. Y position in projected map units. Text justification. Can be hjCenter, hjLeft or hjRight. The following function was added for plug-in 3.1 version compatibility Adds an extended label to this layer. The text of the label. The color of the label text. X position in projected map units. Y position in projected map units. Text justification. Can be hjCenter, hjLeft or hjRight. The rotation angle for the label. Clears all labels for this layer. Clears out the list of images to be used by the tkImageList point type. See also UserPointImageListAdd, UserPointImageListItem, UserPointImageListCount, and (on the shape interface) ShapePointImageListID. Sets the font to use for all labels on this layer. Name of the font or font family. Example: "Arial" Size of the font. Gets the underlying MapWinGIS object for this layer. The object can be either a MapWinGIS.Shapefile or a MapWinGIS.Image. If the layer is a grid layer the MapWinGIS.Grid object can be retrieved using the GetGridObject method. Gets a single row in the user defined line stipple. There are 32 rows in a fill stipple (0-31). Each row is defined the same way as a UserLineStipple. The index of the row to get. Must be between 0 and 31 inclusive. A single stipple row. Hides all vertices in the shapefile. Only applies to line and polygon shapefiles. Loads the shapefile rendering properties from a .mwsr file whose base fileName matches the shapefile. If the file isn't found, false is returned. Function call is ignored and returns false if the layer is a grid. Loads the shapefile rendering properties from the specified fileName. Function call is ignored and returns false if the layer is a grid. Moves this layer to a new position in the layer list. The highest position is the topmost layer in the display. The new position. The group to put this layer in. Saves the shapefile rendering properties to a .mwsr file whose base fileName matches the shapefile. Function call is ignored and returns false if the layer is a grid. Saves the shapefile rendering properties to the specified fileName. Function call is ignored if the layer is a grid. Sets a single row in the user defined line stipple. There are 32 rows in a fill stipple (0-31). Each row is defined the same way as a UserLineStipple. The index of the row to set. Must be between 0 and 31 inclusive. The row value to set in the fill stipple. Updates the label information file stored for this layer. Adds an image to the list of point images used by the tkImageList point type. See also UserPointImageListItem, UserPointImageListCount, ClearUDPointImageList, and (on the shape interface) ShapePointImageListID. The new image to add. The index for this image, to be passed to ShapePointImageListID or other functions. Gets the count of images from the list of images to be used by the tkImageList point type. See also UserPointImageListAdd, UserPointImageListItem, ClearUDPointImageList, and (on the shape interface) ShapePointImageListID. The count of items in the image list. Gets an image from the list of images to be used by the tkImageList point type. See also UserPointImageListAdd, UserPointImageListCount, ClearUDPointImageList, and (on the shape interface) ShapePointImageListID. The image index to retrieve. The index associated with this index; or null/nothing if nonexistant. Zooms the display to this layer, taking into acount the View.ExtentPad. Shows all vertices for the entire shapefile. Applies only to line and polygon shapefiles. The color to draw vertices with. The size of each vertex. Returns information about the given layer in a human-readible string. Returns the MapWinGIS.Grid object associated with the layer. If the layer is not a grid layer, "Nothing" will be returned. Indicates whether to skip over the layer when saving a project. Gets or sets the color of this shapefile. Applies only to shapefiles. Setting the color of the shapefile will clear any selected shapes and will also reset each individual shape to the same color. The coloring scheme will also be overriden. Gets or sets the coloring scheme. The Shapefile and Grid objects each have their own coloring scheme object. It is important to cast the ColoringScheme to the proper type. Gets or sets whether or not to draw the fill for a polygon shapefile. Gets or sets the extents where the layer changes from visible to not visible or vice versa. If the map is zoomed beyond these extents, the layer is invisible until the map is zoomed to be within these extents. Gets or sets whether the layer's coloring scheme is expanded in the legend. Returns the extents of this layer. Returns the fileName of this layer. If the layer is memory-based only it may not have a valid fileName. Gets or sets the stipple pattern to use for the entire shapefile. The valid values for this property are: Custom DashDotDash Dashed Dotted None Gets or sets the position of the layer without respect to any group. Gets or sets the handle of the group that this layer belongs to. Gets or sets the position of the layer within a group. Returns the layer handle of this layer. The DotSpatial automatically sets the LayerHandle for the layer, and it cannot be reset. Indicates whether to skip over the layer when drawing the legend. Gets or sets the icon to use in the legend for this layer. Gets or sets the color that represents transparent in an Image layer. The following label properties were added for plug-in 3.1 version compatibility Determines the distance from the label point to the text for the label in pixels. Determines whether labels are scaled for this layer. Determines whether labels are shadowed for this layer. Determines the color of the labels shadows. Turns labels on or off for this layer. Returns the type of this layer. Valid values are: Grid Image Invalid LineShapefile PointShapefile PolygonShapefile Gets or sets the line or point size. If the PointType is ptUserDefined then the size of the user defined point will be multiplied by the LineOrPointSize. For all other points and for lines, the LineOrPointSize is represented in pixels. The following was added for plug-in 3.1 version compatibility Sets the width between lines for multiple-line drawing styles (e.g, doublesolid). Gets or sets the stipple pattern to use for the entire shapefile. The valid values for this property are: Custom DashDotDash Dashed Dotted None Returns or sets the projection of this layer. Projections must be / will be in PROJ4 format. If no projection is present, "" will be returned. If an invalid projection is provided, it's not guaranteed to be saved! Gets or sets the layer name. Gets or sets the outline color for this layer. Only applies to polygon shapefile layers. Gets or sets the Point Image Scheme object for a given point layer. To be used from DotSpatial only Gets or sets the point type for this shapefile. The valid values for this property are: ptCircle ptDiamond ptSquare ptTriangleDown ptTriangleLeft ptTriangleRight ptTriangleUp ptUserDefined This property gives access to all shapes in the layer. Only applies to shapefile layers. Gets or sets the tag for this layer. The tag is simply a string that can be used by the programmer to store any information desired. Specifies whether or not to use DynamicVisibility. Determines whether MapWinGIS ocx will hide labels which collide with already drawn labels or not. Gets or sets the user defined line stipple. A line stipple is simply a 32-bit integer whose bits define a pattern that can be displayed on the screen. For example, the value 0011 0011 in binary would represent a dashed line ( -- --). Gets or sets the user defined point image for this layer. To display the user defined point the layer's PointType must be set to ptUserDefined. Gets or sets whether to use transparency on an Image layer. (Doesn't apply to line shapefiles) Indicates whether the vertices of a line or polygon are visible. Gets or sets whether the layer is visible. Layers Default add layer overload. Displays an open file dialog An array of DotSpatial.Interfaces.Layer objects. Adds a layer by fileName. Returns a Layer object. Adds a layer by fileName. The layer name is also set. Returns a Layer object. Adds an Image layer to the DotSpatial. Returns a Layer object. Adds an Image layer to the DotSpatial with the specified layer name. Returns a Layer object. Adds a FeatureSet layer to the DotSpatial. Returns a Layer object. Adds a FeatureSet layer to the DotSpatial with the specified layer name. Returns a Layer object. Adds a FeatureSet layer to the DotSpatial with the specified properties. Returns a Layer object. Adds a FeatureSet layer to the DotSpatial with the specified properties. Returns a Layer object. Adds a Raster layer to the DotSpatial. Returns a Layer object. Adds a Raster layer to the DotSpatial, with the specified coloring scheme. Returns a Layer object. Adds a Raster layer to the DotSpatial with the specified layer name. Returns a Layer object. Adds a Rster object to the DotSpatial with the specified properties. Returns a Layer object. Adds a layer by fileName. The layer name is also set, as well as the legend visibility. Returns a Layer object. Adds a layer to the map, optionally placing it above the currently selected layer (otherwise at top of layer list). The name of the file to add. The name of the layer, as displayed in the legend. Whether or not the layer is visible upon adding it. Whether the layer should be placed above currently selected layer, or at top of layer list. Removes all layers from the map. Returns true if the layer handle specified belongs to a valid layer. Drawing layers are not considered normal layers so this function will not return consistent results if a drawing layer is passed in. Handle of the layer to check. True if the layer handle is valid. False otherwise. Moves a layer to another position and/or group. Handle of the layer to move. New position in the target group. Group to move the layer to. Rebuilds a grid layer using the specified GridColorScheme Handle of the grid layer. Grid object corresponding to that layer handle. Coloring scheme to use when rebuilding. Removes the layer from the DotSpatial. Finds a layer handle when given the global position of a layer. Position in the layers list, disregarding groups. The handle of the layer at the specified position, or -1 if no layer is found there. Gets or sets the current layer handle. Allows access to group properties in the legend. Returns the number of layers loaded in the DotSpatial. Drawing layers are not counted. Returns the layer object corresponding the the specified LayerHandle IMapWin Returns dialog title for the main window to the default "project name" title. Prompt the user to select a projection, and return the PROJ4 representation of this projection. Specify the dialog caption and an optional default projection ("" for none). The text to be displayed on the dialog, e.g. "Please select a projection." The PROJ4 projection string of the projection to default to, "" for none. Refreshes the DotSpatial display. Refreshes Dynamic Visibility Sets the dialog title to be displayed after the "AppInfo" name for the main window. Overrides the default "project name" title. Displays the DotSpatial error dialog. Displays the DotSpatial error dialog, sending to a specific address. Returns the underlying MapWinGIS activex control for advanced operations. Provides control over application-level settings like the app name. Specify whether the full project path should be specified rather than just fileName, in title bar for main window. Gets the last error message set. Note: This error message could have been set at any time. Returns the Layers object that handles layers. Returns the Menus object that manages the menus. Returns the Plugins object that manages plugins. Returns the PreviewMap object that manages the preview map. Provides control over project and configuration files. Provides access to report generation methods and properties. Returns the StausBar object that manages the status bar. Returns the Toolbar object that manages toolbars. Provides access to the user panel in the lower right of the DotSpatial form. User-interactive functions. Used to prompt users to enter things, or otherwise prompt users. Returns the View object that handles the map view. An object that represents a menu item within the Main Menu Gets a submenu item by its 0-based index Gets a submenu item by its string name Gets/Sets the Text shown for the MenuItem Gets/Sets the icon for the menu item Gets/Sets the category for this item (used when the user customizes the menu) Gets/Sets the checked state of the item Gets/Sets the tool tip text that will pop up for the item when a mouse over event occurs Gets/Sets whether or not this item should draw a dividing line between itself and any items before this item Gets/Sets the cursor used when the mouse is over this control Gets/Sets the description of this menu item, used in customization of menu by the user Gets/Sets the Displayed state of this item Gets/Sets the enabled state of this item Gets the Name of this item Gets/Sets the visibility state of this item Gets the count of the submenu items contained within this item Returns whether this menu item is the first visible submenu item. This is only valid in submenus, i.e. menus which have a parent. Used for manipulation of the menu system for the application Adds a menu with the specified name Adds a menu with the specified name and icon Adds a menu with the specified name, icon and text Adds a menu with the specified name to the menu indicated by ParentMenu Adds a menu with the specified name and icon to the menu indicated by ParentMenu Adds a menu with the specified name, icon and text to the specified ParentMenu Adds a menu with the specified name, icon and text to the specified ParentMenu and after the specifed item Adds a menu with the specified name and text to the specified ParentMenu and before the specifed item Removes a MenuItem Name of the item to remove true on success, false otherwise Gets a MenuItem by its name During the Initialize method, the This method is called by the DotSpatial when the plugin is loaded. The IMapWin interface to use when interacting with the DotSpatial. The windows handle of the DotSpatial form. This can be used to make the DotSpatial the parent of any forms in the plugin. This method is called by the DotSpatial when a toolbar or menu item is clicked. Name of the item that was clicked. Set this parameter to true if your plugin handles this so that no other plugins recieve this message. This method is called by the DotSpatial when one or more layer(s) is/are added. An array of Layer objects that were added. This method is called by the DotSpatial when all layers are cleared from the map. This method is called by the DotSpatial when a layer is removed from the map. Handle of the layer that was removed. This method is called by the DotSpatial when a layer is selected in code or by the legend. Handle of the newly selected layer. This method is called by the DotSpatial when the user double-clicks on the legend. Handle of the layer or group that was double-clicked Location that was clicked. Either a layer or a group. Set this parameter to true if your plugin handles this so that no other plugins recieve this message. This method is called by the DotSpatial when the user presses a mouse button on the legend. Handle of the layer or group that was under the cursor. The mouse button that was pressed. You can use the vb6Buttons enumeration to determine which button was pressed. Location that was clicked. Either a layer or a group Set this parameter to true if your plugin handles this so that no other plugins recieve this message. This method is called by the DotSpatial when the user releases a mouse button on the legend. Handle of the layer or group that was under the cursor. The mouse button that was released. You can use the vb6Buttons enumeration to determine which button it was. Location that was clicked. Either a layer or a group Set this parameter to true if your plugin handles this so that no other plugins recieve this message. This method is called by the DotSpatial when the extents of the map have changed. This method is called by the DotSpatial when the user presses a mouse button over the map. The button that was pressed. These values can be compared to the vb6Butttons enumerations. This value represents the state of the ctrl, alt and shift keyboard buttons. The values use VB6 values. The x coordinate in pixels. The y coordinate in pixels. Set this parameter to true if your plugin handles this so that no other plugins recieve this message. This method is called by the DotSpatial when the user moves the mouse over the map display. The x coordinate in pixels. The y coordinate in pixels. Set this parameter to true if your plugin handles this so that no other plugins recieve this message. This method is called by the DotSpatial when the user releases a mouse button over the map. The button that was released. These values can be compared to the vb6Butttons enumerations. This value represents the state of the ctrl, alt and shift keyboard buttons. The values use VB6 values. The x coordinate in pixels. The y coordinate in pixels. Set this parameter to true if your plugin handles this so that no other plugins recieve this message. This method is called by the DotSpatial when the user completes a dragging operation on the map. The rectangle that was selected, in pixel coordinates. Set this parameter to true if your plugin handles this so that no other plugins recieve this message. This method is called by the DotSpatial when a project is being loaded. Filename of the project file. Settings string for this plugin from the project file. This method is called by the DotSpatial when a project is being saved. Filename of the project file. Reference parameter. Set this value in order to save your plugin's settings string in the project file. This method is called by the DotSpatial when the plugin is unloaded. This method is called by the DotSpatial when shapes are selected by the user. Handle of the shapefile layer that was selected on. The SelectInfo object containing information about the selected shapes. This message is relayed by the DotSpatial when another plugin broadcasts a message. Messages can be used to send messages between plugins. The message being relayed. Set this parameter to true if your plugin handles this so that no other plugins recieve this message. Author of the plugin. Short description of the plugin. Plugin serial number. NO LONGER NEEDED; kept for backward compatibility. Name of the plugin. Build date. Plugin version. Interface for manipulating plugins of the IPlugin type. This differs from "CondensedPlugins" in that the Item ([]) property returns IPlugin instead of IPluginDetails. The original "Plugins" (this one) cannot be changed without breaking the backward compatibility of the interface. clears all plugins from the list of available plugins, but doesn't unload loaded plugins Add a plugin from a file path to the plugin true on success, false on failure Adds any compatible plugins from a directory(recursive into subdirs) path to the directory true on success, false otherwise Loads a plugin from an instance of an object the Plugin object to load The Key by which this plugin can be identified at a later time A string that contains any settings that should be passed to the plugin after it is loaded into the system true on success, false otherwise Loads a plugin from an instance of an object the Plugin object to load The Key by which this plugin can be identified at a later time true on success, false otherwise Starts (loads) a specified plugin Identifying key for the plugin to start true on success, false otherwise Stops (unloads) a specified plugin Identifying key for the plugin to stop Removes a plugin from the list of available plugins and unloads the plugin if loaded 0-based integer index or string key for the plugin to remove Checks to see if a plugin is currently loaded (running) Unique key identifying the plugin true if loaded, false otherwise Shows the dialog for loading/starting/stopping plugins Sends a broadcast message to all loaded plugins The message that should be sent Returns the key belonging to a plugin with the given name. An empty string is returned if the name is not found. The name of the plugin number of available plugins Gets an IPlugin object from the list of all loaded plugins 0-based index into the list of plugins Gets or Sets the default folder where plugins are loaded from Interface for manipulating the PreviewMap Tells the PreviewMap to rebuild itself by getting new data from the main view Tells the PreviewMap to rebuild itself by getting new data from the main view (current extents). Tells the PreviewMap to rebuild itself by getting new data from the main view. Update from full extent or current view? Loads a picture into the PreviewMap from a specified file The path to the file to load true on success, false on failure Gets/Sets the back color Gets/Sets the Picture to be displayed Gets/Sets the color used for the LocatorBox Project Loads a project file. Filename of the project to load. Returns true if successful. Loads a project file into the current project as a subgroup. Filename of the project to load. Saves the current project. Filename to save the project as. Returns true if successful. Saves the current configuration to a configuration file. The fileName to save the configuration as. Returns true if successful. Returns the fileName of the configuration file that was used to load the current DotSpatial project. Returns whether the configuration file specified by the project has been loaded. Returns the fileName of the current project. Return or set the current map units, in the format "Meters", "Feet", etc Return or set the current alternate display units, in the format "Meters", "Feet", etc Gets or sets the project modified flag. Return or set the current project projection, in the format "+proj=tmerc +ellps=WGS84 etc etc +datum=WGS84" Returns an ArrayList of the recent projects (the full path to the projects) Gets or sets the option to save shape-level formatting. Reports Similar to GetLegendSnapshot except that only one layer is considered. Handle of the layer to take a snapshot of. Maximum width of the image. The height of the image depends on the coloring scheme of the layer. Returns an image of the legend. Specifies that only the visible layers are part of the snapshot. Maximum width of the image. The height of the image depends on the number of layers loaded. Returns an image of a north arrow. Returns an image that represents an accurate scale bar. You must specify what the map units are. The unit of measurement to display on the scale bar. This function can convert the map units to any other unit. Maximum width of the scale bar image. Returns an image that represents an accurate scale bar. You must specify what the map units are. The unit of measurement to display on the scale bar. This function can convert the map units to any other unit. Maximum width of the scale bar image. Returns a MapWinGIS.Image of the view at the specified extents. The area that you wish to take the picture of. Uses projected map units. The SelectedShape interface is used to access information about a shape that is selected in the DotSpatial. Initializes all information in the SelectedShape object then highlights the shape on the map. Index of the shape in the shapefile. Color to use when highlighting the shape. Returns the extents of this selected shape. Returns the shape index of this selected shape. This interface is used to manage and access all selected shapes. All selection is done only to the selected layer. The selected layer handle can be accessed using the LayerHandle property. Adds a SelectedShape object to the managed collection of all selected shapes. The SelectedShape object to add. Adds a new SelectedShape to the collection from the provided shape index. The index of the shape to add. The color to use when highlighting the shape. Clears the list of selected shapes, returning each selected shape to it's original color. Removes a SelectedShape from the collection, reverting it to it's original color. Index in the collection of the SelectedShape. Removes a SelectedShape from the collection, reverting it to it's original color. The shape index of the SelectedShape to remove. Returns the LayerHandle of the selected layer. Returns the number of shapes that are currently selected. Returns the total extents of all selected shapes. Returns the SelectedShape at the specified index. Used to manipulate the status bar at the bottom of Mapwindow. Adds a new panel to the status bar. This function has been deprecated. Please use the AddPanel(Text) overload. The StatusBarItem that was just added Adds a new panel to the status bar. This function has been deprecated. Please use the AddPanel(Text) overload. The index at which the panel should be added The StatusBarItem that was just added This is the preferred method to use to add a statusbar panel. Text to display in the panel. Position to insert panel at. Width of the panel in pixels. Panel AutoSize property. A StatusBarPanel object. Removes the specified Panel. There must always be one panel. If you remove the last panel, the DotSpatial will automatically add one. Zero-Based index of the panel to be removed Removes the panel object specified. There must always be one panel. If you remove the last panel, the DotSpatial will automatically add one. StatusBarPanel to remove. This function makes the progress bar fit into the last panel of the status bar. Call this function whenever you change the size of ANY panel in the status bar. You do not need to call this on AddPanel or RemovePanel. Gets/Sets the enabled state of the StatusBar Gets/Sets whether or not the StatusBar's ProgressBar should be shown Gets/Sets the value of the StatusBar's ProgressBar Iterator for all panels within the StatusBar Index of the StatusBarItem to retrieve Returns the number of panels in the StatusBar. Number of panels in the StatusBar. The object given back when a panel is added to the status bar. This object can be used to Gets/Sets the Alignment of the text Gets/Sets whether or not this StatusBarItem should auto size itself Gets/Sets the minimum allowed width for this StatusBarItem Gets/Sets the Text within the StatusBarItem Gets/Sets the width of the StatusBarItem Used to add/remove Toolbars, buttons, combo boxes, etc. to/from the application Adds a Toolbar group to the Main Toolbar The name to give to the Toolbar item true on success, false on failure Adds a button to a specified to the default Toolbar The name to give to the new ToolbarButton Adds a button to a specified to the default Toolbar The name to give to the new ToolbarButton Should this button support drop-down items? Adds a button to a specified to the default Toolbar The name to give to the new ToolbarButton /// The name of the Toolbar to which this ToolbarButton should belong (if null or empty, then the default Toolbar will be used Should this button support drop-down items? Adds a separator to a toolstrip dropdown button. The name to give to the new separator. The name of the Toolbar to which this separator should belong (if null or empty, then the default Toolbar will be used. The name of the ToolbarButton to which this new separator should be added as a subitem. Adds a button to a specified to the default Toolbar The name to give to the new ToolbarButton The Icon/Bitmap to use as a picture on the ToolbarButton face Adds a button to a specified to the default Toolbar The name to give to the new ToolbarButton The Icon/Bitmap to use as a picture on the ToolbarButton face The text name for the ToolbarButton. This is the text the user will see if customizing the Toolbar Adds a button to a specified to the specified Toolbar. The name to give to the new ToolbarButton. The name of the Toolbar to which this ToolbarButton should belong (if null or empty, then the default Toolbar will be used. The name of the ToolbarButton to which this new ToolbarButton should be added as a subitem. The name of the ToolbarButton after which this new ToolbarButton should be added. Adds a ComboBoxItem to a specified to the default Toolbar. The name to give to the new ComboBoxItem. The name of the Toolbar to which this ToolbarButton should belong. The name of the ToolbarButton/ComboBoxItem afterwhich this new item should be added. returns the specified ToolbarButton (null on failure) The name of the ToolbarButton to retrieve returns the specified ComboBoxItem Name of the item to retrieve Returns the number of buttons on the specified toolbar, or 0 if the toolbar can't be found. The name of the toolbar. The number of buttons on the toolbar. Presses the specified ToolBar button (if it's enabled) as if a user had pressed it. The name of the toolbar button to press. true on success, false on failure (i.e. bad toolbar button name) Removes the specified Toolbar and any ToolbarButton/ComboBoxItems contained within the control The name of the Toolbar to be removed true on success, false on failure Removes the specified ToolbarButton item The name of the ToolbarButton to be removed true on success, false on failure Removes the specified ComboBoxItem The name of the ComboBoxItem to be removed true on success, false on failure Object given back when a button is added to a Toolbar. This object can then be used to manipulate (change properties) for the button. Returns the Subitem with the specified zero-based index (null if out of range) returns the Subitem with the specified name (null if it doesn't exist) Gets/Sets a flag indicating that this item starts a new group by drawing a seperator line if necessary Gets/Sets the Category for this ToolbarButton item (used when user is customizing the Toolbar) Gets/Sets the Cursor for this control Gets/Sets the description for the control (used when the user customizes the Toolbar) Gets/Sets a flag marking whether or not this ToolbarButton is displayed Gets/Sets the enabled state Gets the name of the ToolbarButton item Gets the number of subitems Gets/Sets the picture for the ToolbarButton Gets/Sets the pressed state of the ToolbarButton Gets/Sets the Text/Caption of the ToolbarButton Gets/Sets the tooltip text for the control Gets/Sets the visibility of the ToolbarButton A function that is called upon close of a panel. The name (caption) of the closed panel is passed into the OnPanelClose function. UiPanel Adds a function (onCloseFunction) which is called when the panel specified by caption is closed. Returns a Panel that can be used to add dockable content to DotSpatial. Returns a Panel that can be used to add dockable content to DotSpatial. Deletes the specified panel. Hides or shows a panel without necessarily deleting it. UserInteraction Prompt the user to select a projection, and return the PROJ4 representation of this projection. Specify the dialog caption and an optional default projection ("" for none). The text to be displayed on the dialog, e.g. "Please select a projection." The PROJ4 projection string of the projection to default to, "" for none. Retrieve a color ramp, defined by a start and end color, from the user. The start color to initialize the dialog with. The end color to initialize the dialog with. The start color that the user selected. The end color that the user selected. Boolean, true if the effort was successful. The View interface is used to manipulate or work with the main DotSpatial display. Clears all selected shapes from the DotSpatial, reverting them to their original colors. Queries all of the active shapefile layers for any within the specified tolerance of the given point. The x coordinate, in projected map units, of the point to query. The y coordinate, in projected map units, of the point to query. Tolerance is the distance, in projected map units, around the point to include in the query. Returns an IdentifiedLayers object containing query results. Prevents the legend from showing any changes made to it until the UnlockLegend function is called. The legend maintains a count of the number of locks it has, only redrawing if there are no locks. Unlocking the Legend allows it to redraw and update the view to reflect any changes that were made. The legend maintains a count of the number of locks it has, only redrawing if there are no locks. There can never be a negative number of locks. Prevents the map from updating due to any changes made to the layers that are loaded until the UnlockMap function is called. The map maintains a count of the number of locks it has, only redrawing if there are no locks. Allows the map to redraw entirely when changes are made. The map maintains a count of the number of locks it has, only redrawing if there are no locks. There can never be a negative number of locks. Converts a point in pixel coordinates to a point in projected map units. X coordinate of the original point in pixels. Y coordinate of the original point in pixels. ByRef. X coordinate of the projected point. ByRef. Y coordinate of the projected point. Converts a point in projected map units to a point in screen coordinates. X coordinate of the projected map point. Y coordinate of the projected map point. ByRef. X coordinate of the screen point in pixels. ByRef. Y coordinate of the screen point in pixels. Forces the map to redraw. This function has no effect if the map is locked. Shows a tooltip under the cursor on the map. The text to display in the tooltip. Number of milliseconds before the tooltip automatically disappears. Zooms the view to the maximum extents of all the loaded and visible layers. Zooms the display in by the given factor. The percentage to zoom by. Zooms the display out by the given factor. The percentage to zoom by. Zooms to the previous extent. Takes a snapshot of the currently visible layers at the extents specified. The area to take the snapshot of. Triggers reloading of field values for the given layer. No action will occur if the layer handle is invalid, not a shapefile, or has no labels. Displays the label editor form for the specified layer. No action will occur if the layer handle is invalid or not a shapefile. Selects shapes in the mapwindow from the specified point. The tolerance used is the global tolerance set through the View.SelectionTolerance. This function uses the same selection routines that are called when a user selects with a mouse. The x coordinate in pixels of the location to select. The y coordinate in pixels of the location to select. Specifies whether to clear all previously selected shapes or not. Selects shapes in the mapwindow from the specified rectangle. This function uses the same selection routines that are called when a user selects with a mouse. The rectangle to select shapes with. This rectangle must be in screen (pixel) coordinates. Specifies whether to clear all previously selected shapes or not. Determines whether the preview map panel is visible. Determines whether the legend panel is visible. Gets or sets the background color of the map. Gets or sets the current cursor mode. The cursor mode can be any of the following: None Pan Selection ZoomIn ZoomOut Returns a DotSpatial.Interfaces.Draw interface used to add custom drawing to the map. Gets or sets the amount to pad around the extents when calling ZoomToMaxExtents, ZoomToLayer, and ZoomToShape. Gets or sets the map's current extents. Gets or sets the cursor to use on the map. The enumeration can be any of the following: crsrAppStarting crsrArrow crsrCross crsrHelp crsrIBeam crsrMapDefault crsrNo crsrSizeAll crsrSizeNESW crsrSizeNS crsrSizeNWSE crsrSizeWE crsrUpArrow crsrUserDefined crsrWait Indicates that the map should handle file drag-drop events (as opposed to firing a message indicating file(s) were dropped). Gets or sets the MapState string which describes in a single string the entire map state, including layers and coloring schemes. Returns a SelectInfo object containing information about all shapes that are currently selected. Determines whether labels are loaded from and saved to a project-specific label file or from a shapefile-specific label file. Using a project-level label file will create a new subdirectory with the project's name. Gets or sets whether selection should be persistent. If selection is persistent, previously selected shapes are not cleared before selecting the new shapes. When selection is persistent you must select nothing to clear the selection. The default value for this property is false. When selection is not persistent, all selected shapes are cleared between selection routines unless the user is holding down a control or shift key. The tolerance, in projected map units, to use for selection. Gets or sets the selection method to use. Inclusion Intersection Inclusion means that the entire shape must be within the selection bounds in order to select the shape. Intersection means that only a portion of the shape must be within the selection bounds in order for the shape to be selected. Gets or sets the color used to indicate a selected shape. Gets or sets a tag for the map. The tag is a string variable that can be used by a developer to store any information they desire. Gets or sets the handle of the cursor to use when the CursorMode is cmUserDefined. Gets or sets the default zoom percentage to use when interacting with the map using a mouse. LayerType Raster Layer Image Layer Not a valid layer format Line FeatureSet Layer Point FeatureSet Layer Polygon FeatureSet Layer PluginManager for dealing with additional plugins The Designer for hte Legacy Plugin Manager class Constructor for Plugin Manager Constructor for Plugin Manager A Container Checks the dlls in the Plugins folder or any subfolder and adds a new checked menu item for each one that it finds. This can also be controlled using the PluginMenuIsVisible property. Looks for a menu named Plug-ins and removes it. Control this through the PluginMenuIsVisible property. This can also be controlled using the PluginMenuIsVisible property. 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 Legend associated with this plugin manager Gets or sets the Map associated with this plugin manager Gets or sets the MapMenuStrip associated with this plugin manager Gets or sets the MapToolStrip associated with this plugin manager Gets or sets the Preview Map associated with this plugin manager Controls whether or not a Plugin menu will be added to the MapMenuStrip specified by this Plugin Manager MapCursorModes AppStarting Arrow Cross Help IBeam MapDefault No SizeAll SizeNESW SizeNS SizeNWSE SizeWE UpArrow UserDefined Wait App starting icon typical white arrow with black border A right angle cross Question mark An IBeam like for editing text An arrow A circle with a diagonal line Arrows pointing north, south, east and west A diagonal line with arrows pointing northeast and southwest A vertical line with arrows up and down A diagonal line with arrows pointing northwest and southeast A horizontal line with arrows pointing west and east An up pointed arrow Use a custom icon Windows wait cursor (varies from system to system) MapWin Constructs a new empty instance of this interface wrapper that is mostly used for backwards compatibility. Constructs a new instance of a MapWin interface where the Map, Legend, Form and MenuStrip are all specified. Any valid implementation of IBasicMap Any valid implementation of ILegend Any valid windows Form Any valid windows MenuStrip Returns dialog title for the main window to the default "project name" title. Prompt the user to select a projection, and return the PROJ4 representation of this projection. Specify the dialog caption and an optional default projection ("" for none). The text to be displayed on the dialog, e.g. "Please select a projection." The PROJ4 projection string of the projection to default to, "" for none. Refreshes the DotSpatial display. Refreshes Dynamic Visibility Sets the dialog title to be displayed after the "AppInfo" name for the main window. Overrides the default "project name" title. Displays the DotSpatial error dialog. Displays the DotSpatial error dialog, sending to a specific address. In The new context, this return whatever the BasicMap is. Provides control over application-level settings like the app name. Specify whether the full project path should be specified rather than just fileName, in title bar for main window. Gets the last error message set. Note: This error message could have been set at any time. Returns the Layers object that handles layers. Returns the Menus object that manages the menus. Returns the Plugins object that manages plugins. Returns the PreviewMap object that manages the preview map. Provides control over project and configuration files. Provides access to report generation methods and properties. Returns the StausBar object that manages the status bar. Returns the Toolbar object that manages toolbars. Provides access to the user panel in the lower right of the DotSpatial form. User-interactive functions. Used to prompt users to enter things, or otherwise prompt users. Returns the View object that handles the map view. Gets or sets the basic map for this MapWin Gets or sets the legend to use for this MapWin Gets or sets the main form to use for this MapWin Gets or sets the menu strip to use for this MapWin MenuItem Creates a new instance of MenuItem The ToolStripMenuItem to wrap with this item Gets a submenu item by its 0-based index Gets a submenu item by its string name Gets/Sets the Text shown for the MenuItem Gets/Sets the icon for the menu item Gets/Sets the category for this item (used when the user customizes the menu) Gets/Sets the checked state of the item Gets/Sets the tool tip text that will pop up for the item when a mouse over event occurs Gets/Sets whether or not this item should draw a dividing line between itself and any items before this item Gets/Sets the cursor used when the mouse is over this control Gets/Sets the description of this menu item, used in customization of menu by the user Gets/Sets the Displayed state of this item ... Side Note ... I have no idea what this is supposed to do, so it is redundant with visible for now and possibly should be made obsolete. Gets/Sets the enabled state of this item Gets the Name of this item Gets/Sets the visibility state of this item Gets the count of the submenu items contained within this item Returns whether this menu item is the first visible submenu item. This is only valid in submenus, i.e. menus which have a parent. Menus Creates a new instance of Menus Adds a menu with the specified name and uses the name as the text. The string name of the menu item to add. Adds a menu with the specified name and image, and uses the name as the text. the string name of the menu item and text The image to associate with the menu item Adds a menu with the specified name, icon and text The name to use to identify this item later An image to associate with this item The string text to appear for this item Adds a menu with the specified name to the menu indicated by ParentMenu The string name to use The string name of the parent to add the menu to Adds a menu with the specified name and icon to the menu indicated by ParentMenu the name to use as a key to identify this item and as text the parent menu item The image to use for this item Adds a menu with the specified name, icon and text to the specified ParentMenu The string name to use as a key for this item The name of the parent menu to add this new item to The picture to add for this item The string text to add for this item Adds a menu with the specified name, icon and text to the specified ParentMenu and after the specifed item The string name to use as a key for this item The name of the parent menu to add this new item to The picture to add for this item The string text to add for this item The name of the sibling menu item to add this item directly after Adds a menu with the specified name and text to the specified ParentMenu and before the specifed item The string name to use as a key for this item The name of the parent menu to add this new item to The string text to add for this item The name of the sibling to insert this menu item on top of Removes a MenuItem Name of the item to remove true on success, false otherwise Gets a MenuItem by its name PointTypes Circular points Diamond Square Triangle pointed down Triangle pointed left Triangle pointed right Triangle pointed up User defined Enumeration of possible preview map update types. Update using full exents. Update using current map view. ReferenceTypes The coordinates are drawn in screen coordinates on the layer, and stay fixed as the map zooms and pans The drawing layer is geographically referenced and will move with the other spatially referenced map content. Gets or sets the selection method to use. Inclusion Intersection Inclusion means that the entire shape must be within the selection bounds in order to select the shape. Intersection means that only a portion of the shape must be within the selection bounds in order for the shape to be selected. The entire contents of the potentially selected item must fall withing the specified extents The item will be selected if any of the contents of the potentially selected item can be found in the specified extents. Docking styles for DotSpatial UIPanels Floating Dock Left Dock Right Dock Top Dock Bottom Dock Left Autohidden Dock Right Autohidden Dock Top Autohidden Dock Bottom Autohidden FillStipple Use a custom stipple pattern A dashes and dots Dashes only Dots only No stipple pattern should be used UnitOfMeasure The units are in decimal degrees. The units are in millimeters. The units are in centimeters. The units are in inches. The units are in feet. The units are in Yards. The units are in meters. The units are in miles. The units are in kilometers. The units are in nautical miles. The units are in acres. The units are in hectares. The units are unknown. UserInteraction Prompt the user to select a projection, and return the PROJ4 representation of this projection. Specify the dialog caption and an optional default projection ("" for none). The text to be displayed on the dialog, e.g. "Please select a projection." The PROJ4 projection string of the projection to default to, "" for none. Retrieve a color ramp, defined by a start and end color, from the user. The start color to initialize the dialog with. The end color to initialize the dialog with. The start color that the user selected. The end color that the user selected. Boolean, true if the method was successful.