SetOverlayImageSize Method

Summary

Changes the size of the overlay image for a certain index.

Syntax

Objective-C

C++

Java

public void SetOverlayImageSize( 
   int index, 
   int width, 
   int height 
)

Public Sub SetOverlayImageSize( _ 
   ByVal index As Integer, _ 
   ByVal width As Integer, _ 
   ByVal height As Integer _ 
)

- (BOOL)setOverlaySize:(LeadSize)size  
       forImageAtIndex:(NSInteger)index  
                 error:(NSError **)error

public void setOverlayImageSize( 
  int index,  
  int width,  
  int 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