RatingControl RatingControl RatingControl RatingControl 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 lets a user enter a star rating.

public : class RatingControl : Control, IRatingControlpublic class RatingControl : Control, IRatingControlPublic Class RatingControl Inherits Control Implements IRatingControl// You can use this class in JavaScript.
<RatingControl/>

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

RatingControl() RatingControl() RatingControl() RatingControl()

Prerelease. Initializes a new instance of the RatingControl class.

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

Properties

Caption Caption Caption Caption

Prerelease. Gets or sets the text label for the control.

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

Value
PlatForm::String string string string

The text label for the control. The default is an empty string.

CaptionProperty CaptionProperty CaptionProperty CaptionProperty

Prerelease. Identifies the Caption dependency property.

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

The identifier for Caption dependency property.

InitialSetValue InitialSetValue InitialSetValue InitialSetValue

Prerelease. Gets or sets the initial set rating value.

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

Value
int int int int

The initial set rating value. The default is 1.

InitialSetValueProperty InitialSetValueProperty InitialSetValueProperty InitialSetValueProperty

Prerelease. Identifies the InitialSetValue dependency property.

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

The identifier for InitialSetValue dependency property.

IsClearEnabled IsClearEnabled IsClearEnabled IsClearEnabled

Prerelease. Gets or sets the value that determines if the user can remove the rating.

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

Value
PlatForm::Boolean bool bool bool

true if the user can remove the rating; otherwise, false. The default is true.

IsClearEnabledProperty IsClearEnabledProperty IsClearEnabledProperty IsClearEnabledProperty

Prerelease. Identifies the IsClearEnabled dependency property.

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

The identifier for IsClearEnabled dependency property.

IsReadOnly IsReadOnly IsReadOnly IsReadOnly

Prerelease. Gets or sets the value that determines if the user can change the rating.

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

Value
PlatForm::Boolean bool bool bool

true if the rating is read-only; otherwise, false. The default is false.

IsReadOnlyProperty IsReadOnlyProperty IsReadOnlyProperty IsReadOnlyProperty

Prerelease. Identifies the IsReadOnly dependency property.

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

The identifier for IsReadOnly dependency property.

ItemInfo ItemInfo ItemInfo ItemInfo

Prerelease. Gets or sets info about the visual states of the items that represent a rating.

public : RatingItemInfo ItemInfo { get; set; }public RatingItemInfo ItemInfo { get; set; }Public ReadWrite Property ItemInfo As RatingItemInfo// You can use this property in JavaScript.
<RatingControl ItemInfo="resourceReferenceToRatingItemInfo"/>

Value
RatingItemInfo RatingItemInfo RatingItemInfo RatingItemInfo

A RatingItemInfo-derived object that contains details about the visual states of the items that represent a rating.

Remarks

You can set the ItemInfo property to replace the default stars with other glyphs or images that represent a rating.

ItemInfoProperty ItemInfoProperty ItemInfoProperty ItemInfoProperty

Prerelease. Identifies the ItemInfo dependency property.

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

The identifier for ItemInfo dependency property.

MaxRating MaxRating MaxRating MaxRating

Prerelease. Gets or sets the maximum allowed rating value.

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

Value
int int int int

The maximum allowed rating value. The default is 5.

MaxRatingProperty MaxRatingProperty MaxRatingProperty MaxRatingProperty

Prerelease. Identifies the MaxRating dependency property.

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

The identifier for MaxRating dependency property.

PlaceholderValue PlaceholderValue PlaceholderValue PlaceholderValue

Prerelease. Gets or sets the rating that is displayed in the control until the value is changed by a user action or some other operation.

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

Value
double double double double

The rating that is displayed in the control when no value is entered. The default is null.

PlaceholderValueProperty PlaceholderValueProperty PlaceholderValueProperty PlaceholderValueProperty

Prerelease. Identifies the PlaceholderValue dependency property.

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

The identifier for PlaceholderValue dependency property.

Value Value Value Value

Prerelease. Gets or sets the rating value.

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

Value
double double double double

The rating value. The default is null.

ValueProperty ValueProperty ValueProperty ValueProperty

Prerelease. Identifies the Value dependency property.

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

The identifier for Value dependency property.

Events

ValueChanged ValueChanged ValueChanged ValueChanged

Prerelease. Occurs when the Value property has changed.

public : event TypedEventHandler ValueChanged<RatingControl,  object>public event TypedEventHandler ValueChanged<RatingControl,  object>Public Event ValueChanged<RatingControl,  object>// You can use this event in JavaScript.
<RatingControl ValueChanged="eventhandler"/>