EndKey Method

Applies To

Selection object.

Description

Moves or extends the selection to the end of the specified unit. This method returns an integer that indicates the number of characters the selection or active end was actually moved, or it returns 0 (zero) if the move was unsuccessful.

Note This method corresponds to functionality of the END key.

Syntax

expression.EndKey(Unit, Extend)

expression Required. An expression that returns a Selection object.

Unit Optional Variant. The unit by which the selection is to be moved or extended. Can be one of the following WdUnits constants: wdStory, wdColumn, wdLine, or wdRow. The default value is wdLine.

Extend Optional Variant. Specifies the way the selection is moved. Can be one of the following WdMovementType constants: wdMove or wdExtend. If the value of this argument is wdMove, the selection is collapsed to an insertion point and moved to the end of the specified unit. If it's wdExtend, the end of the selection is extended to the end of the specified unit. The default value is wdMove.

See Also

HomeKey method, IPAtEndOfLine property, MoveEnd method.

Example

This example moves the selection to the end of the current line and assigns the number of characters moved to the pos variable.

pos = Selection.EndKey(Unit:=wdLine, Extend:=wdMove)

This example moves the selection to the beginning of the current table column and then extends the selection to the end of the column.

If Selection.Information(wdWithInTable) = True Then
    Selection.HomeKey Unit:=wdColumn, Extend:=wdMove
    Selection.EndKey Unit:=wdColumn, Extend:=wdExtend
End If

This example moves the selection to the end of the current story. If the selection is in the main text story, the example moves the selection to the end of the document.

Selection.EndKey Unit:=wdStory, Extend:=wdMove