Word.Interfaces.SelectionLoadOptions interface
Represents a selected range or the insertion point in a Word document.
Remarks
[ API set: WordApiDesktop 1.4 ]
Note: Range objects share many of the same methods and properties as Selection objects. Using Range objects is preferable for manipulating a document when there isn't a reason to physically change the current selection.
Properties
| $all | Specifying |
| end | Specifies the ending character position of the selection. |
| fit |
Specifies the width in which Word fits the text in the current selection. |
| font | Returns the |
| formatted |
Specifies a |
| has |
Returns whether the spelling and grammar checker ignores the selected text. If the selected text contains a mix of proofed and un-proofed content, this API returns |
| is |
Returns whether the selection in the specified window or pane is active. |
| is |
Specifies whether column selection mode is active. |
| is |
Returns whether the selection is at the end-of-row mark in a table. |
| is |
Specifies whether Extend mode is active. |
| is |
Returns whether the insertion point is at the end of a line. |
| is |
Specifies whether the beginning of the selection is active. |
| language |
Specifies whether Word has detected the language of the selected text. |
| language |
Returns the language for the selection. |
| language |
Returns the East Asian language for the selection. |
| language |
Returns the language for the selection that isn't classified as an East Asian language. |
| orientation | Specifies the orientation of text in the selection. |
| range | Returns the |
| shading | Returns the |
| start | Specifies the starting character position of the selection. |
| story |
Returns the number of characters in the story that contains the selection. |
| story |
Returns the story type for the selection. |
| text | Specifies the text in the selection. |
| type | Returns the selection type. |
Property Details
$all
Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
$all?: boolean;Property Value
boolean
end
Specifies the ending character position of the selection.
end?: boolean;Property Value
boolean
Remarks
fitTextWidth
Specifies the width in which Word fits the text in the current selection.
fitTextWidth?: boolean;Property Value
boolean
Remarks
font
Returns the Font object that represents the character formatting of the selection.
font?: Word.Interfaces.FontLoadOptions;Property Value
Remarks
formattedText
Specifies a Range object that includes the formatted text in the range or selection.
formattedText?: Word.Interfaces.RangeLoadOptions;Property Value
Remarks
hasNoProofing
Returns whether the spelling and grammar checker ignores the selected text. If the selected text contains a mix of proofed and un-proofed content, this API returns null.
hasNoProofing?: boolean;Property Value
boolean
Remarks
isActive
Returns whether the selection in the specified window or pane is active.
isActive?: boolean;Property Value
boolean
Remarks
isColumnSelectModeActive
Specifies whether column selection mode is active.
isColumnSelectModeActive?: boolean;Property Value
boolean
Remarks
isEndOfRowMark
Returns whether the selection is at the end-of-row mark in a table.
isEndOfRowMark?: boolean;Property Value
boolean
Remarks
isExtendModeActive
Specifies whether Extend mode is active.
isExtendModeActive?: boolean;Property Value
boolean
Remarks
isInsertionPointAtEndOfLine
Returns whether the insertion point is at the end of a line.
isInsertionPointAtEndOfLine?: boolean;Property Value
boolean
Remarks
isStartActive
Specifies whether the beginning of the selection is active.
isStartActive?: boolean;Property Value
boolean
Remarks
languageDetected
Specifies whether Word has detected the language of the selected text.
languageDetected?: boolean;Property Value
boolean
Remarks
languageId
Returns the language for the selection.
languageId?: boolean;Property Value
boolean
Remarks
languageIdFarEast
Returns the East Asian language for the selection.
languageIdFarEast?: boolean;Property Value
boolean
Remarks
languageIdOther
Returns the language for the selection that isn't classified as an East Asian language.
languageIdOther?: boolean;Property Value
boolean
Remarks
orientation
Specifies the orientation of text in the selection.
orientation?: boolean;Property Value
boolean
Remarks
range
Returns the Range object for the portion of the document contained in the selection.
range?: Word.Interfaces.RangeLoadOptions;Property Value
Remarks
shading
Returns the ShadingUniversal object for the shading formatting for the selection.
shading?: Word.Interfaces.ShadingUniversalLoadOptions;Property Value
Remarks
start
Specifies the starting character position of the selection.
start?: boolean;Property Value
boolean
Remarks
storyLength
Returns the number of characters in the story that contains the selection.
storyLength?: boolean;Property Value
boolean
Remarks
storyType
Returns the story type for the selection.
storyType?: boolean;Property Value
boolean
Remarks
text
Specifies the text in the selection.
text?: boolean;Property Value
boolean
Remarks
type
Returns the selection type.
type?: boolean;Property Value
boolean