In This Article

LiteralPart Class

Represents a literal text part.

public class LiteralPart : PartBase<string>, ILiteralPart, IPart
Inheritance:
object PartBase<string> object
Implements:
ILiteralPart IPart

Constructors

LiteralPart()

Initializes an instance of the class with empty text.

public LiteralPart()

LiteralPart(string)

Initializes an instance of the class with the specified text.

public LiteralPart(string text)
Parameter Type Description
text string

The literal text.

Properties

IsDelimiter

Indicates whether the part is a delimiter literal, paired with another optional part.

public virtual bool IsDelimiter { get; }

Property Value

bool:

true if the part is a delimiter literal; otherwise, false.

IsEditable

Indicates whether the part is editable.

public override bool IsEditable { get; }

Property Value

bool:

true if the part is editable; otherwise, false.

IsLiteral

Indicates whether the part is a literal.

[Obsolete("Instead of the IsLiteral property, test if an object implements the ILiteralPart interface.")]
public override bool IsLiteral { get; }

Property Value

bool:

true if the part is a literal; otherwise, false.

IsOptional

Indicates whether this part is optional.

public override bool IsOptional { get; }

Property Value

bool:

true if this part is optional; otherwise, false.

Text

The literal text.

public string Text { get; set; }

Property Value

string

Methods

IsTextInputAllowed(string, int, CultureInfo)

Indicates whether the input text is allowed.

public override bool IsTextInputAllowed(string text, int offset, CultureInfo culture)
Parameter Type Description
text string

The text to examine.

offset int

The absolute offset at which the text would be input if allowed, which can be compared to StartOffset to determine the relative offset within the part.

culture CultureInfo

The CultureInfo to use.

Returns

bool:

true if the text input is allowed; otherwise, false.

Remarks

This method is only called when the corresponding edit box has enabled input filtering.

See Also

ToString()

Returns the string representation of this object.

public override string ToString()

Returns

string:

The string representation of this object.

TryParseText(IList<IPart>, string, int, CultureInfo, out int)

Tries to parse the text starting offset and returns the offset through which parsing was completed.

public override bool TryParseText(IList<IPart> parts, string text, int startOffset, CultureInfo culture, out int offset)
Parameter Type Description
parts IList<IPart>

The part collection in which this part is a member.

text string

The text to examine.

startOffset int

The start offset.

culture CultureInfo

The CultureInfo to use.

offset int

Returns the offset through which parsing was completed.

Returns

bool:

true if parsing was successful; otherwise, false.

Inherited Members

Extension Methods