codepointProperty

Retrieves a Unicode Character Database (UCD )character property of a Unicode codepoint.

# Metadata

Platforms: desktop, server, mobile OS: mac, windows, linux, ios, android Introduced: 7.0 Security:

# Syntax

codepointProperty(unicodeCodepoint, propertyName)

# Params

- unicodeCodepoint : A Unicode codepoint, or an expression which evaulates to a Unicode codepoint. - propertyName : The name of a supported UCD codepoint property. Examples of supported properties, for a full list see http://www.unicode.org/versions/Unicode6.2.0/ch04.pdf

# Examples

get codepointProperty("A","Script") -- returns "Latin"

put codePointProperty(codepoint 1 of tString, "Name")

# Description

Use the codepointProperty function to retrieve a UCD property of a Unicode codepoint.

The Unicode standard and the associated Unicode Character Database (UCD) define a series of properties for each codepoint in the Unicode standard. A number of these properties are used internally by the engine during text processing but it is also possible to query these properties directly using this function.

There are many properties available; please see the version 6.3.0 of the Unicode standard, Chapter 4 and Section 5 of Unicode Technical Report (TR)#44 for details on the names and values of properties. Property names may be specified with either spaces or underscores and are not case-sensitive.

>*Note:* This function is not intended for general-purpose use; please > use functions such as toUpper or the is operators instead.

# Tags

# See

- **keyword:** codepoint, codepoints - **function:** nativeCharToNum, numToNativeChar, toUpper, numToCodepoint - **operator:** equals