This document is archived and information here might be outdated.  Recommended version.


IToolbarControl2.BackColor Property (ArcObjects .NET 10.4 SDK)
ArcObjects Library Reference (Controls)  

IToolbarControl2.BackColor Property

Background color of the ToolbarControl.

[Visual Basic .NET]
Public Property BackColor As Integer
[C#]
public int BackColor {get; set;}
[C++]
HRESULT get_BackColor(
  long* pclr
);
[C++]
HRESULT put_BackColor(
  long pclr
);
[C++]

Parameters pclr [out, retval] pclr is a parameter of type long pclr [in] pclr is a parameter of type long

Product Availability

Available with ArcGIS Engine.

Description

Returns or sets the background color of the ToolbarControl. By default BackColor is set to the Windows System '3D Objects' color. 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.

If the BackColor is different to the FadeColor the ToolbarControl background will be shaded between the BackColor and FadeColor by the FillDirection.

Remarks

The BackColor, FadeColor and FillDirection properties do not affect the visual appearance of the ToolbarControl when Transparent is set to true.

When ThemedDrawing is false the background color of any items on the ToolbarControl is an alpha blend of the BackColor and the Windows System '3D Highlight' color. When ThemedDrawing is true the system controls the background color.

[C#]

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

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

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

IToolbarControl2 toolbarControl=(IToolbarControl2) axToolbarControl1.Object;
toolbarControl.BackColor=255;

[Visual Basic .NET]

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

AxToolbarControl1.BackColor=System.Drawing.Color.Red

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

Dim toolbarControl As IToolbarControl2=AxToolbarControl1.Object
toolbarControl.BackColor=Convert.ToUInt32(255)

See Also

IToolbarControl2 Interface