ImageAttributes.SetBrushRemapTable Method

Definition

Namespace:

System.Drawing.Imaging

Assembly:

System.Drawing.Common.dll

Package:

System.Drawing.Common v9.0.0-preview.3.24172.9

Overloads

SetBrushRemapTable(ColorMap[])

Sets the color-remap table for the brush category.

SetBrushRemapTable(ColorMap[])

Source:

ImageAttributes.cs

Sets the color-remap table for the brush category.

public:
 void SetBrushRemapTable(... cli::array <System::Drawing::Imaging::ColorMap ^> ^ map);

public void SetBrushRemapTable (params System.Drawing.Imaging.ColorMap[] map);

member this.SetBrushRemapTable : System.Drawing.Imaging.ColorMap[] -> unit

Public Sub SetBrushRemapTable (ParamArray map As ColorMap())

Parameters

map

ColorMap[]

An array of ColorMap objects.

Examples

The following code example is designed for use with Windows Forms, and it requires PaintEventArgs e, which is a parameter of the Paint event handler. The code performs the following actions:

1. Creates a single-element ColorMap array that holds red as the old color and green as the new color.

2. Passes this array to a newly created ImageAttributes object.

void SetBrushRemapTableExample( PaintEventArgs^ /*e*/ )
{
   // Create a color map.
   array<ColorMap^>^myColorMap = gcnew array<ColorMap^>(1);
   myColorMap[ 0 ] = gcnew ColorMap;
   myColorMap[ 0 ]->OldColor = Color::Red;
   myColorMap[ 0 ]->NewColor = Color::Green;

   // Create an ImageAttributes object, passing it to the myColorMap
   // array.
   ImageAttributes^ imageAttr = gcnew ImageAttributes;
   imageAttr->SetBrushRemapTable( myColorMap );
}

public void SetBrushRemapTableExample(PaintEventArgs e)
{
             
    // Create a color map.
    ColorMap[] myColorMap = new ColorMap[1];
    myColorMap[0] = new ColorMap();
    myColorMap[0].OldColor = Color.Red;
    myColorMap[0].NewColor = Color.Green;
             
    // Create an ImageAttributes object, passing it to the myColorMap
             
    // array.
    ImageAttributes imageAttr = new ImageAttributes();
    imageAttr.SetBrushRemapTable(myColorMap);
}

Public Sub SetBrushRemapTableExample(ByVal e As PaintEventArgs)

    ' Create a color map.
    Dim myColorMap(0) As ColorMap
    myColorMap(0) = New ColorMap
    myColorMap(0).OldColor = Color.Red
    myColorMap(0).NewColor = Color.Green

    ' Create an ImageAttributes object, passing it to the myColorMap

    ' array.
    Dim imageAttr As New System.Drawing.Imaging.ImageAttributes
    imageAttr.SetBrushRemapTable(myColorMap)
End Sub

Remarks

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.

Calling the SetBrushRemapTable method has the same effect as passing Brush to the SetRemapTable method. The specified remap table applies to items in metafiles that are filled with a brush.

This method is intended to be used only with metafiles.