This documentation is archived and is not being maintained.

ImageAttributes.SetColorMatrix Method (ColorMatrix, ColorMatrixFlag, ColorAdjustType)

.NET Framework 1.1

Sets the color-adjustment matrix for a specified category.

[Visual Basic]
Overloads Public Sub SetColorMatrix( _
   ByVal newColorMatrix As ColorMatrix, _
   ByVal mode As ColorMatrixFlag, _
   ByVal type As ColorAdjustType _
)
[C#]
public void SetColorMatrix(
 ColorMatrix newColorMatrix,
 ColorMatrixFlag mode,
 ColorAdjustType type
);
[C++]
public: void SetColorMatrix(
 ColorMatrix* newColorMatrix,
 ColorMatrixFlag mode,
 ColorAdjustType type
);
[JScript]
public function SetColorMatrix(
   newColorMatrix : ColorMatrix,
 mode : ColorMatrixFlag,
 type : ColorAdjustType
);

Parameters

newColorMatrix
The color-adjustment matrix.
mode
Element of the ColorMatrixFlag enumeration that specifies the type of image and color that will be affected by the color-adjustment matrix.
type
Element of the ColorAdjustType enumeration that specifies the category for which the color-adjustment matrix is set.

Return Value

This method does not return a value.

Remarks

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-adjustment matrix for the default category, a different color-adjustment matrix for the bitmap category, and still a different color-adjustment matrix for the pen category.

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

As soon as you specify a color- 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-adjustment matrix for the pen category by passing ColorAdjustTypePen to the SetColorMatrix method, then none of the default adjustment settings will apply to pens.

Example

For an example, see ImageAttributes.SetColorMatrix Method (ColorMatrix).

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

ImageAttributes Class | ImageAttributes Members | System.Drawing.Imaging Namespace | ImageAttributes.SetColorMatrix Overload List

Show: