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


IPageLayoutControl3.BackColor Property (ArcObjects .NET 10.8 SDK)
ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > Controls > ESRI ArcGIS Controls > Interfaces > IP > IPageLayoutControl3 Interface > IPageLayoutControl3.BackColor Property
ArcGIS Developer Help

IPageLayoutControl3.BackColor Property

Background color of the PageLayoutControl.

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

Product Availability

Available with ArcGIS Engine.

Description

Returns or sets the Background Color of the PageLayoutControl. The Background color is used to draw the area of the Control outside the Page itself. 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.

[C#]

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

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

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

IPageLayoutControl3 pageLayoutControl = (IPageLayoutControl3) AxPageLayoutControl1.Object;
pageLayoutControl.BackColor = 255;

To set the background color of the Page itself use the following code:

IRgbColor rgbColor = new RgbColorClass();
rgbColor.Blue = 255;
axPageLayoutControl1.Page.BackgroundColor = rgbColor;

[Visual Basic .NET]

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

AxPageLayoutControl1.BackColor = System.Drawing.Color.Red

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

Dim pageLayoutControl As IPageLayoutControl3 = AxPageLayoutControl1.Object
pageLayoutControl.BackColor = Convert.ToUInt32(255)

To set the background color of the Page itself use the following code:

Dim pColor As IRgbColor
pColor = New RgbColor
pColor.Blue = 255
AxPageLayoutControl1.Page.BackgroundColor = pColor

See Also

IPageLayoutControl3 Interface