Edit

Share via

Word.SelectionMoveUpDownOptions interface

Package:
word

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the options for the Selection.moveUp and Selection.moveDown methods.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Properties

count

If provided, specifies the number of units the selection is to be moved. The default value is 1.
extend

If provided, specifies the type of movement. The movement direction (up or down) is according to the calling method. If set to move, the selection is collapsed to the endpoint and moved in the appropriate direction. If set to extend, the selection is extended in the appropriate direction. The default value is move.
unit

If provided, specifies the unit by which to move the selection. The default value is line.

Property Details

count

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the number of units the selection is to be moved. The default value is 1.

count?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

extend

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the type of movement. The movement direction (up or down) is according to the calling method. If set to move, the selection is collapsed to the endpoint and moved in the appropriate direction. If set to extend, the selection is extended in the appropriate direction. The default value is move.

extend?: Word.MovementType | "Move" | "Extend";

Property Value

Word.MovementType | "Move" | "Extend"

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

unit

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the unit by which to move the selection. The default value is line.

unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item";

Property Value

Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]