UIButton: imageForState() method
The imageForState() method returns the image the button uses in a given state.
Syntax
imageForState(state)Parameters
state
One state name, a string: one of 'normal', 'highlighted', 'disabled', 'selected', 'focused'.
Unlike the setter methods, only one state name can be passed here, not an array.
Return value
UIImage, or null. It returns the same object that was set.
When this state hasn't been set separately, it returns the one for the normal state. When normal hasn't been set either, it returns null.
Exceptions
TypeError
state is not one of the state names above.
Examples
js
const button = UIButton.buttonWithType('system');
const heart = UIImage.systemImageNamed('heart');
button.setImage(heart, { forState: ['normal'] });
console.log(button.imageForState('normal') === heart);Result: Prints true. Not verified in the simulator.
Corresponding iOS API
-[UIButton imageForState:].
See also
setImage()current…properties: reading the one the button is displaying right now