PickObjectsInRectangle Method (GoLayer)

Return a collection of objects that are surrounded by a given rectangle.

Syntax

Visual Basic
C#

'Declaration
 
Public Function PickObjectsInRectangle( _
   ByVal rect As RectangleF, _
   ByVal pickstyle As GoPickInRectangleStyle, _
   ByVal coll As IGoCollection, _
   ByVal max As Integer _
) As IGoCollection

public IGoCollection PickObjectsInRectangle( 
   RectangleF rect,
   GoPickInRectangleStyle pickstyle,
   IGoCollection coll,
   int max
)

Parameters

rect: A RectangleF in document coordinates.
pickstyle: If GoPickInRectangleStyle.SelectableOnlyContained or GoPickInRectangleStyle.SelectableOnlyIntersectsBounds, only consider objects for which GoObject.CanSelect is true.
coll: An IGoCollection that is modified by adding results and then returned. If this value is null, a GoCollection is allocated and returned.
max: A limit on the number of objects to be found and added to the result collection.

Return Value

The coll argument, or a newly allocated one if that was null.

Remarks

This heeds this GoLayer's CanViewObjects and the GoObject's GoObject.CanView predicates. If pickstyle is GoPickInRectangleStyle.SelectableOnlyContained, this method also heeds the CanSelectObjects and GoObject.CanSelect predicates. This actually checks to see if the whole GoObject.SelectionObject is within the rect bounds. Such a policy allows a GoGroup to be selected even though only one part of the group is in the rectangle, the object's GoObject.SelectionObject that appears to the user to be selected. This will consider the children of GoGroups. Once it finds a selectable object within the rectangle, it does not recurse further into that object. This method is called by SelectInRectangle.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

GoLayer Class
GoLayer Members