GraphicFileMask function

In unit Graphics

Gets one or more file masks which can be used to select image files for the specified TGraphicClass instance.

Declaration

pascal

function GraphicFileMask(GraphicClass: TGraphicClass): string

Arguments

GraphicClass

TGraphicClass instance to locate in the registered graphic formats for the platform.

Function result

Delimited list of file masks for the graphics class, or an empty string when the graphics class is not supported.

Description

GraphicFileMask is a String function used to get a list of file mask(s) which can be used for files compatible with the specified graphics class.

GraphicClass is the TGraphicClass instance with the TGraphic descendant requested in the routine. It can contain one of the graphic classes like TBitmap, TCursorImage, TIcon, TPNGImage, TJPEGImage, et. al. If TGraphic is passed in the argument, a list with file masks for all of the registered image formats is returned. File masks are separated by the ';' delimiter.

For example:

sMask := GraphicFileMask(TJpegImage);

Returns:

*.jpeg;*.jpg;*.jpe;*.jfif

While:

sMask := GraphicFileMask(TGraphic);

Returns:

*.png;*.xpm;*.bmp;*.cur;*.ico;*.icns;*.jpeg;*.jpg;*.jpe;*.jfif;
*.tif;*.tiff;*.gif;*.pbm;*.pgm;*.ppm

Formatted for readability; the return value is a string without line breaks. Content depends on the images types supported on a given platform.

Use GraphicFilter to get a filter value for graphic class type(s) which can be assigned to the Filter property in a dialog.

Use GraphicExtension to get a single file extension (without the leading '.') for a graphic class type.

GraphicFileMask function

Declaration

Arguments

Function result

Description

See also