Class FoldingRegionMatch

Represents a folding start or end match structure. It keeps the index of the match and the start/end tag (keyword) which is matched in the document.

Inheritance
System.Object
FoldingRegionMatch
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Controls.SyntaxEditor.Taggers
Assembly: Telerik.Windows.Controls.SyntaxEditor.dll

Syntax

public class FoldingRegionMatch : IComparable

Constructors

FoldingRegionMatch()

Declaration
public FoldingRegionMatch()

Properties

Index

Gets the index of the folding match.

Declaration
public int Index { get; }
Property Value
System.Int32

IsStart

Gets a value indicating whether the folding match is start or end of a folding region.

Declaration
public bool IsStart { get; }
Property Value
System.Boolean

IsUsed

Gets or sets a value indicating whether the folding match is already used in a folding region.

Declaration
public bool IsUsed { get; set; }
Property Value
System.Boolean

Tag

Gets the tag (keyword) of the folding match.

Declaration
public string Tag { get; }
Property Value
System.String

Methods

CompareTo(Object)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Declaration
public int CompareTo(object obj)
Parameters
System.Object obj

An object to compare with this instance.
Returns
System.Int32

A value that indicates the relative order of the objects being compared.
Implements
System.IComparable.CompareTo(System.Object)

Equals(Object)

Determines whether the specified System.Object is equal to this instance.

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

The object to compare with the current object.
Returns
System.Boolean

true if the specified System.Object is equal to this instance; otherwise, false.
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Returns a hash code for this instance.

Declaration
public override int GetHashCode()
Returns
System.Int32

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
Overrides
System.Object.GetHashCode()

Operators

Equality(FoldingRegionMatch, FoldingRegionMatch)

Implements the == operator.

Declaration
public static bool operator ==(FoldingRegionMatch left, FoldingRegionMatch right)
Parameters
FoldingRegionMatch left

The left.
FoldingRegionMatch right

The right.
Returns
System.Boolean

The result of the operator.

GreaterThan(FoldingRegionMatch, FoldingRegionMatch)

Implements the > operator.

Declaration
public static bool operator>(FoldingRegionMatch left, FoldingRegionMatch right)
Parameters
FoldingRegionMatch left

The left.
FoldingRegionMatch right

The right.
Returns
System.Boolean

The result of the operator.

GreaterThanOrEqual(FoldingRegionMatch, FoldingRegionMatch)

Implements the >= operator.

Declaration
public static bool operator >=(FoldingRegionMatch left, FoldingRegionMatch right)
Parameters
FoldingRegionMatch left

The left.
FoldingRegionMatch right

The right.
Returns
System.Boolean

The result of the operator.

Inequality(FoldingRegionMatch, FoldingRegionMatch)

Implements the != operator.

Declaration
public static bool operator !=(FoldingRegionMatch left, FoldingRegionMatch right)
Parameters
FoldingRegionMatch left

The left.
FoldingRegionMatch right

The right.
Returns
System.Boolean

The result of the operator.

LessThan(FoldingRegionMatch, FoldingRegionMatch)

Implements the < operator.

Declaration
public static bool operator <(FoldingRegionMatch left, FoldingRegionMatch right)
Parameters
FoldingRegionMatch left

The left.
FoldingRegionMatch right

The right.
Returns
System.Boolean

The result of the operator.

LessThanOrEqual(FoldingRegionMatch, FoldingRegionMatch)

Implements the <= operator.

Declaration
public static bool operator <=(FoldingRegionMatch left, FoldingRegionMatch right)
Parameters
FoldingRegionMatch left

The left.
FoldingRegionMatch right

The right.
Returns
System.Boolean

The result of the operator.

Extension Methods