PersonPicture.PreferSmallImage Property

Definition

Namespace:

Windows.UI.Xaml.Controls

Gets or sets a value that indicates whether a small image is displayed rather than a large image when both are available.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.PersonPicture.PreferSmallImage (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

public:
 property bool PreferSmallImage { bool get(); void set(bool value); };

bool PreferSmallImage();

void PreferSmallImage(bool value);

public bool PreferSmallImage { get; set; }

var boolean = personPicture.preferSmallImage;
personPicture.preferSmallImage = boolean;

Public Property PreferSmallImage As Boolean

<PersonPicture PreferSmallImage="bool"/>

Property Value

Boolean

bool

true to display a small image even when a large image is available; otherwise, false. The default is false.

Remarks

If an image is available, the control displays the first image it finds, in this order:

1. LargeDisplayPicture
2. SmallDisplayPicture
3. Thumbnail

You can change which image is chosen by setting the PreferSmallImage property to true. This gives the SmallDisplayPicture a higher priority than LargeDisplayPicture.