MoveStart Method (streamPoint, count)

Pageflex Document Action API

previous page next page
Pageflex Document Action API MoveStart Method (streamPoint, count)
Namespaces > Pageflex.Scripting > Range > MoveStart(StreamPoint, Int32)
Moves the start of the range by the specified number of stream points.
Syntax
C# Visual Basic Managed C++ 
public void MoveStart (
	StreamPoint streamPoint,
	int count
)
Public Sub MoveStart ( _
	streamPoint As StreamPoint, _
	count As Integer _
)
public:
void MoveStart (
	StreamPoint streamPoint, 
	int count
)
Parameters
streamPoint (StreamPoint)
The StreamPoint by which the start of the range is to be moved.
count (Int32)
The number of stream points by which the start of the range is to be moved.
Remarks
This method doesn't rearrange text in the document. Instead, it redefines the range to refer to a new location in the document.

If count is a positive number, the start of the range is moved forward. If it's a negative number, the start is moved backward. If count is 0, the start of the range is moved to the specified StreamPoint unless it is already there.

If streamPoint is StreamStart or StreamEnd, count is ignored.

Exceptions
Exception Condition
MoveRangeFailedException Attempt to move past the beginning or end of the stream.
StaleScriptingObjectException This object's associated internal object no longer exists.

Assembly: PFScript Version: 8.0.7.1407 (Module: PFScript)

previous page start next page