image() [1/2]

virtual const drawing::image & xtd::forms::button_base::image ( ) const

virtualnoexcept

Gets the image that is displayed on a button control.

Returns

The Image displayed on the button control. The default value is xtd::drawing::image::empty.

Remarks

When the image property is set, the image_list property will be set to xtd::forms::image_list::empty, and the image_index property will be set to its default, -1.

Note

If the flat_style property is set to xtd::forms::flat_style::system, any images assigned to the image property are not displayed.

Examples

demo.cpp.