TextPresenter Class
Definition
public class TextPresenter
Constructors
| Name | Description |
|---|---|
| TextPresenter | No summary available. |
TextPresenter Constructor
public TextPresenter()
Methods
| Name | Description |
|---|---|
| AddHandler (2 overloads) | Adds a handler for the specified routed event. Inherited from Interactive. |
| ApplyStyling | Applies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement. |
| ApplyTemplate | Creates the visual children of the control, if necessary Inherited from Layoutable. |
| Arrange | Arranges the control and its children. Inherited from Layoutable. |
| BeginInit | Inherited from StyledElement. |
| Bind (8 overloads) | Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject. |
| CheckAccess | Returns a value indicating whether the current thread is the UI thread. Inherited from AvaloniaObject. |
| ClearValue (4 overloads) | Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject. |
| CoerceValue | Coerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject. |
| EndInit | Inherited from StyledElement. |
| Equals | Compares two objects using reference equality. Inherited from AvaloniaObject. |
| Focus | Focuses the control. Inherited from InputElement. |
| GetBaseValue | Inherited from AvaloniaObject. |
| GetFlowDirection | Gets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual. |
| GetHashCode | Gets the hash code for the object. Inherited from AvaloniaObject. |
| GetIsHoldingEnabled | Inherited from InputElement. |
| GetIsHoldWithMouseEnabled | Inherited from InputElement. |
| GetNextCharacterHit | No summary available. |
| GetValue (3 overloads) | Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| HideCaret | No summary available. |
| InvalidateArrange | Invalidates the arrangement of the control and queues a new layout pass. Inherited from Layoutable. |
| InvalidateMeasure | Invalidates the measurement of the control and queues a new layout pass. Inherited from Layoutable. |
| InvalidateVisual | Invalidates the visual and queues a repaint. Inherited from Visual. |
| IsAnimating | Checks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject. |
| IsSet | Checks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject. |
| Measure | Carries out a measure of the control. Inherited from Layoutable. |
| MoveCaretHorizontal | No summary available. |
| MoveCaretToPoint | No summary available. |
| MoveCaretToTextPosition | No summary available. |
| MoveCaretVertical | No summary available. |
| RaiseEvent | Raises a routed event. Inherited from Interactive. |
| RemoveHandler (2 overloads) | Removes a handler for the specified routed event. Inherited from Interactive. |
| Render | No summary available. |
| SetCurrentValue (2 overloads) | Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject. |
| SetFlowDirection | Sets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual. |
| SetIsHoldingEnabled | Inherited from InputElement. |
| SetIsHoldWithMouseEnabled | Inherited from InputElement. |
| SetValue (3 overloads) | Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| ShowCaret | No summary available. |
| TryGetResource | Inherited from StyledElement. |
| UpdateLayout | Executes a layout pass. Inherited from Layoutable. |
| VerifyAccess | Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject. |
GetNextCharacterHit Method
public Avalonia.Media.CharacterHit GetNextCharacterHit(Avalonia.Media.TextFormatting.LogicalDirection direction)
Parameters
direction Avalonia.Media.TextFormatting.LogicalDirection
Returns
HideCaret Method
public void HideCaret()
MoveCaretHorizontal Method
public void MoveCaretHorizontal(Avalonia.Media.TextFormatting.LogicalDirection direction)
Parameters
MoveCaretToPoint Method
public void MoveCaretToPoint(Avalonia.Point point)
Parameters
point Avalonia.Point
MoveCaretToTextPosition Method
public void MoveCaretToTextPosition(int textPosition, bool trailingEdge)
Parameters
textPosition int
trailingEdge bool
MoveCaretVertical Method
public void MoveCaretVertical(Avalonia.Media.TextFormatting.LogicalDirection direction)
Parameters
Render Method
public void Render(Avalonia.Media.DrawingContext context)
Parameters
context Avalonia.Media.DrawingContext
ShowCaret Method
public void ShowCaret()
Properties
| Name | Description |
|---|---|
| ActualThemeVariant | Gets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. Inherited from StyledElement. |
| Background | Gets or sets a brush used to paint the control's background. |
| Bounds | Gets the bounds of the control relative to its parent. Inherited from Visual. |
| CacheMode | Gets or sets the cache mode of the visual. Inherited from Visual. |
| CaretBlinkInterval | Gets or sets the caret blink rate |
| CaretBrush | No summary available. |
| CaretIndex | No summary available. |
| Classes | Gets or sets the styled element's classes. Inherited from StyledElement. |
| Clip | Gets or sets the geometry clip for this visual. Inherited from Visual. |
| ClipToBounds | Gets or sets a value indicating whether the control should be clipped to its bounds. Inherited from Visual. |
| ContextFlyout | Gets or sets a context flyout to the control Inherited from Control. |
| ContextMenu | Gets or sets a context menu to the control. Inherited from Control. |
| Cursor | Gets or sets associated mouse cursor. Inherited from InputElement. |
| DataContext | Gets or sets the control's data context. Inherited from StyledElement. |
| DataTemplates | Gets or sets the data templates for the control. Inherited from Control. |
| DesiredSize | Gets the size that this element computed during the measure pass of the layout process. Inherited from Layoutable. |
| Dispatcher | Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject. |
| Effect | Gets or sets the effect of the control. Inherited from Visual. |
| FlowDirection | Gets or sets the text flow direction. Inherited from Visual. |
| Focusable | Gets or sets a value indicating whether the control can receive focus. Inherited from InputElement. |
| FocusAdorner | Gets or sets the control's focus adorner. Inherited from Control. |
| FontFamily | Gets or sets the font family. |
| FontFeatures | Gets or sets the font family. |
| FontSize | Gets or sets the font size. |
| FontStretch | Gets or sets the font stretch. |
| FontStyle | Gets or sets the font style. |
| FontWeight | Gets or sets the font weight. |
| Foreground | Gets or sets a brush used to paint the text. |
| GestureRecognizers | Inherited from InputElement. |
| HasMirrorTransform | Gets or sets a value indicating whether to apply mirror transform on this control. Inherited from Visual. |
| Height | Gets or sets the height of the element. Inherited from Layoutable. |
| HorizontalAlignment | Gets or sets the element's preferred horizontal alignment in its parent. Inherited from Layoutable. |
| IsArrangeValid | Gets a value indicating whether the control's layouts arrange is valid. Inherited from Layoutable. |
| IsEffectivelyEnabled | Gets a value indicating whether this control and all its parents are enabled. Inherited from InputElement. |
| IsEffectivelyVisible | Gets a value indicating whether this control and all its parents are visible. Inherited from Visual. |
| IsEnabled | Gets or sets a value indicating whether the control is enabled for user interaction. Inherited from InputElement. |
| IsFocused | Gets a value indicating whether the control is focused. Inherited from InputElement. |
| IsHitTestVisible | Gets or sets a value indicating whether the control is considered for hit testing. Inherited from InputElement. |
| IsInitialized | Gets a value that indicates whether the element has finished initialization. Inherited from StyledElement. |
| IsKeyboardFocusWithin | Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. Inherited from InputElement. |
| IsLoaded | Gets a value indicating whether the control is fully constructed in the visual tree and both layout and render are complete. Inherited from Control. |
| IsMeasureValid | Gets a value indicating whether the control's layout measure is valid. Inherited from Layoutable. |
| IsPointerOver | Gets a value indicating whether the pointer is currently over the control. Inherited from InputElement. |
| IsTabStop | Gets or sets a value that indicates whether the control is included in tab navigation. Inherited from InputElement. |
| IsVisible | Gets or sets a value indicating whether this control is visible. Inherited from Visual. |
| Item | Inherited from AvaloniaObject. |
| KeyBindings | Inherited from InputElement. |
| LetterSpacing | Gets or sets the letter spacing. |
| LineHeight | Gets or sets the line height. By default, this is set to double.NaN, which determines the appropriate height automatically. |
| Margin | Gets or sets the margin around the element. Inherited from Layoutable. |
| MaxHeight | Gets or sets the maximum height of the element. Inherited from Layoutable. |
| MaxWidth | Gets or sets the maximum width of the element. Inherited from Layoutable. |
| MinHeight | Gets or sets the minimum height of the element. Inherited from Layoutable. |
| MinWidth | Gets or sets the minimum width of the element. Inherited from Layoutable. |
| Name | Gets or sets the name of the styled element. Inherited from StyledElement. |
| Opacity | Gets or sets the opacity of the control. Inherited from Visual. |
| OpacityMask | Gets or sets the opacity mask of the control. Inherited from Visual. |
| Parent | Gets the styled element's logical parent. Inherited from StyledElement. |
| PasswordChar | No summary available. |
| PreeditText | No summary available. |
| PreeditTextCursorPosition | No summary available. |
| RenderTransform | Gets or sets the render transform of the control. Inherited from Visual. |
| RenderTransformOrigin | Gets or sets the transform origin of the control. Inherited from Visual. |
| Resources | Gets or sets the styled element's resource dictionary. Inherited from StyledElement. |
| RevealPassword | No summary available. |
| SelectionBrush | No summary available. |
| SelectionEnd | No summary available. |
| SelectionForegroundBrush | No summary available. |
| SelectionStart | No summary available. |
| ShowSelectionHighlight | Gets or sets a value that determines whether the TextPresenter shows a selection highlight. |
| StyleKey | Gets the type by which the element is styled. Inherited from StyledElement. |
| Styles | Gets the styles for the styled element. Inherited from StyledElement. |
| TabIndex | Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by pressing the Tab key. Inherited from InputElement. |
| Tag | Gets or sets a user-defined object attached to the control. Inherited from Control. |
| TemplatedParent | Gets the styled element whose lookless template this styled element is part of. Inherited from StyledElement. |
| Text | Gets or sets the text. |
| TextAlignment | Gets or sets the text alignment. |
| TextLayout | Gets the Avalonia.Controls.Presenters.TextPresenter.TextLayout used to render the text. |
| TextWrapping | Gets or sets the control's text wrapping mode. |
| Theme | Gets or sets the theme to be applied to the element. Inherited from StyledElement. |
| Transitions | Gets or sets the property transitions for the control. Inherited from Animatable. |
| UseLayoutRounding | Gets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time. Inherited from Layoutable. |
| VerticalAlignment | Gets or sets the element's preferred vertical alignment in its parent. Inherited from Layoutable. |
| Width | Gets or sets the width of the element. Inherited from Layoutable. |
| ZIndex | Gets or sets the Z index of the control. Inherited from Visual. |
Background Property
Gets or sets a brush used to paint the control's background.
public Avalonia.Media.IBrush Background { get; set; }
CaretBlinkInterval Property
Gets or sets the caret blink rate
public TimeSpan CaretBlinkInterval { get; set; }
CaretBrush Property
public Avalonia.Media.IBrush CaretBrush { get; set; }
CaretIndex Property
public int CaretIndex { get; set; }
FontFamily Property
Gets or sets the font family.
public Avalonia.Media.FontFamily FontFamily { get; set; }
FontFeatures Property
Gets or sets the font family.
public Avalonia.Media.FontFeatureCollection FontFeatures { get; set; }
FontSize Property
Gets or sets the font size.
public double FontSize { get; set; }
FontStretch Property
Gets or sets the font stretch.
public Avalonia.Media.FontStretch FontStretch { get; set; }
FontStyle Property
Gets or sets the font style.
public Avalonia.Media.FontStyle FontStyle { get; set; }
FontWeight Property
Gets or sets the font weight.
public Avalonia.Media.FontWeight FontWeight { get; set; }
Foreground Property
Gets or sets a brush used to paint the text.
public Avalonia.Media.IBrush Foreground { get; set; }
LetterSpacing Property
Gets or sets the letter spacing.
public double LetterSpacing { get; set; }
LineHeight Property
Gets or sets the line height. By default, this is set to double.NaN, which determines the appropriate height automatically.
public double LineHeight { get; set; }
PasswordChar Property
public char PasswordChar { get; set; }
PreeditText Property
public string PreeditText { get; set; }
PreeditTextCursorPosition Property
public Nullable<int> PreeditTextCursorPosition { get; set; }
RevealPassword Property
public bool RevealPassword { get; set; }
SelectionBrush Property
public Avalonia.Media.IBrush SelectionBrush { get; set; }
SelectionEnd Property
public int SelectionEnd { get; set; }
SelectionForegroundBrush Property
public Avalonia.Media.IBrush SelectionForegroundBrush { get; set; }
SelectionStart Property
public int SelectionStart { get; set; }
ShowSelectionHighlight Property
Gets or sets a value that determines whether the TextPresenter shows a selection highlight.
public bool ShowSelectionHighlight { get; set; }
Text Property
Gets or sets the text.
public string Text { get; set; }
TextAlignment Property
Gets or sets the text alignment.
public Avalonia.Media.TextAlignment TextAlignment { get; set; }
TextLayout Property
Gets the Avalonia.Controls.Presenters.TextPresenter.TextLayout used to render the text.
public Avalonia.Media.TextFormatting.TextLayout TextLayout { get; set; }
TextWrapping Property
Gets or sets the control's text wrapping mode.
public Avalonia.Media.TextWrapping TextWrapping { get; set; }
Fields
BackgroundProperty Field
Defines the Avalonia.Controls.Presenters.TextPresenter.Background property.
public Avalonia.StyledProperty<Avalonia.Media.IBrush> BackgroundProperty
CaretBlinkIntervalProperty Field
public Avalonia.StyledProperty<TimeSpan> CaretBlinkIntervalProperty
CaretBrushProperty Field
public Avalonia.StyledProperty<Avalonia.Media.IBrush> CaretBrushProperty
CaretIndexProperty Field
public Avalonia.StyledProperty<int> CaretIndexProperty
LetterSpacingProperty Field
Defines the Avalonia.Controls.Presenters.TextPresenter.LetterSpacing property.
public Avalonia.StyledProperty<double> LetterSpacingProperty
LineHeightProperty Field
Defines the Avalonia.Controls.Presenters.TextPresenter.LineHeight property.
public Avalonia.StyledProperty<double> LineHeightProperty
PasswordCharProperty Field
public Avalonia.StyledProperty<char> PasswordCharProperty
PreeditTextCursorPositionProperty Field
Defines the Avalonia.Controls.Presenters.TextPresenter.PreeditText property.
public Avalonia.StyledProperty<Nullable<int>> PreeditTextCursorPositionProperty
PreeditTextProperty Field
Defines the Avalonia.Controls.Presenters.TextPresenter.PreeditText property.
public Avalonia.StyledProperty<string> PreeditTextProperty
RevealPasswordProperty Field
public Avalonia.StyledProperty<bool> RevealPasswordProperty
SelectionBrushProperty Field
public Avalonia.StyledProperty<Avalonia.Media.IBrush> SelectionBrushProperty
SelectionEndProperty Field
public Avalonia.StyledProperty<int> SelectionEndProperty
SelectionForegroundBrushProperty Field
public Avalonia.StyledProperty<Avalonia.Media.IBrush> SelectionForegroundBrushProperty
SelectionStartProperty Field
public Avalonia.StyledProperty<int> SelectionStartProperty
ShowSelectionHighlightProperty Field
public Avalonia.StyledProperty<bool> ShowSelectionHighlightProperty
TextAlignmentProperty Field
Defines the Avalonia.Controls.Presenters.TextPresenter.TextAlignment property.
public Avalonia.StyledProperty<Avalonia.Media.TextAlignment> TextAlignmentProperty
TextProperty Field
Defines the Avalonia.Controls.Presenters.TextPresenter.Text property.
public Avalonia.StyledProperty<string> TextProperty
TextWrappingProperty Field
Defines the Avalonia.Controls.Presenters.TextPresenter.TextWrapping property.
public Avalonia.StyledProperty<Avalonia.Media.TextWrapping> TextWrappingProperty
Events
| Name | Description |
|---|---|
| ActualThemeVariantChanged | Raised when the theme variant is changed on the element or an ancestor of the element. Inherited from StyledElement. |
| AttachedToLogicalTree | Raised when the styled element is attached to a rooted logical tree. Inherited from StyledElement. |
| AttachedToVisualTree | Raised when the control is attached to a rooted visual tree. Inherited from Visual. |
| CaretBoundsChanged | No summary available. |
| ContextCanceled | Occurs when the context input gesture continues into another gesture, to notify the element that the context flyout should not be opened. Inherited from InputElement. |
| ContextRequested | Occurs when the user has completed a context input gesture, such as a right-click. Inherited from InputElement. |
| DataContextChanged | Occurs when the Avalonia.StyledElement.DataContext property changes. Inherited from StyledElement. |
| DetachedFromLogicalTree | Raised when the styled element is detached from a rooted logical tree. Inherited from StyledElement. |
| DetachedFromVisualTree | Raised when the control is detached from a rooted visual tree. Inherited from Visual. |
| DoubleTapped | Occurs when the user briefly contacts and releases twice on a single point, without significant movement. Inherited from InputElement. |
| EffectiveViewportChanged | Occurs when the element's effective viewport changes. Inherited from Layoutable. |
| GettingFocus | Occurs before the control receives focus. Inherited from InputElement. |
| GotFocus | Occurs when the control receives focus. Inherited from InputElement. |
| Holding | Occurs when the user makes a single contact, then maintains contact beyond a given time threshold without releasing or making another contact. Inherited from InputElement. |
| Initialized | Occurs when the styled element has finished initialization. Inherited from StyledElement. |
| KeyDown | Occurs when a key is pressed while the control has focus. Inherited from InputElement. |
| KeyUp | Occurs when a key is released while the control has focus. Inherited from InputElement. |
| LayoutUpdated | Occurs when a layout pass completes for the control. Inherited from Layoutable. |
| Loaded | Occurs when the control has been fully constructed in the visual tree and both layout and render are complete. Inherited from Control. |
| LosingFocus | Occurs before the control loses focus. Inherited from InputElement. |
| LostFocus | Occurs when the control loses focus. Inherited from InputElement. |
| Pinch | Occurs when the user moves two contact points closer together. Inherited from InputElement. |
| PinchEnded | Occurs when the user releases both contact points used in a pinch gesture. Inherited from InputElement. |
| PointerCaptureLost | Occurs when the control or its child control loses the pointer capture for any reason, event will not be triggered for a parent control if capture was transferred to another child of that parent control. Inherited from InputElement. |
| PointerEntered | Occurs when the pointer enters the control. Inherited from InputElement. |
| PointerExited | Occurs when the pointer leaves the control. Inherited from InputElement. |
| PointerMoved | Occurs when the pointer moves over the control. Inherited from InputElement. |
| PointerPressed | Occurs when the pointer is pressed over the control. Inherited from InputElement. |
| PointerReleased | Occurs when the pointer is released over the control. Inherited from InputElement. |
| PointerTouchPadGestureMagnify | Occurs when the user moves two contact points away from each other on a touchpad. Inherited from InputElement. |
| PointerTouchPadGestureRotate | Occurs when the user places two contact points and moves them in a circular motion on a touchpad. Inherited from InputElement. |
| PointerTouchPadGestureSwipe | Occurs when the user performs a rapid dragging motion in a single direction on a touchpad. Inherited from InputElement. |
| PointerWheelChanged | Occurs when the mouse is scrolled over the control. Inherited from InputElement. |
| PropertyChanged | Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject. |
| PullGesture | Occurs when the user drags from the edge of a control. Inherited from InputElement. |
| PullGestureEnded | Occurs when the user releases the pointer after a pull gesture. Inherited from InputElement. |
| ResourcesChanged | Occurs when a resource in this styled element or a parent styled element has changed. Inherited from StyledElement. |
| RightTapped | Occurs when the user briefly contacts and releases a single point, without significant movement, using a mechanism on the input device recognized as a right button or equivalent. Inherited from InputElement. |
| ScrollGesture | Occurs when the user continuously moves the pointer in the same direction within the control’s boundaries. Inherited from InputElement. |
| ScrollGestureEnded | Occurs when a scroll gesture has fully stopped, taking into account any inertial movement that continues the scroll after the user has released the pointer. Inherited from InputElement. |
| ScrollGestureInertiaStarting | Occurs within a scroll gesture, when the user releases the pointer, and scrolling continues by transitioning to momentum-based gliding movement. Inherited from InputElement. |
| SizeChanged | Occurs when the bounds (actual size) of the control have changed. Inherited from Control. |
| SwipeGesture | Occurs when the user rapidly drags the pointer in a single direction across the control. Inherited from InputElement. |
| SwipeGestureEnded | Occurs when a swipe gesture ends on the control. Inherited from InputElement. |
| Tapped | Occurs when the user briefly contacts and releases a single point, without significant movement. Inherited from InputElement. |
| TextInput | Occurs when a user typed some text while the control has focus. Inherited from InputElement. |
| TextInputMethodClientRequested | Occurs when an input element gains input focus and input method is looking for the corresponding client Inherited from InputElement. |
| Unloaded | Occurs when the control is removed from the visual tree. Inherited from Control. |
CaretBoundsChanged Event
public event EventHandler CaretBoundsChanged