CustomTextGenerator Class

Text generator using placeholders for generating text.

Inheritance Hierarchy

Namespace: RAYLASE.Marker.Common.TextGenerator
Assembly: RAYLASE.Marker.Common (in RAYLASE.Marker.Common.dll) Version: 2.32.0

Syntax

public class CustomTextGenerator : BaseIncrementalTextGenerator

The CustomTextGenerator type exposes the following members.

Constructors

	Name	Description
	CustomTextGenerator	Initializes a new instance of the CustomTextGenerator class

Properties

	Name	Description
	Batch	Result will incremented after batch times iterations. (Inherited from BaseIncrementalTextGenerator)
	CurrentIteration	Current iteration. (Inherited from BaseIncrementalTextGenerator)
	Increment	Increments result by value each iteration. (Inherited from BaseIncrementalTextGenerator)
	LastSimulationID	(Inherited from BaseIncrementalTextGenerator)
	LastValue	(Inherited from BaseIncrementalTextGenerator)
	LogPath	Logs the executed string, if not null. (Inherited from BaseTextGenerator)
	MinDigits	Minumum number of digits. Prepends 0 to reach the minimum length. (Overrides BaseIncrementalTextGeneratorMinDigits)
	ResetCounterDelegate	(Inherited from BaseIncrementalTextGenerator)
	ResetType	(Inherited from BaseIncrementalTextGenerator)
	Start	Start value. Setting a new value will reset CurrentIteration. (Inherited from BaseIncrementalTextGenerator)
	Text	String containing the placeholders for generation the text. See CustomTextGenerator for detailed information.
	Time
	Type	Type of the text generator. (Overrides BaseTextGeneratorType)
	UserRuleGenerator

Methods

	Name	Description
	DoGetNextValue	(Inherited from BaseIncrementalTextGenerator)
	GetCurrentIndex	Returns the current index. (Inherited from BaseIncrementalTextGenerator)
	GetFormatString	(Inherited from BaseIncrementalTextGenerator)
	GetNextValue	Returns the generated text. (Inherited from BaseTextGenerator)
	ResetCounter	(Inherited from BaseIncrementalTextGenerator)
	UpdateNextValue	(Overrides BaseIncrementalTextGeneratorUpdateNextValue(Boolean, Boolean, NullableGuid, Boolean))

Remarks

Text contains placeholders, prepended by %, defining the result. Valid placeholder are:

A	Day of week abbr
B	Month abbr
C	Date and time
c	Date
D	Day of month
K	Month code
L	Year last digit
M	Month
N	Minutes
F	Seconds
O	Incremental number
P	AM PM
R	Week starting 01.01
r	Week starting first thursday
T	Time HH:MM
t	Time HH:MM:SS
W	Day of week 1 = Sunday
w	Day of week 1 = Monday
Y	Year two digits
(my_variable_name)	The value stored in variable "my_variable_name"

E.g: "Today is %A, the %D.%M." results in: "Today is Tue, the 09.10." Non valid control characters are ignored, escape character is \.