LEADTOOLS (Leadtools assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
GetRegion Method
See Also 
Leadtools Namespace > RasterImage Class : GetRegion 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.
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.
Gets the RasterRegion object that describes this RasterImage current region. Supported in Silverlight, Windows Phone 7

Syntax

Visual Basic (Declaration) 
Public Function GetRegion( _
   ByVal xform As RasterRegionXForm _
) As RasterRegion
Visual Basic (Usage)Copy Code
Dim instance As RasterImage
Dim xform As RasterRegionXForm
Dim value As RasterRegion
 
value = instance.GetRegion(xform)
C# 
public RasterRegion GetRegion( 
   RasterRegionXForm xform
)
C++/CLI 
public:
RasterRegion^ GetRegion( 
   RasterRegionXForm^ xform
) 

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.

Return Value

An RasterRegion object that describes this RasterImage current region.

Example

For an example, refer to RasterRegion.

Remarks

To set or updated the RasterRegion object that describes the current image region, use SetRegion.

If the image does not have a region, this method will return an empty RasterRegion object.

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