SetRemapTable Method (ColorMap[], ColorAdjustType)

ImageAttributes::SetRemapTable Method (array<ColorMap^>^, ColorAdjustType)


Sets the color-remap table for a specified category.

Namespace:   System.Drawing.Imaging
Assembly:  System.Drawing (in System.Drawing.dll)

void SetRemapTable(
	array<ColorMap^>^ map,
	ColorAdjustType type


Type: array<System.Drawing.Imaging::ColorMap^>^

An array of color pairs of type ColorMap. Each color pair contains an existing color (the first value) and the color that it will be mapped to (the second value).

Type: System.Drawing.Imaging::ColorAdjustType

An element of ColorAdjustType that specifies the category for which the color-remap table is set.

This method does not return a value.

A color-remap table is an array of ColorMap structures. Each ColorMap structure has two Color objects: one that specifies an old color and one that specifies a corresponding new color. During rendering, any color that matches one of the old colors in the remap table is changed to the corresponding new color.

An ImageAttributes object maintains color and grayscale settings for five adjustment categories: default, bitmap, brush, pen, and text. For example, you can specify a color remap for the default category, a color-remap table for the bitmap category, and still a different color-remap table for the pen category.

The default color-adjustment and grayscale-adjustment settings apply to all categories that do not have adjustment settings of their own. For example, if you never specify any adjustment settings for the pen category, the default settings apply to the pen category.

As soon as you specify a color-adjustment or grayscale-adjustment setting for a certain category, the default adjustment settings no longer apply to that category. For example, suppose you specify a collection of adjustment settings for the default category. If you set the color-remap table for the pen category by passing Pen to the SetRemapTable method, none of the default adjustment settings will apply to pens.

For a code example, see the SetRemapTable(array<ColorMap^>^) method.

.NET Framework
Available since 1.1
Return to top
© 2015 Microsoft