Edit

SrgsItem.Weight Property

  • Reference

Definition

Namespace:
System.Speech.Recognition.SrgsGrammar
Assembly:
System.Speech.dll
Package:
System.Speech v8.0.0
Package:
System.Speech v9.0.0-preview.3.24172.9
Source:
SrgsItem.cs
Source:
SrgsItem.cs
Source:
SrgsItem.cs

Gets or sets a multiplying factor that adjusts the likelihood that an SrgsItem in a SrgsOneOf object will be spoken.

public:
 property float Weight { float get(); void set(float value); };
public float Weight { get; set; }
member this.Weight : single with get, set
Public Property Weight As Single

Property Value

Single

A floating point value that adjusts the likelihood of this item being spoken.

Exceptions

ArgumentOutOfRangeException

An attempt is made to set Weight to a negative value.

Remarks

The default value of this property is 1.0, which is equivalent to no weighting of the item. A weight greater than 1.0 positively biases the likelihood that the item will be spoken, and a weight less than 1.0 negatively biases the likelihood that the item will be spoken.

This property is relevant only to SrgsItem objects within an SrgsOneOf instance; it is ignored in all other cases.

Applies to

See also