Share via


RuleBasedCollator.GetRules(Boolean) Method

Definition

Returns current rules.

[Android.Runtime.Register("getRules", "(Z)Ljava/lang/String;", "", ApiSince=24)]
public string? GetRules (bool fullrules);
[<Android.Runtime.Register("getRules", "(Z)Ljava/lang/String;", "", ApiSince=24)>]
member this.GetRules : bool -> string

Parameters

fullrules
Boolean

true if the rules that defines the full set of collation order is required, otherwise false for returning only the tailored rules

Returns

the current rules that defines this Collator.

Attributes

Remarks

Returns current rules. The argument defines whether full rules (root collation + tailored) rules are returned or just the tailoring.

The root collation rules are an approximation of the root collator's sort order. They are almost never used or useful at runtime and can be removed from the data. See User Guide: Collation Customization, Building on Existing Locales

#getRules() should normally be used instead.

Java documentation for android.icu.text.RuleBasedCollator.getRules(boolean).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to