<String type>.Format (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Standard functions

String management functions

Prefix syntax

Format

Presentation

Example

<String type>.Format and UNICODE

See also

<String type>.Format (Function)

In french: <Type Chaîne>.Formate

Formats a character string according to the selected options.

Example

MyString1 is string = "Developing is fantastic"
MyString1 = MyString1.Format(ccUpCase)
// MyString1 contains "DEVELOPING IS FANTASTIC"

Syntax

<Result> = <String>.Formats(<Options>)

<Result>: Character string

String formatted according to the selected criteria.

<String>: Character string

Character string to format.
You can use Unicode strings.
You cannot use Unicode strings.

<Options>: Constant or combination of constants

Formatting options:
ccIgnoreAccent Format without accented characters.
ccIgnoreInsideSpace The following characters are deleted within the string:
space (character 32)
tab (character 9)
carriage return (character 13) and line feed (character 10)
control characters 11 and 12
This constant is not available.
ccIgnorePunctuationAndSpace Removes spaces and punctuation characters.
ccIgnoreSpace The following characters are deleted at the beginning and at the end of the string:
space (character 32)
tab (character 9)
carriage return (character 13) and line feed (character 10)
control characters 11 and 12
ccLowCase Converts the string to lowercase characters.
ccNormal No formatting is performed.
ccUpCase Converts the string to uppercase characters (including accented characters).

Remarks

<String type>.Format and UNICODE

If the string passed as a parameter is an ANSI string, the result will be an ANSI string.

If the string passed as a parameter is a UNICODE string, the result will be a UNICODE string.

Remark: If the result of <String type>.Format on an ANSI string is assigned to a UNICODE string (and vice versa), the conversion will be implicitly performed.

For more details, see Managing UNICODE.

Component: wd270vm.dll