InputScope Enumeration

Article
10/16/2006

InputScope Enumeration

Overview of InputScope Enumeration.

The InputScope enumeration contains values that specify which input scope(s) are applied to a given field.

typedef enum
{
    // common input scopes
    IS_DEFAULT                        = 0,
    IS_URL                            = 1,
    IS_FILE_FULLFILEPATH              = 2,
    IS_FILE_FILENAME                  = 3,
    IS_EMAIL_USERNAME                 = 4,
    IS_EMAIL_SMTPEMAILADDRESS         = 5,
    IS_LOGINNAME                      = 6,
    IS_PERSONALNAME_FULLNAME          = 7,
    IS_PERSONALNAME_PREFIX            = 8,
    IS_PERSONALNAME_GIVENNAME         = 9,
    IS_PERSONALNAME_MIDDLENAME        = 10,
    IS_PERSONALNAME_SURNAME           = 11,
    IS_PERSONALNAME_SUFFIX            = 12,
    IS_ADDRESS_FULLPOSTALADDRESS      = 13,
    IS_ADDRESS_POSTALCODE             = 14,
    IS_ADDRESS_STREET                 = 15,
    IS_ADDRESS_STATEORPROVINCE        = 16,
    IS_ADDRESS_CITY                   = 17,
    IS_ADDRESS_COUNTRYNAME            = 18,
    IS_ADDRESS_COUNTRYSHORTNAME       = 19,
    IS_CURRENCY_AMOUNTANDSYMBOL       = 20,
    IS_CURRENCY_AMOUNT                = 21,
    IS_DATE_FULLDATE                  = 22,
    IS_DATE_MONTH                     = 23,
    IS_DATE_DAY                       = 24,
    IS_DATE_YEAR                      = 25,
    IS_DATE_MONTHNAME                 = 26,
    IS_DATE_DAYNAME                   = 27,
    IS_DIGITS                         = 28,
    IS_NUMBER                         = 29,
    IS_ONECHAR                        = 30,
    IS_PASSWORD                       = 31,
    IS_TELEPHONE_FULLTELEPHONENUMBER  = 32,
    IS_TELEPHONE_COUNTRYCODE          = 33,
    IS_TELEPHONE_AREACODE             = 34,
    IS_TELEPHONE_LOCALNUMBER          = 35,
    IS_TIME_FULLTIME                  = 36,
    IS_TIME_HOUR                      = 37,
    IS_TIME_MINORSEC                  = 38,
    IS_NUMBER_FULLWIDTH               = 39,
    IS_ALPHANUMERIC_HALFWIDTH         = 40,
    IS_ALPHANUMERIC_FULLWIDTH         = 41,
    IS_CURRENCY_CHINESE               = 42,
    IS_BOPOMOFO                       = 43,
    IS_HIRAGANA                       = 44,
    IS_KATAKANA_HALFWIDTH             = 45,
    IS_KATAKANA_FULLWIDTH             = 46,
    IS_HANJA                          = 47,
    IS_PHRASELIST                     = -1,
    IS_REGULAREXPRESSION              = -2,
    IS_SRGS                           = -3,
    IS_XML                            = -4,
} InputScope;

Elements

IS_DEFAULT

Standard recognition bias. Treated as default and utilizes the default lexicon (vocabulary). If combined with another input scope, it does not force coercion on the other input scope.

IS_URL

URL, File, and FTP formats. Examples:

IS_FILE_FULLFILEPATH

Characters used in describing a file path. Includes the following conditions:

For server name and share name, allows all IS_ONECHAR characters except: * ? : < > |
For file name, allows all IS_ONECHAR characters except: \ / : < > |
Input must start with \\ or drive name or \ or ..\ or .\ or /
Spaces are allowed.

Examples:

\\servername\sharename\filename.txt
C:\temp\current work.doc
..\images\hank.jpg

IS_FILE_FILENAME

Characters used in describing a file name. Includes the following conditions:

Accepts either extension or no extension.
Allows all IS_ONECHAR characters except: \ / : < > |
Spaces are allowed.

Example:

filename.txt
filename
file name.txt

IS_EMAIL_USERNAME

E-mail user names. Examples:

jeffsm
JeffSm
Jsmith
JSmith
jeffsmith

IS_EMAIL_SMTPEMAILADDRESS

Complete SMTP email address. For example, someone@example.com.

IS_LOGINNAME

Allows all IS_ONECHAR characters.
Does not allow domain or username to start or end in a non-alphanumeric character.
Spaces are not allowed.
The following characters are not allowed: + * / (plus sign, asterisk, forward slash).

Examples:

CHICAGO\JSMITH
JSMITH

IS_PERSONALNAME_FULLNAME

Combinations of first, middle, and last names. Examples, formatted for English (United States):

Mr. Jeff A. Smith, Jr.
Jeff Smith
Smith, Jeff
Smith, Jeff A

IS_PERSONALNAME_PREFIX

Honorific or title preceding a name. Examples, formatted for English (United States):

Mr.
Dr.
Miss
Sir

IS_PERSONALNAME_GIVENNAME

First name or initial. Examples, formatted for English (United States):

Jeff
J.
J.A.

IS_PERSONALNAME_MIDDLENAME

Middle name or initial. Examples:

Albert
A

IS_PERSONALNAME_SURNAME

Last name. Examples, formatted for English (United States):

Smith
Smith Jones
Smith-Jones

IS_PERSONALNAME_SUFFIX

Name suffix abbreviations and Roman numerals. For example, Jr.

IS_ADDRESS_FULLPOSTALADDRESS

Full address, including numbers. Examples, formatted for English (United States):

123 Main Street, Seattle, WA 98121
PO Box 123, Redmond, WA 98052

IS_ADDRESS_POSTALCODE

Alphanumeric (for international support) postal code. Examples, formatted for English (United States):

98033

98052-6399

IS_ADDRESS_STREET

House number, street number, apartment name and number, and postal box only. For example, 123 Main Street.

IS_ADDRESS_STATEORPROVINCE

Full name or abbreviation of state or province. Examples, formatted for English (United States):

WA
Washington
Wa

IS_ADDRESS_CITY

Name or abbreviation of city. Examples, formatted for English (United States):

New York
NYC

IS_ADDRESS_COUNTRYNAME

Name of Country. Examples, formatted for English (United States):

Italy
Japan
United States of America

IS_ADDRESS_COUNTRYSHORTNAME

Abbreviation for country. Examples, formatted for English (United States):

USA
U.S.A.

IS_CURRENCY_AMOUNTANDSYMBOL

Currency symbols and numbers. Examples, formatted for English (United States):

$ 2,100.25
$.35
$1,234.50 USD

IS_CURRENCY_AMOUNT

Numeric values for currency, excluding currency symbols. For example, 2,100.25.

IS_DATE_FULLDATE

Full date, in a variety of formats. Examples, formatted for English (United States):

07-17-2001
7/17/01
7/17
Dec. 12
July 17
July 17, 2001

IS_DATE_MONTH

Numeric representation of months, constrained to 1-12. Examples:

IS_DATE_DAY

Numeric representation of days, constrained to 1-31. Examples:

IS_DATE_YEAR

Numeric representation of years. Examples:

1988
2004
88
04
'88

IS_DATE_MONTHNAME

Character representation of months. Examples, formatted for English (United States):

February
Dec
Dec.

IS_DATE_DAYNAME

Character representation of days. Examples, formatted for English (United States):

Wednesday
Wed
Mon.

IS_DIGITS

Positive whole numbers. Digit strings made of 0-9 are allowed.

IS_NUMBER

Numbers, including commas, negative sign, and decimal. For United States locations, includes the following conditions.

The thousand separator is a comma.
The decimal separator is a period.
Negative numbers are represented with a hyphen without a space, not with parentheses.

IS_ONECHAR

A single ANSI character, codepage 1252. For United States locations, this includes the following characters:

ABCDEFGHIJKLMNOPQRSTUVWXYZabcdEfghijklmnopqrstuvwxyz0123456789!\"#$%&'()*+,-./:;<=>?@[\]^_`{|}~

IS_PASSWORD

Not used by Tablet PC recognizers.

IS_TELEPHONE_FULLTELEPHONENUMBER

Telephone number. Does not support numbers with letters. Examples, formatted for English (United States):

(425) 555-0112
555-0123
555.0123
206-555-0123
1-206-555-0123x1234
+1 (206) 555-1234

IS_TELEPHONE_COUNTRYCODE

Telephone country codes. Examples, formatted for English (United States):

+1
+44
001
00 44

IS_TELEPHONE_AREACODE

Telephone area codes. Examples, formatted for English (United States):

(425)
425

IS_TELEPHONE_LOCALNUMBER

Telephone number, excluding country or area code. Examples, formatted for English (United States):

555-0112
555 0112
555.0123

IS_TIME_FULLTIME

Hours, minutes, seconds, and alphabetic time abbreviations. US English uses the 12 hour clock. Leading zeros are optional for hours but required for minutes and seconds. Hours are constrained to 0-24; minutes and seconds are contstrained to 0-59. Examples, formatted for English (United States):

3:20
04:30
11:20:55
11:15 am
4:30 AM

IS_TIME_HOUR

Numeric representation of hours. Constrained to 0-24.

IS_TIME_MINORSEC

Numeric representation of minutes or seconds. Constrained to 0-59.

IS_NUMBER_FULLWIDTH

Full-width number (Japanese locations only). Constrains to full-width numbers and Kanji numbers.

IS_ALPHANUMERIC_HALFWIDTH

Half-width alphanumeric (East-Asian languages only). Constrains to half-width alphabet characters and numbers.

IS_ALPHANUMERIC_FULLWIDTH

Full-width alphanumeric (East-Asian languages only). Constrains to full-width alphabet characters and numbers.

IS_CURRENCY_CHINESE

Reserved

IS_BOPOMOFO

Reserved

IS_HIRAGANA

Reserved

IS_KATAKANA_HALFWIDTH

Reserved

IS_KATAKANA_FULLWIDTH

Reserved

IS_HANJA

Reserved

IS_PHRASELIST

Used to indicate that a phrase list was passed in.

IS_REGULAREXPRESSION

Used to indicate that a regular expression was passed in.

IS_SRGS

Reserved.

IS_XML

Reserved

Remarks

The IS_SRGS and IS_XML input scopes are not used in Windows XP Tablet PC Edition 2004. The input scopes that are marked as "Reserved" are not used by the handwriting recognizers in Windows XP Tablet PC Edition 2004.

Windows XP: Included in Windows XP SP2.

Header: Declared in InputScope.idl and InputScope.h.

Library: Included as a resource in Msctf.dll.

InputScope Enumeration

InputScope Enumeration

Additional resources