RangesCollection module

class RangesCollection.RangesCollection(ptr)

Bases: XlsRangesCollection

Add(range: CellRange)

<summary>

Adds a range to the collection.

</summary> <param name=”range”>Range to add.</param>

AddComment() → ExcelComment

<summary>

Adds a comment to the range.

</summary> <returns>Added comment.</returns>

AddRange(range: CellRange)

<summary>

Adds a range to the collection.

</summary> <param name=”range”>Range to add.</param>

property Borders: BordersCollection

<summary>

Returns a Borders collection that represents the borders of a style or a range of cells (including a range defined as part of a conditional format).

</summary>

property Comment: ExcelComment

<summary>

Returns a Comment object that represents the comment associated with the cell in the upper-left corner of the range.

</summary>

Copy

<summary>

Copies the range to the specified range.

</summary> <param name=”destRange”>Destination range</param> <returns>Destination range</returns>

property EndCell: CellRange

<summary>

Returns a Range object that represents the cell at the end of the

region that contains the source range.

</summary>

property EntireColumn: RangesCollection

<summary>

Returns a Range object that represents the entire column (or

columns) that contains the specified range.

</summary>

property EntireRow: RangesCollection

<summary>

Returns a Range object that represents the entire row (or rows) that contains the specified range.

</summary>

FindBool(boolValue: bool) → CellRange

<summary>

Finds the cell with the input bool.

</summary> <param name=”boolValue”>Bool value to search for</param> <returns>Found range</returns>

FindDateTime(dateTimeValue: DateTime) → CellRange

<summary>

Finds the cell with the input datetime.

</summary> <param name=”dateTimeValue”>Datetime value to search for</param> <returns>Found range</returns>

FindNumber(doubleValue: float, formulaValue: bool) → CellRange

<summary>

Finds the cell with the input double.

</summary> <param name=”doubleValue”>Double value to search for</param> <param name=”formulaValue”>Indicates whether includes formula value to search for</param> <returns>Found range</returns>

FindString(stringValue: str, formula: bool, formulaValue: bool) → CellRange

<summary>

Finds the cell with the input string.

</summary> <param name=”stringValue”>String value to search for</param> <param name=”formula”>Indicates whether includes formula to search for</param> <param name=”formulaValue”>Indicates whether includes formula value to search for</param> <returns>Found range</returns>

FindTimeSpan(timeSpanValue: TimeSpan) → CellRange

<summary>

Finds the cell with the input time span.

</summary> <param name=”timeSpanValue”>Time span value to search for.</param> <returns>Found range.</returns>

Intersect(range: CellRange) → CellRange

<summary>

Get intersection range with the specified range.

</summary> <param name=”range”>Range which to intersect.</param> <returns>Range intersection.</returns>

property MergeArea: RangesCollection

<summary>

Returns a Range object that represents the merged range containing the specified cell.

</summary>

Move

<summary>

Moves the cells to the specified Range.

</summary> <param name=”destination”>Destnation Range.</param>

Remove(range: CellRange)

<summary>

Removes range from the collection.

</summary> <param name=”range”>Range to remove.</param>

property RichText: RichText

<summary>

Returns a RichTextString object that represents the rich text style.

</summary>

property Style: CellStyle

<summary>

Returns a Style object that represents the style of the specified range

</summary>

property Worksheet: Worksheet