Share via


Imagelist.setOverlayImage Method

Adds an image to the list of images to be used as overlay masks.

Syntax

public boolean setOverlayImage(int imageIdx, int overlayIdx)

Run On

Client

Parameters

  • imageIdx
    Type: int
    The zero-based index of an image in the image list.
  • overlayIdx
    Type: int
    The one-based index of the overlay mask.

Return Value

Type: boolean
1 if the method was successful.

Examples

The following example creates an image list that has three images, and then sets the last image that will be used as an overlay mask.

Imagelist list = new Imagelist( 
    Imagelist::iconWidth(), 
    Imagelist::iconHeight() ); 
  
list.add(new Image(824)); // Image 0 
list.add(new Image(815)); // Image 1 
list.add(new Image(936)); //Image 2 
  
list.setOverlayImage (2,1);

See Also

Reference

Imagelist Class