PersonPicture PersonPicture PersonPicture PersonPicture Class

Definition

Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Prerelease APIs are identified by a Prerelease label.

[Contains prerelease APIs.]
Represents a control that displays the avatar image for a person, if one is available; if not, it displays the person's initials or a generic glyph.

public : class PersonPicture : Control, IPersonPicturepublic class PersonPicture : Control, IPersonPicturePublic Class PersonPicture Inherits Control Implements IPersonPicture// You can use this class in JavaScript.
<PersonPicture/>

Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Inherited Members

Inherited properties

Inherited events

Inherited methods

Constructors

PersonPicture() PersonPicture() PersonPicture() PersonPicture()

Prerelease. Initializes a new instance of the PersonPicture class.

public : PersonPicture()public PersonPicture()Public Sub New()// You can use this method in JavaScript.

Properties

BadgeGlyph BadgeGlyph BadgeGlyph BadgeGlyph

Prerelease. Gets or sets a Segoe MDL2 Assets font glyph to display on the badge.

public : PlatForm::String BadgeGlyph { get; set; }public string BadgeGlyph { get; set; }Public ReadWrite Property BadgeGlyph As string// You can use this property in JavaScript.
<PersonPicture BadgeGlyph="characterCode"/>

Value
PlatForm::String string string string

The hexadecimal character code for the badge glyph.

BadgeGlyphProperty BadgeGlyphProperty BadgeGlyphProperty BadgeGlyphProperty

Prerelease. Identifies the BadgeGlyph dependency property.

public : static DependencyProperty BadgeGlyphProperty { get; }public static DependencyProperty BadgeGlyphProperty { get; }Public Static ReadOnly Property BadgeGlyphProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the BadgeGlyph dependency property.

BadgeImageSource BadgeImageSource BadgeImageSource BadgeImageSource

Prerelease. Gets or sets the source of an image to display on the badge.

public : ImageSource BadgeImageSource { get; set; }public ImageSource BadgeImageSource { get; set; }Public ReadWrite Property BadgeImageSource As ImageSource// You can use this property in JavaScript.
<PersonPicture BadgeImageSource="uri"/>

Value
ImageSource ImageSource ImageSource ImageSource

An object that represents the image source file for the drawn image. Typically you set this with a BitmapImage object, constructed with the Uniform Resource Identifier (URI) that describes the path to a valid image source file. Or, you can initialize a BitmapSource with a stream, perhaps a stream from a storage file.

BadgeImageSourceProperty BadgeImageSourceProperty BadgeImageSourceProperty BadgeImageSourceProperty

Prerelease. Identifies the BadgeImageSource dependency property.

public : static DependencyProperty BadgeImageSourceProperty { get; }public static DependencyProperty BadgeImageSourceProperty { get; }Public Static ReadOnly Property BadgeImageSourceProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the BadgeImageSource dependency property.

BadgeNumber BadgeNumber BadgeNumber BadgeNumber

Prerelease. Gets or sets the contact number to display on the badge.

public : int BadgeNumber { get; set; }public int BadgeNumber { get; set; }Public ReadWrite Property BadgeNumber As int// You can use this property in JavaScript.
<PersonPicture BadgeNumber="int"/>

Value
int int int int

The contact number to display on the badge.

BadgeNumberProperty BadgeNumberProperty BadgeNumberProperty BadgeNumberProperty

Prerelease. Identifies the BadgeNumber dependency property.

public : static DependencyProperty BadgeNumberProperty { get; }public static DependencyProperty BadgeNumberProperty { get; }Public Static ReadOnly Property BadgeNumberProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the BadgeNumber dependency property.

BadgeText BadgeText BadgeText BadgeText

Prerelease. Gets or sets the contact text to display on the badge.

public : PlatForm::String BadgeText { get; set; }public string BadgeText { get; set; }Public ReadWrite Property BadgeText As string// You can use this property in JavaScript.
<PersonPicture BadgeText="string"/>

Value
PlatForm::String string string string

The contact text to display on the badge.

BadgeTextProperty BadgeTextProperty BadgeTextProperty BadgeTextProperty

Prerelease. Identifies the BadgeText dependency property.

public : static DependencyProperty BadgeTextProperty { get; }public static DependencyProperty BadgeTextProperty { get; }Public Static ReadOnly Property BadgeTextProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the BadgeText dependency property.

Contact Contact Contact Contact

Prerelease. Gets or sets a Contact object that contains information about the person.

public : Contact Contact { get; set; }public Contact Contact { get; set; }Public ReadWrite Property Contact As Contact// You can use this property in JavaScript.
<PersonPicture Contact="{x:Bind contactObject}"/>

Value
Contact Contact Contact Contact

A Contact object that contains information about the person.

ContactProperty ContactProperty ContactProperty ContactProperty

Prerelease. Identifies the Contact dependency property.

public : static DependencyProperty ContactProperty { get; }public static DependencyProperty ContactProperty { get; }Public Static ReadOnly Property ContactProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the Contact dependency property.

DisplayName DisplayName DisplayName DisplayName

Prerelease. Gets or sets the contact's display name.

public : PlatForm::String DisplayName { get; set; }public string DisplayName { get; set; }Public ReadWrite Property DisplayName As string// You can use this property in JavaScript.
<PersonPicture DisplayName="string"/>

Value
PlatForm::String string string string

The contact's display name.

DisplayNameProperty DisplayNameProperty DisplayNameProperty DisplayNameProperty

Prerelease. Identifies the DisplayName dependency property.

public : static DependencyProperty DisplayNameProperty { get; }public static DependencyProperty DisplayNameProperty { get; }Public Static ReadOnly Property DisplayNameProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the DisplayName dependency property.

Initials Initials Initials Initials

Prerelease. Gets or sets the contact's initials.

public : PlatForm::String Initials { get; set; }public string Initials { get; set; }Public ReadWrite Property Initials As string// You can use this property in JavaScript.
<PersonPicture Initials="string"/>

Value
PlatForm::String string string string

The contact's initials.

InitialsProperty InitialsProperty InitialsProperty InitialsProperty

Prerelease. Identifies the Initials dependency property.

public : static DependencyProperty InitialsProperty { get; }public static DependencyProperty InitialsProperty { get; }Public Static ReadOnly Property InitialsProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the Initials dependency property.

IsGroup IsGroup IsGroup IsGroup

Prerelease. Gets or sets a value that indicates whether the PersonPicture represents a group or an individual.

public : PlatForm::Boolean IsGroup { get; set; }public bool IsGroup { get; set; }Public ReadWrite Property IsGroup As bool// You can use this property in JavaScript.
<PersonPicture IsGroup="bool"/>

Value
PlatForm::Boolean bool bool bool

true if the PersonPicture represents a group; otherwise, false.

IsGroupProperty IsGroupProperty IsGroupProperty IsGroupProperty

Prerelease. Identifies the IsGroup dependency property.

public : static DependencyProperty IsGroupProperty { get; }public static DependencyProperty IsGroupProperty { get; }Public Static ReadOnly Property IsGroupProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the IsGroup dependency property.

PreferSmallImage PreferSmallImage PreferSmallImage PreferSmallImage

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

public : PlatForm::Boolean PreferSmallImage { get; set; }public bool PreferSmallImage { get; set; }Public ReadWrite Property PreferSmallImage As bool// You can use this property in JavaScript.
<PersonPicture PreferSmallImage="bool"/>

Value
PlatForm::Boolean bool bool 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.

PreferSmallImageProperty PreferSmallImageProperty PreferSmallImageProperty PreferSmallImageProperty

Prerelease. Identifies the PreferSmallImage dependency property.

public : static DependencyProperty PreferSmallImageProperty { get; }public static DependencyProperty PreferSmallImageProperty { get; }Public Static ReadOnly Property PreferSmallImageProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the PreferSmallImage dependency property.

ProfilePicture ProfilePicture ProfilePicture ProfilePicture

Prerelease. Gets or sets the source of the contact's profile picture.

public : ImageSource ProfilePicture { get; set; }public ImageSource ProfilePicture { get; set; }Public ReadWrite Property ProfilePicture As ImageSource// You can use this property in JavaScript.
<PersonPicture ProfilePicture="uri"/>

Value
ImageSource ImageSource ImageSource ImageSource

An object that represents the image source file for the drawn image. Typically you set this with a BitmapImage object, constructed with the Uniform Resource Identifier (URI) that describes the path to a valid image source file. Or, you can initialize a BitmapSource with a stream, perhaps a stream from a storage file.

ProfilePictureProperty ProfilePictureProperty ProfilePictureProperty ProfilePictureProperty

Prerelease. Identifies the ProfilePicture dependency property.

public : static DependencyProperty ProfilePictureProperty { get; }public static DependencyProperty ProfilePictureProperty { get; }Public Static ReadOnly Property ProfilePictureProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the ProfilePicture dependency property.