Share via


Range Members (Word)

Represents a contiguous area in a document. Each Range object is defined by a starting and ending character position.

Methods

Name

Description

AutoFormat

Automatically formats a document. Use the Kind property to specify a document type.

Calculate

Calculates a mathematical expression within a range or selection. Returns the result as a Single.

CheckGrammar

Begins a spelling and grammar check for the specified range.

CheckSpelling

Begins a spelling check for the specified document or range.

CheckSynonyms

Displays the Thesaurus dialog box, which lists alternative word choices, or synonyms, for the text in the specified range.

Collapse

Collapses a range or selection to the starting or ending position. After a range or selection is collapsed, the starting and ending points are equal.

ComputeStatistics

Returns a Long that represents a statistic based on the contents of the specified range.

ConvertHangulAndHanja

Converts the specified range from hangul to hanja or vice versa.

ConvertToTable

Converts text within a range to a table. Returns the table as a Table object.

Copy

Copies the specified range to the Clipboard.

CopyAsPicture

The CopyAsPicture method works the same way as the Copy method.

Cut

Removes the specified object from the document and places it on the Clipboard.

Delete

Deletes the specified number of characters or words.

DetectLanguage

Analyzes the specified text to determine the language that it is written in.

EndOf

Moves or extends the ending character position of a range to the end of the nearest specified text unit.

Expand

Expands the specified range or selection. Returns the number of characters added to the range or selection. Long.

ExportAsFixedFormat

Saves a portion of a document as PDF or XPS format. .

ExportFragment

Exports the selected range into a document for use as a document fragment.

GetSpellingSuggestions

Returns a SpellingSuggestions collection that represents the words suggested as spelling replacements for the first word in the specified range.

GoTo

Returns a Range object that represents the start position of the specified item, such as a page, bookmark, or field.

GoToEditableRange

Returns a Range object that represents an area of a document that can be modified by the specified user or group of users.

GoToNext

Returns a Range object that refers to the start position of the next item or location specified by the What argument. .

GoToPrevious

Returns a Range object that refers to the start position of the previous item or location specified by the What argument.

ImportFragment

Imports a document fragment into the document at the specified range.

InRange

Returns True if the range to which the method is applied is contained in the range specified by the Range argument.

InsertAfter

Inserts the specified text at the end of a range.

InsertAlignmentTab

Inserts an absolute tab that is always positioned in the same spot, relative to either the margins or indents.

InsertAutoText

Attempts to match the text in the specified range or the text surrounding the range with an existing AutoText entry name.

InsertBefore

Inserts the specified text before the specified range.

InsertBreak

Inserts a page, column, or section break.

InsertCaption

Inserts a caption immediately preceding or following the specified range.

InsertCrossReference

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).

InsertDatabase

Retrieves data from a data source (for example, a separate Microsoft Word document, a Microsoft Office Excel worksheet, or a Microsoft Office Access database) and inserts the data as a table in place of the specified range.

InsertDateTime

Inserts the current date or time, or both, either as text or as a TIME field.

InsertFile

Inserts all or part of the specified file.

InsertParagraph

Replaces the specified range with a new paragraph.

InsertParagraphAfter

Inserts a paragraph mark after a range.

InsertParagraphBefore

Inserts a new paragraph before the specified range.

InsertSymbol

Inserts a symbol in place of the specified range.

InsertXML

Inserts the specified XML into the document at the specified range, replacing any text contained within the range.

InStory

True if the range to which this method is applied is in the same story as the range specified by the Range argument.

IsEqual

True if the range to which this method is applied is equal to the range specified by the Range argument.

LookupNameProperties

Looks up a name in the global address book list and displays the Properties dialog box, which includes information about the specified name.

ModifyEnclosure

Adds, modifies, or removes an enclosure around the specified character or characters.

Move

Collapses the specified range to its start or end position and then moves the collapsed object by the specified number of units.

MoveEnd

Moves the ending character position of a range. .

MoveEndUntil

Moves the end position of the specified range until any of the specified characters are found in the document. If the movement is forward in the document, the range is expanded.

MoveEndWhile

Moves the ending character position of a range while any of the specified characters are found in the document.

MoveStart

Moves the start position of the specified range.

MoveStartUntil

Moves the start position of the specified range until one of the specified characters is found in the document.

MoveStartWhile

Moves the start position of the specified range while any of the specified characters are found in the document.

MoveUntil

Moves the specified range until one of the specified characters is found in the document.

MoveWhile

Moves the specified range while any of the specified characters are found in the document.

Next

Returns a Range object that represents the specified unit relative to the specified range.

NextSubdocument

Moves the range to the next subdocument.

Paste

Inserts the contents of the Clipboard at the specified range.

PasteAndFormat

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. No cells are overwritten.

PasteAsNestedTable

Pastes a cell or group of cells as a nested table into the selected range.

PasteExcelTable

Pastes and formats a Microsoft Excel table.

PasteSpecial

Inserts the contents of the Clipboard. .

PhoneticGuide

Adds phonetic guides to the specified range.

Previous

Returns the previous range a relative to the specified range.

PreviousSubdocument

Moves the range to the previous subdocument.

Relocate

In outline view, moves the paragraphs within the specified range after the next visible paragraph or before the previous visible paragraph.

Select

Selects the specified range.

SetListLevel

Sets the list level for one or more items in a numbered list.

SetRange

Sets the starting and ending character positions for an existing range.

Sort

Sorts the paragraphs in the specified range.

SortAscending

Sorts paragraphs or table rows in ascending alphanumeric order.

SortDescending

Sorts paragraphs in descending alphanumeric order.

StartOf

Moves or extends the start position of the specified range or selection to the beginning of the nearest specified text unit. This method returns a Long that indicates the number of characters by which the range or selection was moved or extended. The method returns a negative number if the movement is backward through the document.

TCSCConverter

Converts the specified range from Traditional Chinese to Simplified Chinese or vice versa.

WholeStory

Expands a range to include the entire story.

Properties

Name

Description

Application

Returns an Application object that represents the Microsoft Word application.

Bold

True if the range is formatted as bold. Read/write Long.

BoldBi

True if the font or range is formatted as bold. Returns True, False, or wdUndefined (for a mixture of bold and non-bold text). Can be set to True, False, or wdToggle. Read/write Long.

BookmarkID

Returns the number of the bookmark that encloses the beginning of the specified range; returns 0 (zero) if there is no corresponding bookmark. Read-only Long.

Bookmarks

Returns a Bookmarks collection that represents all the bookmarks in a document, range, or selection. Read-only.

Borders

Returns a Borders collection that represents all the borders for the specified object.

Case

Returns or sets a WdCharacterCase constant that represents the case of the text in the specified range. Read/write.

Cells

Returns a Cells collection that represents the table cells in a range. Read-only.

Characters

Returns a Characters collection that represents the characters in a range. Read-only.

CharacterStyle

Returns a Variant that represents the style used to format one or more characters. Read-only.

CharacterWidth

Returns or sets the character width of the specified range. Read/write WdCharacterWidth.

Columns

Returns a Columns collection that represents all the table columns in the range. Read-only.

CombineCharacters

True if the specified range contains combined characters. Read/write Boolean.

Comments

Returns a Comments collection that represents all the comments in the specified document, selection, or range. Read-only.

Conflicts

Returns a Conflicts collection object that contains all the conflict objects in the range. Read-only.

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. Read-only Long.

DisableCharacterSpaceGrid

True if Microsoft Word ignores the number of characters per line for the corresponding Range object. Read/write Boolean.

Document

Returns a Document object associated with the specified range. Read-only.

Duplicate

Returns a read-only Range object that represents all the properties of the specified range.

Editors

Returns an Editors object that represents all the users authorized to modify a selection or range within a document.

EmphasisMark

Returns or sets the emphasis mark for a character or designated character string. Read/write WdEmphasisMark.

End

Returns or sets the ending character position of a range. Read/write Long.

EndnoteOptions

Returns an EndnoteOptions object that represents the endnotes in a range.

Endnotes

Returns an Endnotes collection that represents all the endnotes in a range. Read-only.

EnhMetaFileBits

Returns a Variant that represents a picture representation of how a range of text appears.

Fields

Returns a Fields collection that represents all the fields in the range. Read-only.

Find

Returns a Find object that contains the criteria for a find operation. Read-only.

FitTextWidth

Returns or sets the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. Read/write Single.

Font

Returns or sets a Font object that represents the character formatting of the specified object. Read/write Font.

FootnoteOptions

Returns FootnoteOptions object that represents the footnotes in a selection or range.

Footnotes

Returns a Footnotes collection that represents all the footnotes in a range. Read-only.

FormattedText

Returns or sets a Range object that includes the formatted text in the specified range or selection. Read/write.

FormFields

Returns a FormFields collection that represents all the form fields in the range. Read-only.

Frames

Returns a Frames collection that represents all the frames in a range. Read-only.

GrammarChecked

True if a grammar check has been run on the specified range or document. Read/write Boolean.

GrammaticalErrors

Returns a ProofreadingErrors collection that represents the sentences that failed the grammar check on the specified document or range. Read-only.

HighlightColorIndex

Returns or sets the highlight color for the specified range. Read/write WdColorIndex.

HorizontalInVertical

Returns or sets the formatting for horizontal text set within vertical text. Read/write WdHorizontalInVerticalType.

HTMLDivisions

Returns an HTMLDivisions object that represents an HTML division in a Web document.

Hyperlinks

Returns a Hyperlinks collection that represents all the hyperlinks in the specified range. Read-only.

ID

Returns or sets the identification name for the specified range. Read/write String.

Information

Returns information about the specified range. Read-only Variant.

InlineShapes

Returns an InlineShapes collection that represents all the InlineShape objects in a range. Read-only.

IsEndOfRowMark

True if the specified range is collapsed and is located at the end-of-row mark in a table. Read-only Boolean.

Italic

True if the font or range is formatted as italic. Read/write Long.

ItalicBi

True if the font or range is formatted as italic. Read/write Long.

Kana

Returns or sets whether the specified range of Japanese language text is hiragana or katakana. Read/write WdKana.

LanguageDetected

Returns or sets a value that specifies whether Microsoft Word has detected the language of the specified text. Read/write Boolean.

LanguageID

Returns or sets a WdLanguageID constant that represents the language for the specified range. Read/write.

LanguageIDFarEast

Returns or sets an East Asian language for the specified object. Read/write WdLanguageID.

LanguageIDOther

Returns or sets the language for the specified range. Read/write WdLanguageID.

ListFormat

Returns a ListFormat object that represents all the list formatting characteristics of a range. Read-only.

ListParagraphs

Returns a ListParagraphs collection that represents all the numbered paragraphs in the range. Read-only.

ListStyle

Returns a Variant that represents the style used to format a bulleted list or numbered list. Read-only.

Locks

Returns a CoAuthLocks collection object that represents all the locks in the range. Read-only.

NextStoryRange

Returns a Range object that refers to the next story. Read-only Range.

NoProofing

True if the spelling and grammar checker ignores the specified text. Read/write Long.

OMaths

Returns an OMaths collection that represents the OMath objects within the specified range. Read-only.

Orientation

Returns or sets the orientation of text in a range when the Text Direction feature is enabled. Read/write WdTextOrientation.

PageSetup

Returns a PageSetup object that's associated with the specified range.

ParagraphFormat

Returns or sets a ParagraphFormat object that represents the paragraph settings for the specified range. Read/write.

Paragraphs

Returns a Paragraphs collection that represents all the paragraphs in the specified range. Read-only.

ParagraphStyle

Returns a Variant that represents the style used to format a paragraph. Read-only.

Parent

Returns an Object that represents the parent object of the specified Range 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 range. Read-only Long.

ReadabilityStatistics

Returns a ReadabilityStatistics collection that represents the readability statistics for the specified document or range. Read-only.

Revisions

Returns a Revisions collection that represents the tracked changes in the range. Read-only.

Rows

Returns a Rows collection that represents all the table rows in a range. Read-only.

Scripts

Returns a Scripts collection that represents the collection of HTML scripts in the specified object.

Sections

Returns a Sections collection that represents the sections in the specified range. Read-only.

Sentences

Returns a Sentences collection that represents all the sentences in the range. Read-only.

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. Read-only.

ShowAll

True if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. Read/write Boolean.

SpellingChecked

True if spelling has been checked throughout the specified range or document. False if all or some of the range or document has not been checked for spelling. Read/write Boolean.

SpellingErrors

Returns a ProofreadingErrors collection that represents the words identified as spelling errors in the specified range. Read-only.

Start

Returns or sets the starting character position of a range. Read/write Long.

StoryLength

Returns the number of characters in the story that contains the specified range. Read-only Long.

StoryType

Returns the story type for the specified range, selection, or bookmark. Read-only WdStoryType.

Style

Returns or sets the style for the specified object. Read/write Variant.

Subdocuments

Returns a Subdocuments collection that represents all the subdocuments in the specified range or document. Read-only.

SynonymInfo

Returns a SynonymInfo object that contains information from the thesaurus on synonyms, antonyms, or related words and expressions for the contents of a range.

Tables

Returns a Tables collection that represents all the tables in the specified range. Read-only.

TableStyle

Returns a Variant that represents the style used to format a table. Read-only.

Text

Returns or sets the text in the specified range or selection. Read/write String. Read/write String.

TextRetrievalMode

Returns a TextRetrievalMode object that controls how text is retrieved from the specified Range. Read/write.

TopLevelTables

Returns a Tables collection that represents the tables at the outermost nesting level in the current range. Read-only.

TwoLinesInOne

Returns or sets whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. Read/write WdTwoLinesInOneType.

Underline

Returns or sets the type of underline applied to a range. Read/write WdUnderline.

Updates

Returns a CoAuthUpdates collection object that represents all the available updates in the range. Read-only.

WordOpenXML

Returns a String that represents the XML contained within the range in the Microsoft Word Open XML format. Read-only.

Words

Returns a Words collection that represents all the words in a range. Read-only.

XML

Returns a String that represents the XML text in the specified object. .

XMLNodes

Returns an XMLNodes collection that represents the XML elements in the specified range—including any elements that are only partially within the range. Read-only.

XMLParentNode

Returns an XMLNode object that represents the parent XML node of a range. Read-only.