Skip to main content

PagedTextView Class

Definition​

Assembly:Avalonia.Controls.Documents
Package:Avalonia.Controls.Documents

A text view that lays the document out as discrete pages (Word's print layout): blocks fill page bands until the page content height is reached or a page break forces a new page, page sheets render behind the content, and the placement seams of Avalonia.Controls.Documents.Primitives.TextViewBase are answered from a break table so the anchored virtualization, extent, and scrollbar projections work unchanged.

public class PagedTextView

Remarks​

Pagination is sequential (a block's page depends on every height before it), so the break table is filled by an idle-time dispatcher pass that measures blocks at the page content width — realized blocks reuse their measurement, others are measured through a transient node and recycled immediately. Avalonia.Controls.Documents.Primitives.PagedTextView.PageCount grows while the pass runs; blocks beyond the table lay out packed until it catches up.

V1 places whole blocks: a block taller than the remaining page moves to the next page, and a block taller than a full page overflows its own page. Splitting blocks across pages (paragraph lines, table rows) is the fragmentation stage of the paged layout plan.

Constructors​

NameDescription
PagedTextViewNo summary available.

PagedTextView Constructor​

public PagedTextView()

Methods​

NameDescription
AddHandler (2 overloads)Adds a handler for the specified routed event. Inherited from Interactive.
ApplyStylingApplies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement.
ApplyTemplateCreates the visual children of the control, if necessary Inherited from TemplatedControl.
ArrangeArranges the control and its children. Inherited from Layoutable.
BeginInitInherited from StyledElement.
Bind (8 overloads)Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject.
BringPageIntoViewScrolls to the given 1-based page, landing the viewport one Avalonia.Controls.Documents.Primitives.PagedTextView.PageGap above the page sheet so the sheet shows whole: its top edge, top margin, and then the content — not the content flush at the viewport top.
CheckAccessReturns 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.
CoerceValueCoerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject.
EndInitInherited from StyledElement.
EnsurePositionVisibleEnsures the block containing position is in the viewport. After the next layout pass the block will be realized and Avalonia.Controls.Documents.Primitives.TextViewBase.GetRectangleFromTextPosition(Avalonia.Controls.Documents.TextModel.TextPointer,Avalonia.Controls.Documents.TextModel.LogicalDirection) will return a valid rect. Inherited from TextViewBase.
EqualsCompares two objects using reference equality. Inherited from AvaloniaObject.
FocusFocuses the control. Inherited from InputElement.
GetBaseValueInherited from AvaloniaObject.
GetFlowDirectionGets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual.
GetHashCodeGets the hash code for the object. Inherited from AvaloniaObject.
GetIsHoldingEnabledInherited from InputElement.
GetIsHoldWithMouseEnabledInherited from InputElement.
GetIsTemplateFocusTargetGets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl.
GetLineFromPositionGets the line containing the specified position. Inherited from TextViewBase.
GetNextLineGets the next line after the specified line. Inherited from TextViewBase.
GetPageContextGets the page context of a control.
GetPositionAtLineEndGets the position at the end of the line containing the specified position. Inherited from TextViewBase.
GetPositionAtLineStartGets the position at the start of the line containing the specified position. Inherited from TextViewBase.
GetPositionAtLineXReturns the text position on line closest to the specified X coordinate. The result is guaranteed to stay on line; it never crosses into a neighbouring line or block, regardless of how far x lies outside the line's horizontal bounds. Inherited from TextViewBase.
GetPreviousLineGets the previous line before the specified line. Inherited from TextViewBase.
GetRectangleFromTextPositionGets the bounding rectangle for a character at the specified position. Inherited from TextViewBase.
GetTextPositionFromPointGets the text position from a screen point. Inherited from TextViewBase.
GetValue (3 overloads)Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
GetVisibleLineAtOrAfterGets the first visible line at or after the specified position. Inherited from TextViewBase.
InvalidateArrangeInvalidates the arrangement of the control and queues a new layout pass. Inherited from Layoutable.
InvalidateMeasureInvalidates the measurement of the control and queues a new layout pass. Inherited from Layoutable.
InvalidateVisualInvalidates the visual and queues a repaint. Inherited from Visual.
IsAnimatingChecks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject.
IsSetChecks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject.
MeasureCarries out a measure of the control. Inherited from Layoutable.
RaiseEventRaises a routed event. Inherited from Interactive.
RemoveHandler (2 overloads)Removes a handler for the specified routed event. Inherited from Interactive.
RenderRenders the visual to a Avalonia.Media.DrawingContext.
SetCurrentValue (2 overloads)Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject.
SetFlowDirectionSets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual.
SetIsHoldingEnabledInherited from InputElement.
SetIsHoldWithMouseEnabledInherited from InputElement.
SetIsTemplateFocusTargetSets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl.
SetPageContextNo summary available.
SetValue (3 overloads)Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
TryGetResourceInherited from StyledElement.
UpdateLayoutExecutes a layout pass. Inherited from Layoutable.
VerifyAccessChecks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject.

BringPageIntoView Method​

Scrolls to the given 1-based page, landing the viewport one Avalonia.Controls.Documents.Primitives.PagedTextView.PageGap above the page sheet so the sheet shows whole: its top edge, top margin, and then the content — not the content flush at the viewport top.

public void BringPageIntoView(int pageNumber)

Parameters​

pageNumber int

GetPageContext Method​

Gets the page context of a control.

public Nullable<Avalonia.Controls.Documents.Primitives.PageContext> GetPageContext(Avalonia.Controls.Control control)

Parameters​

control Avalonia.Controls.Control

Returns​

Nullable<Avalonia.Controls.Documents.Primitives.PageContext>

Render Method​

Renders the visual to a Avalonia.Media.DrawingContext.

public void Render(Avalonia.Media.DrawingContext context)

Parameters​

context Avalonia.Media.DrawingContext

The drawing context.

SetPageContext Method​

public void SetPageContext(Avalonia.Controls.Control control, Nullable<Avalonia.Controls.Documents.Primitives.PageContext> value)

Parameters​

control Avalonia.Controls.Control

value Nullable<Avalonia.Controls.Documents.Primitives.PageContext>

Properties​

NameDescription
ActualThemeVariantGets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. Inherited from StyledElement.
AdornerLayerGets the unified adorner layer discovered from the template, or null if the template has not been applied yet. Inherited from InteractiveTextView.
BackgroundGets or sets the brush used to draw the control's background. Inherited from TemplatedControl.
BackgroundSizingGets or sets how the control's background is drawn relative to the control's border. Inherited from TemplatedControl.
BorderBrushGets or sets the brush used to draw the control's border. Inherited from TemplatedControl.
BorderThicknessGets or sets the thickness of the control's border. Inherited from TemplatedControl.
BoundsGets the bounds of the control relative to its parent. Inherited from Visual.
CacheModeGets or sets the cache mode of the visual. Inherited from Visual.
CaretBrushGets or sets the brush used to paint the caret. Inherited from InteractiveTextView.
CaretElementGets the caret element discovered from the template, or null if the template has not been applied yet. Inherited from InteractiveTextView.
ClassesGets or sets the styled element's classes. Inherited from StyledElement.
ClipGets or sets the geometry clip for this visual. Inherited from Visual.
ClipToBoundsGets or sets a value indicating whether the control should be clipped to its bounds. Inherited from Visual.
ContextFlyoutGets or sets a context flyout to the control Inherited from Control.
ContextMenuGets or sets a context menu to the control. Inherited from Control.
CornerRadiusGets or sets the radius of the border rounded corners. Inherited from TemplatedControl.
CurrentPageNumberGets the 1-based page number at the viewport center.
CursorGets or sets associated mouse cursor. Inherited from InputElement.
DataContextGets or sets the control's data context. Inherited from StyledElement.
DataTemplatesGets or sets the data templates for the control. Inherited from Control.
DesiredSizeGets the size that this element computed during the measure pass of the layout process. Inherited from Layoutable.
DispatcherReturns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject.
DocumentGets or sets the document to display, or when the view has none. A view with no document renders empty and reports an empty extent. Inherited from TextViewBase.
EffectGets or sets the effect of the control. Inherited from Visual.
EffectiveZoomGets the zoom factor currently in effect: Avalonia.Controls.Documents.Primitives.PagedTextView.Zoom clamped, or the fit-derived factor when Avalonia.Controls.Documents.Primitives.PagedTextView.ZoomMode tracks the viewport.
FlowDirectionGets or sets the text flow direction. Inherited from Visual.
FocusableGets or sets a value indicating whether the control can receive focus. Inherited from InputElement.
FocusAdornerGets or sets the control's focus adorner. Inherited from Control.
FontFamilyGets or sets the font family used to draw the control's text. Inherited from TemplatedControl.
FontFeaturesGets or sets the font features turned on/off. Inherited from TemplatedControl.
FontSizeGets or sets the size of the control's text in points. Inherited from TemplatedControl.
FontStretchGets or sets the font stretch used to draw the control's text. Inherited from TemplatedControl.
FontStyleGets or sets the font style used to draw the control's text. Inherited from TemplatedControl.
FontWeightGets or sets the font weight used to draw the control's text. Inherited from TemplatedControl.
ForegroundGets or sets the brush used to draw the control's text and other foreground elements. Inherited from TemplatedControl.
GestureRecognizersInherited from InputElement.
HasMirrorTransformGets or sets a value indicating whether to apply mirror transform on this control. Inherited from Visual.
HeightGets or sets the height of the element. Inherited from Layoutable.
HorizontalAlignmentGets or sets the element's preferred horizontal alignment in its parent. Inherited from Layoutable.
IsArrangeValidGets a value indicating whether the control's layouts arrange is valid. Inherited from Layoutable.
IsEffectivelyEnabledGets a value indicating whether this control and all its parents are enabled. Inherited from InputElement.
IsEffectivelyVisibleGets a value indicating whether this control and all its parents are visible. Inherited from Visual.
IsEnabledGets or sets a value indicating whether the control is enabled for user interaction. Inherited from InputElement.
IsFocusedGets a value indicating whether the control is focused. Inherited from InputElement.
IsHitTestVisibleGets or sets a value indicating whether the control is considered for hit testing. Inherited from InputElement.
IsInitializedGets a value that indicates whether the element has finished initialization. Inherited from StyledElement.
IsKeyboardFocusWithinGets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. Inherited from InputElement.
IsLoadedGets a value indicating whether the control is fully constructed in the visual tree and both layout and render are complete. Inherited from Control.
IsMeasureValidGets a value indicating whether the control's layout measure is valid. Inherited from Layoutable.
IsPaginationCompleteGets whether the break table covers the whole document.
IsPointerOverGets a value indicating whether the pointer is currently over the control. Inherited from InputElement.
IsTabStopGets or sets a value that indicates whether the control is included in tab navigation. Inherited from InputElement.
IsVisibleGets or sets a value indicating whether this control is visible. Inherited from Visual.
ItemInherited from AvaloniaObject.
KeyBindingsInherited from InputElement.
LetterSpacingGets or sets the letter spacing for the control's text content. Inherited from TemplatedControl.
MarginGets or sets the margin around the element. Inherited from Layoutable.
MaxHeightGets or sets the maximum height of the element. Inherited from Layoutable.
MaxWidthGets or sets the maximum width of the element. Inherited from Layoutable.
MaxZoomGets or sets the largest allowed effective zoom factor.
MinHeightGets or sets the minimum height of the element. Inherited from Layoutable.
MinWidthGets or sets the minimum width of the element. Inherited from Layoutable.
MinZoomGets or sets the smallest allowed effective zoom factor.
NameGets or sets the name of the styled element. Inherited from StyledElement.
OpacityGets or sets the opacity of the control. Inherited from Visual.
OpacityMaskGets or sets the opacity mask of the control. Inherited from Visual.
PaddingGets or sets the padding placed between the border of the control and its content. Inherited from TemplatedControl.
PageBackgroundGets or sets the brush the page sheets are filled with.
PageBandDistanceGets or sets the distance from the sheet edge to a page band: the header's top sits this far below the sheet top, the footer's bottom this far above the sheet bottom (Word's header/footer distance). A band is clipped to the margin area.
PageBorderBrushGets or sets the brush the page sheet borders are drawn with.
PageBoundsBrushGets or sets the brush used to render page boundary indicators. Defaults to a faint gray when null. Inherited from TextViewBase.
PageBreakMarkerBrushGets or sets the brush of the dashed marker drawn across the top edge of a block with Avalonia.Controls.Documents.Block.BreakPageBefore, Word draft-view style. Paint only - the rule never affects layout. Whether markers show at all is Avalonia.Controls.Documents.Primitives.TextViewBase.ShowPageBreakMarkers; a null brush falls back to the theme's. Inherited from TextViewBase.
PageCountGets the number of pages paginated so far. Grows while background pagination runs; final once Avalonia.Controls.Documents.Primitives.PagedTextView.IsPaginationComplete is true.
PageGapGets or sets the vertical gap between page sheets. The same gap surrounds the sheet stack: above the first sheet and below the last.
PageMarginsGets or sets the page margins. When null, the document's page padding is used, falling back to 2 cm on every side.
PagePaddingGets the document-level page padding, synchronised from the current Avalonia.Controls.Documents.FlowDocument.PagePadding. Inherited from TextViewBase.
PageSizeGets or sets the page size in device-independent pixels. When null, the document's fixed page dimensions are used, falling back to A4 per dimension.
ParentGets the styled element's logical parent. Inherited from StyledElement.
RenderTransformGets or sets the render transform of the control. Inherited from Visual.
RenderTransformOriginGets or sets the transform origin of the control. Inherited from Visual.
RequestedThemeVariantGets or sets the UI theme variant used by this text view and all document content rendered inside it. Setting this to Avalonia.Styling.ThemeVariant.Light prevents dark-theme resources from affecting the document rendering while the surrounding chrome (scrollbars, toolbar) continues to follow the application theme. Inherited from TextViewBase.
ResourcesGets or sets the styled element's resource dictionary. Inherited from StyledElement.
ShowPageBandsInContinuousLayoutGets or sets whether the continuous flow shows the document's running header above the first block and its running footer below the last, as nested-document containers of this view (the same nodes the sheets show in page layout, realized while their edge of the flow is on screen). First-page and even-page bands and a section's own bands are page concepts and show in page layout only; a page-number field shows its cached result here. A paged view shows the bands on its sheets regardless of this property. Inherited from TextViewBase.
ShowPageBoundsGets or sets whether page boundary indicators are rendered. Draws a subtle page border when Avalonia.Controls.Documents.FlowDocument.PageWidth is fixed and dotted lines at each page padding boundary edge. Inherited from TextViewBase.
ShowPageBreakMarkersGets or sets whether the view reserves the marker band below lines ending with an explicit page break and draws the dashed rule across it. True in the continuous flow, where the break is otherwise invisible; a paged view defaults it to false, because a break manifests as a real page transition there and its paragraph geometry must match the export paginators. Inherited from TextViewBase.
StyleKeyGets the type by which the element is styled. Inherited from StyledElement.
StylesGets the styles for the styled element. Inherited from StyledElement.
TabIndexGets 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.
TagGets or sets a user-defined object attached to the control. Inherited from Control.
TemplateGets or sets the template that defines the control's appearance. Inherited from TemplatedControl.
TemplatedParentGets the styled element whose lookless template this styled element is part of. Inherited from StyledElement.
ThemeGets or sets the theme to be applied to the element. Inherited from StyledElement.
TransitionsGets or sets the property transitions for the control. Inherited from Animatable.
UseLayoutRoundingGets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time. Inherited from Layoutable.
VerticalAlignmentGets or sets the element's preferred vertical alignment in its parent. Inherited from Layoutable.
WidthGets or sets the width of the element. Inherited from Layoutable.
ZIndexGets or sets the Z index of the control. Inherited from Visual.
ZoomGets or sets the zoom factor applied when Avalonia.Controls.Documents.Primitives.PagedTextView.ZoomMode is Avalonia.Controls.PageZoomMode.Custom (1.0 = 100%). Zoom is a pure visual scale on the page sheets: text never re-wraps and pagination is unaffected, so what you see is what prints at every factor. The effective value is clamped to [Avalonia.Controls.Documents.Primitives.PagedTextView.MinZoom, Avalonia.Controls.Documents.Primitives.PagedTextView.MaxZoom].
ZoomModeGets or sets how the zoom factor is resolved: an explicit Avalonia.Controls.Documents.Primitives.PagedTextView.Zoom, or tracking the viewport so a sheet fills its width or fits it whole. Ctrl+wheel zooming switches back to Avalonia.Controls.PageZoomMode.Custom.

CurrentPageNumber Property​

Gets the 1-based page number at the viewport center.

public int CurrentPageNumber { get; set; }

EffectiveZoom Property​

Gets the zoom factor currently in effect: Avalonia.Controls.Documents.Primitives.PagedTextView.Zoom clamped, or the fit-derived factor when Avalonia.Controls.Documents.Primitives.PagedTextView.ZoomMode tracks the viewport.

public double EffectiveZoom { get; set; }

IsPaginationComplete Property​

Gets whether the break table covers the whole document.

public bool IsPaginationComplete { get; set; }

MaxZoom Property​

Gets or sets the largest allowed effective zoom factor.

public double MaxZoom { get; set; }

MinZoom Property​

Gets or sets the smallest allowed effective zoom factor.

public double MinZoom { get; set; }

PageBackground Property​

Gets or sets the brush the page sheets are filled with.

public Avalonia.Media.IBrush PageBackground { get; set; }

PageBandDistance Property​

Gets or sets the distance from the sheet edge to a page band: the header's top sits this far below the sheet top, the footer's bottom this far above the sheet bottom (Word's header/footer distance). A band is clipped to the margin area.

public double PageBandDistance { get; set; }

Remarks​

The value belongs to the document (Avalonia.Controls.Documents.FlowDocument.PageBandDistance) and this property is a handle on it: setting it writes through, and it follows the document when the document's value changes. A band taller than the space it leaves pushes the body down, so the distance decides where pages break and print and PDF export must resolve the same one - a copy kept per view would break the same document on different lines.

PageBorderBrush Property​

Gets or sets the brush the page sheet borders are drawn with.

public Avalonia.Media.IBrush PageBorderBrush { get; set; }

PageCount Property​

Gets the number of pages paginated so far. Grows while background pagination runs; final once Avalonia.Controls.Documents.Primitives.PagedTextView.IsPaginationComplete is true.

public int PageCount { get; set; }

PageGap Property​

Gets or sets the vertical gap between page sheets. The same gap surrounds the sheet stack: above the first sheet and below the last.

public double PageGap { get; set; }

PageMargins Property​

Gets or sets the page margins. When null, the document's page padding is used, falling back to 2 cm on every side.

public Nullable<Avalonia.Thickness> PageMargins { get; set; }

PageSize Property​

Gets or sets the page size in device-independent pixels. When null, the document's fixed page dimensions are used, falling back to A4 per dimension.

public Nullable<Avalonia.Size> PageSize { get; set; }

Zoom Property​

Gets or sets the zoom factor applied when Avalonia.Controls.Documents.Primitives.PagedTextView.ZoomMode is Avalonia.Controls.PageZoomMode.Custom (1.0 = 100%). Zoom is a pure visual scale on the page sheets: text never re-wraps and pagination is unaffected, so what you see is what prints at every factor. The effective value is clamped to [Avalonia.Controls.Documents.Primitives.PagedTextView.MinZoom, Avalonia.Controls.Documents.Primitives.PagedTextView.MaxZoom].

public double Zoom { get; set; }

ZoomMode Property​

Gets or sets how the zoom factor is resolved: an explicit Avalonia.Controls.Documents.Primitives.PagedTextView.Zoom, or tracking the viewport so a sheet fills its width or fits it whole. Ctrl+wheel zooming switches back to Avalonia.Controls.PageZoomMode.Custom.

public Avalonia.Controls.PageZoomMode ZoomMode { get; set; }

Fields​

NameDescription
BackgroundPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.Background property. Inherited from TemplatedControl.
BackgroundSizingPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.BackgroundSizing property. Inherited from TemplatedControl.
BorderBrushPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.BorderBrush property. Inherited from TemplatedControl.
BorderThicknessPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.BorderThickness property. Inherited from TemplatedControl.
BoundsPropertyDefines the Avalonia.Visual.Bounds property. Inherited from Visual.
CacheModePropertyDefines the Avalonia.Visual.CacheMode property. Inherited from Visual.
CaretBrushPropertyDefines the Avalonia.Controls.Documents.Primitives.InteractiveTextView.CaretBrush property. Inherited from InteractiveTextView.
ClipPropertyDefines the Avalonia.Visual.Clip property. Inherited from Visual.
ClipToBoundsPropertyDefines the Avalonia.Visual.ClipToBounds property. Inherited from Visual.
ContextCanceledEventProvides event data for the Avalonia.Input.InputElement.ContextCanceled event. Inherited from InputElement.
ContextFlyoutPropertyDefines the Avalonia.Controls.Control.ContextFlyout property Inherited from Control.
ContextMenuPropertyDefines the Avalonia.Controls.Control.ContextMenu property. Inherited from Control.
ContextRequestedEventProvides event data for the Avalonia.Input.InputElement.ContextRequested event. Inherited from InputElement.
CornerRadiusPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.CornerRadius property. Inherited from TemplatedControl.
CurrentPageNumberPropertyDefines the Avalonia.Controls.Documents.Primitives.PagedTextView.CurrentPageNumber property.
CursorPropertyGets or sets associated mouse cursor. Inherited from InputElement.
DataContextPropertyDefines the Avalonia.StyledElement.DataContext property. Inherited from StyledElement.
DesiredSizePropertyDefines the Avalonia.Layout.Layoutable.DesiredSize property. Inherited from Layoutable.
DocumentPropertyDefines the Avalonia.Controls.Documents.Primitives.TextViewBase.Document property. Inherited from TextViewBase.
DoubleTappedEventDefines the Avalonia.Input.InputElement.DoubleTapped event. Inherited from InputElement.
EffectiveZoomPropertyDefines the Avalonia.Controls.Documents.Primitives.PagedTextView.EffectiveZoom property.
EffectPropertyDefines the Avalonia.Visual.Effect property. Inherited from Visual.
FlowDirectionPropertyDefines the Avalonia.Visual.FlowDirection property. Inherited from Visual.
FocusablePropertyDefines the Avalonia.Input.InputElement.Focusable property. Inherited from InputElement.
FocusAdornerPropertyDefines the Avalonia.Controls.Control.FocusAdorner property. Inherited from Control.
FontFamilyPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontFamily property. Inherited from TemplatedControl.
FontFeaturesPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontFeaturesProperty property. Inherited from TemplatedControl.
FontSizePropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontSize property. Inherited from TemplatedControl.
FontStretchPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontWeight property. Inherited from TemplatedControl.
FontStylePropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontStyle property. Inherited from TemplatedControl.
FontWeightPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.FontWeight property. Inherited from TemplatedControl.
ForegroundPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.Foreground property. Inherited from TemplatedControl.
GettingFocusEventDefines the Avalonia.Input.InputElement.GettingFocus event. Inherited from InputElement.
GotFocusEventDefines the Avalonia.Input.InputElement.GotFocus event. Inherited from InputElement.
HasMirrorTransformPropertyDefines the Avalonia.Visual.HasMirrorTransform property. Inherited from Visual.
HeightPropertyDefines the Avalonia.Layout.Layoutable.Height property. Inherited from Layoutable.
HoldingEventDefines the Avalonia.Input.InputElement.Holding event. Inherited from InputElement.
HorizontalAlignmentPropertyDefines the Avalonia.Layout.Layoutable.HorizontalAlignment property. Inherited from Layoutable.
IsEffectivelyEnabledPropertyDefines the Avalonia.Input.InputElement.IsEffectivelyEnabled property. Inherited from InputElement.
IsEnabledPropertyDefines the Avalonia.Input.InputElement.IsEnabled property. Inherited from InputElement.
IsFocusedPropertyDefines the Avalonia.Input.InputElement.IsFocused property. Inherited from InputElement.
IsHitTestVisiblePropertyDefines the Avalonia.Input.InputElement.IsHitTestVisible property. Inherited from InputElement.
IsHoldingEnabledPropertyDefines the IsHoldingEnabled attached property. Inherited from InputElement.
IsHoldWithMouseEnabledPropertyDefines the IsHoldWithMouseEnabled attached property. Inherited from InputElement.
IsKeyboardFocusWithinPropertyDefines the Avalonia.Input.InputElement.IsKeyboardFocusWithin property. Inherited from InputElement.
IsPaginationCompletePropertyDefines the Avalonia.Controls.Documents.Primitives.PagedTextView.IsPaginationComplete property.
IsPointerOverPropertyDefines the Avalonia.Input.InputElement.IsPointerOver property. Inherited from InputElement.
IsTabStopPropertyDefines the Avalonia.Input.InputElement.IsTabStop property. Inherited from InputElement.
IsTemplateFocusTargetPropertyDefines the IsTemplateFocusTarget attached property. Inherited from TemplatedControl.
IsVisiblePropertyDefines the Avalonia.Visual.IsVisible property. Inherited from Visual.
KeyDownEventDefines the Avalonia.Input.InputElement.KeyDown event. Inherited from InputElement.
KeyUpEventDefines the Avalonia.Input.InputElement.KeyUp event. Inherited from InputElement.
LetterSpacingPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.LetterSpacing property. Inherited from TemplatedControl.
LoadedEventDefines the Avalonia.Controls.Control.Loaded event. Inherited from Control.
LosingFocusEventDefines the Avalonia.Input.InputElement.LosingFocus event. Inherited from InputElement.
LostFocusEventDefines the Avalonia.Input.InputElement.LostFocus event. Inherited from InputElement.
MarginPropertyDefines the Avalonia.Layout.Layoutable.Margin property. Inherited from Layoutable.
MaxHeightPropertyDefines the Avalonia.Layout.Layoutable.MaxHeight property. Inherited from Layoutable.
MaxWidthPropertyDefines the Avalonia.Layout.Layoutable.MaxWidth property. Inherited from Layoutable.
MaxZoomPropertyDefines the Avalonia.Controls.Documents.Primitives.PagedTextView.MaxZoom property.
MinHeightPropertyDefines the Avalonia.Layout.Layoutable.MinHeight property. Inherited from Layoutable.
MinWidthPropertyDefines the Avalonia.Layout.Layoutable.MinWidth property. Inherited from Layoutable.
MinZoomPropertyDefines the Avalonia.Controls.Documents.Primitives.PagedTextView.MinZoom property.
NamePropertyDefines the Avalonia.StyledElement.Name property. Inherited from StyledElement.
OpacityMaskPropertyDefines the Avalonia.Visual.OpacityMask property. Inherited from Visual.
OpacityPropertyDefines the Avalonia.Visual.Opacity property. Inherited from Visual.
PaddingPropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.Padding property. Inherited from TemplatedControl.
PageBackgroundPropertyDefines the Avalonia.Controls.Documents.Primitives.PagedTextView.PageBackground property.
PageBandDistancePropertyDefines the Avalonia.Controls.Documents.Primitives.PagedTextView.PageBandDistance property.
PageBorderBrushPropertyDefines the Avalonia.Controls.Documents.Primitives.PagedTextView.PageBorderBrush property.
PageBoundsBrushPropertyDefines the Avalonia.Controls.Documents.Primitives.TextViewBase.PageBoundsBrush property. Inherited from TextViewBase.
PageBreakMarkerBrushPropertyDefines the Avalonia.Controls.Documents.Primitives.TextViewBase.PageBreakMarkerBrush property. Inherited from TextViewBase.
PageContextPropertyDefines the attached PageContext property: the page a control presents and the page count, inherited into the text views inside it so their page-number fields resolve per page. The page bands on the sheets carry their context on their Avalonia.Controls.Documents.Primitives.DocumentNodes.NestedDocumentNode instead; the property serves an application presenting a view of its own per page.
PageCountPropertyDefines the Avalonia.Controls.Documents.Primitives.PagedTextView.PageCount property.
PageGapPropertyDefines the Avalonia.Controls.Documents.Primitives.PagedTextView.PageGap property.
PageMarginsPropertyDefines the Avalonia.Controls.Documents.Primitives.PagedTextView.PageMargins property.
PagePaddingPropertyDefines the Avalonia.Controls.Documents.Primitives.TextViewBase.PagePadding property. Inherited from TextViewBase.
PageSizePropertyDefines the Avalonia.Controls.Documents.Primitives.PagedTextView.PageSize property.
ParentPropertyDefines the Avalonia.StyledElement.Parent property. Inherited from StyledElement.
PinchEndedEventDefines the Avalonia.Input.InputElement.PinchEnded event. Inherited from InputElement.
PinchEventDefines the Avalonia.Input.InputElement.Pinch event. Inherited from InputElement.
PointerCaptureLostEventDefines the Avalonia.Input.InputElement.PointerCaptureLost routed event. Inherited from InputElement.
PointerEnteredEventDefines the Avalonia.Input.InputElement.PointerEntered event. Inherited from InputElement.
PointerExitedEventDefines the Avalonia.Input.InputElement.PointerExited event. Inherited from InputElement.
PointerMovedEventDefines the Avalonia.Input.InputElement.PointerMoved event. Inherited from InputElement.
PointerPressedEventDefines the Avalonia.Input.InputElement.PointerPressed event. Inherited from InputElement.
PointerReleasedEventDefines the Avalonia.Input.InputElement.PointerReleased event. Inherited from InputElement.
PointerTouchPadGestureMagnifyEventDefines the Avalonia.Input.InputElement.PointerTouchPadGestureMagnify event. Inherited from InputElement.
PointerTouchPadGestureRotateEventDefines the Avalonia.Input.InputElement.PointerTouchPadGestureRotate event. Inherited from InputElement.
PointerTouchPadGestureSwipeEventDefines the Avalonia.Input.InputElement.PointerTouchPadGestureSwipe event. Inherited from InputElement.
PointerWheelChangedEventDefines the Avalonia.Input.InputElement.PointerWheelChanged event. Inherited from InputElement.
PullGestureEndedEventDefines the Avalonia.Input.InputElement.PullGestureEnded event. Inherited from InputElement.
PullGestureEventDefines the Avalonia.Input.InputElement.PullGesture event. Inherited from InputElement.
RenderTransformOriginPropertyDefines the Avalonia.Visual.RenderTransformOrigin property. Inherited from Visual.
RenderTransformPropertyDefines the Avalonia.Visual.RenderTransform property. Inherited from Visual.
RequestBringIntoViewEventEvent raised when an element wishes to be scrolled into view. Inherited from Control.
RequestedThemeVariantPropertyDefines the Avalonia.Controls.Documents.Primitives.TextViewBase.RequestedThemeVariant property. When set to a non-default value the text view acts as a theme boundary, isolating document content from the application theme so that dark-theme resources do not leak into text rendering. Inherited from TextViewBase.
RightTappedEventDefines the Avalonia.Input.InputElement.RightTapped event. Inherited from InputElement.
ScrollGestureEndedEventDefines the Avalonia.Input.InputElement.ScrollGestureEnded event. Inherited from InputElement.
ScrollGestureEventDefines the Avalonia.Input.InputElement.ScrollGesture event. Inherited from InputElement.
ScrollGestureInertiaStartingEventDefines the Avalonia.Input.InputElement.ScrollGestureInertiaStarting event. Inherited from InputElement.
ShowPageBandsInContinuousLayoutPropertyDefines the Avalonia.Controls.Documents.Primitives.TextViewBase.ShowPageBandsInContinuousLayout property. Inherited from TextViewBase.
ShowPageBoundsPropertyDefines the Avalonia.Controls.Documents.Primitives.TextViewBase.ShowPageBounds property. When true, subtle visual indicators are drawn for the page content area. Inherited from TextViewBase.
ShowPageBreakMarkersPropertyDefines the Avalonia.Controls.Documents.Primitives.TextViewBase.ShowPageBreakMarkers property. Inherited from TextViewBase.
SizeChangedEventDefines the Avalonia.Controls.Control.SizeChanged event. Inherited from Control.
SwipeGestureEndedEventDefines the Avalonia.Input.InputElement.SwipeGestureEnded event. Inherited from InputElement.
SwipeGestureEventDefines the Avalonia.Input.InputElement.SwipeGesture event. Inherited from InputElement.
TabIndexPropertyDefines the Avalonia.Input.InputElement.TabIndex property. Inherited from InputElement.
TagPropertyDefines the Avalonia.Controls.Control.Tag property. Inherited from Control.
TappedEventDefines the Avalonia.Input.InputElement.Tapped event. Inherited from InputElement.
TemplateAppliedEventDefines the Avalonia.Controls.Primitives.TemplatedControl.TemplateApplied routed event. Inherited from TemplatedControl.
TemplatedParentPropertyDefines the Avalonia.StyledElement.TemplatedParent property. Inherited from StyledElement.
TemplatePropertyDefines the Avalonia.Controls.Primitives.TemplatedControl.Template property. Inherited from TemplatedControl.
TextInputEventDefines the Avalonia.Input.InputElement.TextInput event. Inherited from InputElement.
TextInputMethodClientRequestedEventDefines the Avalonia.Input.InputElement.TextInputMethodClientRequested event. Inherited from InputElement.
ThemePropertyDefines the Avalonia.StyledElement.Theme property. Inherited from StyledElement.
TransitionsPropertyDefines the Avalonia.Animation.Animatable.Transitions property. Inherited from Animatable.
UnloadedEventDefines the Avalonia.Controls.Control.Unloaded event. Inherited from Control.
UseLayoutRoundingPropertyDefines the Avalonia.Layout.Layoutable.UseLayoutRounding property. Inherited from Layoutable.
VerticalAlignmentPropertyDefines the Avalonia.Layout.Layoutable.VerticalAlignment property. Inherited from Layoutable.
VisualParentPropertyDefines the Avalonia.Visual.VisualParent property. Inherited from Visual.
WidthPropertyDefines the Avalonia.Layout.Layoutable.Width property. Inherited from Layoutable.
ZIndexPropertyDefines the Avalonia.Visual.ZIndex property. Inherited from Visual.
ZoomModePropertyDefines the Avalonia.Controls.Documents.Primitives.PagedTextView.ZoomMode property.
ZoomPropertyDefines the Avalonia.Controls.Documents.Primitives.PagedTextView.Zoom property.

CurrentPageNumberProperty Field​

Defines the Avalonia.Controls.Documents.Primitives.PagedTextView.CurrentPageNumber property.

public Avalonia.DirectProperty<Avalonia.Controls.Documents.Primitives.PagedTextView, int> CurrentPageNumberProperty

EffectiveZoomProperty Field​

Defines the Avalonia.Controls.Documents.Primitives.PagedTextView.EffectiveZoom property.

public Avalonia.DirectProperty<Avalonia.Controls.Documents.Primitives.PagedTextView, double> EffectiveZoomProperty

IsPaginationCompleteProperty Field​

Defines the Avalonia.Controls.Documents.Primitives.PagedTextView.IsPaginationComplete property.

public Avalonia.DirectProperty<Avalonia.Controls.Documents.Primitives.PagedTextView, bool> IsPaginationCompleteProperty

MaxZoomProperty Field​

Defines the Avalonia.Controls.Documents.Primitives.PagedTextView.MaxZoom property.

public Avalonia.StyledProperty<double> MaxZoomProperty

MinZoomProperty Field​

Defines the Avalonia.Controls.Documents.Primitives.PagedTextView.MinZoom property.

public Avalonia.StyledProperty<double> MinZoomProperty

PageBackgroundProperty Field​

Defines the Avalonia.Controls.Documents.Primitives.PagedTextView.PageBackground property.

public Avalonia.StyledProperty<Avalonia.Media.IBrush> PageBackgroundProperty

PageBandDistanceProperty Field​

Defines the Avalonia.Controls.Documents.Primitives.PagedTextView.PageBandDistance property.

public Avalonia.StyledProperty<double> PageBandDistanceProperty

PageBorderBrushProperty Field​

Defines the Avalonia.Controls.Documents.Primitives.PagedTextView.PageBorderBrush property.

public Avalonia.StyledProperty<Avalonia.Media.IBrush> PageBorderBrushProperty

PageContextProperty Field​

Defines the attached PageContext property: the page a control presents and the page count, inherited into the text views inside it so their page-number fields resolve per page. The page bands on the sheets carry their context on their Avalonia.Controls.Documents.Primitives.DocumentNodes.NestedDocumentNode instead; the property serves an application presenting a view of its own per page.

public Avalonia.AttachedProperty<Nullable<Avalonia.Controls.Documents.Primitives.PageContext>> PageContextProperty

PageCountProperty Field​

Defines the Avalonia.Controls.Documents.Primitives.PagedTextView.PageCount property.

public Avalonia.DirectProperty<Avalonia.Controls.Documents.Primitives.PagedTextView, int> PageCountProperty

PageGapProperty Field​

Defines the Avalonia.Controls.Documents.Primitives.PagedTextView.PageGap property.

public Avalonia.StyledProperty<double> PageGapProperty

PageMarginsProperty Field​

Defines the Avalonia.Controls.Documents.Primitives.PagedTextView.PageMargins property.

public Avalonia.StyledProperty<Nullable<Avalonia.Thickness>> PageMarginsProperty

PageSizeProperty Field​

Defines the Avalonia.Controls.Documents.Primitives.PagedTextView.PageSize property.

public Avalonia.StyledProperty<Nullable<Avalonia.Size>> PageSizeProperty

ZoomModeProperty Field​

Defines the Avalonia.Controls.Documents.Primitives.PagedTextView.ZoomMode property.

public Avalonia.StyledProperty<Avalonia.Controls.PageZoomMode> ZoomModeProperty

ZoomProperty Field​

Defines the Avalonia.Controls.Documents.Primitives.PagedTextView.Zoom property.

public Avalonia.StyledProperty<double> ZoomProperty

Events​

NameDescription
ActualThemeVariantChangedRaised when the theme variant is changed on the element or an ancestor of the element. Inherited from StyledElement.
AttachedToLogicalTreeRaised when the styled element is attached to a rooted logical tree. Inherited from StyledElement.
AttachedToVisualTreeRaised when the control is attached to a rooted visual tree. Inherited from Visual.
ContextCanceledOccurs when the context input gesture continues into another gesture, to notify the element that the context flyout should not be opened. Inherited from InputElement.
ContextRequestedOccurs when the user has completed a context input gesture, such as a right-click. Inherited from InputElement.
DataContextChangedOccurs when the Avalonia.StyledElement.DataContext property changes. Inherited from StyledElement.
DetachedFromLogicalTreeRaised when the styled element is detached from a rooted logical tree. Inherited from StyledElement.
DetachedFromVisualTreeRaised when the control is detached from a rooted visual tree. Inherited from Visual.
DoubleTappedOccurs when the user briefly contacts and releases twice on a single point, without significant movement. Inherited from InputElement.
EffectiveViewportChangedOccurs when the element's effective viewport changes. Inherited from Layoutable.
GettingFocusOccurs before the control receives focus. Inherited from InputElement.
GotFocusOccurs when the control receives focus. Inherited from InputElement.
HoldingOccurs when the user makes a single contact, then maintains contact beyond a given time threshold without releasing or making another contact. Inherited from InputElement.
InitializedOccurs when the styled element has finished initialization. Inherited from StyledElement.
KeyDownOccurs when a key is pressed while the control has focus. Inherited from InputElement.
KeyUpOccurs when a key is released while the control has focus. Inherited from InputElement.
LayoutUpdatedOccurs when a layout pass completes for the control. Inherited from Layoutable.
LoadedOccurs when the control has been fully constructed in the visual tree and both layout and render are complete. Inherited from Control.
LosingFocusOccurs before the control loses focus. Inherited from InputElement.
LostFocusOccurs when the control loses focus. Inherited from InputElement.
PinchOccurs when the user moves two contact points closer together. Inherited from InputElement.
PinchEndedOccurs when the user releases both contact points used in a pinch gesture. Inherited from InputElement.
PointerCaptureLostOccurs 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.
PointerEnteredOccurs when the pointer enters the control. Inherited from InputElement.
PointerExitedOccurs when the pointer leaves the control. Inherited from InputElement.
PointerMovedOccurs when the pointer moves over the control. Inherited from InputElement.
PointerPressedOccurs when the pointer is pressed over the control. Inherited from InputElement.
PointerReleasedOccurs when the pointer is released over the control. Inherited from InputElement.
PointerTouchPadGestureMagnifyOccurs when the user moves two contact points away from each other on a touchpad. Inherited from InputElement.
PointerTouchPadGestureRotateOccurs when the user places two contact points and moves them in a circular motion on a touchpad. Inherited from InputElement.
PointerTouchPadGestureSwipeOccurs when the user performs a rapid dragging motion in a single direction on a touchpad. Inherited from InputElement.
PointerWheelChangedOccurs when the mouse is scrolled over the control. Inherited from InputElement.
PropertyChangedRaised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject.
PullGestureOccurs when the user drags from the edge of a control. Inherited from InputElement.
PullGestureEndedOccurs when the user releases the pointer after a pull gesture. Inherited from InputElement.
ResourcesChangedOccurs when a resource in this styled element or a parent styled element has changed. Inherited from StyledElement.
RightTappedOccurs 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.
ScrollGestureOccurs when the user continuously moves the pointer in the same direction within the control’s boundaries. Inherited from InputElement.
ScrollGestureEndedOccurs 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.
ScrollGestureInertiaStartingOccurs within a scroll gesture, when the user releases the pointer, and scrolling continues by transitioning to momentum-based gliding movement. Inherited from InputElement.
SizeChangedOccurs when the bounds (actual size) of the control have changed. Inherited from Control.
SwipeGestureOccurs when the user rapidly drags the pointer in a single direction across the control. Inherited from InputElement.
SwipeGestureEndedOccurs when a swipe gesture ends on the control. Inherited from InputElement.
TappedOccurs when the user briefly contacts and releases a single point, without significant movement. Inherited from InputElement.
TemplateAppliedRaised when the control's template is applied. Inherited from TemplatedControl.
TextInputOccurs when a user typed some text while the control has focus. Inherited from InputElement.
TextInputMethodClientRequestedOccurs when an input element gains input focus and input method is looking for the corresponding client Inherited from InputElement.
UnloadedOccurs when the control is removed from the visual tree. Inherited from Control.