SetBackgroundColor Method (RasterImageryOptions)

In This Topic

Sets the raster background color. Use SetDisplayBackground and SetBackgroundValue to display the background value. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Sub SetBackgroundColor( _
   ByVal backgroundColor As CIMColor _
)

public void SetBackgroundColor( 
   CIMColor backgroundColor
)

Parameters

backgroundColor

Exceptions

Exception	Description
System.ArgumentNullException	The backgroundColor is null.
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.

Remarks

You can display the background of a raster dataset in a specific color or with transparency. This allows you to hide or highlight the background. Usually, the background color is set to transparent so that it is hidden.

Requirements

Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

ArcGIS Pro version: 3.4 or higher.

Reference

RasterImageryOptions Class
RasterImageryOptions Members

Send feedback