Skip to main content

ToolbarTargetAreas Enum

Definition​

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

Defines the areas of a document a tool, a menu entry or a block adorner applies to.

public enum ToolbarTargetAreas

Inheritance: Enum -> ToolbarTargetAreas

Fields​

NameDescription
AllThe caret-derived target areas. The released name for Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas.CaretAreas, which reads better beside the areas that are opted into by name.
BlockApplies to block-level elements.
CaretAreasThe caret-derived target areas. Not every flag: a selection-driven area (Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas.TableCells) and the nested-document areas (Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas.PageBand, Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas.Footnote) are opted into by name.
FootnoteA footnote: the caret is in a note's document. Like Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas.PageBand, outside Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas.CaretAreas, so a tool opts in to notes.
ImageApplies to inline image elements.
ListApplies to list elements.
NoneNo target area.
PageBandApplies while the caret is in a page band (a header or footer on a page sheet). A band is text too, so tools targeting the text areas stay available there; deliberately not part of Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas.CaretAreas, so a tool that lists this area alone appears only inside a band.
TableApplies to table elements.
TableCellsApplies while the selection is a set of whole table cells (a table strip selection or a text selection spanning multiple cells). Driven by the selection shape rather than the caret's ancestry, and deliberately not part of Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas.CaretAreas: cell tools opt in explicitly so they appear only for cell selections.
TextApplies to inline text editing regions.

All Field​

The caret-derived target areas. The released name for Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas.CaretAreas, which reads better beside the areas that are opted into by name.

public Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas All

Block Field​

Applies to block-level elements.

public Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas Block

CaretAreas Field​

The caret-derived target areas. Not every flag: a selection-driven area (Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas.TableCells) and the nested-document areas (Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas.PageBand, Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas.Footnote) are opted into by name.

public Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas CaretAreas

Footnote Field​

A footnote: the caret is in a note's document. Like Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas.PageBand, outside Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas.CaretAreas, so a tool opts in to notes.

public Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas Footnote

Image Field​

Applies to inline image elements.

public Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas Image

List Field​

Applies to list elements.

public Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas List

None Field​

No target area.

public Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas None

PageBand Field​

Applies while the caret is in a page band (a header or footer on a page sheet). A band is text too, so tools targeting the text areas stay available there; deliberately not part of Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas.CaretAreas, so a tool that lists this area alone appears only inside a band.

public Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas PageBand

Table Field​

Applies to table elements.

public Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas Table

TableCells Field​

Applies while the selection is a set of whole table cells (a table strip selection or a text selection spanning multiple cells). Driven by the selection shape rather than the caret's ancestry, and deliberately not part of Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas.CaretAreas: cell tools opt in explicitly so they appear only for cell selections.

public Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas TableCells

Text Field​

Applies to inline text editing regions.

public Avalonia.Controls.Documents.Primitives.Adorners.ToolbarTargetAreas Text