Class
LineBasedUILayer<TTag>

Class LineBasedUILayer represents line based layer abstraction. Implements the TagBasedUILayer<TTag>

Definition

Namespace:Telerik.Windows.Controls.SyntaxEditor.UI.Layers

Assembly:Telerik.Windows.Controls.SyntaxEditor.dll

Type Parameters:

TTag

The type of the t tag.

Syntax:

cs-api-definition
public abstract class LineBasedUILayer<TTag> : TagBasedUILayer<TTag> where TTag : ITag

Inheritance: objectUILayerPooledUILayerTagBasedUILayer<TTag>LineBasedUILayer<TTag>

Derived Classes: TextBorderUILayerTextHighlightUILayerTextToolTipUILayerTextUILayerTextUnderlineUILayer

Inherited Members TagBasedUILayer<TTag>.UpdateUIOverride(UIUpdateContext)TagBasedUILayer<TTag>.TaggerPooledUILayer.AddElementToPool(object)PooledUILayer.CanRecycle(object)PooledUILayer.GetElementFromPool<T>()PooledUILayer.ResetPooledElementProperties(object)UILayer.UpdateUI()UILayer.UpdateUI(UIUpdateContext)UILayer.OnAssociatedEditorChanged(RadSyntaxEditor, RadSyntaxEditor)UILayer.TranslateAndScale(UIUpdateContext)UILayer.ContainerUILayer.NameUILayer.AssociatedEditor

Constructors

LineBasedUILayer()

Initializes a new instance of the LineBasedUILayer<TTag> class.

Declaration

cs-api-definition
protected LineBasedUILayer()

Fields

ElementToSnapshotSpanCache

The UI element to snapshot span cache.

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Design", "CA1051:DoNotDeclareVisibleInstanceFields")]
protected readonly Dictionary<FrameworkElement, TextSnapshotSpan> ElementToSnapshotSpanCache

Field Value

Dictionary<FrameworkElement, TextSnapshotSpan>

Methods

ArrangeLinePartUIElement(FrameworkElement, Span, UIUpdateContext)

Arranges the line part UI element.

Declaration

cs-api-definition
protected virtual void ArrangeLinePartUIElement(FrameworkElement uiElement, Span span, UIUpdateContext updateContext)

Parameters

uiElement

FrameworkElement

The UI element.

span

Span

The span.

updateContext

UIUpdateContext

The update context.

Clear()

Clears this instance.

Declaration

cs-api-definition
public override void Clear()

Overrides PooledUILayer.Clear()

GetLinePartUIElement(TTag, Span, UIUpdateContext)

Gets the line part UI element.

Declaration

cs-api-definition
protected abstract FrameworkElement GetLinePartUIElement(TTag tag, Span span, UIUpdateContext updateContext)

Parameters

tag

TTag

The tag.

span

Span

The span.

updateContext

UIUpdateContext

The update context.

Returns

FrameworkElement

System.Windows.FrameworkElement.

GetLineUIElements(Span, IEnumerable<TagSpan<TTag>>, UIUpdateContext)

Gets the line UI elements.

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Design", "CA1006:DoNotNestGenericTypesInMemberSignatures")]
protected virtual IEnumerable<FrameworkElement> GetLineUIElements(Span currentLineSpan, IEnumerable<TagSpan<TTag>> tags, UIUpdateContext updateContext)

Parameters

currentLineSpan

Span

The current line span.

tags

IEnumerable<TagSpan<TTag>>

The tags.

updateContext

UIUpdateContext

The update context.

Returns

IEnumerable<FrameworkElement>

IEnumerable<FrameworkElement>.

NormalizeByTextFormatDefinitionPriority(Span, IEnumerable<TagSpan<TTag>>, UIUpdateContext)

Normalizes the by text format definition priority.

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Design", "CA1006:DoNotNestGenericTypesInMemberSignatures")]
protected static IEnumerable<TagSpan<TTag>> NormalizeByTextFormatDefinitionPriority(Span currentLineSpan, IEnumerable<TagSpan<TTag>> tags, UIUpdateContext updateContext)

Parameters

currentLineSpan

Span

The current line span.

tags

IEnumerable<TagSpan<TTag>>

The tags.

updateContext

UIUpdateContext

The update context.

Returns

IEnumerable<TagSpan<TTag>>

IEnumerable<TagSpan<TTag>>.

OnTextFormatDefinitionsRegistryChanged()

Called when [text format definitions registry changed].

Declaration

cs-api-definition
protected override void OnTextFormatDefinitionsRegistryChanged()

Overrides TagBasedUILayer<TTag>.OnTextFormatDefinitionsRegistryChanged()

UpdateUIOverride(UIUpdateContext, TextSnapshotSpan)

Updates the UI override.

Declaration

cs-api-definition
protected override void UpdateUIOverride(UIUpdateContext updateContext, TextSnapshotSpan changedSnapshotSpan)

Parameters

updateContext

UIUpdateContext

The update context.

changedSnapshotSpan

TextSnapshotSpan

The changed snapshot span.

Overrides TagBasedUILayer<TTag>.UpdateUIOverride(UIUpdateContext, TextSnapshotSpan)