---
title: "setBackgroundImage(_:for:barMetrics:)"
framework: uikit
role: symbol
role_heading: Instance Method
path: "uikit/uisearchbar/setbackgroundimage(_:for:barmetrics:)"
---

# setBackgroundImage(_:for:barMetrics:)

Sets the image to use for the background in a given position and with given metrics.

## Declaration

```swift
func setBackgroundImage(_ backgroundImage: UIImage?, for barPosition: UIBarPosition, barMetrics: UIBarMetrics)
```

## Parameters

- `backgroundImage`: The image to use for the search bar background in the position specified by barPosition and with the metrics specified by barMetrics.
- `barPosition`: A bar position constant.
- `barMetrics`: A bar metrics constant.

## See Also

### Customizing the search bar appearance

- [backgroundImage](uikit/uisearchbar/backgroundimage.md)
- [backgroundImage(for:barMetrics:)](uikit/uisearchbar/backgroundimage(for:barmetrics:).md)
- [image(for:state:)](uikit/uisearchbar/image(for:state:).md)
- [setImage(_:for:state:)](uikit/uisearchbar/setimage(_:for:state:).md)
- [positionAdjustment(for:)](uikit/uisearchbar/positionadjustment(for:).md)
- [setPositionAdjustment(_:for:)](uikit/uisearchbar/setpositionadjustment(_:for:).md)
- [inputAccessoryView](uikit/uisearchbar/inputaccessoryview.md)
- [searchFieldBackgroundImage(for:)](uikit/uisearchbar/searchfieldbackgroundimage(for:).md)
- [setSearchFieldBackgroundImage(_:for:)](uikit/uisearchbar/setsearchfieldbackgroundimage(_:for:).md)
- [searchFieldBackgroundPositionAdjustment](uikit/uisearchbar/searchfieldbackgroundpositionadjustment.md)
- [searchTextPositionAdjustment](uikit/uisearchbar/searchtextpositionadjustment.md)