Home Library Learn Samples Downloads Support Community Forums
1 out of 1 rated this helpful - Rate this topic

How to: Programmatically Define and Select Ranges in Documents

Visual Studio 2012

You can define a range in a Microsoft Office Word document by using a Range object. You can select the entire document in a number of ways, for example, by using the Select method of the Range object, or by using the Content property of the Microsoft.Office.Tools.Word.Document class (in a document-level customization) or the Microsoft.Office.Interop.Word.Document class (in an application-level add-in).

Applies to: The information in this topic applies to document-level projects and application-level projects for Word 2013 and Word 2010. For more information, see Features Available by Office Application and Project Type.

The following example shows how to create a new Range object that includes the first seven characters in the active document, including non-printing characters. It then selects the text within the range.

To define a range in a document-level customization

  • Add the range to the document by passing a start and end character to the Range method of the Microsoft.Office.Tools.Word.Document class. To use this code example, run it from the ThisDocument class in your project.

    C#
    VB
    Copy 
    object start = 0; 
object end = 7; 
Word.Range rng = this.Range(ref start, ref end); 

rng.Select();

To define a range by using an application-level add-in

  • Add the range to the document by passing a start and end character to the Range method of the Microsoft.Office.Interop.Word.Document class. The following code example adds a range to the active document. To use this code example, run it from the ThisAddIn class in your project.

    C#
    VB
    Copy 
    Word.Range rng = this.Application.ActiveDocument.Range(0, 7);

rng.Select();

The following examples show how to select the entire document by using the Select method of a Range object, or by using the Content property of the Microsoft.Office.Tools.Word.Document class.

To select the entire document as a range by using the Select method

  • Use the Select method of a Range that contains the entire document. To use the following code example, run it from the ThisDocument class in your project.

    C#
    VB
    Copy 
    object start = this.Content.Start;
object end = this.Content.End;

this.Range(ref start, ref end).Select();

To select the entire document as a range by using the Content property

  • Use the Content property to define a range that encompasses the entire document.

    C#
    VB
    Copy 
    this.Content.Select();

You can also use the methods and properties of other objects to define a range.

To select a sentence in the active document

  • Set the range by using the Sentences collection. Use the index of the sentence you want to select.

    C#
    VB
    Copy 
    Word.Range s2 = this.Sentences[2]; 
s2.Select();

Another way to select a sentence is to manually set the start and end values for the range.

To select a sentence by manually setting the start and end values

  1. Create a range variable.

    C#
    VB
    Copy 
    Word.Range rng;

  2. Check to see if there are at least two sentences in the document, set the Start and End arguments of the range, and then select the range.

    C#
    VB
    Copy 
    if (this.Sentences.Count >= 2) 
{
    object startLocation = this.Sentences[2].Start; 
    object endLocation = this.Sentences[2].End; 

    // Supply a Start and End value for the Range. 
    rng = this.Range(ref startLocation, ref endLocation); 

    // Select the Range.
    rng.Select();
}

The following examples show how to select the entire document by using the Select method of a Range object, or by using the Content property of the Microsoft.Office.Interop.Word.Document class.

To select the entire document as a range by using the Select method

  • Use the Select method of a Range that contains the entire document. The following code example selects the contents of the active document. To use this code example, run it from the ThisAddIn class in your project.

    C#
    VB
    Copy 
    this.Application.ActiveDocument.Range(
    this.Application.ActiveDocument.Content.Start,
    this.Application.ActiveDocument.Content.End).Select();

To select the entire document as a range by using the Content property

  • Use the Content property to define a range that encompasses the entire document.

    C#
    VB
    Copy 
    this.Application.ActiveDocument.Content.Select();

You can also use the methods and properties of other objects to define a range.

To select a sentence in the active document

  • Set the range by using the Sentences collection. Use the index of the sentence you want to select.

    C#
    VB
    Copy 
    Word.Range s2 = this.Application.ActiveDocument.Sentences[2];
s2.Select();

Another way to select a sentence is to manually set the start and end values for the range.

To select a sentence by manually setting the start and end values

  1. Create a range variable.

    C#
    VB
    Copy 
    Word.Range rng;

  2. Check to see if there are at least two sentences in the document, set the Start and End arguments of the range, and then select the range.

    C#
    VB
    Copy 
    Word.Document document = this.Application.ActiveDocument;

if (document.Sentences.Count >= 2)
{
    object startLocation = document.Sentences[2].Start;
    object endLocation = document.Sentences[2].End;

    // Supply a Start and End value for the Range. 
    rng = document.Range(ref startLocation, ref endLocation);

    // Select the Range.
    rng.Select();
}
Did you find this helpful?
(1500 characters remaining)
© 2013 Microsoft. All rights reserved.