IRangeProvider.Union(Range[]) Method

Creates a complex range that is the union of multiple ranges.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v19.1.Core.dll

Declaration

C#

Range Union(
    params Range[] ranges
)

VB.NET

Function Union(
    ParamArray ranges As Range()
) As Range

Parameters

Name	Type	Description
ranges	Range[]	An array of Range objects.

Returns

Type	Description
Range	A Range composed of multiple ranges.

Remarks

A complex (union) range can be also created by multiple selection in a worksheet. A complex range can be used in the same manner as a simple range. The Range.Areas property provides access to the ranges to which a complex range is comprised.

This example demonstrates how to create a complex (union) range. There are several ways to accomplish this.

• Use the Range.Union method to combine a single range with another range.
• Use the IRangeProvider.Union method to create a complex range from a list of ranges or from an array of ranges. The IRangeProvider object can be accessed via the Worksheet.Range or IWorkbook.Range property.

Ranges which comprise a complex range can be accessed using the Range.Areas property.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-spreadsheetcontrol-api-e4655

CellActions.cs

Range rangeA1D4 = worksheet["A1:D4"];
Range rangeD5E7 = worksheet["D5:E7"];
Range rangeRow11 = worksheet["11:11"];
Range rangeF7 = worksheet["F7"];

// Create a complex range using the Range.Union method.
Range complexRange1 = worksheet["A7:A9"].Union(rangeD5E7);

// Create a complex range using the IRangeProvider.Union method.
Range complexRange2 = worksheet.Range.Union(new Range[] { rangeRow11, rangeA1D4, rangeF7 });

// Fill the ranges with different colors.
complexRange1.FillColor = myColor1;
complexRange2.FillColor = myColor2;

// Use the Areas property to get access to a component of a complex range.
complexRange2.Areas[2].FillColor = Color.Beige;

CellActions.vb

Dim rangeA1D4 As Range = worksheet("A1:D4")
Dim rangeD5E7 As Range = worksheet("D5:E7")
Dim rangeRow11 As Range = worksheet("11:11")
Dim rangeF7 As Range = worksheet("F7")

' Create a complex range using the Range.Union method.
Dim complexRange1 As Range = worksheet("A7:A9").Union(rangeD5E7)

' Create a complex range using the IRangeProvider.Union method.
Dim complexRange2 As Range = worksheet.Range.Union(New Range() { rangeRow11, rangeA1D4, rangeF7 })

' Fill the ranges with different colors.
complexRange1.FillColor = myColor1
complexRange2.FillColor = myColor2

' Use the Areas property to get access to a component of a complex range.
complexRange2.Areas(2).FillColor = Color.Beige

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Union(Range[]) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

VB.NET

how-to-apply-conditional-formatting-to-a-range-of-cells-e4929/VB/SpreadsheetControl/SpreadsheetActions/ConditionalFormatting.vb#L358

' Create a union range to which the rule will be applied.
Dim complexRange As Range = worksheet.Range.Union(worksheet("G3:G6"), worksheet("G9:G12"))

wpf-spreadsheetcontrol-api-part-3-t289419/VB/SpreadsheetControl_WPF_API_Part03/CodeExamples/DataValidationActions.vb#L81

' Create a union range.
Dim range As Range = worksheet.Range.Union(worksheet("F4:F5"), worksheet("F6:F11"))
' Restrict data entry to a number within limits.

winforms-spreadsheetcontrol-api-part-3-t231273/VB/SpreadsheetControl_API_Part03/CodeExamples/DataValidationActions.vb#L80

' Create a union range.
Dim range As Range = worksheet.Range.Union(worksheet("F4:F5"), worksheet("F6:F11"))
' Restrict data entry to a number within limits.

C#

wpf-spreadsheetcontrol-api-part-3-t289419/CS/SpreadsheetControl_WPF_API_Part03/CodeExamples/DataValidationActions.cs#L79

// Create a union range.
Range range = worksheet.Range.Union(worksheet["F4:F5"], worksheet["F6:F11"]);
// Restrict data entry to a number within limits.

winforms-spreadsheetcontrol-api-part-3-t231273/CS/SpreadsheetControl_API_Part03/CodeExamples/DataValidationActions.cs#L78

// Create a union range.
Range range = worksheet.Range.Union(worksheet["F4:F5"], worksheet["F6:F11"]);
// Restrict data entry to a number within limits.