Word.Interfaces.SelectionUpdateData interface
An interface for updating data on the Selection
object, for use in selection.set({ ... })
.
Properties
end | Specifies the ending character position of the selection. |
fit |
Specifies the width in which Word fits the text in the current selection. |
is |
Specifies whether column selection mode is active. |
is |
Specifies whether Extend mode is active. |
is |
Specifies whether the beginning of the selection is active. |
language |
Specifies whether Word has detected the language of the selected text. |
orientation | Specifies the orientation of text in the selection. |
start | Specifies the starting character position of the selection. |
text | Specifies the text in the selection. |
Property Details
end
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.
Specifies the ending character position of the selection.
end?: number;
Property Value
number
Remarks
fitTextWidth
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.
Specifies the width in which Word fits the text in the current selection.
fitTextWidth?: number;
Property Value
number
Remarks
isColumnSelectModeActive
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.
Specifies whether column selection mode is active.
isColumnSelectModeActive?: boolean;
Property Value
boolean
Remarks
isExtendModeActive
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.
Specifies whether Extend mode is active.
isExtendModeActive?: boolean;
Property Value
boolean
Remarks
isStartActive
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.
Specifies whether the beginning of the selection is active.
isStartActive?: boolean;
Property Value
boolean
Remarks
languageDetected
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.
Specifies whether Word has detected the language of the selected text.
languageDetected?: boolean;
Property Value
boolean
Remarks
orientation
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.
Specifies the orientation of text in the selection.
orientation?: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical";
Property Value
Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"
Remarks
start
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.
Specifies the starting character position of the selection.
start?: number;
Property Value
number
Remarks
text
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.
Specifies the text in the selection.
text?: string;
Property Value
string