←Select platform

CombineFloater Method

Summary

Combines the floater of this item with the image of the same or another item.

Syntax

C#
VB
C++
public virtual bool CombineFloater( 
   ImageViewerItem targetItem, 
   bool deleteFloater 
) 
Public Overridable Function CombineFloater( 
   ByVal targetItem As ImageViewerItem, 
   ByVal deleteFloater As Boolean 
) As Boolean 
public:  
   virtual bool CombineFloater( 
      ImageViewerItem^ targetItem, 
      bool deleteFloater 
   )

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.

Remarks

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.

Example

For an example, refer to Floater.

Requirements

Target Platforms

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Controls.WinForms Assembly
Introduction
Getting Started
Namespaces
Leadtools.Controls Namespace
Assemblies