BlockExtensions Class

Namespace: Meziantou.Framework.Markdown.Syntax
Assembly: Meziantou.Framework.Markdown.dll
Package: Meziantou.Framework.Markdown 1.0.8
Source: BlockExtensions.cs
Available in package assets: net10.0net11.0

Extensions for Block

public static class BlockExtensions

Methods

Name	Description
CompareToPosition(Block, int)	Compares a block to a position.
ContainsPosition(Block, int)	Determines whether a position is in a block: from its first character to the position just after its last character, where a caret at the end of the block is.
FindBlockAtPosition(Block, int)	Finds the deepest block that contains a position, as `BlockExtensions.ContainsPosition` defines it.
FindClosestBlock(Block, int)	Performs the find closest block operation.
FindClosestLine(MarkdownDocument, int)	Performs the find closest line operation.

CompareToPosition(Block, int)

BlockExtensions.cs

Compares a block to a position.

public static int CompareToPosition(this Block block, int position)

Parameters

block Block
position int

Returns

int 1 when the block is after the position, -1 when it is before, and 0 when it contains it (see BlockExtensions.ContainsPosition).

ContainsPosition(Block, int)

BlockExtensions.cs

Determines whether a position is in a block: from its first character to the position just after its last character, where a caret at the end of the block is.

public static bool ContainsPosition(this Block block, int position)

Parameters

block Block
position int

Returns

bool

FindBlockAtPosition(Block, int)

BlockExtensions.cs

Finds the deepest block that contains a position, as BlockExtensions.ContainsPosition defines it.

public static Block? FindBlockAtPosition(this Block rootBlock, int position)

Parameters

rootBlock Block
position int

Returns

Block? The deepest block containing the position, or null when rootBlock does not contain it.

FindClosestBlock(Block, int)

BlockExtensions.cs

Performs the find closest block operation.

public static Block? FindClosestBlock(this Block rootBlock, int line)

Parameters

rootBlock Block
line int

Returns

Block?

FindClosestLine(MarkdownDocument, int)

BlockExtensions.cs

Performs the find closest line operation.

public static int FindClosestLine(this MarkdownDocument root, int line)

Parameters

root MarkdownDocument
line int

Returns

int