BarGalleryItemViewModel<TValue> Class

public class BarGalleryItemViewModel<TValue> : ObservableObjectBase, IBarGalleryItemViewModel, IEquatable<IBarGalleryItemViewModel>

protected BarGalleryItemViewModel()

protected BarGalleryItemViewModel(TValue value)

Parameter	Type	Description
value	TValue	The item's value.

protected BarGalleryItemViewModel(TValue value, string category)

Parameter	Type	Description
value	TValue	The item's value.
category	string	The item's category, or null if categorization is not supported.

protected BarGalleryItemViewModel(TValue value, string category, string label)

Parameter	Type	Description
value	TValue	The item's value.
category	string	The item's category, or null if categorization is not supported.
label	string	The text label to display, or null if the label can be coerced from the current value.

public string Category { get; set; }

Property Value

string:

The item's category.

public string Description { get; set; }

Property Value

string:

The text description to display in screen tips.

public ImageSource ImageSource { get; set; }

Property Value

ImageSource:

An ImageSource for the image.

public virtual bool IsLabelVisible { get; }

Property Value

bool:

true if the Label is visible; otherwise, false.

public bool IsVisible { get; set; }

Property Value

bool:

The default value is true.

public string KeyTipText { get; set; }

Property Value

string:

The key tip text used to access the control.

public string Label { get; set; }

Property Value

string:

The text label to display.

Remarks

If the label is not explicitly defined, the value may be coerced.

public BarGalleryItemLayoutBehavior LayoutBehavior { get; set; }

Property Value

BarGalleryItemLayoutBehavior:

A BarGalleryItemLayoutBehavior indicating how the gallery item should be visually displayed. The default value is Default.

public virtual TValue Value { get; set; }

Property Value

TValue:

An object of type TValue.

protected virtual string CoerceLabel()

Returns

string:

The coerced text label to display.

See Also

• Label

protected static string ConvertEnumValueToString(Type enumType, object enumValue, bool useAttributes)

Parameter	Type	Description
enumType	Type	The enumeration Type to examine.
enumValue	object	The enumeration value.
useAttributes	bool	Whether to use description or display attributes.

Returns

string:

A string representation of the specified value or null if the value and/or type is not recognized as an enumeration.

protected static string ConvertEnumValueToString<TEnum>(TEnum enumValue, bool useAttributes) where TEnum : struct, IComparable, IFormattable

Type Parameters:

TEnum -

The type of the enumeration.

Parameter	Type	Description
enumValue	TEnum	The enumeration value.
useAttributes	bool	Whether to use description or display attributes.

Returns

string:

A string representation of the specified value or null if the value type is not an enumeration.

public virtual bool Equals(IBarGalleryItemViewModel other)

Parameter	Type	Description
other	IBarGalleryItemViewModel	An object to compare with this object.

Returns

bool:

true if the current object is equal to the other parameter; otherwise, false.

public override sealed bool Equals(object obj)

Parameter	Type	Description
obj	object	The object to compare with the current object.

Returns

bool:

true if the specified object is equal to the current object; otherwise, false.

public override int GetHashCode()

Returns

int:

A hash code for the current object.

protected virtual void OnValueChanged()

public override string ToString()

Returns

string:

The string representation of this object.