CopyFromCollection(IGoCollection,Boolean,Boolean,SizeF,GoCopyDictionary) Method

Add a copy of the objects in the given collection into this document, with locations offset from their existing locations.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Overridable Function CopyFromCollection( _
   ByVal coll As IGoCollection, _
   ByVal copyableOnly As Boolean, _
   ByVal dragging As Boolean, _
   ByVal offset As SizeF, _
   ByVal env As GoCopyDictionary _
) As GoCopyDictionary

public virtual GoCopyDictionary CopyFromCollection( 
   IGoCollection coll,
   bool copyableOnly,
   bool dragging,
   SizeF offset,
   GoCopyDictionary env
)

Parameters

coll: the IGoCollection of GoObjects
copyableOnly: whether to heed the GoObject.CanCopy property for each object that might be copied, and whether to heed the GoLayer.CanInsertObjects predicate for the corresponding destination layer
dragging: whether to copy the GoObject.DraggingObject instead of the object itself
offset: the SizeF offset in document coordinates
env: the copy dictionary which can control and record the results of the copy; if null it calls CreateCopyDictionary to get one

Return Value

the GoCopyDictionary holding the results of the copy

Remarks

This is a two-pass process. In the first pass, this method copies everything, by calling Copy on each object and then adding the object to the appropriate layer in this document. The layer is chosen to be one that matches the layer of the original object, by calling GoLayerCollection.Find. If no such layer is found, it adds the new object to the default layer. The second pass checks for any objects that were delayed during the copy. Any such objects have their GoObject.CopyObjectDelayed method called to fix up whatever is needed.

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
Overload List