StaticLayout.Builder.SetHyphenationFrequency(HyphenationFrequency) Method

Definition

Namespace:: Android.Text

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Set hyphenation frequency, to control the amount of automatic hyphenation used.

[Android.Runtime.Register("setHyphenationFrequency", "(I)Landroid/text/StaticLayout$Builder;", "", ApiSince=23)]
public Android.Text.StaticLayout.Builder SetHyphenationFrequency(Android.Text.HyphenationFrequency hyphenationFrequency);

[<Android.Runtime.Register("setHyphenationFrequency", "(I)Landroid/text/StaticLayout$Builder;", "", ApiSince=23)>]
member this.SetHyphenationFrequency : Android.Text.HyphenationFrequency -> Android.Text.StaticLayout.Builder

Parameters

hyphenationFrequency: HyphenationFrequency

hyphenation frequency for the paragraph. Value is one of the following: Layout.HYPHENATION_FREQUENCY_NORMAL; Layout.HYPHENATION_FREQUENCY_NORMAL_FAST; Layout.HYPHENATION_FREQUENCY_FULL; Layout.HYPHENATION_FREQUENCY_FULL_FAST; Layout.HYPHENATION_FREQUENCY_NONE

Returns

StaticLayout.Builder

this builder, useful for chaining. This value cannot be null.

Attributes: RegisterAttribute

Remarks

Set hyphenation frequency, to control the amount of automatic hyphenation used. The possible values are defined in Layout, by constants named with the pattern HYPHENATION_FREQUENCY_*. The default is Layout.HYPHENATION_FREQUENCY_NONE.

Enabling hyphenation with either using Layout.HYPHENATION_FREQUENCY_NORMAL or Layout.HYPHENATION_FREQUENCY_FULL while line breaking is set to one of Layout.BREAK_STRATEGY_BALANCED, Layout.BREAK_STRATEGY_HIGH_QUALITY improves the structure of text layout however has performance impact and requires more time to do the text layout.

Android reference for android.text.StaticLayout.Builder.setHyphenationFrequency.

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