GetMaskImage(EventHandler<ProgressEventArgs>) Method (IconPage)

Vintasoft.Imaging.Codecs.ImageFiles.Ico Namespace / IconPage Class / GetMaskImage(EventHandler<ProgressEventArgs>) Method

Syntax Exceptions Remarks Requirements SeeAlso

In This Topic

GetMaskImage(EventHandler<ProgressEventArgs>) Method (IconPage)

In This Topic

Returns the mask image of this page.

Syntax

'Declaration

Public Function GetMaskImage( _
   ByVal progressDelegateProgress delegate.
 As System.EventHandler(Of ProgressEventArgs) _
) As Vintasoft.Imaging.VintasoftImage

public Vintasoft.Imaging.VintasoftImage GetMaskImage(
   System.EventHandler<ProgressEventArgs> progressDelegate
)

public: Vintasoft.Imaging.VintasoftImage* GetMaskImage(
   System.EventHandler<ProgressEventArgs*>* progressDelegate
)

public:
Vintasoft.Imaging.VintasoftImage^ GetMaskImage(
   System.EventHandler<ProgressEventArgs^>^ progressDelegate
)

Parameters

progressDelegate: Progress delegate.

Return Value

The mask 1-bpp image associated with this IconPage object if image was loaded successfully; otherwise, null.

Exceptions

Exception	Description
System.InvalidOperationException	Thrown if page has no mask image.

Remarks

This 1-bpp mask defines which pixels of source image are transparent. Pixel of mask image with value 1 means that the corresponding pixel of source image is transparent; pixel with value 0 means that pixel of source image is not transparent.

Requirements

Target Platforms: .NET 10; .NET 9; .NET 8; .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5

Reference

IconPage Class
IconPage Members

GetImage(DecodingSettings,EventHandler<ProgressEventArgs>)
GetSourceImage(EventHandler<ProgressEventArgs>)
HasMaskImage

Send Feedback