FarPoint.Win.SuperEdit.IManageFmtInput
IManageFmtInput Interface
Interface that provides a way to determine if the specified user input action is valid for a format and supplies the results of the action.
Namespace: FarPoint.Win.SuperEdit
Assembly: FarPoint.Win.dll
Syntax
public interface IManageFmtInputPublic Interface IManageFmtInputProperties
| Name | Description |
|---|---|
| InitialValue | Gets or sets the initial value if the string is null. (Optional. To clear, set to null.) |
| MaximumValue | Gets or sets the maximum value allowed. (Optional. To clear, set to null.) |
| MinimumValue | Gets or sets the minimum value allowed. (Optional. To clear, set to null.) |
Methods
| Name | Description |
|---|---|
| ChangeText(string, int, int, string, out string, out int, bool) | Returns the resulting text and position if the change is allowed for the given conditions. If no changes are made (due to invalid input), returns false. |
| ChangeText(string, out string) | Returns the resulting text if the change is allowed for the given conditions. If no changes are made (due to invalid input), false is returned. |
| CharInput(int, char, string, int, int, out string, out int, bool) | Returns the resulting text and position if the input character is allowed under given conditions. If not allowed, returns false. |
| GetCaretTypeAtPos(string, int) | Returns one of the following values for the position in the given text: InputPosType.InsertPos, .FixedFldPos, or .LiteralPos |
| GetFormatStringAtPos(string, int) | Returns the format string for the field at the specified position in the given text. |
| GetInitialInputPos(string) | Returns the initial input position for the given text. This initial position may not be the first input position. |
| GetInitialText() | Returns the initial text for a format. |
| GetLastPosInputIsAllowed(string) | Returns the last position that can receive input for the given text. |
| GetNextInputPos(string, int, int) | Returns the next input position dependent on the direction, the current text, and the current position. A value of -1 for direction means the previous direction. |
| IncrementValue(string, int, object, bool, object, out string, out int) | Increments or decrements (dependent on sign of "incrAmt") the value represented by the text. |
| IsInputAllowedAtPos(string, int) | Returns whether the input is allowed at the specified position (index) for the given text. |
| IsNegative(string) | Returns whether a string is negative according to the regional settings. |