Crosstales.BWF.Filter.CapitalizationFilter Class Reference

Filter for excessive capitalization. The class can also replace all capitalizations inside a string. More...

Inheritance diagram for Crosstales.BWF.Filter.CapitalizationFilter:

Public Member Functions
	CapitalizationFilter (int capitalizationCharsNumber=3, bool disableOrdering=false)
	Instantiate the class. More...
override bool	Contains (string text, params string[] sourceNames)
	Searches for bad words in a text. More...
override System.Collections.Generic.List< string >	GetAll (string text, params string[] sourceNames)
	Searches for bad words in a text. More...
override string	ReplaceAll (string text, bool markOnly=false, string prefix="", string postfix="", params string[] sourceNames)
	Searches and replaces all bad words in a text. More...
Public Member Functions inherited from Crosstales.BWF.Filter.BaseFilter
	BaseFilter (bool disableOrdering)
	Instantiate the class. More...
virtual string	Unmark (string text, string prefix="<b><color=red>", string postfix="</color></b>")
	Unmarks the text with a prefix and postfix. More...
virtual string	Mark (string text, bool replace=false, string prefix="<b><color=red>", string postfix="</color></b>", params string[] sourceNames)
	Marks the text with a prefix and postfix. More...

Public Attributes
override bool	isReady => true
	Checks the readiness status of the filter. More...
Public Attributes inherited from Crosstales.BWF.Filter.BaseFilter
bool	DisableOrdering

Properties
System.Text.RegularExpressions.Regex	RegularExpression [get]
	RegEx to find excessive capitalization. More...
int?	CharacterNumber [get, set]
	Defines the number of allowed capital letters in a row. More...
Properties inherited from Crosstales.BWF.Filter.BaseFilter
virtual System.Collections.Generic.List< Source >	Sources [get]
abstract bool	isReady [get]
Properties inherited from Crosstales.BWF.Filter.IFilter
System.Collections.Generic.List< Crosstales.BWF.Data.Source >	Sources [get]
	All sources of the current filter. More...
bool	isReady [get]
	Checks the readiness status of the current filter. More...

Additional Inherited Members
Static Protected Member Functions inherited from Crosstales.BWF.Filter.BaseFilter
static void	logFilterNotReady ()
static void	logResourceNotFound (string res)
static void	logContains ()
static void	logGetAll ()
static void	logReplaceAll ()
Protected Attributes inherited from Crosstales.BWF.Filter.BaseFilter
readonly System.Collections.Generic.Dictionary< string, Source >	_sources = new System.Collections.Generic.Dictionary<string, Source>()
readonly System.Collections.Generic.List< string >	_getAllResult = new System.Collections.Generic.List<string>()

Detailed Description

Filter for excessive capitalization. The class can also replace all capitalizations inside a string.

Constructor & Destructor Documentation

CapitalizationFilter()

Crosstales.BWF.Filter.CapitalizationFilter.CapitalizationFilter	(	int	capitalizationCharsNumber = 3,
		bool	disableOrdering = false
	)

Instantiate the class.

Parameters

capitalizationCharsNumber	Defines the number of allowed capital letters in a row (default: 3, optional).
disableOrdering	Disables the ordering of the 'GetAll'-method (default: false, optional).

Member Function Documentation

Contains()

override bool Crosstales.BWF.Filter.CapitalizationFilter.Contains ( string  text, params string[]  sourceNames  )

virtual

Searches for bad words in a text.

Parameters

text	Text to check
sourceNames	Relevant sources (e.g. "english", optional)

Returns

True if a match was found

Implements Crosstales.BWF.Filter.BaseFilter.

GetAll()

override System.Collections.Generic.List<string> Crosstales.BWF.Filter.CapitalizationFilter.GetAll ( string  text, params string[]  sourceNames  )

virtual

Searches for bad words in a text.

Parameters

text	Text to check
sourceNames	Relevant sources (e.g. "english", optional)

Returns

List with all the matches

Implements Crosstales.BWF.Filter.BaseFilter.

ReplaceAll()

override string Crosstales.BWF.Filter.CapitalizationFilter.ReplaceAll ( string  text, bool  markOnly = false, string  prefix = "", string  postfix = "", params string[]  sourceNames  )

virtual

Searches and replaces all bad words in a text.

Parameters

text	Text to check
markOnly	Only mark the words (default: false, optional)
prefix	Prefix for every found bad word (optional)
postfix	Postfix for every found bad word (optional)
sourceNames	Relevant sources (e.g. "english", optional)

Returns

Clean text

Implements Crosstales.BWF.Filter.BaseFilter.

Member Data Documentation

isReady

override bool Crosstales.BWF.Filter.CapitalizationFilter.isReady => true

Checks the readiness status of the filter.

Returns

True if the filter is ready.

Property Documentation

CharacterNumber

int? Crosstales.BWF.Filter.CapitalizationFilter.CharacterNumber

getset

Defines the number of allowed capital letters in a row.

RegularExpression

System.Text.RegularExpressions.Regex Crosstales.BWF.Filter.CapitalizationFilter.RegularExpression

get

RegEx to find excessive capitalization.

---

The documentation for this class was generated from the following file:

• C:/Users/slaub/Unity/assets/BWFPro/BWFPro/Assets/Plugins/crosstales/BadWordFilter/Scripts/Filter/CapitalizationFilter.cs