Leadtools Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.3.5
SetOverlayImageSize Method
See Also 
Leadtools Namespace > RasterImage Class : SetOverlayImageSize Method




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.
Changes the size of the overlay image for a certain index.

Syntax

Visual Basic (Declaration) 
Public Sub SetOverlayImageSize( _
   ByVal index As Integer, _
   ByVal width As Integer, _
   ByVal height As Integer _
) 
Visual Basic (Usage)Copy Code
Dim instance As RasterImage
Dim index As Integer
Dim width As Integer
Dim height As Integer
 
instance.SetOverlayImageSize(index, width, height)
C# 
public void SetOverlayImageSize( 
   int index,
   int width,
   int height
)
Managed Extensions for C++ 
public: void SetOverlayImageSize( 
   int index,
   int width,
   int height
) 
C++/CLI 
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.

Example

For an example, refer to GetOverlayImage

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.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also