GetBackgroundColor Method

In This Topic

Gets the raster background color. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public CIMColor GetBackgroundColor()

Public Function GetBackgroundColor() As CIMColor

Return Value

ArcGIS.Core.CIM.CIMColor

Exceptions

Exception	Description
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, Windows 10

ArcGIS Pro version: 3.4 or higher.

Reference

RasterImageryOptions Class
RasterImageryOptions Members

Send feedback