CombineFloater Method (ImageViewerItem)

public virtual bool CombineFloater( 
   ImageViewerItem targetItem,
   bool deleteFloater
)

'Declaration
 

Public Overridable Function CombineFloater( _
   ByVal targetItem As ImageViewerItem, _
   ByVal deleteFloater As Boolean _
) As Boolean

Parameters

targetItem

Target item. If this value is null, then the floater will be combined with the image of this same item, otherwise; the floater will be combined with the image of targetItem.

deleteFloater

true to automatically delete the floater image from the item after combining, otherwise; false.

This method is called by ImageViewer.CombineFloater.

The floater transformation (position, scale and rotation value) is stored in ImageViewerItem.FloaterTransform and this method will use this value during the combine operation.

Internally, the viewer will use the image in Floater transformed by FloaterTransform and combine the result into Image using CombineFastCommand.

After this method finishes, the ItemChanged event will fire with ImageViewerItemChangedReason.Image. If the floater is deleted, ImageViewerItemChangedReason.Floater will also occur.

When deleteFloater is true, then this method will delete the floater by setting the value of Floater to null.

For an example, refer to Floater.

Target Platforms

Reference

ImageViewerItem Class
ImageViewerItem Members