Table of Contents

Class TextFlow

Namespace
GHIElectronics.Endpoint.UI.Controls
Assembly
GHIElectronics.Endpoint.UI.dll
public class TextFlow : UIElement
Inheritance
TextFlow
Inherited Members

Constructors

TextFlow() 

public TextFlow()

Fields

TextRuns 

public TextRunCollection TextRuns

Field Value

TextRunCollection

Properties

LineCount 

public int LineCount { get; }

Property Value

int

ScrollingStyle 

public ScrollingStyle ScrollingStyle { get; set; }

Property Value

ScrollingStyle

TextAlignment 

public TextAlignment TextAlignment { get; set; }

Property Value

TextAlignment

TopLine 

public int TopLine { get; set; }

Property Value

int

Methods

MeasureOverride(int, int, out int, out int)

Measurement override. Implement your size-to-content logic here.

protected override void MeasureOverride(int availableWidth, int availableHeight, out int desiredWidth, out int desiredHeight)

Parameters

availableWidth int

Available size that parent can give to the child. May be MaxValue(when parent wants to measure to content). This is soft constraint. Child can return bigger size to indicate that it wants bigger space and hope that parent can throw in scrolling...

availableHeight int
desiredWidth int
desiredHeight int

Remarks

MeasureOverride is designed to be the main customizability point for size control of layout. UIElement authors should override this method, call Measure on each child UIElement, and compute their desired size based upon the measurement of the children. The return value should be the desired size.

Note: It is required that a parent UIElement calls Measure on each child or they won't be sized/arranged. Typical override follows a pattern roughly like this (pseudo-code): 
protected override void MeasureOverride(int avialableWidth, int availableHeight, out int desiredWidth, out int desiredHeight)
{
foreach (UIElement child in VisualChildren)
{
child.Measure(availableSize);
availableSize.Deflate(child.DesiredSize);
_cache.StoreInfoAboutChild(child);
}

         Size desired = CalculateBasedOnCache(_cache);
         return desired;
     }</code></pre></example>



The key aspects of this snippet are:

  • You must call Measure on each child UIElement
  • It is common to cache measurement information between the MeasureOverride and ArrangeOverride method calls
  • Calling base.MeasureOverride is not required.
  • Calls to Measure on children are passing either the same availableSize as the parent, or a subset of the area depending
on the type of layout the parent will perform (for example, it would be valid to remove the area
for some border or padding).

OnButtonDown(ButtonEventArgs)

An event reporting a button was pressed.

protected override void OnButtonDown(ButtonEventArgs e)

Parameters

e ButtonEventArgs

OnRender(DrawingContext) 

public override void OnRender(DrawingContext dc)

Parameters

dc DrawingContext
Edit this page