In This Article

IPart Interface

Provides the base requirements for a part within a part-based edit box.

public interface IPart

Properties

IsEditable

Indicates whether the part is editable.

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.")]
bool IsLiteral { get; }

Property Value

bool:

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

IsOptional

Indicates whether this part is optional.

bool IsOptional { get; }

Property Value

bool:

true if this part is optional; otherwise, false.

Length

The character length of the part within the text.

int Length { get; set; }

Property Value

int

StartOffset

The start offset of the part within the text.

int StartOffset { get; set; }

Property Value

int

StringValue

The current string value of the part, if known.

string? StringValue { get; set; }

Property Value

string

Methods

IsTextInputAllowed(string, int, CultureInfo)

Indicates whether the input text is allowed.

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

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

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

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.

Extension Methods