ArcObjects Library Reference (Controls)

IMapControl2.BackColor Property

Background color of the MapControl.

[Visual Basic .NET]
Public Property BackColor As Integer

[C#]
public int BackColor {get; set;}

[C++]
HRESULT get_BackColor(
  long* BackColor
);

[C++]
HRESULT put_BackColor(
  long BackColor
);

[C++]
Parameters
BackColor [out, retval]
  BackColor is a parameter of type long
BackColor [in]
  BackColor is a parameter of type long

Product Availability

Available with ArcGIS Engine.

Description

Returns or sets the Background Color of the MapControl. Internally the OLE_Color is stored as a long integer where the value may be calculated for any RGB combination as follows:

OLE_Color = (Red) + (Green * 256) + (Blue * 256 * 256)

Where Red, Green and Blue are Long Integers within the range 0 - 255.

Errors Returned

1057 800a0421: The supplied color value is invalid

[C#]

When working directly with AxControls class use the BackColor property as follows:

AxMapControl1.BackColor = System.Drawing.Color.Red;

When using the Controls interop assembly use the BackColor property as follows:

IMapControl2 mapControl = (IMapControl2) AxMapControl1.Object;
mapControl.BackColor = 255;

[Visual Basic .NET]