Selection Interface
Definition
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.
Represents the current selection in a window or pane.
public interface class Selection[System.Runtime.InteropServices.Guid("00020975-0000-0000-C000-000000000046")]
public interface Selectiontype Selection = interfacePublic Interface Selection- Attributes
Remarks
A selection represents either a selected (or highlighted) area in the document, or it represents the insertion point if nothing in the document is selected. There can only be one Selection object per document window pane, and only one Selection object in the entire application can be active.
Use the Selection property to return the Selection object. If no object qualifier is used with the Selection property, Microsoft Word returns the selection from the active pane of the active document window.
The document doesn't have to be active to access its current selection.
Use the Text property to set or return the text in the current selection.
The Selection object has various methods and properties with which you can:
Use properties like Flags, Information[WdInformation], and Type to return information about the current selection.
Even when a selection is collapsed to an insertion point, it isn't necessarily empty. For example, the Text property will still return the character to the right of the insertion point; this character also appears in the Characters collection of the Selection object. However, calling methods like Cut() or Copy() from a collapsed selection will cause an error.
It's possible for the user to select a region in a document that doesn't represent contiguous text (for example, when using the ALT key with the mouse). Because the behavior of such a selection can be unpredictable, you may want to include a step in your code that checks the Type property of a selection before performing any operations on it. Similarly, selections that include table cells can also lead to unpredictable behavior. The Information[WdInformation] property will tell you if a selection is inside a table.
Because 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
| Active |
Determines if the selection in the specified window or pane is active. |
| Application |
Returns a _Application object that represents the Microsoft Word application. |
| BookmarkID |
Returns the number of the bookmark that encloses the beginning of the specified selection or 0 (zero) if there's no corresponding bookmark. |
| Bookmarks |
Returns a Bookmarks collection that represents all the bookmarks in a selection. |
| Borders |
Returns a Borders collection that represents all the borders for the specified object. |
| Cells |
Returns a Cells collection that represents the table cells in a selection. |
| Characters |
Returns a Characters collection that represents the characters in a selection. |
| ChildShapeRange |
Returns a ShapeRange object representing the child shapes of a selection. |
| Columns |
Returns a Columns collection that represents all the table columns in the selection. |
| ColumnSelectMode |
Determines if column selection mode is active. |
| Comments |
Returns a Comments collection that represents all the comments in the specified selection. |
| ContentControls |
Returns a ContentControls collection that represents the content controls contained within a range. Read-only. |
| Creator |
Returns a 32-bit integer that indicates the application in which the specified object was created. |
| Document |
Returns a Document object associated with the specified selection. |
| Editors |
Returns a Editors object that represents all the users authorized to modify a selection within a document. |
| End |
Returns or sets the ending character position of a selection. |
| EndnoteOptions |
Returns a EndnoteOptions object that represents the endnotes in a selection. |
| Endnotes |
Returns a Endnotes collection that represents all the endnotes in a selection. |
| EnhMetaFileBits |
Returns an Object that represents a picture representation of how a selection of text appears. |
| ExtendMode |
Determines if Extend mode is active. |
| Fields |
Returns a read-only Fields collection that represents all the fields in the selection. |
| Find |
Returns a Find object that contains the criteria for a find operation. |
| FitTextWidth |
Returns or sets the width (in the current measurement units) in which Microsoft Word fits the text in the current selection. |
| Flags |
Returns or sets properties of the selection. |
| Font |
Returns or sets a Font object that represents the character formatting of the specified object. |
| FootnoteOptions |
Returns a FootnoteOptions object that represents the footnote properties in a selection. |
| Footnotes |
Returns a Footnotes collection that represents all the footnotes in a selection. |
| FormattedText |
Returns or sets a Range object that includes the formatted text in the specified selection. |
| FormFields |
Returns a FormFields collection that represents all the form fields in the selection. |
| Frames |
Returns a Frames collection that represents all the frames in a selection. |
| HasChildShapeRange |
Determines if the selection contains child shapes. |
| HeaderFooter |
Returns a HeaderFooter object for the specified selection. |
| HTMLDivisions |
Returns a HTMLDivisions object that represents an HTML division in a Web document. |
| Hyperlinks |
Returns a Hyperlinks collection that represents all the hyperlinks in the specified selection. |
| Information[WdInformation] |
Returns information about the specified selection or range. |
| InlineShapes |
Returns a InlineShapes collection that represents all the InlineShape objects in a selection. |
| IPAtEndOfLine |
Determines if the insertion point is at the end of a line that wraps to the next line. |
| IsEndOfRowMark |
Determines if the specified selection is collapsed and is located at the end-of-row mark in a table. |
| LanguageDetected |
Returns or sets a value that specifies whether Microsoft Word has detected the language of the specified text. |
| LanguageID |
Returns or sets the language for the specified object. |
| LanguageIDFarEast |
Returns or sets an East Asian language for the specified object. |
| LanguageIDOther |
Returns or sets the language for the specified object. |
| NoProofing |
Determines if the spelling and grammar checker ignores the specified text. |
| OMaths |
Returns an OMaths collection that represents the OMath objects within the current selection. Read-only. |
| Orientation |
Returns or sets the orientation of text in a selection when the Text Direction feature is enabled. |
| PageSetup |
Returns a PageSetup object that's associated with the specified selection. |
| ParagraphFormat |
Returns or sets a ParagraphFormat object that represents the paragraph settings for the specified selection. |
| Paragraphs |
Returns a Paragraphs collection that represents all the paragraphs in the specified selection. |
| Parent |
Returns an object that represents the parent object of the specified object. |
| ParentContentControl |
Returns a ContentControl object that represents the parent content control for the specified range. Read-only. |
| PreviousBookmarkID |
Returns the number of the last bookmark that starts before or at the same place as the specified selection or returns 0 (zero) if there's no corresponding bookmark. |
| Range |
Returns a Range object that represents the portion of a document that's contained in the specified object. |
| Rows |
Returns a Rows collection that represents all the table rows in a selection. |
| Sections |
Returns a Sections collection that represents the sections in the specified selection. |
| Sentences |
Returns a Sentences collection that represents all the sentences in the selection. |
| Shading |
Returns a Shading object that refers to the shading formatting for the specified object. |
| ShapeRange |
Returns a ShapeRange collection that represents all the Shape objects in the specified range or selection. |
| SmartTags |
Returns a SmartTags object that represents a smart tag in a document. |
| Start |
Returns or sets the starting character position of a selection. |
| StartIsActive |
Determines if the beginning of the selection is active. |
| StoryLength |
Returns the number of characters in the story that contains the specified selection. |
| StoryType |
Returns the story type for the specified selection. |
| Style |
Returns or sets the style for the specified object. |
| Tables |
Returns a Tables collection that represents all the tables in the specified selection. |
| Text |
Returns or sets the text in the specified selection. |
| TopLevelTables |
Returns a Tables collection that represents the tables at the outermost nesting level in the current selection. |
| Type |
Returns the selection type. |
| WordOpenXML |
Returns a String that represents the XML contained within the selection in the Microsoft Office Word Open XML format. Read-only. |
| Words |
Returns a Words collection that represents all the words in a selection. |
| XML[Boolean] |
Returns a String that represents the XML text in the specified object. |
| XMLNodes |
This object, member, or enumeration is deprecated and is not intended to be used in your code. |
| XMLParentNode |
This object, member, or enumeration is deprecated and is not intended to be used in your code. |
Methods
| BoldRun() |
Adds the bold character format to or removes it from the current run. |
| Calculate() |
Calculates a mathematical expression within a selection. |
| ClearCharacterAllFormatting() |
Removes all character formatting (formatting applied either through character styles or manually applied formatting) from the selected text. |
| ClearCharacterDirectFormatting() |
Removes character formatting (formatting that has been applied manually using the buttons on the Ribbon or through the dialog boxes) from the selected text. |
| ClearCharacterStyle() |
Removes character formatting that has been applied through character styles from the selected text. |
| ClearFormatting() |
Removes text and paragraph formatting from a selection. |
| ClearParagraphAllFormatting() |
Removes all paragraph formatting (formatting applied either through paragraph styles or manually applied formatting) from the selected text. |
| ClearParagraphDirectFormatting() |
Removes paragraph formatting that has been applied manually (using the buttons on the Ribbon or through the dialog boxes) from the selected text. |
| ClearParagraphStyle() |
Removes paragraph formatting that has been applied through paragraph styles from the selected text. |
| Collapse(Object) |
Collapses a selection to the starting or ending position. |
| ConvertToTable(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object) |
Converts text within a selection to a table. |
| ConvertToTableOld(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object) |
Reserved for internal use. |
| Copy() |
Copies the specified object to the Clipboard. |
| CopyAsPicture() |
Copies the specified object to the Clipboard. |
| CopyFormat() |
Copies the character formatting of the first character in the selected text. |
| CreateAutoTextEntry(String, String) |
Adds a new AutoTextEntry object to the AutoTextEntries collection, based on the current selection. |
| CreateTextbox() |
Adds a default-size text box around the selection. |
| Cut() |
Removes the specified object from the document and places it on the Clipboard. |
| Delete(Object, Object) |
Deletes the specified number of characters or words. |
| DetectLanguage() |
Analyzes the specified text to determine the language that it is written in. |
| EndKey(Object, Object) |
Moves or extends the selection to the end of the specified unit. |
| EndOf(Object, Object) |
Moves or extends the ending character position of a selection to the end of the nearest specified text unit. |
| EscapeKey() |
Cancels a mode such as extend or column select (equivalent to pressing the ESC key). |
| Expand(Object) |
Expands the specified selection. |
| ExportAsFixedFormat(String, WdExportFormat, Boolean, WdExportOptimizeFor, Boolean, WdExportItem, Boolean, Boolean, WdExportCreateBookmarks, Boolean, Boolean, Boolean, Object) |
Saves the current selection as PDF or XPS format. . |
| Extend(Object) |
Turns extend mode on, or extends the selection to the next larger unit of text if Extend mode is already on. |
| GoTo(Object, Object, Object, Object) |
Moves the insertion point to the character position immediately preceding the specified item. |
| GoToEditableRange(Object) |
Returns a Range object that represents an area of a document that can be modified by the specified user or group of users. |
| GoToNext(WdGoToItem) |
Returns a Range object that refers to the start position of the next item or location specified by the |
| GoToPrevious(WdGoToItem) |
Returns a Range object that refers to the start position of the previous item or a specified location. |
| HomeKey(Object, Object) |
Moves or extends the selection to the beginning of the specified unit. |
| InRange(Range) |
Determines if the selection to which the method is applied is contained in a specified range. |
| InsertAfter(String) |
Inserts the specified text at the end of a selection. |
| InsertBefore(String) |
Inserts the specified text before the specified selection. |
| InsertBreak(Object) |
Inserts a page, column, or section break. |
| InsertCaption(Object, Object, Object, Object, Object) |
Inserts a caption immediately preceding or following the specified selection. |
| InsertCaptionXP(Object, Object, Object, Object) |
Reserved for internal use. |
| InsertCells(Object) |
Adds cells to an existing table. |
| InsertColumns() |
Inserts columns to the left of the column that contains the selection. |
| InsertColumnsRight() |
Inserts columns to the right of the current selection. |
| InsertCrossReference_2002(Object, WdReferenceKind, Object, Object, Object) |
Reserved for internal use. |
| InsertCrossReference(Object, WdReferenceKind, Object, Object, Object, Object, Object) |
Inserts a cross-reference to a heading, bookmark, footnote, or endnote, or to an item for which a caption label is defined (for example, an equation, figure, or table). |
| InsertDateTime(Object, Object, Object, Object, Object) |
Inserts the current date or time, or both, either as text or as a TIME field. |
| InsertDateTimeOld(Object, Object, Object) |
Reserved for internal use. |
| InsertFile(String, Object, Object, Object, Object) |
Inserts all or part of the specified file. |
| InsertFormula(Object, Object) |
Inserts an = (Formula) field that contains a formula at the selection. |
| InsertNewPage() |
Inserts a new page at the position of the Insertion Point. |
| InsertParagraph() |
Replaces the specified selection with a new paragraph. |
| InsertParagraphAfter() |
Inserts a paragraph mark after a selection. |
| InsertParagraphBefore() |
Inserts a new paragraph before the specified selection. |
| InsertRows(Object) |
Inserts the specified number of new rows above the row that contains the selection. |
| InsertRowsAbove(Object) |
Inserts rows above the current selection. |
| InsertRowsBelow(Object) |
Inserts rows below the current selection. |
| InsertStyleSeparator() |
Inserts a special hidden paragraph mark that allows Microsoft Word to join paragraphs formatted using different paragraph styles. |
| InsertSymbol(Int32, Object, Object, Object) |
Inserts a symbol in place of the specified selection. |
| InsertXML(String, Object) |
Inserts the specified XML text into the specified selection. |
| InStory(Range) |
Determines if the selection to which this method is applied is in the same story as the specified range. |
| IsEqual(Range) |
Determines if the selection to which this method is applied is equal to the range specified by the |
| ItalicRun() |
Adds the italic character format to or removes it from the current run. |
| LtrPara() |
Sets the reading order and alignment of the specified paragraphs to left-to-right. |
| LtrRun() |
Sets the reading order and alignment of the specified run to left-to-right. |
| Move(Object, Object) |
Collapses the specified selection to its start or end position and then moves the collapsed object by the specified number of units. |
| MoveDown(Object, Object, Object) |
Moves the selection down and returns the number of units it's been moved. |
| MoveEnd(Object, Object) |
Moves the ending character position of a selection. |
| MoveEndUntil(Object, Object) |
Moves the end position of the specified selection until any of the specified characters are found in the document. |
| MoveEndWhile(Object, Object) |
Moves the ending character position of a selection while any of the specified characters are found in the document. |
| MoveLeft(Object, Object, Object) |
Moves the selection to the left and returns the number of units it's been moved. |
| MoveRight(Object, Object, Object) |
Moves the selection to the right and returns the number of units it's been moved. |
| MoveStart(Object, Object) |
Moves the start position of the specified selection. |
| MoveStartUntil(Object, Object) |
Moves the start position of the specified selection until one of the specified characters is found in the document. |
| MoveStartWhile(Object, Object) |
Moves the start position of the specified selection while any of the specified characters are found in the document. |
| MoveUntil(Object, Object) |
Moves the specified selection until one of the specified characters is found in the document. |
| MoveUp(Object, Object, Object) |
Moves the selection up and returns the number of units it's been moved. |
| MoveWhile(Object, Object) |
Moves the specified selection while any of the specified characters are found in the document. |
| Next(Object, Object) |
Returns a Range object that represents the specified unit relative to the specified selection. |
| NextField() |
Selects the next field. |
| NextRevision(Object) |
Locates and returns the next tracked change as a Revision object. |
| NextSubdocument() |
Moves the selection to the next subdocument. |
| Paste() |
Inserts the contents of the Clipboard at the specified selection. |
| PasteAndFormat(WdRecoveryType) |
Pastes the selected table cells and formats them as specified. |
| PasteAppendTable() |
Merges pasted cells into an existing table by inserting the pasted rows between the selected rows. |
| PasteAsNestedTable() |
Pastes a cell or group of cells as a nested table into the selected range. |
| PasteExcelTable(Boolean, Boolean, Boolean) |
Pastes and formats a Microsoft Excel table. |
| PasteFormat() |
Applies formatting copied with the CopyFormat() method to the selection. |
| PasteSpecial(Object, Object, Object, Object, Object, Object, Object) |
Inserts the contents of the Clipboard. |
| Previous(Object, Object) |
Returns a Range object relative to the specified selection. |
| PreviousField() |
Selects the previous field. |
| PreviousRevision(Object) |
Locates and returns the previous tracked change as a Revision object. |
| PreviousSubdocument() |
Moves the selection to the previous subdocument. |
| ReadingModeGrowFont() |
Increases the size of the displayed text one point size when the document is displayed in Reading mode. |
| ReadingModeShrinkFont() |
Decreases the size of the displayed text one point size when the document is displayed in Reading mode. |
| RtlPara() |
Sets the reading order and alignment of the specified paragraphs to right-to-left. |
| RtlRun() |
Sets the reading order and alignment of the specified run to right-to-left. |
| Select() |
Selects the specified object. |
| SelectCell() |
Selects the entire cell containing the current selection. |
| SelectColumn() |
Selects the column that contains the insertion point, or selects all columns that contain the selection. |
| SelectCurrentAlignment() |
Extends the selection forward until text with a different paragraph alignment is encountered. |
| SelectCurrentColor() |
Extends the selection forward until text with a different color is encountered. |
| SelectCurrentFont() |
Extends the selection forward until text in a different font or font size is encountered. |
| SelectCurrentIndent() |
Extends the selection forward until text with different left or right paragraph indents is encountered. |
| SelectCurrentSpacing() |
Extends the selection forward until a paragraph with different line spacing is encountered. |
| SelectCurrentTabs() |
Extends the selection forward until a paragraph with different tab stops is encountered. |
| SelectRow() |
Selects the row that contains the insertion point, or selects all rows that contain the selection. |
| SetRange(Int32, Int32) |
Sets the starting and ending character positions for the selection. |
| Shrink() |
Shrinks the selection to the next smaller unit of text. |
| ShrinkDiscontiguousSelection() |
Deselects all but the most recently selected text when a selection contains multiple, unconnected selections. |
| Sort(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object) |
Sorts the paragraphs in the specified selection. |
| Sort2000(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object) |
Reserved for internal use. |
| SortAscending() |
Sorts paragraphs or table rows in ascending alphanumeric order. |
| SortByHeadings(Object, Object, Object, Object, Object, Object, Object, Object, Object) |
Sorts the headings in the specified selection. |
| SortDescending() |
Sorts paragraphs or table rows in descending alphanumeric order. |
| SortOld(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object) |
Reserved for internal use. |
| SplitTable() |
Inserts an empty paragraph above the first row in the selection. |
| StartOf(Object, Object) |
Moves or extends the start position of the specified selection to the beginning of the nearest specified text unit. |
| ToggleCharacterCode() |
Switches a selection between a Unicode character and its corresponding hexadecimal value. |
| TypeBackspace() |
Deletes the character preceding a collapsed selection (an insertion point). |
| TypeParagraph() |
Inserts a new, blank paragraph. |
| TypeText(String) |
Inserts the specified text. |
| WholeStory() |
Expands a selection to include the entire story. |