LEADTOOLS (Leadtools assembly)
LEAD Technologies, Inc

SetOverlayImageSize Method






The index of the overlay for which to set the image size. This index is zero-based and should be less than or equal to MaxOverlays.
New image width in pixels
New image height in pixels.
Changes the size of the overlay image for a certain index. .NET support Silverlight support WinRT support
Syntax
public void SetOverlayImageSize( 
   int index,
   int width,
   int height
)
'Declaration
 
Public Sub SetOverlayImageSize( _
   ByVal index As Integer, _
   ByVal width As Integer, _
   ByVal height As Integer _
) 
'Usage
 
Dim instance As RasterImage
Dim index As Integer
Dim width As Integer
Dim height As Integer
 
instance.SetOverlayImageSize(index, width, height)
public void SetOverlayImageSize( 
   int index,
   int width,
   int height
)
 function Leadtools.RasterImage.SetOverlayImageSize( 
   index ,
   width ,
   height 
)
public:
void SetOverlayImageSize( 
   int index,
   int width,
   int height
) 

Parameters

index
The index of the overlay for which to set the image size. This index is zero-based and should be less than or equal to MaxOverlays.
width
New image width in pixels
height
New image height in pixels.
Remarks

This method is available in the (Document/Medical only) Toolkits.

Sets the size of the overlay image for a certain index. If the image already has an overlay image at index, it will be freed and the overlay size will be set to width by height pixels. If the image has no overlay image at index, a new empty overlay image will be created with size of width and height. After calling SetOverlayImageSize, you must call UpdateOverlayBits to allocate the overlay bitmap and set the data.

For more information, refer to Overlay Overview.

Example
For an example, refer to GetOverlayImage
Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

RasterImage Class
RasterImage Members

 

 


Products | Support | Contact Us | Copyright Notices

© 2006-2012 All Rights Reserved. LEAD Technologies, Inc.