WinForms

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class CollapsableRegion

    Show / Hide Table of Contents

    Class CollapsableRegion

    Represents a class that contains region which can be collapsed.

    Inheritance
    System.Object
    CollapsableRegion
    Implements
    System.IComparable
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.Windows.Forms.Edit.Implementation.Parser
    Assembly: Syncfusion.Edit.Windows.dll
    Syntax
    public class CollapsableRegion : 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 Description
    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 Description
    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 Description
    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 Description
    ILexem

    EndStack

    Gets or sets the end stack of the collapsible region.

    Declaration
    public ConfigStack EndStack { get; set; }
    Property Value
    Type Description
    ConfigStack

    Lexem

    Gets or sets the lexem at start position.

    Declaration
    public ILexem Lexem { get; set; }
    Property Value
    Type Description
    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 Description
    IParsePoint

    StartStack

    Gets or sets the start stack of the collapsible region.

    Declaration
    public ConfigStack StartStack { get; set; }
    Property Value
    Type Description
    ConfigStack

    UnreliableEnding

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

    Declaration
    public bool UnreliableEnding { get; }
    Property Value
    Type Description
    System.Boolean

    Methods

    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()

    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 Description
    System.EventHandler

    OutliningBeforeCollapse

    Occurs before region is about to collapse.

    Declaration
    public event OutliningCancellableEventHandler OutliningBeforeCollapse
    Event Type
    Type Description
    OutliningCancellableEventHandler

    OutliningBeforeExpand

    Occurs before region is about to expand.

    Declaration
    public event OutliningCancellableEventHandler OutliningBeforeExpand
    Event Type
    Type Description
    OutliningCancellableEventHandler

    OutliningCollapse

    Occurs when region collapses.

    Declaration
    public event OutliningEventHandler OutliningCollapse
    Event Type
    Type Description
    OutliningEventHandler

    OutliningExpand

    Occurs when region expands.

    Declaration
    public event OutliningEventHandler OutliningExpand
    Event Type
    Type Description
    OutliningEventHandler

    RegionDeleted

    Occurs when start of the region was deleted.

    Declaration
    public event EventHandler RegionDeleted
    Event Type
    Type Description
    System.EventHandler

    Implements

    System.IComparable
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved