Class SpecialCharacters

Use these constants when you want or need your listings to be crystal clear about certain ambiguous literals.

Since static classes are implicitly sealed, this class cannot be inherited.

Inheritance
System.Object
SpecialCharacters
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: WizardWrx
Assembly: WizardWrx.Common.dll
Syntax
public static class SpecialCharacters
Remarks

For ease of access, I promoted the classes that expose only constants to the root of the WizardWrx namespace.

Fields

| Improve this Doc View Source

ALARM

The Alarm (bell or BEL) character must often be stripped from strings.

Declaration
public const char ALARM = '\a'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

AMPERSAND

Use this when your code requires a ampersand literal, when you want the listing to be crystal clear about what it is.

Declaration
public const char AMPERSAND = '&'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

ASTERISK

Asterisks are everywhere; use this constant to make asterisks that are intended to be treated as characters unambiguous.

Declaration
public const char ASTERISK = '*'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

ASTERISK_CHAR

Both ASTERISK_CHAR and ASTERISK resolve to the same character.

Declaration
public const char ASTERISK_CHAR = '*'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

AT_CHAR

Use this when your code requires the AT character literal, when you want the listing to be crystal clear about what it is.

Declaration
public const char AT_CHAR = '@'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

AT_SIGN

Both AT_SIGH and AT_CHAR resolve to the same character.

Declaration
public const char AT_SIGN = '@'
Field Value
Type Description
System.Char
Remarks

The '@' character has many uses in computing circles, mostly obscure ones, such as their use in many command line tools to denote that a specified file is not, itself, the object of interest, but is a list of files or other entities that are.

See Also
| Improve this Doc View Source

BACKSPACE

The backspace character is sometimes also cited as the non-destructive backspace because it moves the cursor backwards without destroying the character at that positon.

Declaration
public const char BACKSPACE = '\b'
Field Value
Type Description
System.Char
| Improve this Doc View Source

BEL

The Alarm (bell or BEL) character must often be stripped from strings.

Declaration
public const char BEL = '\a'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

BELL

The Alarm (bell or BEL) character must often be stripped from strings.

Declaration
public const char BELL = '\a'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

BRACE_LEFT

Use this in your code to specify a left French brace, also called a left brace or opening brace, as a character literal.

Declaration
public const char BRACE_LEFT = '{'
Field Value
Type Description
System.Char
Remarks

In addition to implementing DLM_FORMAT_ITEM_BEGIN for a specific use case, I implemented the generic use case and its twin, BRACE_RIGHT.

See Also
| Improve this Doc View Source

BRACE_RIGHT

Use this in your code to specify a right French brace, also called a right brace or closing brace, as a character literal.

Declaration
public const char BRACE_RIGHT = '}'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

BRACKET_LEFT

Use this in your code to specify a left square bracket, also called an opening bracket, as a character literal.

Declaration
public const char BRACKET_LEFT = '['
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

BRACKET_RIGHT

Use this in your code to specify a right square bracket, also called a closing bracket, as a character literal.

Declaration
public const char BRACKET_RIGHT = ']'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

CARRIAGE_RETURN

Use this character anywhere in your code that requires a bare carriage return character.

Declaration
public const char CARRIAGE_RETURN = '\r'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

CHAR_LC_I

Lower case I, for use in code, where it might be easily mistaken for a number 1 or a letter L.

Declaration
public const char CHAR_LC_I = 'i'
Field Value
Type Description
System.Char
| Improve this Doc View Source

CHAR_LC_L

Lower case L, for use in code, where it might be easily mistaken for a number 1 or a letter I.

Declaration
public const char CHAR_LC_L = 'l'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

CHAR_LC_O

Lower case O, for use in code where it might be easily mistaken for a number zero.

Declaration
public const char CHAR_LC_O = 'o'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

CHAR_LC_Z

Lower case Z, for use in code where it might be easily mistaken for a numeric character 2 or 7.

Declaration
public const char CHAR_LC_Z = 'z'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

CHAR_NUMERAL_0

Numeric character 0, for use in code where it might be mistaken for a letter O.

Declaration
public const char CHAR_NUMERAL_0 = '0'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

CHAR_NUMERAL_1

Numeric character 1, for use in code where it might be mistaken for a lower case l or an upper case I.

Declaration
public const char CHAR_NUMERAL_1 = '1'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

CHAR_NUMERAL_2

Numeric character 2, for use in code where it might be mistaken for a letter Z or a numeral 7.

Declaration
public const char CHAR_NUMERAL_2 = '2'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

CHAR_NUMERAL_7

Numeric character 2, for use in code where it might be mistaken for a letter Z or a numeral 7.

Declaration
public const char CHAR_NUMERAL_7 = '7'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

CHAR_UC_I

Upper case I, for use in code, where it might be easily mistaken for a number 1 or a letter L.

Declaration
public const char CHAR_UC_I = 'I'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

CHAR_UC_L

Upper case L, for use in code, where it might be easily mistaken for a number 1 or a letter I.

Declaration
public const char CHAR_UC_L = 'L'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

CHAR_UC_O

Upper case O, for use in code where it might be easily mistaken for a number zero.

Declaration
public const char CHAR_UC_O = 'O'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

CHAR_UC_Z

Upper case Z, for use in code where it might be easily mistaken for a numeric character 2 or 7.

Declaration
public const char CHAR_UC_Z = 'Z'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

CHECK_MARK_CHAR

The check-mark character prints as such only in selected Windows fonts.

Declaration
public const char CHECK_MARK_CHAR = 'û'
Field Value
Type Description
System.Char
| Improve this Doc View Source

COLON

Use this when your code requires a colon literal, when you want the listing to be crystal clear about what it is.

Declaration
public const char COLON = ':'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

COMMA

Use this when your code requires a comma literal, when you want the listing to be crystal clear about what it is.

Declaration
public const char COMMA = ','
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

DLM_FORMAT_ITEM_BEGIN

Use this when you code requires a Left French Brace literal, such as at the beginning of a Format Item.

Declaration
public const char DLM_FORMAT_ITEM_BEGIN = '{'
Field Value
Type Description
System.Char
Remarks

This constant is copied from WizardWrx.FormatStringEngine.FormatItem, in which it is called DLM_ITEM_BEGIN, for use independently of that library, which brings with it a chain of otherwise unused dependent DLLs.

It came to this library to fill a need for finding the first format item in a format control string, to determine at run time how many characters precede a format item that spans two or more lines.

See Also
| Improve this Doc View Source

DOUBLE_QUOTE

Use this when your code requires a double quotation mark literal, when you want the listing to be crystal clear about what it is.

Declaration
public const char DOUBLE_QUOTE = '"'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

END_OF_FILE

Though seldome encountered today, the MS-DOS End of File (EOF) character has, at minimum, historical significance.

Declaration
public const char END_OF_FILE = '\u001a'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

ENV_STR_DLM

Environment strings that appear in REG_EXPAND_SZ Registry keys and elsewhere are enclosed in pairs of this character.

Declaration
public const char ENV_STR_DLM = '%'
Field Value
Type Description
System.Char
Remarks

Construct a valid environment string substitution token from the name of an environment string by calling the MakeToken extension method, which is visible when WizardWrx.Core is imported into your module.

| Improve this Doc View Source

EOF

Though seldome encountered today, the MS-DOS End of File (EOF) character has, at minimum, historical significance.

Declaration
public const char EOF = '\u001a'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

EQUALS_SIGN

Use this constant when your code requires a literal equals sign.

Declaration
public const char EQUALS_SIGN = '='
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

ESCAPE_CHAR

Another character that is largely of historical interest, yet may appear from time to time in a dsta stream is the ASCII ESCape character.

Declaration
public const char ESCAPE_CHAR = '\u001b'
Field Value
Type Description
System.Char
| Improve this Doc View Source

FULL_STOP

Use this character to unambiguously denote a period character, for example, when specifying a delimiter character or appending a full stop character to a string.

Declaration
public const char FULL_STOP = '.'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

HASH_TAG

Use this constant to specify a hash-tag literal character

Declaration
public const char HASH_TAG = '#'
Field Value
Type Description
System.Char
| Improve this Doc View Source

HYPHEN

Literal hyphens are also easily confused in code, especially with minus signs.

Declaration
public const char HYPHEN = '-'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

LAST_ASCII_CHAR

The highest integer that can represent any ASCII character is 255, which is all 8 bits turned ON.

Declaration
public const char LAST_ASCII_CHAR = 'ÿ'
Field Value
Type Description
System.Char
| Improve this Doc View Source

LINEFEED

Use this character anywhere in your code that requires a bare linefeed character.

Declaration
public const char LINEFEED = '\n'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

LOGICAL_NEGATE

Thanks to a suggestion from my esteemed colleague Bud Pass, this is my new preferred field delimiter character. It supersedes my favorite for many years, PIPE_CHAR.

Declaration
public const char LOGICAL_NEGATE = '¬'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

MINUS

Use this character anywhere in your code that requires a plus sign that represents that symbol explicitly as a character.

Declaration
public const char MINUS = '-'
Field Value
Type Description
System.Char
| Improve this Doc View Source

NONBREAKING_SPACE_CHAR

The non-breaking space character doesn't print; although the Unicode encoding treats it as a white space character, most other encodings, including both Unicode and US-ASCII, do not.

Declaration
public const char NONBREAKING_SPACE_CHAR = ' '
Field Value
Type Description
System.Char
| Improve this Doc View Source

NULL_CHAR

Use this when your code requires a literal null character, and you want the listing to be crystal clear. This can be especially useful to distinguish a null character from a null reference.

Declaration
public const char NULL_CHAR = '\0'
Field Value
Type Description
System.Char
| Improve this Doc View Source

PARENTHESIS_LEFT

Use this in your code to specify a left parenthesis, also called an opening parenthesis, as a character literal.

Declaration
public const char PARENTHESIS_LEFT = '('
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

PARENTHESIS_RIGHT

Use this in your code to specify a right parenthesis, also called a closing parenthesis, as a character literal.

Declaration
public const char PARENTHESIS_RIGHT = ')'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

PERCENT_SIGN

Use this when your code requires a ampersand literal, when you want the listing to be crystal clear about what it is.

Declaration
public const char PERCENT_SIGN = '%'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

PIPE_CHAR

How have I got on this long without my faithful field separator?

Declaration
public const char PIPE_CHAR = '|'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

PLUS

Declaration
public const char PLUS = '+'
Field Value
Type Description
System.Char
| Improve this Doc View Source

QUESTION_MARK

The question mark is another special character that is frequently used as an operator; use this to differentiate such use from that of an operand.

Declaration
public const char QUESTION_MARK = '?'
Field Value
Type Description
System.Char
| Improve this Doc View Source

SEMICOLON

Use this when your code requires a semicolon literal, when you want the listing to be crystal clear about what it is.

Declaration
public const char SEMICOLON = ';'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

SINGLE_QUOTE

Use this when your code requires a single quotation mark literal, when you want the listing to be crystal clear about what it is.

Declaration
public const char SINGLE_QUOTE = '\''
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

SPACE_CHAR

Use this when your code requires a single space when you want the listing to be crystal clear about what it is.

Declaration
public const char SPACE_CHAR = ' '
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

TAB_CHAR

Use this when your code requires a tab literal, when you want the listing to be crystal clear about what it is.

Declaration
public const char TAB_CHAR = '\t'
Field Value
Type Description
System.Char
See Also
| Improve this Doc View Source

UNDERSCORE_CHAR

Underscores can be really hard to see in code, both on paper and on screen.

Declaration
public const char UNDERSCORE_CHAR = '_'
Field Value
Type Description
System.Char
See Also

See Also