Skip to content

Commit cf4affb

Browse files
committed
Updated documentation for behavior of the SelectBoxFinal event.
1 parent c735878 commit cf4affb

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

docs/AxInterop.MapWinGIS/AxMap.cs

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2873,12 +2873,22 @@ public double GeodesicLength(Shape polyline)
28732873

28742874
/// <summary>
28752875
/// This event is fired when the user finishes dragging a selection box in the map control.
2876-
/// The map property SendSelectBoxFinal must be set to True for this event to be fired.
2876+
/// The map property SendSelectBoxFinal must be set to True for this event to be fired.
28772877
/// </summary>
28782878
/// <param name="left">The left boundary of the selection box in pixel coordinates.</param>
28792879
/// <param name="right">The right boundary of the selection box in pixel coordinates.</param>
28802880
/// <param name="bottom">The bottom boundary of the selection box in pixel coordinates.</param>
28812881
/// <param name="top">The top boundary of the selection box in pixel coordinates.</param>
2882+
/// <remarks>
2883+
/// Prior to version 5.0, there was ambiguity as to whether or not this event was fired
2884+
/// in all circumstances. In the case of the cmZoomIn tool, this event was always fired.
2885+
/// But in the case of the cmSelection tool, it was only fired in the case when no shapes
2886+
/// were actually 'selected'. If any shapes were 'selected', the SelectionChanged event
2887+
/// was fired, but the SelectBoxFinal was not. As of version 5.0, the SelectBoxFinal event
2888+
/// will always be fired after dragging a rectangle, whether or not any shapes were actually
2889+
/// 'selected'.
2890+
/// </remarks>
2891+
/// \new500 Modified in version 5.0
28822892
public event _DMapEvents_SelectBoxFinalEventHandler SelectBoxFinal;
28832893

28842894
/// <summary>

0 commit comments

Comments
 (0)