UIBarButtonItem.GetBackgroundImage Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
GetBackgroundImage(UIControlState, UIBarMetrics) |
The background image for the button. |
GetBackgroundImage(UIControlState, UIBarButtonItemStyle, UIBarMetrics) |
The UIImage used as a background by the UIBarButtonItem. |
GetBackgroundImage(UIControlState, UIBarMetrics)
The background image for the button.
[Foundation.Export("backgroundImageForState:barMetrics:")]
public virtual UIKit.UIImage GetBackgroundImage (UIKit.UIControlState state, UIKit.UIBarMetrics barMetrics);
abstract member GetBackgroundImage : UIKit.UIControlState * UIKit.UIBarMetrics -> UIKit.UIImage
override this.GetBackgroundImage : UIKit.UIControlState * UIKit.UIBarMetrics -> UIKit.UIImage
Parameters
- state
- UIControlState
The control state to return the background image for.
- barMetrics
- UIBarMetrics
The bar metrics to return the background image for.
Returns
The background imnage for the specified state and bar metrics.
- Attributes
Remarks
This member participates in the UIAppearance styling system. See the Appearance property and the AppearanceWhenContainedIn(Type[]) method.
Applies to
GetBackgroundImage(UIControlState, UIBarButtonItemStyle, UIBarMetrics)
The UIImage used as a background by the UIBarButtonItem.
[Foundation.Export("backgroundImageForState:style:barMetrics:")]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 6, 0, ObjCRuntime.PlatformArchitecture.All, null)]
public virtual UIKit.UIImage GetBackgroundImage (UIKit.UIControlState state, UIKit.UIBarButtonItemStyle style, UIKit.UIBarMetrics barMetrics);
abstract member GetBackgroundImage : UIKit.UIControlState * UIKit.UIBarButtonItemStyle * UIKit.UIBarMetrics -> UIKit.UIImage
override this.GetBackgroundImage : UIKit.UIControlState * UIKit.UIBarButtonItemStyle * UIKit.UIBarMetrics -> UIKit.UIImage
Parameters
- state
- UIControlState
- style
- UIBarButtonItemStyle
- barMetrics
- UIBarMetrics
Returns
- Attributes
Remarks
This member participates in the UIAppearance styling system. See the Appearance property and the AppearanceWhenContainedIn(Type[]) method.