ArcObjects Library Reference (Controls)

ISceneControlDefault.BackColor Property

Background color of the SceneControl.

[Visual Basic .NET]
Public Property BackColor As Integer

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

[C++]
HRESULT get_BackColor(
  OLE_COLOR* pclr
);

[C++]
HRESULT put_BackColor(
  OLE_COLOR pclr
);

[C++]
Parameters
pclr [out, retval]
  pclr is a parameter of type OLE_COLOR
pclr [in]
  pclr is a parameter of type OLE_COLOR

Product Availability

Available with ArcGIS Engine.

Description

Returns or sets the Background Color of the SceneControl. 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.

To ensure the BackColor property overrides any background color set in a scene document, set the OverrideBackColor to true.

Errors Returned

1057 800a0421: The supplied color value is invalid

[C#]

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

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

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

ISceneControlDefault sceneControl = (ISceneControlDefault) AxSceneControl1.Object;
sceneControl.BackColor = 255;

[Visual Basic .NET]