Class SfAvatarView

SfAvatarView is a graphical representation of the user image. You can customize it by adding image, background color, icon, text etc.

Inheritance

System.Object

SfBorder

SfAvatarView

Inherited Members

SfBorder.BorderColor

SfBorder.BorderColorProperty

SfBorder.BorderThickness

SfBorder.BorderThicknessProperty

SfBorder.BorderWidth

SfBorder.BorderWidthProperty

SfBorder.DashArray

SfBorder.DashArrayProperty

SfBorder.HasShadow

SfBorder.HasShadowProperty

SfBorder.LayoutChildren(Double, Double, Double, Double)

SfBorder.OnMeasure(Double, Double)

SfBorder.ShadowColor

SfBorder.ShadowColorProperty

Namespace: Syncfusion.XForms.AvatarView

Assembly: Syncfusion.Core.XForms.dll

Syntax

public class SfAvatarView : SfBorder, IParentThemeElement, IThemeElement

Constructors

SfAvatarView()

Initializes a new instance of the SfAvatarView class.

Declaration

public SfAvatarView()

Fields

AspectProperty

Using a DependencyProperty as the backing store for Aspect . This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty AspectProperty

Field Value

Type
Xamarin.Forms.BindableProperty

AvatarCharacterProperty

Using a DependencyProperty as the backing store for DefaultAvatar. This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty AvatarCharacterProperty

Field Value

Type
Xamarin.Forms.BindableProperty

AvatarNameProperty

Using a DependencyProperty as the backing store for Name. This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty AvatarNameProperty

Field Value

Type
Xamarin.Forms.BindableProperty

AvatarShapeProperty

Using a DependencyProperty as the backing store for AvatarStyle. This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty AvatarShapeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

AvatarSizeProperty

Using a DependencyProperty as the backing store for AvatarStyle. This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty AvatarSizeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

BackgroundColorMemberPathProperty

Using a DependencyProperty as the backing store for BackgroundColorMemberPath. This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty BackgroundColorMemberPathProperty

Field Value

Type
Xamarin.Forms.BindableProperty

BackgroundColorProperty

Using a DependencyProperty as the backing store for BackgroundColor. This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty BackgroundColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

BackgroundGradientProperty

Using a DependencyProperty as the backing store for BackgroundGradient. This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty BackgroundGradientProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ColorModeProperty

Using a DependencyProperty as the backing store for CanUseAutomaticBackgroundColor. This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty ColorModeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ContentTypeProperty

Using a DependencyProperty as the backing store for AvatarType. This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty ContentTypeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

CornerRadiusProperty

Using a DependencyProperty as the backing store for CornerRadius. This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty CornerRadiusProperty

Field Value

Type
Xamarin.Forms.BindableProperty

FontAttributesProperty

Using a DependencyProperty as the backing store for FontAttributes. This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty FontAttributesProperty

Field Value

Type
Xamarin.Forms.BindableProperty

FontFamilyProperty

Using a DependencyProperty as the backing store for FontFamily. This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty FontFamilyProperty

Field Value

Type
Xamarin.Forms.BindableProperty

FontSizeProperty

Using a DependencyProperty as the backing store for FontSize. This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty FontSizeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

GroupSourceProperty

Using a DependencyProperty as the backing store for GroupSource. This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty GroupSourceProperty

Field Value

Type
Xamarin.Forms.BindableProperty

HeightRequestProperty

Using a DependencyProperty as the backing store for HeightRequest. This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty HeightRequestProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ImageSourceMemberPathProperty

Using a DependencyProperty as the backing store for ImageSourceMemberPath. This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty ImageSourceMemberPathProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ImageSourceProperty

Using a DependencyProperty as the backing store for ImageSource. This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty ImageSourceProperty

Field Value

Type
Xamarin.Forms.BindableProperty

InitialsColorMemberPathProperty

Using a DependencyProperty as the backing store for InitialsColorMemberPath. This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty InitialsColorMemberPathProperty

Field Value

Type
Xamarin.Forms.BindableProperty

InitialsColorProperty

Using a DependencyProperty as the backing store for InitialsColor. This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty InitialsColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

InitialsMemberPathProperty

Using a DependencyProperty as the backing store for InitialsMemberPath. This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty InitialsMemberPathProperty

Field Value

Type
Xamarin.Forms.BindableProperty

InitialsTypeProperty

Using a DependencyProperty as the backing store for InitialType. This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty InitialsTypeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

WidthRequestProperty

Using a DependencyProperty as the backing store for WidthRequest. This enables animation, styling, binding, etc...

Declaration

public static readonly BindableProperty WidthRequestProperty

Field Value

Type
Xamarin.Forms.BindableProperty

Properties

Aspect

Gets or sets the Aspect value of the images . This is Bindable Property . The default value of the Aspect is Aspect.AspectFill.

Declaration

public Aspect Aspect { get; set; }

Property Value

Type
Xamarin.Forms.Aspect

AvatarCharacter

Gets or sets the value of the AvatarCharacter, which is shown only when the avatar type is AvatarCharacter. They have vector images in the avatarcharacter types.

Declaration

public AvatarCharacter AvatarCharacter { get; set; }

Property Value

Type
AvatarCharacter

AvatarColorMode

Gets or sets the value for the ColorMode, which consists of three types: default, dark color, and light color. Based on the types, it is displayed in the view.

Declaration

public AvatarColorMode AvatarColorMode { get; set; }

Property Value

Type
AvatarColorMode

AvatarName

Gets or sets the value for the initials type, which displays the text in the avatar view.

Declaration

public string AvatarName { get; set; }

Property Value

Type
System.String

AvatarShape

Gets or sets the value for the enum AvatarShape used for changing the shapes of the avatar views.

Declaration

public AvatarShape AvatarShape { get; set; }

Property Value

Type
AvatarShape

AvatarSize

Gets or sets the value for the enum AvatarSize used for changing the sizes of the avatar views.

Declaration

public AvatarSize AvatarSize { get; set; }

Property Value

Type
AvatarSize

BackgroundColor

Gets or sets the value for the Background color used for setting the background color for the avatar view.

Declaration

public Color BackgroundColor { get; set; }

Property Value

Type
Xamarin.Forms.Color

BackgroundColorMemberPath

Gets or sets the value for the BackgroundColorMemberPath that shows the background color value when avatar type is set to Group.

Declaration

public string BackgroundColorMemberPath { get; set; }

Property Value

Type
System.String

BackgroundGradient

Gets or sets the value for the background used for applying the gradient color.

Declaration

public SfGradientBrush BackgroundGradient { get; set; }

Property Value

Type
SfGradientBrush

Content

Gets or sets the value for the Content.

Declaration

public View Content { get; set; }

Property Value

Type
Xamarin.Forms.View

ContentType

Gets or sets the value for the Avatar enum type. Based on the avatar type only, it shows the SfAvatarView. The types are initials, group, custom, and avatarcharacter.

Declaration

public ContentType ContentType { get; set; }

Property Value

Type
ContentType

CornerRadius

Gets or sets the SfAvatarView corner radius.

Declaration

public Thickness CornerRadius { get; set; }

Property Value

Type
Xamarin.Forms.Thickness

FontAttributes

Gets or sets the font attributes in the initials string given in the text for the SfAvatarView. This is a bindable property.

Declaration

public FontAttributes FontAttributes { get; set; }

Property Value

Type
Xamarin.Forms.FontAttributes

FontFamily

Gets or sets the font family of the font in the initials string given in the text for the SfAvatarView. The default value for the font icon family is set to static AvatarViewStaticText.DefaultFontIconText.

Declaration

public string FontFamily { get; set; }

Property Value

Type
System.String

FontSize

Gets or sets the size of the font in the initials string given in the text for the SfAvatarView. The default value for the font size is 18.

Declaration

public double FontSize { get; set; }

Property Value

Type
System.Double

GroupSource

Gets or sets the value for the GroupSource used for setting more than one image/text, and this is shown only when avatar type is set to Group.

Declaration

public IEnumerable GroupSource { get; set; }

Property Value

Type
System.Collections.IEnumerable

HeightRequest

Gets or sets the SfAvatarView height request.

Declaration

public double HeightRequest { get; set; }

Property Value

Type
System.Double

ImageSource

Gets or sets the custom image used for adding the custom image.

Declaration

public ImageSource ImageSource { get; set; }

Property Value

Type
Xamarin.Forms.ImageSource

ImageSourceMemberPath

Gets or sets the value for the ImageSourceMemberPath that shows the image value when avatar type is set to Group.

Declaration

public string ImageSourceMemberPath { get; set; }

Property Value

Type
System.String

InitialsColor

Gets or sets the color of the initials color value that defines color for the initials string. This is a bindable property.

Declaration

public Color InitialsColor { get; set; }

Property Value

Type
Xamarin.Forms.Color

InitialsColorMemberPath

Gets or sets the value for the InitialsColorMemberPath that shows the initials color value when avatar type is set to Group.

Declaration

public string InitialsColorMemberPath { get; set; }

Property Value

Type
System.String

InitialsMemberPath

Gets or sets the value for the InitialsMemberPath that shows the initials value when avatar type is set to Group.

Declaration

public string InitialsMemberPath { get; set; }

Property Value

Type
System.String

InitialsType

Gets or sets the value for the Avatar enum type. Based on the avatar type only, it shows the SfAvatarView. The types are initials, group, custom, and avatarcharacter.

Declaration

public InitialsType InitialsType { get; set; }

Property Value

Type
InitialsType

WidthRequest

Gets or sets the SfAvatar view SfAvatarView width request.

Declaration

public double WidthRequest { get; set; }

Property Value

Type
System.Double