Class
FoldingManager

Class FoldingManager.

Definition

Namespace:Telerik.Windows.Controls.SyntaxEditor.Folding

Assembly:Telerik.Windows.Controls.SyntaxEditor.dll

Syntax:

cs-api-definition
public class FoldingManager

Inheritance: objectFoldingManager

Properties

Editor

Gets the editor.

Declaration

cs-api-definition
public RadSyntaxEditor Editor { get; }

Property Value

RadSyntaxEditor

The editor.

FoldingRegions

Gets the folding regions.

Declaration

cs-api-definition
public IEnumerable<FoldingRegion> FoldingRegions { get; }

Property Value

IEnumerable<FoldingRegion>

The folding regions.

IsUpdateInProgress

Gets a value indicating whether this instance is update in progress.

Declaration

cs-api-definition
public bool IsUpdateInProgress { get; }

Property Value

bool

true if this instance is update in progress; otherwise, false.

Methods

BeginUpdate()

Begins the update.

Declaration

cs-api-definition
public void BeginUpdate()

ClearFoldings()

Clears the foldings.

Declaration

cs-api-definition
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1650:ElementDocumentationMustBeSpelledCorrectly", Justification = "Reviewed.")]
public void ClearFoldings()

CreateFolding(int, int, bool, string, object)

Creates the folding.

Declaration

cs-api-definition
public FoldingRegion CreateFolding(int start, int end, bool isFolded = false, string title = "...", object toolTipContent = null)

Parameters

start

int

end

int

isFolded

bool

title

string

toolTipContent

object

Returns

FoldingRegion

EndUpdate()

Ends the update.

Declaration

cs-api-definition
public void EndUpdate()

Exceptions

InvalidOperationException

There is no active update to end.

GetFoldingsContainingIndex(int)

Gets the index of the foldings containing.

Declaration

cs-api-definition
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1650:ElementDocumentationMustBeSpelledCorrectly", Justification = "Reviewed.")]
public IEnumerable<FoldingRegion> GetFoldingsContainingIndex(int index)

Parameters

index

int

The index.

Returns

IEnumerable<FoldingRegion>

GetFoldingsContainingLine(int)

Gets the foldings containing line.

Declaration

cs-api-definition
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1650:ElementDocumentationMustBeSpelledCorrectly", Justification = "Reviewed.")]
public IEnumerable<FoldingRegion> GetFoldingsContainingLine(int lineNumber)

Parameters

lineNumber

int

The line number.

Returns

IEnumerable<FoldingRegion>

GetFoldingsIntersectingSpan(Span)

Gets the foldings intersecting span.

Declaration

cs-api-definition
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1650:ElementDocumentationMustBeSpelledCorrectly", Justification = "Reviewed.")]
public IEnumerable<FoldingRegion> GetFoldingsIntersectingSpan(Span span)

Parameters

span

Span

The span.

Returns

IEnumerable<FoldingRegion>

RemoveFolding(FoldingRegion)

Removes the folding.

Declaration

cs-api-definition
public void RemoveFolding(FoldingRegion foldingRegion)

Parameters

foldingRegion

FoldingRegion

The folding region.

UnfoldAllRegionsContaningIndex(int)

Unfolds the index of all regions containing.

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Contaning")]
public void UnfoldAllRegionsContaningIndex(int index)

Parameters

index

int

The index.