This object is used in various places to indicate a region within the editor. To better visualize how this works, imagine a rectangle. Each quadrant of the rectangle is analogus to a range, as ranges contain a starting row and starting column, and an ending row, and ending column.
Range[edit]
Constructors
Creates a new Range object with the given starting and ending row and column points.
Methods
Returns the part of the current Range that occurs within the boundaries of firstRow and lastRow as a new Range object.
- Range.clone()
Returns a duplicate of the calling range.
Returns a duplicate of the calling range.
- Range.collapseRows()
Returns a range containing the starting and ending rows of the original range, but with a column value of 0.
Returns a range containing the starting and ending rows of the original range, but with a column value of 0.
Returns true if the row and column provided are within the given range. This can better be expressed as returning true if:
Returns true if the row and column provided are within the given range. This can better be expressed as returning true if:
this.start.row <= row <= this.end.row && this.start.column <= column <= this.end.column
Arguments
| row | Number | Required. A row to check for |
| column | Number | Required. A column to check for |
Checks the start and end points of range and compares them to the calling range. Returns true if the range is contained within the caller's range.
Checks the start and end points of range and compares them to the calling range. Returns true if the range is contained within the caller's range.
Arguments
| range | Range | Required. A range to compare with |
Changes the row and column points for the calling range for both the starting and ending points. This method returns that range with a new row.
Returns true if the caller's ending row point is the same as row, and if the caller's ending column is the same as column.
Returns true if and only if the starting row and column, and ending tow and column, are equivalent to those given by range.
Returns true if and only if the starting row and column, and ending tow and column, are equivalent to those given by range.
Arguments
| range | Range | Required. A range to check against |
- Range.isMultiLine()
Returns true if the range spans across multiple lines.
Returns true if the range spans across multiple lines.
Returns true if the caller's starting row point is the same as row, and if the caller's starting column is the same as column.
- Range.toScreenRange(EditSession session)
Given the current Range, this function converts those starting and ending points into screen positions, and then returns a new Range object.
Given the current Range, this function converts those starting and ending points into screen positions, and then returns a new Range object.
Arguments
| session | EditSession | Required. The EditSession to retrieve coordinates from |
- Range.toString()
Returns a string containing the range's row and column information, given like this:
Returns a string containing the range's row and column information, given like this:
[start.row/start.column] -> [end.row/end.column]