PickObjects Method (GoDocument)

Return a collection of objects that can be picked at a particular point.

Syntax

Visual Basic
C#

'Declaration
 
Public Overridable Function PickObjects( _
   ByVal p As PointF, _
   ByVal selectableOnly As Boolean, _
   ByVal coll As IGoCollection, _
   ByVal max As Integer _
) As IGoCollection

public virtual IGoCollection PickObjects( 
   PointF p,
   bool selectableOnly,
   IGoCollection coll,
   int max
)

Parameters

p: A PointF location in document coordinates.
selectableOnly: If true, 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 calls GoLayer.PickObjects on each of the layers of this document in reverse order, from front to back. Please note that when objects are found, they might not be a top-level objects. In fact, when selectableOnly is false, it is very likely that if any object is found at the given point, it will be a child of some group.

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

GoDocument Class
GoDocument Members