Instance Method

capitalized(with:)

Returns a capitalized representation of the receiver using the specified locale.

Declaration

func capitalized(with locale: Locale?) -> String

Parameters

locale

The locale. For strings presented to users, pass the current locale ([NSLocale current]). To use the system locale, pass nil.

Return Value

A string with the first character from each word in the receiver changed to its corresponding uppercase value, and all remaining characters set to their corresponding lowercase values.

Discussion

A capitalized string is a string with the first character in each word changed to its corresponding uppercase value, and all remaining characters set to their corresponding lowercase values. A “word” is any sequence of characters delimited by spaces, tabs, or line terminators (listed under getLineStart(_:end:contentsEnd:for:)). Some common word delimiting punctuation isn’t considered, so this property may not generally produce the desired results for multiword strings.

Case transformations aren’t guaranteed to be symmetrical or to produce strings of the same lengths as the originals. See lowercased for an example.

See Also

Related Symbols

func lowercased(with: Locale?)

Returns a version of the string with all letters converted to lowercase, taking into account the specified locale.

func uppercased(with: Locale?)

Returns a version of the string with all letters converted to uppercase, taking into account the specified locale.