RangeBase Class

Base class for Range and GrapeCity.Documents.Word.RangeBase.Body that allows manipulating content in a document.

Inheritance

object

ContentCollection<ContentObject>

ContentObjectCollection<ContentObject>

RangeBase

Body

Range

Implements

IContentList<ContentObject>

IReadOnlyList<ContentObject>

IReadOnlyCollection<ContentObject>

IEnumerable<ContentObject>

IEnumerable

Namespace: GrapeCity.Documents.Word

Assembly: DS.Documents.Word.dll

Syntax

public class RangeBase : ContentObjectCollection<ContentObject>, IContentList<ContentObject>, IReadOnlyList<ContentObject>, IReadOnlyCollection<ContentObject>, IEnumerable<ContentObject>, IEnumerable

Public Class RangeBase
    Inherits ContentObjectCollection(Of ContentObject)
    Implements IContentList(Of ContentObject), IReadOnlyList(Of ContentObject), IReadOnlyCollection(Of ContentObject), IEnumerable(Of ContentObject), IEnumerable

Remarks

A range's content is determined by its Start and End markers. Content objects that satisfy any of the following conditions are included in the range:

An object's start is positioned between the start and the end of the range.
An object's start is positioned on the start or on the end of the range.
An object's end is positioned between the start and the end of the range.
An object's end is positioned on the start or the end of the range.
An object's start is positioned before the start of the range and the object's end is positioned after the end of the range.

The GetInnerCollection<T>() method allows excluding objects that satisfy the last condition.

Properties

Name	Description
BidirectionalOverrides	Gets the collection of bidirectional overrides included in this range.
Bookmarks	Gets the collection of bookmarks included in this range.
CanvasShapes	Gets the collection of canvas shapes included in this range.
Cells	Gets the collection of table cells included in this range.
Comments	Gets the collection of comments included in this range.
ComplexFields	Gets the collection of complex fields included in this range.
ContentControls	Gets the collection of content controls included in this range.
Document	Gets the DocumentBase containing this range.
EditableRanges	Gets the collection of editable range objects included in this range.
End	Gets the end marker of the range.
Endnotes	Gets the collection of endnotes included in this range.
Footnotes	Gets the collection of footnotes included in this range.
GroupShapes	Gets the collection of group shapes included in this range.
Hyperlinks	Gets the collection of hyperlinks included in this range.
InkShapes	Gets the collection of ink shapes included in this range.
IsAlive	Gets a value indicating whether this range is alive and can be used. If this range is a PersistentRange, this property always returns true. If this range is a Range (created by a call to GetRange()) it can become unusable if its content is deleted. In that case this property will return false.
IsEmpty	Gets a value indicating whether this range is empty (does not contain any formattable content).
OMathElements	Gets the collection of OMathElement objects included in this range.
OMathMatrixRows	Gets the collection of OMathMatrixRow objects included in this range.
OMathParagraphs	Gets the collection of OMathParagraph objects included in this range.
OMathStructs	Gets the collection of OMathStruct objects included in this range.
OMaths	Gets the collection of OMath objects included in this range.
Paragraphs	Gets the collection of paragraphs included in this range.
Pictures	Gets the collection of pictures included in this range.
Rows	Gets the collection of table rows included in this range.
Runs	Gets the collection of text runs included in this range.
Sections	Gets the collection of sections included in this range.
Shapes	Gets the collection of shapes included in this range.
SimpleFields	Gets the collection of simple fields included in this range.
Start	Gets the start marker of the range.
Tables	Gets the collection of tables included in this range.
Text	Gets the text included in this range, as a string.
TextFrames	Gets the collection of text frames included in this range.
Texts	Gets the collection of texts included in this range.
Unknowns	Gets the collection of unknown objects included in this range.

Methods

Name	Description
Clear()	Clears all content in this range, excluding bound markers.
ClearFormatting()	Clears formatting on content in this range. Note that this method does not remove formatting applied indirectly via the content hierarchy.
CompareLocationWith(RangeBase)	Compares this range location with another range location.
CopyTo(RangeBase, InsertLocation, FormattingCopyStrategy)	Copies this range to another range.
GetDrawings()	Gets the collection of all drawing objects (derived from ShapeBase) included in this range. Drawing objects include Picture, Shape, and unknow shape types.
GetInnerCollection<T>()	Creates and returns a collection of content objects in the current range. The returned collection differs from enumerating on the current range itself in that it does not include objects that start before the current range's start and end after the current range's end.
GetPersistentRange(ContentObject, ContentObject)	Creates and returns an instance of PersistentRange with bounds on the specified objects. You should dispose the PersistentRange returned by this method when it is no longer needed. Failing to do so may lead to degraded performance.
GetPersistentRange(Marker, Marker)	Creates and returns an instance of PersistentRange with bounds on the specified markers. You should dispose the PersistentRange returned by this method when it is no longer needed. Failing to do so may lead to degraded performance.
InsertOMathEquation(OMathBuiltInEquation, InsertLocation)	Inserts a built-in Office Math equation into the range.
MoveTo(RangeBase, InsertLocation, FormattingCopyStrategy)	Moves this range to another range.
ToString()	Gets string representation of the range.
UpdateFields(WordLayoutSettings)	Updates the results of all document fields that support updating.

Extension Methods

RangeBaseFindReplaceExtensions.Find(RangeBase, FindOptions)

RangeBaseFindReplaceExtensions.Find(RangeBase, string, FindOptions)

RangeBaseFindReplaceExtensions.Replace(RangeBase, string, string, FindReplaceOptions)