CharClass Class

public class CharClass : ICollection<CharInterval>, IEnumerable<CharInterval>, IEnumerable

public CharClass()

public CharClass(CharClass charClass)

Parameter	Type	Description
charClass	CharClass	The CharClass whose items should be added.

public CharClass(CharInterval[] intervals)

Parameter	Type	Description
intervals	CharInterval[]	The array of CharInterval objects that should be added.

public CharClass(char ch)

Parameter	Type	Description
ch	Char	A character to add to the character class.

public CharClass(char ch, bool isNegated)

Parameter	Type	Description
ch	Char	A character to add to the character class.
isNegated	Boolean	Whether to negate the character class after adding the initial character.

public CharClass(char start, char end)

Parameter	Type	Description
start	Char	The start character in the interval.
end	Char	The end character in the interval.

public CharClass(char start, char end, bool isNegated)

Parameter	Type	Description
start	Char	The start character in the interval.
end	Char	The end character in the interval.
isNegated	Boolean	Whether to negate the character class after adding the initial character range.

public CharClass(string characters)

Parameter	Type	Description
characters	String	The string of characters to add to the character class.

public static CharClass All { get; }

Property Value

CharClass:

A CharClass that contains all Unicode characters.

Remarks

This character class is the equivalent of [\u0000-\uFFFF].

public static CharClass Alpha { get; }

Property Value

CharClass:

A CharClass that contains all alphabetic characters.

Remarks

This character class is the equivalent of \p{L} (all letters).

public int CharacterCount { get; }

Property Value

Int32:

The number of characters contained in the CharClass intervals, excluding any Unicode general categories specified.

public int Count { get; }

Property Value

Int32:

The number of elements contained in the CharClass instance.

public static CharClass Digit { get; }

Property Value

CharClass:

A CharClass that contains all Unicode decimal digits.

Remarks

This character class is the equivalent of \d and \p{Nd}.

public bool HasCategorySpecification { get; }

Property Value

Boolean:

true if there is at least one Unicode generate category specification in the character class; otherwise, false.

Remarks

Use the GetCategorySpecification(UnicodeCategory) method to test whether a specific UnicodeCategory is specified, and whether it is positive or negative.

public static CharClass HexDigit { get; }

Property Value

CharClass:

A CharClass that contains all Unicode hexidecimal digits.

Remarks

This character class is the equivalent of [0-9a-fA-F].

public bool IsNegated { get; set; }

Property Value

Boolean:

true if the character class is negated; otherwise, false.

Remarks

The negation is the opposite of the character class, specified by a ^ character after the open square brace. When negated, the return value of Contains(Char) is toggled.

public bool IsReadOnly { get; }

Property Value

Boolean:

true if the colletion is read-only; otherwise, false.

public bool IsSingleCharacter { get; }

Property Value

Boolean:

true if the character class only contains an interval for a single character; otherwise, false.

public CharInterval this[int index] { get; }

Parameter	Type	Description
index	Int32	The index of the interval to return.

Property Value

CharInterval:

The CharInterval at the specified index.

public static CharClass LineTerminator { get; }

Property Value

CharClass:

A CharClass that contains all Unicode line terminators.

Remarks

This character class is the equivalent of [\n\r\p{Zl}\p{Zp}].

public static CharClass LineTerminatorWhitespace { get; }

Property Value

CharClass:

A CharClass that contains all Unicode line terminators and whitespace characters.

Remarks

This character class is the equivalent of \s or [\f\n\r\t\v\x85\p{Z}].

public static CharClass NonAlpha { get; }

Property Value

CharClass:

A CharClass that contains no alphabetic digits.

Remarks

This character class is the equivalent of \P{L} (no letters).

public static CharClass NonDigit { get; }

Property Value

CharClass:

A CharClass that contains no Unicode decimal digits.

Remarks

This character class is the equivalent of \D.

public static CharClass None { get; }

Property Value

CharClass:

A CharClass that contains no characters.

public static CharClass NonHexDigit { get; }

Property Value

CharClass:

A CharClass that contains no Unicode hexidecimal digits.

public static CharClass NonLineTerminator { get; }

Property Value

CharClass:

A CharClass that contains no Unicode line terminators.

Remarks

This character class is the equivalent of [^\n\r\p{Zl}\p{Zp}].

public static CharClass NonLineTerminatorWhitespace { get; }

Property Value

CharClass:

A CharClass that contains no Unicode line terminators or whitespace characters.

Remarks

This character class is the equivalent of \S or [^\f\n\r\t\v\x85\p{Z}].

public static CharClass NonWhitespace { get; }

Property Value

CharClass:

A CharClass that contains no Unicode whitespace characters.

Remarks

This character class is the equivalent of [^\f\t\v\x85\p{Zs}].

public static CharClass NonWord { get; }

Property Value

CharClass:

A CharClass that contains no word characters.

Remarks

This character class is the equivalent of \W and [^\p{L}\p{Nd}\p{Pc}] (no letters, decimal digits, and connectors like underscore).

public static CharClass Whitespace { get; }

Property Value

CharClass:

A CharClass that contains all Unicode whitespace characters.

Remarks

This character class is the equivalent of [\f\t\v\x85\p{Zs}].

public static CharClass Word { get; }

Property Value

CharClass:

A CharClass that contains all word characters.

Remarks

This character class is the equivalent of \w and [\p{L}\p{Nd}\p{Pc}] (all letters, decimal digits, and connectors like underscore).

public void Add(CharInterval interval)

Parameter	Type	Description
interval	CharInterval	The interval of characters to add.

public void Add(char ch)

Parameter	Type	Description
ch	Char	The character to add.

public void Add(char start, char end)

Parameter	Type	Description
start	Char	The start character in the interval.
end	Char	The end character in the interval.

public void AddCategory(UnicodeCategory category, bool negate)

Parameter	Type	Description
category	UnicodeCategory	A UnicodeCategory indicating the category.
negate	Boolean	Whether to negate the category.

public void AddCategory(string categoryName, bool negate)

Parameter	Type	Description
categoryName	String	The name of the category. For example, Lu is used for uppercase letters.
negate	Boolean	Whether to negate the category.

public void AddRange(CharClass charClass)

Parameter	Type	Description
charClass	CharClass	The CharClass whose values are to be added.

public void AddRange(CharInterval[] intervals)

Parameter	Type	Description
intervals	CharInterval[]	The CharInterval array whose values are to be added.

public void Clear()

public bool Contains(CharClass charClass)

Parameter	Type	Description
charClass	CharClass	The CharClass to look for in the collection.

Returns

Boolean:

true if the character class is in the collection; otherwise, false.

public bool Contains(CharInterval interval)

Parameter	Type	Description
interval	CharInterval	The CharInterval to look for in the collection.

Returns

Boolean:

true if the interval is in the collection; otherwise, false.

public bool Contains(char ch)

Parameter	Type	Description
ch	Char	The character to look for in the collection.

Returns

Boolean:

true if the character is in the collection; otherwise, false.

public bool Contains(char start, char end)

Parameter	Type	Description
start	Char	The start character in the interval.
end	Char	The end character in the interval.

Returns

Boolean:

true if the interval of characters is in the collection; otherwise, false.

public void CopyTo(CharInterval[] array, int arrayIndex)

Parameter	Type	Description
array	CharInterval[]	The one-dimensional CharInterval array that is the destination of the elements copied from the collection. The array must have zero-based indexing.
arrayIndex	Int32	The zero-based index in array at which copying begins.

public override bool Equals(object obj)

Parameter	Type	Description
obj	Object	The Object to compare to the current Object.

Returns

Boolean:

true if the specified Object is equal to the current Object; otherwise, false.

public bool? GetCategorySpecification(UnicodeCategory category)

Parameter	Type	Description
category	UnicodeCategory	A UnicodeCategory indicating the category.

Returns

Nullable<Boolean>:

true if the category is specified as a positive match. false if the category is specified as a negative match. null if the category is not specified.

public IEnumerator<CharInterval> GetEnumerator()

Returns

IEnumerator<CharInterval>:

An IEnumerator object for the entire collection

Remarks

Enumerators are intended to be used only to read data in the collection. Enumerators cannot be used to modify the underlying collection.

The enumerator does not have exclusive access to the collection.

When an enumerator is instantiated, it takes a snapshot of the current state of the collection. If changes are made to the collection, such as adding, modifying or deleting elements, the snapshot gets out of sync and the enumerator throws an InvalidOperationException. Two enumerators instantiated from the same collection at the same time can have different snapshots of the collection.

public override int GetHashCode()

Returns

Int32:

An integer value that specifies a hash value for this object.

public bool Remove(CharInterval interval)

Parameter	Type	Description
interval	CharInterval	The character interval to remove.

Returns

Boolean:

true if the character interval was removed; otherwise, false.

public bool Remove(char ch)

Parameter	Type	Description
ch	Char	The character to remove.

Returns

Boolean:

true if the character was removed; otherwise, false.

public void RemoveCategory(UnicodeCategory category)

Parameter	Type	Description
category	UnicodeCategory	A UnicodeCategory indicating the category.

public void RemoveCategory(string categoryName)

Parameter	Type	Description
categoryName	String	The name of the category. For example, Lu is used for uppercase letters.

public override string ToString()

Returns

String:

A string whose value represents this object.