LEADTOOLS (Leadtools assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
SetRegion Method
See Also 
Leadtools Namespace > RasterImage Class : SetRegion Method



xform
RasterRegionXForm object that LEADTOOLS uses to translate between display coordinates and image coordinates. If you specify null (Nothing in Visual Basic) 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 (Nothing in Visual Basic), then the current region in the image will be deleted (this is the equivalant of calling MakeRegionEmpty.
combineMode
The action to take regarding the existing image region, if one is defined.
xform
RasterRegionXForm object that LEADTOOLS uses to translate between display coordinates and image coordinates. If you specify null (Nothing in Visual Basic) 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 (Nothing in Visual Basic), then the current region in the image will be deleted (this is the equivalant of calling MakeRegionEmpty.
combineMode
The action to take regarding the existing image region, if one is defined.
Sets or updates the RasterRegion object that describes this RasterImage current region. Supported in Silverlight, Windows Phone 7

Syntax

Visual Basic (Declaration) 
Public Sub SetRegion( _
   ByVal xform As RasterRegionXForm, _
   ByVal region As RasterRegion, _
   ByVal combineMode As RasterRegionCombineMode _
) 
Visual Basic (Usage)Copy Code
Dim instance As RasterImage
Dim xform As RasterRegionXForm
Dim region As RasterRegion
Dim combineMode As RasterRegionCombineMode
 
instance.SetRegion(xform, region, combineMode)
C# 
public void SetRegion( 
   RasterRegionXForm xform,
   RasterRegion region,
   RasterRegionCombineMode combineMode
)
C++/CLI 
public:
void SetRegion( 
   RasterRegionXForm^ xform,
   RasterRegion^ region,
   RasterRegionCombineMode combineMode
) 

Parameters

xform
RasterRegionXForm object that LEADTOOLS uses to translate between display coordinates and image coordinates. If you specify null (Nothing in Visual Basic) 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 (Nothing in Visual Basic), then the current region in the image will be deleted (this is the equivalant of calling MakeRegionEmpty.
combineMode
The action to take regarding the existing image region, if one is defined.

Example

For an example, refer to RasterRegion.

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 System.IDisposable interface, so you must call System.IDisposable.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.

Requirements

Target Platforms: Silverlight, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only), Windows Phone 7

See Also