Class CollapsableRegion

Represents a class that contains region which can be collapsed.

Inheritance

System.Object

CollapsableRegion

Implements

System.IComparable

Namespace: Syncfusion.Windows.Forms.Edit.Implementation.Parser

Assembly: Syncfusion.Edit.Windows.dll

Syntax

public class CollapsableRegion : Object, IComparable

Constructors

CollapsableRegion()

Declaration

public CollapsableRegion()

Properties

Collapsed

Gets or sets a value indicating whether the region is collapsed or not.

Declaration

public bool Collapsed { get; set; }

Property Value

Type
System.Boolean

CollapseName

Gets or sets the name of the collapse that is shown as text in collapsed region.

Declaration

public string CollapseName { get; set; }

Property Value

Type
System.String

End

Gets or sets the end of the collapsible region (Points to the start of the last lexem in the region). It can be null: in that case file will be parsed until end the end of this region.

Declaration

public IParsePoint End { get; set; }

Property Value

Type
IParsePoint

EndLexem

Gets or sets the lexem at end position ( the last lexem in the region. Example: "}" ).

Declaration

public ILexem EndLexem { get; set; }

Property Value

Type
ILexem

EndStack

Gets or sets the end stack of the collapsible region.

Declaration

public ConfigStack EndStack { get; set; }

Property Value

Type
ConfigStack

Lexem

Gets or sets the lexem at start position.

Declaration

public ILexem Lexem { get; set; }

Property Value

Type
ILexem

Start

Gets or sets the beginning of the collapsing region. It value can not be null.

Declaration

public IParsePoint Start { get; set; }

Property Value

Type
IParsePoint

StartStack

Gets or sets the start stack of the collapsible region.

Declaration

public ConfigStack StartStack { get; set; }

Property Value

Type
ConfigStack

UnreliableEnding

Gets a value indicating whether regions end stack is reliable or not.

Declaration

public bool UnreliableEnding { get; }

Property Value

Type
System.Boolean

Methods

add_OutliningBeforeCollapse(OutliningCancellableEventHandler)

Declaration

public void add_OutliningBeforeCollapse(OutliningCancellableEventHandler value)

Parameters

Type	Name	Description
OutliningCancellableEventHandler	value

add_OutliningBeforeExpand(OutliningCancellableEventHandler)

Declaration

public void add_OutliningBeforeExpand(OutliningCancellableEventHandler value)

Parameters

Type	Name	Description
OutliningCancellableEventHandler	value

add_OutliningCollapse(OutliningEventHandler)

Declaration

public void add_OutliningCollapse(OutliningEventHandler value)

Parameters

Type	Name	Description
OutliningEventHandler	value

add_OutliningExpand(OutliningEventHandler)

Declaration

public void add_OutliningExpand(OutliningEventHandler value)

Parameters

Type	Name	Description
OutliningEventHandler	value

AttachMonitoredEndPoint(IParsePoint)

Adds monitored point.

Declaration

public void AttachMonitoredEndPoint(IParsePoint point)

Parameters

Type	Name	Description
IParsePoint	point	IParsePoint to be monitored.

Remarks

When points is moved, region ending is treated as unreliable.

CompareTo(Object)

Helps to compares objects.

Declaration

public int CompareTo(object obj)

Parameters

Type	Name	Description
System.Object	obj	An object to compare with this instance.

Returns

Type	Description
System.Int32	Standard IComparable return value.

Contains(IParsePoint)

Determines whether region contains given IParsePoint object.

Declaration

public bool Contains(IParsePoint point)

Parameters

Type	Name	Description
IParsePoint	point	IParsePoint object.

Returns

Type	Description
System.Boolean	True if contains, otherwise false.

RaiseCollapsedStateChanged()

Raiser for CollapsedStateChanged event.

Declaration

protected void RaiseCollapsedStateChanged()

RaiseRegionDeletedEvent()

Raiser form RegionDeleted event.

Declaration

protected void RaiseRegionDeletedEvent()

remove_OutliningBeforeCollapse(OutliningCancellableEventHandler)

Declaration

public void remove_OutliningBeforeCollapse(OutliningCancellableEventHandler value)

Parameters

Type	Name	Description
OutliningCancellableEventHandler	value

remove_OutliningBeforeExpand(OutliningCancellableEventHandler)

Declaration

public void remove_OutliningBeforeExpand(OutliningCancellableEventHandler value)

Parameters

Type	Name	Description
OutliningCancellableEventHandler	value

remove_OutliningCollapse(OutliningEventHandler)

Declaration

public void remove_OutliningCollapse(OutliningEventHandler value)

Parameters

Type	Name	Description
OutliningEventHandler	value

remove_OutliningExpand(OutliningEventHandler)

Declaration

public void remove_OutliningExpand(OutliningEventHandler value)

Parameters

Type	Name	Description
OutliningEventHandler	value

ResetEnd()

Resets information about region end.

Declaration

public void ResetEnd()

Events

CollapsedStateChanged

Occurs when collapsed state of the region has changed.

Declaration

public event EventHandler CollapsedStateChanged

Event Type

Type
System.EventHandler

OutliningBeforeCollapse

Occurs before region is about to collapse.

Declaration

public event OutliningCancellableEventHandler OutliningBeforeCollapse

Event Type

Type
OutliningCancellableEventHandler

OutliningBeforeExpand

Occurs before region is about to expand.

Declaration

public event OutliningCancellableEventHandler OutliningBeforeExpand

Event Type

Type
OutliningCancellableEventHandler

OutliningCollapse

Occurs when region collapses.

Declaration

public event OutliningEventHandler OutliningCollapse

Event Type

Type
OutliningEventHandler

OutliningExpand

Occurs when region expands.

Declaration

public event OutliningEventHandler OutliningExpand

Event Type

Type
OutliningEventHandler

RegionDeleted

Occurs when start of the region was deleted.

Declaration

public event EventHandler RegionDeleted

Event Type

Type
System.EventHandler

Implements

System.IComparable