Class SpanLayoutBox

collection

SpanLayoutBox(DocumentElement, DocumentStructureCollection, bool)

Declaration

cs-api-definition

public SpanLayoutBox(DocumentElement parentElement, DocumentStructureCollection collection, bool isFragment)

Parameters

parentElement

collection

isFragment

SpanLayoutBox(DocumentElement, DocumentStructureCollection, string)

Declaration

cs-api-definition

public SpanLayoutBox(DocumentElement parentElement, DocumentStructureCollection collection, string text)

Parameters

parentElement

collection

text

Properties

AssociatedSpan

Gets or sets the associated span for the SpanLayoutBox.

Declaration

cs-api-definition

public Span AssociatedSpan { get; set; }

Property Value

Span

BaselineOffset

Gets the baseline offset of the span layout box, which indicates the distance from the top of the box to its baseline.

Declaration

cs-api-definition

public override float BaselineOffset { get; }

Property Value

float

Overrides InlineLayoutBox.BaselineOffset

CanCreateLayoutBoxesFromContent

Declaration

cs-api-definition

protected override bool CanCreateLayoutBoxesFromContent { get; }

Property Value

Overrides LayoutBox.CanCreateLayoutBoxesFromContent

DesiredTextSize

Gets the desired size of the text within the SpanLayoutBox.

Declaration

cs-api-definition

public SizeF DesiredTextSize { get; }

Property Value

SizeF

HasWidthAtTheEndOfLine

Indicates whether the layout box has a defined width at the end of the line.

Declaration

cs-api-definition

public override bool HasWidthAtTheEndOfLine { get; }

Property Value

Overrides InlineLayoutBox.HasWidthAtTheEndOfLine

IsContainerBox

Indicates whether the span layout box is a container box.

Declaration

cs-api-definition

public override bool IsContainerBox { get; }

Property Value

Overrides InlineLayoutBox.IsContainerBox

IsDecimal

Gets a value indicating whether the current SpanLayoutBox represents a decimal number.

Declaration

cs-api-definition

public bool IsDecimal { get; set; }

Property Value

IsParagraphSymbol

Gets a value indicating whether the current layout box represents a paragraph symbol.

Declaration

cs-api-definition

public bool IsParagraphSymbol { get; }

Property Value

IsReadonly

Gets or sets a value indicating whether the layout box is in a read-only state.

Declaration

cs-api-definition

public override bool IsReadonly { get; }

Property Value

Overrides InlineLayoutBox.IsReadonly

IsSplittable

Gets or sets a value indicating whether the span layout box can be split.

Declaration

cs-api-definition

public override bool IsSplittable { get; }

Property Value

true if the span layout box is splitable; otherwise, false.

Overrides InlineLayoutBox.IsSplittable

PositionsCountInBox

Gets the number of positions within the layout box.

Declaration

cs-api-definition

public override int PositionsCountInBox { get; }

Property Value

int

Overrides InlineLayoutBox.PositionsCountInBox

Text

Gets or sets the text content of the SpanLayoutBox.

Declaration

cs-api-definition

public override string Text { get; set; }

Property Value

Overrides InlineLayoutBox.Text

Methods

ContainsFormattingSymbol(string)

Determines whether the specified string contains a formatting symbol.

Declaration

cs-api-definition

public static bool ContainsFormattingSymbol(string text)

Parameters

text

The string to be checked for formatting symbols.

Returns

true if the string contains a formatting symbol; otherwise, false.

CreateLayoutElement()

Creates a layout element from the current span layout box.

Declaration

cs-api-definition

public override LayoutElement CreateLayoutElement()

Returns

LayoutElement

A new layout element that represents the span layout box.

Overrides LayoutBox.CreateLayoutElement()

CreateNewFragment(float, bool)

Creates a new fragment with the specified height and visibility status.

Declaration

cs-api-definition

public override LayoutBox CreateNewFragment(float availableWidth, bool isFirstBoxInLine)

Parameters

availableWidth

float

The available width for the new fragment.

isFirstBoxInLine

A boolean indicating whether this is the first box in the current line

Returns

LayoutBox

A new instance of the LayoutBox class representing the created fragment.

Overrides InlineLayoutBox.CreateNewFragment(float, bool)

CreateSpanLayoutBox(DocumentElement, DocumentStructureCollection, string)

Creates a new instance of SpanLayoutBox for the specified document element using the provided document structure collection and text.

Declaration

cs-api-definition

public static SpanLayoutBox CreateSpanLayoutBox(DocumentElement parentElement, DocumentStructureCollection collection, string text)

Parameters

parentElement

The document element for which the span layout box is being created.

collection

A collection of document structures related to the layout.

text

The text in the current SpanLayoutBox

Returns

SpanLayoutBox

A new instance of SpanLayoutBox representing the layout of the specified document element.

GetPositionHandler()

Gets the position of the layout box.

Declaration

cs-api-definition

public override PositionHandler GetPositionHandler()

Returns

PositionHandler

The position of the layout box as a PositionHandler object.

Overrides InlineLayoutBox.GetPositionHandler()

InvalidateTextMeasure()

Invalidates the text measurement for the current SpanLayoutBox, forcing a recalculation of the text layout measurements the next time they are needed.

Declaration

cs-api-definition

public void InvalidateTextMeasure()

IsWordStart()

Determines whether the current layout box marks the start of a word.

Declaration

cs-api-definition

public bool IsWordStart()

Returns

MeasureOverride(SizeF)

Measures the space required by the LayoutElement Used by the layout system.

Declaration

cs-api-definition

protected override SizeF MeasureOverride(SizeF availableSize)

Parameters

availableSize

SizeF

The size that is available to the LayoutElement. The available size can be infinity (to take the full size of the element)

Returns

SizeF

The minimum size required by the element to be completely visible. Cannot be infinity.

Overrides LayoutElement.MeasureOverride(SizeF)

Remarks

In this method call to the Measure method of each child must be made.

MeasureTextOverride(SubStringPosition)

Declaration

cs-api-definition

protected virtual BoxMeasurementInfo MeasureTextOverride(SubStringPosition subStringPosition = 0)

Parameters

subStringPosition

SubStringPosition

Returns

BoxMeasurementInfo

MergeWithNext(LayoutBox)

Merges the current span layout box with the next layout box if applicable.

Declaration

cs-api-definition

public override void MergeWithNext(LayoutBox nextSpanBox)

Parameters

nextSpanBox

LayoutBox

The layout box to merge with the current span layout box.

Overrides InlineLayoutBox.MergeWithNext(LayoutBox)

OnAssociateDocumentElementChanged()

Declaration

cs-api-definition

protected override void OnAssociateDocumentElementChanged()

Overrides LayoutBox.OnAssociateDocumentElementChanged()

OnPropertyChanged(string)

Declaration

cs-api-definition

protected virtual void OnPropertyChanged(string propName)

Parameters

propName

SplitSpanByIndex(int, bool)

Splits the span at the specified index, creating two separate spans.

Declaration

cs-api-definition

public void SplitSpanByIndex(int splitIndex, bool isBefore)

Parameters

splitIndex

int

The index at which to split the span.

isBefore

A boolean value indicating whether to take the text before or after the index

ToString()

Returns a string representation of the current instance of the SpanLayoutBox.

Declaration

cs-api-definition

public override string ToString()

Returns

A string that represents the current SpanLayoutBox object.

Overrides LayoutBox.ToString()

Update(string)

Updates the span layout box with the specified string value.

Declaration

cs-api-definition

public void Update(string text)

Parameters

text