TextPointer.DeleteTextInRun(Int32) Method

Reference

Definition

Namespace:: System.Windows.Documents

Assembly:: PresentationFramework.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Deletes the specified number of characters from the position indicated by the current TextPointer.

public:
 int DeleteTextInRun(int count);

public int DeleteTextInRun (int count);

member this.DeleteTextInRun : int -> int

Public Function DeleteTextInRun (count As Integer) As Integer

Parameters

count: Int32

The number of characters to delete, starting at the current position. Specify a positive value to delete characters that follow the current position; specify a negative value to delete characters that precede the current position.

Returns

Int32

The number of characters actually deleted.

Exceptions

InvalidOperationException

The method is called at a position where text is not allowed.

Remarks

Specify a positive value to delete characters that follow the current position (as in LogicalDirection.Forward); specify a negative value to delete characters that precede the current position (as in LogicalDirection.Backward).

The number of characters actually deleted may be less than the number specified by count. This happens in cases where count specifies more characters than exist to be deleted.

Applies to