How to: Programmatically collapse ranges or selections in documents
Applies to: Visual Studio Visual Studio for Mac Visual Studio Code
If you are working with a Range or Selection object, you might want to change the selection to an insertion point before inserting text, to avoid overwriting existing text. Both the Range and Selection objects have a Collapse method, which makes use of the WdCollapseDirection enumeration values:
wdCollapseStart collapses the selection to the beginning of the selection. This is the default if you do not specify an enumeration value.
wdCollapseEnd collapses the selection to the end of the selection.
Applies to: The information in this topic applies to document-level projects and VSTO Add-in projects for Word. For more information, see Features available by Office application and project type.
To collapse a range and insert new text
Create a Range object that consists of the first paragraph in the document.
The following code example can be used in a document-level customization.
The following code example can be used in a VSTO Add-in. This code uses the active document.
Use the wdCollapseStart enumeration value to collapse the range.
Insert the new text.
Select the Range.
If you use the wdCollapseEnd enumeration value, the text is inserted at the beginning of the following paragraph.
You might expect that inserting a new sentence would insert it before the paragraph marker, but that is not the case because the original range includes the paragraph marker. For more information, see How to: Programmatically exclude paragraph marks when creating ranges.
Document-level customization example
To collapse a range in a document-level customization
The following example shows the complete method for a document-level customization. To use this code, run it from the
ThisDocumentclass in your project.
VSTO Add-in example
To collapse a range in a VSTO Add-in
The following example shows the complete method for a VSTO Add-in. To use this code, run it from the
ThisAddInclass in your project.
- How to: Programmatically insert text into Word documents
- How to: Programmatically define and select ranges in documents
- How to: Programmatically retrieve start and end characters in ranges
- How to: Programmatically exclude paragraph marks when creating ranges
- How to: Programmatically extend ranges in documents
- How to: Programmatically reset ranges in Word documents
Submit and view feedback for