Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

Range Struct

Namespace:
ActiproSoftware.Text.Utility
Assembly:
ActiproSoftware.Text.WinForms.dll

Represents an ordered pair of min and max values.

public struct Range

Constructors

Range(int)

Initializes a new instance of the Range class with the specified min and max value.

public Range(int value)
Parameter Type Description
value int

The value to use for both the min and max.

Range(int, int)

Initializes a new instance of the Range class with the specified min and max values.

public Range(int min, int max)
Parameter Type Description
min int

The minimum value of the range.
max int

The maximum value of the range.

Properties

Empty

Returns an empty Range.

public static Range Empty { get; }

Property Value

Range:

A Range that is empty.

IsEmpty

Returns whether the Range is empty.

public bool IsEmpty { get; }

Property Value

bool:

true if the Range is empty; otherwise, false.

IsNormalized

Gets whether the range is normalized (the maximum value is greater than or equal to the minimum).

public bool IsNormalized { get; }

Property Value

bool:

true if the range is normalized; otherwise, false.

IsZeroLength

Gets whether the range has a zero length.

public bool IsZeroLength { get; }

Property Value

bool:

true if the range has a zero length; otherwise, false.

Length

Gets the length of this Range.

public int Length { get; }

Property Value

int:

The length of this Range.

Max

Gets or sets the maximum value of this Range.

public int Max { get; set; }

Property Value

int:

The maximum value of this Range.

Min

Gets or sets the minimum value of this Range.

public int Min { get; set; }

Property Value

int:

The minimum value of this Range.

Methods

Contains(Range)

Returns whether the range inclusively contains the specified Range.

public bool Contains(Range range)
Parameter Type Description
range Range

The Range to check.

Returns

bool:

true if the range inclusively contains the specified Range; otherwise, false.

Contains(int)

Returns whether the range inclusively contains the specified value.

public bool Contains(int value)
Parameter Type Description
value int

The value to check.

Returns

bool:

true if the range inclusively contains the specified value; otherwise, false.

Equals(object)

Determines whether the specified Object is equal to the current Object.

public override bool Equals(object obj)
Parameter Type Description
obj object

The Object to compare to the current Object.

Returns

bool:

true if the specified Object is equal to the current Object; otherwise, false.

GetHashCode()

Returns a hash code for this object.

public override int GetHashCode()

Returns

int:

An integer value that specifies a hash value for this object.

Intersect(Range, Range)

Returns the intersection of two Range objects.

public static Range Intersect(Range range1, Range range2)
Parameter Type Description
range1 Range

The first Range to examine.
range2 Range

The second Range to examine.

Returns

Range:

The intersection of two Range objects.

IntersectsWith(Range)

Returns whether the range intersects with the specified Range.

public bool IntersectsWith(Range range)
Parameter Type Description
range Range

The Range to check.

Returns

bool:

true if the range intersects with the specified Range; otherwise, false.

Normalize()

Normalizes the range values (ensures that the maximum value is greater than or equal to the minimum).

public void Normalize()

OverlapsWith(Range)

Returns whether the Range overlaps with, or crosses, the specified Range.

public bool OverlapsWith(Range range)
Parameter Type Description
range Range

The Range to examine.

Returns

bool:

true if the Range overlaps with, or crosses, the specified Range; otherwise, false.

ToString()

Converts the object to a String.

public override string ToString()

Returns

string:

A string whose value represents this object.

Union(Range)

Changes this Range to be the union of this Range with another Range.

public void Union(Range range)
Parameter Type Description
range Range

The Range with which to merge.

Operators

operator ==(Range, Range)

Compares two Range objects. The result specifies whether the values of the Min and Max properties of the two Range objects are equal.

public static bool operator ==(Range left, Range right)
Parameter Type Description
left Range

A Range to compare.
right Range

A Range to compare.

Returns

bool:

true if the Min and Max values of left and right are equal; otherwise, false.

operator !=(Range, Range)

Compares two Range objects. The result specifies whether the values of the Min and Max properties of the two Range objects are unequal.

public static bool operator !=(Range left, Range right)
Parameter Type Description
left Range

A Range to compare.
right Range

A Range to compare.

Returns

bool:

true if the Min and Max values of left and right are unequal; otherwise, false.

Inherited Members