CharacterGrouping CharacterGrouping CharacterGrouping CharacterGrouping Class

A container for character group information. Characters are grouped in an index that enables an application to determine where the grouping boundaries are.

Syntax

Declaration

public sealed class CharacterGroupingpublic sealed class CharacterGroupingPublic NotInheritable Class CharacterGrouping

Remarks

Examples

// Create a CharacterGroupings object for the default collation.
var characterGroupings = new Windows.Globalization.Collation.CharacterGroupings();
// Get the number of CharacterGrouping objects.
var size = characterGroupings.size;
if (size > 0) {
    // Get the first characterGrouping.
    var characterGrouping = characterGroupings.getAt(0);
    // Get the first item in this characterGrouping.
    var first = characterGrouping.first;
    // Get the label of the first item in this characterGrouping.
    var label = characterGrouping.label;
}

Properties summary

Gets the first item that appears in the grouping under this index.

Gets the label that is associated with this index.

Properties

  • First
    First
    First
    First

    Gets the first item that appears in the grouping under this index.

    public string First { get; }public string First { get; }Public ReadOnly Property First As string

    Property Value

    • string
      string
      string
      string

      The string that defines the start of the group that has the associated Label. The start of the next group implicitly determines its end.

  • Label
    Label
    Label
    Label

    Gets the label that is associated with this index.

    public string Label { get; }public string Label { get; }Public ReadOnly Property Label As string

    Property Value

    • string
      string
      string
      string

      The string to use as the label for all strings of this group. This string may be empty, in which case the label is considered to be "other".

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.MarshalingBehaviorAttribute
Windows.Foundation.Metadata.DualApiPartitionAttribute
Windows.Foundation.Metadata.ContractVersionAttribute

Details

Assembly

Windows.Globalization.Collation.dll