<!--
{
  "availability" : [
    "iOS: 5.0.0 -",
    "iPadOS: 5.0.0 -",
    "macCatalyst: 13.1.0 -",
    "tvOS: -",
    "visionOS: 1.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "UIKit",
  "identifier" : "/documentation/UIKit/UIBarButtonItem/setBackgroundImage(_:for:barMetrics:)",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Method",
  "symbol" : {
    "kind" : "Instance Method",
    "modules" : [
      "UIKit"
    ],
    "preciseIdentifier" : "c:objc(cs)UIBarButtonItem(im)setBackgroundImage:forState:barMetrics:"
  },
  "title" : "setBackgroundImage(_:for:barMetrics:)"
}
-->

# setBackgroundImage(_:for:barMetrics:)

Sets the background image for a specified state and bar metrics.

```
func setBackgroundImage(_ backgroundImage: UIImage?, for state: UIControl.State, barMetrics: UIBarMetrics)
```

## Parameters

`backgroundImage`

The background image for the specified state and metrics.

`state`

A control state.

`barMetrics`

Bar metrics.

## Discussion

For good results, `backgroundImage` must be a stretchable image.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)