MaskFileName (ImageKit Control/ Effect Property)

This property refers to the filename for the input mask image

[C++Builder] imagekitcontrolname->Effect->MaskFileName [= UnicodeString ]

[Delphi] imagekitcontrolname.Effect.MaskFileName [= string ]

Property Value

The filename for the input mask image

Explanation

The MaskFileName property refers to the filename for the input mask image. The mask image determines which portion of the image (whose image handle is the ImageHandle property) will be processed. The mask image must be a 1-bit color, black and white image. The input mask image must have the same height and width as the image set in the ImageHandle property

Both the MaskImageHandle property and the MaskFileName property refer to the mask image, however, the last of these properties that is set will determine the mask image that will be used when an effect is processed

If the effect is successful then the mask image will be set into the MaskImageHandle property.

Setting this value

This value can be set during execution.

Retrieving this value

This value is retrieved during execution.