Move Method (streamPoint, count)

Pageflex Document Action API

previous page next page
Pageflex Document Action API Move Method (streamPoint, count)
Namespaces > Pageflex.Scripting > Range > Move(StreamPoint, Int32)
Moves both range endpoints by the specified number of stream points.
Syntax
C# Visual Basic Managed C++ 
public void Move (
	StreamPoint streamPoint,
	int count
)
Public Sub Move ( _
	streamPoint As StreamPoint, _
	count As Integer _
)
public:
void Move (
	StreamPoint streamPoint, 
	int count
)
Parameters
streamPoint (StreamPoint)
The StreamPoint to which the collapsed range is to be moved.
count (Int32)
The number of stream points by which the collapsed 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 range is collapsed to its end position and moved forward by the specified number of stream points. If count is a negative number, the range is collapsed to its start position and moved backward by the specified number of stream points. If count is 0, the range is collapsed to its start and 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