Method Preceding
Preceding(Int32)
Returns the last boundary preceding the specified character offset. If the specified offset equals to the first text boundary, it returns DONE and the iterator's current position is unchanged. Otherwise, the iterator's current position is set to the returned boundary. The value returned is always less than the offset or the value DONE.
Declaration
public abstract int Preceding(int offset)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | offset | the character offset to begin scanning. |
Returns
Type | Description |
---|---|
System.Int32 | The last boundary before the specified offset or DONE if the first text boundary is passed in as the offset. |