←Select platform

SetRegion Method

Summary

Sets or updates the RasterRegion object that describes this RasterImage current region.

Syntax

C#
VB
Java
Objective-C
WinRT C#
C++
- (BOOL)setRegion:(nullable LTRasterRegionXForm *)xform  
           region:(nullable LTRasterRegion *)region  
      combineMode:(LTRasterRegionCombineMode)combineMode  
            error:(NSError **)error 
             
public void setRegion( 
   RasterRegionXForm xform,  
   RasterRegion region,  
   RasterRegionCombineMode combineMode 
) 
             
 function Leadtools.RasterImage.SetRegion(  
   xform , 
   region , 
   combineMode  
) 

Parameters

xform
RasterRegionXForm object that LEADTOOLS uses to translate between display coordinates and image coordinates. If you specify null for this parameter, the scalar fields default to 1, the offsets default to 0, and the view perspective defaults to the image view perspective.

region
A RasterRegion object to set or update into this RasterImage. If this parameter is an empty region or null, then the current region in the image will be deleted (this is the equivalent of calling MakeRegionEmpty.

combineMode
The action to take regarding the existing image region, if one is defined.

Remarks

To get the RasterRegion object that describes the current image region, use GetRegion.

To update an existing region, you specify how the new region is to be combined with the existing one using the combineMode parameter. For more information, refer to RasterRegionCombineMode.

The RasterRegion class provides a platform independent representation of a region of interest in an image that can be used in any platform supported by LEADTOOLS such as GDI, GDI+, WPF and Silverlight. The RasterRegion class contains extensive methods and properties to manipulate the region data and save/load it to a byte array.

To convert a LEADTOOLS RasterRegion object to/from a device dependent region, you can use the following helper classes:

The RasterRegion class implements the IDisposable interface, so you must call Dispose on any region objects you create after using it.

For more information, refer to Creating a Region.

For more information, refer to Saving A Region.

For more information, refer to Working with the Existing Region.

Example

For an example, refer to RasterRegion.

Requirements

Target Platforms

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

Leadtools Assembly