Expand description
ferroui-xaml-interactions-custom
The custom behaviors, triggers and actions of FerroUI, ported from the
Xaml.Behaviors.Interactions.Custom project of Xaml.Behaviors (see NOTICE.md): behaviors for
specific controls (buttons, items controls, split views, windows, scroll viewers, text boxes,
…), input, gestures and focus, validation, commands executed on events, dialogs and
notifications, animations and transitions, and services of the top level.
The namespace of the crate is FerroUI.Xaml.Interactions.Custom (and
FerroUI.Xaml.Interactions.Custom.Converters), mapped into the default XML namespace of the
framework: documents name its types without a prefix once register_types ran.
The crate is organised in four parts, each with the folders of the reference it holds
(part_a.rs to part_d.rs); the folders keep the names of the reference in snake case.
Modules§
- converters
- The converters of the reference (
Converters/, namespaceFerroUI.Xaml.Interactions.Custom.Converters).
Structs§
- Active
Screen Behavior - A behavior that exposes the screen containing the associated
TopLevel. - Actual
Theme Variant Changed Behavior - A base class for behaviors using ActualThemeVariantChanged event.
- Actual
Theme Variant Changed BehaviorV Table - The virtual table of the class.
- Actual
Theme Variant Changed Trigger - A trigger that executes its actions when the actual theme variant of the associated object changed.
- AddClass
Action - Adds a style class to the
styled_element, or to the sender when it is not set. - AddItem
ToItems Control Action - Allows a user to add the item to
ItemsControl. - AddRange
Action - Adds a range of items to a target list when invoked.
- AddTransition
Action - Adds a
TransitionBaseto the transitions collection on the target element. - Animate
OnAttached Behavior - Runs an animation when the associated control is attached to the visual tree.
- Animation
Builder Ref - An animation builder (
IAnimationBuilder) held by a property. - Animation
Completed Trigger - Runs a specified
Animationand executes actions when it completes. - Apply
Tree View Filter Action - Filters a
TreeViewusing the provided query string. - Async
Load Behavior - Behavior that calls an asynchronous method when the associated control is loaded.
- Attached
ToLogical Tree Behavior - A base class for behaviors using attached to logical tree event.
- Attached
ToLogical Tree BehaviorV Table - The virtual table of the class.
- Attached
ToLogical Tree Trigger - A trigger that executes its actions when the associated object is attached to the logical tree.
- Attached
ToLogical Tree Trigger Base - A trigger that executes when the associated object is attached to the logical tree.
- Attached
ToLogical Tree Trigger BaseV Table - The virtual table of the class.
- Attached
ToVisual Tree Behavior - A base class for behaviors using attached to visual tree event.
- Attached
ToVisual Tree BehaviorV Table - The virtual table of the class.
- Attached
ToVisual Tree Trigger - A trigger that executes when the associated object is attached to the visual tree.
- Attached
ToVisual Tree Trigger Base - A trigger that executes when the associated object is attached to the visual tree.
- Attached
ToVisual Tree Trigger BaseV Table - The virtual table of the class.
- Attention
Animations - Provides attention-drawing animation helpers inspired by popular web animation libraries such as animate.css.
- Auto
Complete BoxOpen Drop Down OnFocus Behavior - Opens the drop-down of an
AutoCompleteBoxwhen it receives focus. - Auto
Complete BoxSelection Changed Trigger - Triggers actions when the
AutoCompleteBoxselection changes. - Auto
Focus Behavior - Sets the keyboard focus on the associated control when it is loaded.
- Auto
Scroll ToBottom Behavior - A behavior that automatically scrolls to the bottom of a
ScrollViewerorItemsControlwhen new items are added. - Auto
Select Behavior - Automatically selects the entire content of the associated
TextBoxwhen it is loaded. - Automation
Name Behavior - Sets the
AutomationProperties.Nameproperty on the associated control when attached, and clears it when detached. - Automation
Name Changed Trigger - Executes actions when the
AutomationProperties.Nameproperty of the associated control changes (and once when the trigger is attached, as the observable of the property starts with its current value). - Begin
Animation Action - Starts an
Animationon a specified control when executed. - Bind
Pointer Over Behavior - Binds
is_pointer_overto whether the pointer is over the associated control. - Bind
TagTo Visual Root Data Context Behavior - Binds the tag of the associated control to the data context of its top level.
- Binding
Behavior - Applies a binding to a target property when the control is attached to the visual tree.
- Binding
Trigger Behavior - A behavior that performs actions when the bound data meets a specified condition.
- Bounds
Observer Behavior - Observes the bounds given to
bounds(usually bound to the bounds of a control) and exposes their width and height. - Break
Action - An action that triggers a debugger break.
- Button
Click Event Trigger Behavior - A behavior that listens for a
Button::click_eventevent on its source and executes its actions when that event is fired. - Button
Execute Command OnKey Down Behavior - Executes a command when a key is pressed while the button has focus.
- Button
Hide Flyout Behavior - Behavior that hides a button’s flyout when
is_flyout_openbecomes false. - Button
Hide Flyout OnClick Behavior - Hides the flyout when the button is clicked.
- Button
Hide Popup OnClick Behavior - Hides the popup when the button is clicked.
- Button
Upload File Behavior - Upload file behavior for
Button: a click uploads the file. - Call
Method Async Action - Calls a method of the
target_object(or of the sender) by name: a method without parameters, or with two parameters (the sender and the parameter of the action) whose first parameter is untyped. - Capture
Pointer Action - Captures the pointer.
- Carousel
KeyNavigation Behavior - Enables keyboard navigation for a
Carouselusing arrow keys. - Carousel
Next Action - Advances the target
Carouselto the next page. - Carousel
Previous Action - Moves the target
Carouselto the previous page. - Carousel
Selection Changed Trigger - Executes actions when the associated
Carouselchanges selection. - Case
- A case of a
SwitchCaseActionor aSwitchCaseBehavior: the actions (the content of the case in markup) executed when the switch value equalsvalue. - Case
Collection - The cases of a
SwitchCaseActionor aSwitchCaseBehavior: a list ofCase. - Center
Window Behavior - Centers the attached window on the current screen when it is attached to the visual tree.
- Change
Ferro Property Action - An action that sets a registered property (
target_property) of thetarget_object(or of the sender) tovalue, converted to the type of the property. - Clear
Auto Complete BoxSelection Action - Clears the selection and text of an
AutoCompleteBox. - Clear
Collection Action - Clears all items from a target list when invoked.
- Clear
Items Control Action - Allows a user to clear the items from a
ItemsControl. - Clear
Transitions Action - Clears the transitions collection.
- Click
Event Trigger - Trigger that emulates
Buttonclick semantics on anyControl. - Clipboard
Monitor Behavior - A behavior that monitors the system clipboard for specific data formats.
- Close
Notification Action - Action that closes the specified
NotificationCard. - Close
Window Action - Closes the associated or target window when executed.
- Collection
Changed Behavior - Executes different sets of actions when the observed collection changes: the
added_actionswhen items are added, theremoved_actionswhen items are removed and thereset_actionswhen the collection is reset. - Collection
Changed Trigger - Executes associated actions whenever the bound collection raises a collection changed event.
- Combo
BoxValidation Behavior - Validation behavior for
ComboBoxselected item. - Conditional
Action - An action that executes its
actions(its content in markup) whenconditionis true, itselse_actionsotherwise. - Conditional
Behavior - A trigger that executes its actions (its content in markup) when
conditionchanges to true, itselse_actionswhen it changes to false. - Console
Beep Action - An action that plays a system beep.
- Context
Dialog Behavior - Behavior that manages a context dialog implemented using a
Popup. - Context
Dialog Closed Trigger - Trigger that listens for the
Closedevent ofContextDialogBehavior. - Context
Dialog Opened Trigger - Trigger that listens for the
Openedevent ofContextDialogBehavior. - Data
Context Changed Behavior - A base class for behaviors using DataContextChanged event.
- Data
Context Changed BehaviorV Table - The virtual table of the class.
- Data
Context Changed Trigger - A trigger that executes its actions when the data context of the associated object changed.
- Date
Picker Validation Behavior - Validation behavior for
DatePickerselected date. - Delayed
Load Behavior - Hides the associated control when it is attached to the visual tree and shows it again after a delay.
- Delayed
Load Trigger - Invokes its actions after the associated control is attached to the visual tree and a delay elapses.
- Delayed
Show Control Action - Shows the target control (or the sender) after a delay.
- Detached
From Logical Tree Trigger - A trigger that executes its actions when the associated object is detached from the logical tree.
- Detached
From Visual Tree Trigger - A trigger that executes its actions when the associated object is detached from the visual tree.
- Dialog
Closed Trigger - Executes actions when the dialog window is closed.
- Dialog
Opened Trigger - Executes actions when the dialog window is opened.
- Double
Tapped Gesture Trigger - A trigger of
InputElement::double_tapped_event(a double tap): while the associated visual is in the visual tree, the event runs the actions with its args (TappedEventArgs) as the parameter. - Double
Tapped Trigger - A trigger of
InputElement::double_tapped_event(a double tap): while the associated visual is in the visual tree, the event runs the actions with its args (TappedEventArgs) as the parameter. - Drag
Control Behavior - Drags the target control (or else the associated control) inside its parent with the pointer, through a translate transform.
- Entrance
Animations - Provides entrance animation helpers inspired by common CSS transitions (e.g. animate.css, Framer Motion).
- Execute
Command Behavior Base - The base class of the behaviors that execute a command (the
ExecuteCommandOn*Behaviorclasses): the command, its parameter, whether it can execute, and the element to focus when it runs. - Execute
Command Behavior BaseV Table - The virtual table of the class.
- Execute
Command OnActivated Behavior - A behavior that executes its command when the main window of the application (or the
source_controlwhen it is a window) is activated, in an application with a classic desktop lifetime. - Execute
Command OnDouble Tapped Behavior - A behavior that executes its command when the
InputElement::double_tapped_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnGot Focus Behavior - A behavior that executes its command when the
InputElement::got_focus_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnHolding Behavior - A behavior that executes its command when the
InputElement::holding_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnKey Behavior Base - The base class of the behaviors that execute a command on a key event: the key or the key gesture that executes it.
- Execute
Command OnKey Down Behavior - A behavior that executes its command when the
InputElement::key_down_eventof its source control (thesource_control, or the associated control) is raised and not yet handled with its key or key gesture. - Execute
Command OnKey UpBehavior - A behavior that executes its command when the
InputElement::key_up_eventof its source control (thesource_control, or the associated control) is raised and not yet handled with its key or key gesture. - Execute
Command OnLost Focus Behavior - A behavior that executes its command when the
InputElement::lost_focus_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnPinch Behavior - A behavior that executes its command when the
InputElement::pinch_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnPinch Ended Behavior - A behavior that executes its command when the
InputElement::pinch_ended_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnPointer Capture Lost Behavior - A behavior that executes its command when the
InputElement::pointer_capture_lost_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnPointer Entered Behavior - A behavior that executes its command when the
InputElement::pointer_entered_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnPointer Exited Behavior - A behavior that executes its command when the
InputElement::pointer_exited_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnPointer Moved Behavior - A behavior that executes its command when the
InputElement::pointer_moved_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnPointer Pressed Behavior - A behavior that executes its command when the
InputElement::pointer_pressed_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnPointer Released Behavior - A behavior that executes its command when the
InputElement::pointer_released_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnPointer Touch PadGesture Magnify Behavior - A behavior that executes its command when the
InputElement::pointer_touch_pad_gesture_magnify_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnPointer Touch PadGesture Rotate Behavior - A behavior that executes its command when the
InputElement::pointer_touch_pad_gesture_rotate_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnPointer Touch PadGesture Swipe Behavior - A behavior that executes its command when the
InputElement::pointer_touch_pad_gesture_swipe_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnPointer Wheel Changed Behavior - A behavior that executes its command when the
InputElement::pointer_wheel_changed_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnPull Gesture Behavior - A behavior that executes its command when the
InputElement::pull_gesture_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnPull Gesture Ended Behavior - A behavior that executes its command when the
InputElement::pull_gesture_ended_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnRight Tapped Behavior - A behavior that executes its command when the
InputElement::right_tapped_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnScroll Gesture Behavior - A behavior that executes its command when the
InputElement::scroll_gesture_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnScroll Gesture Ended Behavior - A behavior that executes its command when the
InputElement::scroll_gesture_ended_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnScroll Gesture Inertia Starting Behavior - A behavior that executes its command when the
InputElement::scroll_gesture_inertia_starting_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnTapped Behavior - A behavior that executes its command when the
InputElement::tapped_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnText Input Behavior - A behavior that executes its command when the
InputElement::text_input_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command OnText Input Method Client Requested Behavior - A behavior that executes its command when the
InputElement::text_input_method_client_requested_eventof its source control (thesource_control, or the associated control) is raised and not yet handled. - Execute
Command Routed Event Behavior Base - The base class of the behaviors that execute a command on a routed event: the routing strategies the handler listens to, and whether the event is marked as handled when the command runs.
- Exit
Animations - Provides exit animation helpers inspired by animate.css.
- Fade
Animation - Provides fade animation helpers using composition animations.
- Fade
InBehavior - Plays a simple fade in animation when the associated control is attached.
- Fluid
Move Behavior - Behavior that animates position changes of a control or its children.
- Focus
Auto Complete BoxText BoxBehavior - Focuses the text box of the template of an
AutoCompleteBoxwhen the box receives focus. - Focus
Behavior - Focuses the associated control when
is_focusedbecomes true, and sets it back to false when the control loses the focus. - Focus
Behavior Base - The base class of the behaviors that focus their associated control: the navigation method and the key modifiers the focus is given with.
- Focus
Behavior BaseV Table - The virtual table of the class.
- Focus
Control Action - Focuses the target control (or the sender), in a job of the dispatcher.
- Focus
Control Behavior - Focuses the associated control when
focus_flagbecomes true, or when it is attached to the visual tree while the flag is set. - Focus
Next Element Action - Moves the focus to the next element of the tab order of the top level of the sender, with the tab navigation rules of the framework (the keyboard navigation modes of the containers), without raising key events.
- Focus
OnAttached Behavior - Focuses the associated control when it is attached to the visual tree.
- Focus
OnAttached ToVisual Tree Behavior - Focuses the associated control when it is attached to the visual tree.
- Focus
OnPointer Moved Behavior - Focuses the associated control when the pointer moves over it.
- Focus
OnPointer Pressed Behavior - Focuses the associated control when a pointer is pressed on it.
- Focus
OnVisible Behavior - Focuses the associated control when it is attached to the visual tree while visible, and each time it becomes visible.
- Focus
Selected Item Behavior - Focuses the container of the selected item of the associated items control each time the selection changes.
- Focus
Trap Behavior - Keeps the keyboard focus inside the associated control: the Tab key (and Shift+Tab) moves the focus from its last (first) tab stop back to its first (last) one, and into it from outside.
- Framer
Motion Animations - Provides composition animations inspired by popular Framer Motion presets.
- Global
Hotkey Behavior - A behavior that registers a global hotkey (window-wide) to execute actions: a key down event anywhere in the top level of the control (on the tunnel route) with the key and the key modifiers runs the actions, with the event args as the parameter, and is marked as handled.
- GotFocus
Trigger - A trigger of
InputElement::got_focus_event(the focus coming to the element): while the associated visual is in the visual tree, the event runs the actions with its args (FocusChangedEventArgs) as the parameter. - Hide
Attached Flyout Behavior - Hides the attached flyout of the associated control when
is_flyout_openbecomes false. - Hide
Context Dialog Action - Closes a
ContextDialogBehaviorwhen executed. - Hide
Control Action - Hides the target control (or the sender) by setting its
IsVisibleproperty to false. - Hide
Flyout Action - Hides the flyout of the target control (or of the sender).
- Hide
OnKey Pressed Behavior - Hides the target control when the key is pressed in the associated control.
- Hide
OnLost Focus Behavior - Hides the target control when the associated control loses the focus.
- Hide
Popup Action - Closes the popup.
- Hide
Tool TipAction - Hides the
ToolTipof the associated or target control when executed. - Holding
Gesture Trigger - A trigger of
InputElement::holding_event(a hold): while the associated visual is in the visual tree, the event runs the actions with its args (HoldingRoutedEventArgs) as the parameter. - Holding
Trigger - A trigger of
InputElement::holding_event(a hold): while the associated visual is in the visual tree, the event runs the actions with its args (HoldingRoutedEventArgs) as the parameter. - Horizontal
Scroll Viewer Behavior - Enables horizontal scrolling of a
ScrollViewerusing the mouse wheel. - IfElse
Trigger - A behavior that executes different collections of actions depending on the specified condition.
- Inactivity
Trigger - A trigger that fires when the user has been inactive (no mouse/keyboard input) for a specified duration.
- Increment
View Model Property Action - Increments a numeric view model property when invoked.
- Initialized
Behavior - A base class for behaviors using Initialized event.
- Initialized
BehaviorV Table - The virtual table of the class.
- Initialized
Trigger - A trigger that executes its actions when the associated object is initialized.
- Inline
Edit Behavior - Edits in place: a display control is swapped for an edit control when the display control is
double tapped (or the associated control, with
edit_on_associated_object_double_tapped) or the edit key is pressed on it, and swapped back when the accept or the cancel key is pressed in the edit control or it loses the focus. - Insert
Item ToItems Control Action - Allows a user to insert the item to a
ItemsControl. - Invoke
Button Click Action - Invokes the target button when executed.
- Item
Nudge Drop Behavior - Moves the containers of the associated
ItemsControlaside while an item is dragged over it: the containers after the drag position are translated by their size along theorientation, to show where the item drops. The translations are removed when the drag leaves or drops. - Items
Control Container Clearing Trigger - A behavior that listens for the
ItemsControl::container_clearingevent (ContainerClearing) on its source and executes its actions when that event is fired. - Items
Control Container Events Behavior - Base class that exposes container related events from an
ItemsControl. - Items
Control Container Events BehaviorV Table - The virtual table of the class.
- Items
Control Container Index Changed Trigger - A behavior that listens for the
ItemsControl::container_index_changedevent (ContainerIndexChanged) on its source and executes its actions when that event is fired. - Items
Control Container Prepared Trigger - A behavior that listens for the
ItemsControl::container_preparedevent (ContainerPrepared) on its source and executes its actions when that event is fired. - Items
Control Preparing Container Trigger - A behavior that listens for the
ItemsControl::preparing_containerevent (PreparingContainer) on its source and executes its actions when that event is fired. - KeyDown
Trigger - A trigger of
InputElement::key_down_event: runs the actions with the key args as the parameter when the key or the key gesture is pressed (any key when neither is set). - KeyGesture
Trigger - Trigger that listens for a key gesture.
- KeyTrigger
- A trigger that listens for key events and executes its actions when the specified key or gesture is detected.
- KeyUp
Trigger - A trigger of
InputElement::key_up_event: runs the actions with the key args as the parameter when the key or the key gesture is released (any key when neither is set). - Launch
UriAction - Launches an absolute URI with the launcher of the top level of the sender.
- Launch
UriOr File Action - An action that will launch a process to open a file or URI. For files, this action will launch the default program for the given file extension. A URI will open in a web browser.
- List
BoxSelect AllBehavior - Selects all the items of the associated
ListBoxwhen it is attached to the visual tree. - List
BoxUnselect AllBehavior - Unselects all the items of the associated
ListBoxwhen it is attached to the visual tree. - Loaded
Behavior - A base class for behaviors using loaded event.
- Loaded
BehaviorV Table - The virtual table of the class.
- Loaded
Trigger - A trigger that executes its actions when the associated control is loaded.
- LogAction
- An action that logs a message to the debug output.
- Lose
Focus OnEnter Behavior - A behavior that loses focus when the Enter key is pressed.
- Lost
Focus Trigger - A trigger of
InputElement::lost_focus_event(the focus leaving the element): while the associated visual is in the visual tree, the event runs the actions with its args (FocusChangedEventArgs) as the parameter. - MaxValue
Validation Rule - Validation rule that checks that a value is less than or equal to a maximum value.
- MinLength
Validation Rule - Validation rule that checks that a string has a minimum length.
- MinValue
Validation Rule - Validation rule that checks that a value is greater than or equal to a minimum value.
- Move
Element ToPanel Action - Moves the associated or target element to a specified
Panel. - Move
Item InItems Control Action - Moves an item within an
ItemsControlfromfrom_indextoto_index. - Network
Status Trigger - A trigger that fires when the network status changes.
- NotNull
Validation Rule - Validation rule that checks that a value is not null.
- Notification
Manager Behavior - Provides a
INotificationManagerfor the associatedControl. - Numeric
UpDown Validation Behavior - Validation behavior for
NumericUpDownvalue. - Observable
Trigger Behavior - A trigger that subscribes to an observable and executes its actions whenever a new value is
produced. The emitted value is exposed through the
valueproperty and passed to the actions as a parameter. - Orbit
Effect Behavior - A behavior that allows rotating the attached control in 3D space using pointer manipulation.
- Parallax
Behavior - A behavior that moves the associated element at a different speed than the scrolling container, creating a parallax effect.
- Path
Icon Data Behavior - Sets the
PathIcon::datawhen the associated icon is attached to the visual tree; the data the icon had is restored when it leaves the visual tree. - Path
Icon Data Changed Trigger - Invokes actions whenever the
PathIcon::dataproperty changes (and once when the trigger is attached, as the observable of the property reports its current value). - Pinch
Ended Gesture Trigger - A trigger of
InputElement::pinch_ended_event(the end of a pinch): while the associated visual is in the visual tree, the event runs the actions with its args (PinchEndedEventArgs) as the parameter. - Pinch
Gesture Trigger - A trigger of
InputElement::pinch_event(a pinch): while the associated visual is in the visual tree, the event runs the actions with its args (PinchEventArgs) as the parameter. - Play
Animation Behavior - Plays a specified
Animationwhen the associated element is attached to the visual tree. - Pointer
Capture Lost Trigger - A trigger of
InputElement::pointer_capture_lost_event(the loss of the capture of a pointer): while the associated visual is in the visual tree, the event runs the actions with its args (PointerCaptureLostEventArgs) as the parameter. - Pointer
Entered Trigger - A trigger of
InputElement::pointer_entered_event(a pointer entering the element): while the associated visual is in the visual tree, the event runs the actions with its args (PointerEventArgs) as the parameter. - Pointer
Exited Trigger - A trigger of
InputElement::pointer_exited_event(a pointer leaving the element): while the associated visual is in the visual tree, the event runs the actions with its args (PointerEventArgs) as the parameter. - Pointer
Moved Trigger - A trigger of
InputElement::pointer_moved_event(a pointer moving over the element): while the associated visual is in the visual tree, the event runs the actions with its args (PointerEventArgs) as the parameter. - Pointer
Over Cursor Behavior - Changes the cursor when the pointer is over the associated control.
- Pointer
Pressed Trigger - A trigger of
InputElement::pointer_pressed_event(a press of a pointer): while the associated visual is in the visual tree, the event runs the actions with its args (PointerPressedEventArgs) as the parameter. - Pointer
Released Trigger - A trigger of
InputElement::pointer_released_event(a release of a pointer): while the associated visual is in the visual tree, the event runs the actions with its args (PointerReleasedEventArgs) as the parameter. - Pointer
Touch PadGesture Magnify Gesture Trigger - A trigger of
InputElement::pointer_touch_pad_gesture_magnify_event(a magnify gesture of a touch pad): while the associated visual is in the visual tree, the event runs the actions with its args (PointerDeltaEventArgs) as the parameter. - Pointer
Touch PadGesture Rotate Gesture Trigger - A trigger of
InputElement::pointer_touch_pad_gesture_rotate_event(a rotate gesture of a touch pad): while the associated visual is in the visual tree, the event runs the actions with its args (PointerDeltaEventArgs) as the parameter. - Pointer
Touch PadGesture Swipe Gesture Trigger - A trigger of
InputElement::pointer_touch_pad_gesture_swipe_event(a swipe gesture of a touch pad): while the associated visual is in the visual tree, the event runs the actions with its args (PointerDeltaEventArgs) as the parameter. - Pointer
Wheel Changed Trigger - A trigger of
InputElement::pointer_wheel_changed_event(a turn of the mouse wheel): while the associated visual is in the visual tree, the event runs the actions with its args (PointerWheelEventArgs) as the parameter. - Popup
Action - Opens a popup at the pointer with
childas its content (the content of the action in markup). The popup is created on the first execution, as a logical child of the sender, and follows the data context of the sender. - Popup
Closed Trigger - Executes actions when the closed event of the associated
Popupis raised. - Popup
Opened Trigger - Executes actions when the opened event of the associated
Popupis raised. - Property
Changed Trigger - Represents a trigger that performs actions when the bound data have changed.
- Property
Validation Behavior - Base behavior that validates a property value using a set of rules.
- Pull
Gesture Ended Gesture Trigger - A trigger of
InputElement::pull_gesture_ended_event(the end of a pull gesture): while the associated visual is in the visual tree, the event runs the actions with its args (PullGestureEndedEventArgs) as the parameter. - Pull
Gesture Gesture Trigger - A trigger of
InputElement::pull_gesture_event(a pull gesture): while the associated visual is in the visual tree, the event runs the actions with its args (PullGestureEventArgs) as the parameter. - Range
Validation Rule - Validation rule that checks that a value is within a range.
- Regex
Validation Rule - Validation rule that checks that a string matches a regular expression.
- Release
Pointer Capture Action - Releases the pointer capture.
- Remove
Class Action - Removes a style class from the
styled_element, or to the sender when it is not set. - Remove
Element Action - Removes the
target_object(or the sender) from its parent: a panel, a decorator, a content control, a content presenter or an items control. - Remove
Item AtAction - Removes an item at a specified index from an
ItemsControl: theitems_control, or else the sender. - Remove
Item InItems Control Action - Allows a user to remove the item from a
ItemsControl: the data context of the sender (a control) is removed from the items source of the first items control among the sender and its logical ancestors. - Remove
Item InList BoxAction - Allows a user to remove the item from a
ListBoxitem template. - Remove
Range Action - Removes a range of items from a target list when invoked.
- Remove
Transition Action - Removes a
TransitionBasefrom the transitions collection on the target element. - Render
Render Target Bitmap Action - Action that invokes
IRenderTargetBitmapRenderHost::renderon the specified target. - Render
Target Bitmap Behavior - Behavior that draws into a
RenderTargetBitmapand assigns it to the associatedImage. - Render
Target Bitmap Trigger - Trigger that calls
IRenderTargetBitmapRenderHost::renderperiodically. - Request
Screen Details Action - An action that requests extended screen information from the screens of a top level
(
Screens::request_screen_details). - Required
Date Validation Rule - Validation rule that requires a date value.
- Required
Decimal Validation Rule - Validation rule that requires a decimal value.
- Required
Text Validation Rule - Validation rule that requires a non-empty string value.
- Resources
Changed Behavior - A base class for behaviors using ResourcesChanged event.
- Resources
Changed BehaviorV Table - The virtual table of the class.
- Resources
Changed Trigger - A trigger that executes its actions when the resources of the associated object changed.
- Right
Tapped Gesture Trigger - A trigger of
InputElement::right_tapped_event(a right tap): while the associated visual is in the visual tree, the event runs the actions with its args (TappedEventArgs) as the parameter. - Rotate
Animation - Provides rotation animation helpers using composition animations.
- Routed
Event Trigger - A trigger of a routed event of the associated object, given untyped
(
routed_event): while the associated object is in the visual tree, the event runs the actions with its args as the parameter. - Routed
Event Trigger Base - The base class of the triggers of a routed event of the associated visual
(
RoutedEventTriggerandRoutedEventTriggerBaseOfT): the routing strategies the handler listens to, and whether the actions mark the event as handled. - Routed
Event Trigger Base OfT - A trigger of a routed event of the associated object whose args are of type
T: while the associated object is in the visual tree, the event runs the actions with its args as the parameter. - Routed
Event Trigger Base OfTV Table - The virtual table of the class.
- Routed
Event Trigger Behavior - A behavior that listens for a
RoutedEventevent on its source and executes its actions when that event is fired. - Routed
Event TriggerV Table - The virtual table of the class.
- RunAnimation
Trigger - Runs an animation and invokes actions when the associated control is attached to the visual tree.
- Scale
Animation - Provides scale animation helpers using composition animations.
- Screen
Reader Announce Action - An action that requests a screen reader announcement.
- Screens
Changed Trigger - A trigger that executes its actions when the screen configuration changes.
- Screens
Ref - The screens of a top level (
Screens), compared by identity. - Screenshot
Action - Renders the target control (or the sender) to a bitmap and saves it as a PNG file the user picks.
- Scroll
Changed Trigger - Executes actions when the
ScrollViewer::scroll_changed_eventevent occurs. - Scroll
Gesture Ended Gesture Trigger - A trigger of
InputElement::scroll_gesture_ended_event(the end of a scroll gesture): while the associated visual is in the visual tree, the event runs the actions with its args (ScrollGestureEndedEventArgs) as the parameter. - Scroll
Gesture Gesture Trigger - A trigger of
InputElement::scroll_gesture_event(a scroll gesture): while the associated visual is in the visual tree, the event runs the actions with its args (ScrollGestureEventArgs) as the parameter. - Scroll
Gesture Inertia Starting Gesture Trigger - A trigger of
InputElement::scroll_gesture_inertia_starting_event(the start of the inertia of a scroll gesture): while the associated visual is in the visual tree, the event runs the actions with its args (ScrollGestureInertiaStartingEventArgs) as the parameter. - Scroll
ToControl Action - Brings the target control (or the sender) into view.
- Scroll
ToItem Behavior - Scrolls the associated
ItemsControlto a specific item. - Scroll
ToItem Index Behavior - Scrolls the associated
ItemsControlto a given item index. - Scroll
ToOffset Action - Scrolls a
ScrollViewerto the specified offsets when executed. - Scroll
Viewer Offset Behavior - Sets the
offsetof the associatedScrollViewer. - Select
AllOn Focus Behavior - A behavior that automatically selects all text in a
TextBoxwhen it receives focus. - Select
List BoxItem OnPointer Moved Behavior - Sets the
IsSelectedproperty of theListBoxItemparent of the associated control to true on its pointer moved event. - Selecting
Items Control Behavior - Enables the standard selection indicator animation on selecting items controls.
- Selecting
Items Control Events Behavior - A base class for behaviors that handle the selection changed event of the associated
SelectingItemsControl: the event goes toon_selection_changed. - Selecting
Items Control Events BehaviorV Table - The virtual table of the class.
- Selecting
Items Control Search Behavior - Filters
SelectingItemsControlitems based on the text of a search box: the tab items whose header contains the text stay visible, the first of them is selected. - SetAutomation
IdAction - Sets the
AutomationProperties.AutomationIdproperty on the target control when executed. - SetCursor
Action - Sets the cursor on a target control.
- SetCursor
Behavior - Sets the cursor for the associated control when attached.
- SetCursor
From Provider Action - Sets the cursor on a target control using an
ICursorProvider. - SetCursor
From Provider Behavior - Sets the cursor provided by an
ICursorProviderwhen attached. - SetEnabled
Action - Sets the
IsEnabledproperty of the target control (or of the sender). - SetPath
Icon Data Action - Changes the
PathIcon::dataof a target icon when executed. - SetTheme
Variant Action - Sets the requested theme variant of the
targettheme variant scope (or of the sender when it is one). - SetTool
TipTip Action - Sets the
tip_propertyof the associated or target control when executed. - SetView
Model Property Action - Sets a view model property to a specified value when invoked.
- SetView
Model Property OnLoad Behavior - Sets a view model property when the associated control is loaded.
- Show
Behavior Base - Base class for behaviors that show a control in response to an event.
- Show
Context Dialog Action - Opens a
ContextDialogBehaviorwhen executed. - Show
Context Menu Action - Opens the context menu of the target control (or of the sender).
- Show
Control Action - Shows the target control (or the sender) by setting its
IsVisibleproperty to true. - Show
Dialog Action - Shows a
Windowas a dialog: owned byowner, or else by the window of the sender, or as a plain window when there is no owner. - Show
Error Notification Action - Shows an error notification using an
INotificationManager. - Show
Flyout Action - Shows the flyout of the target control (or of the sender) at that control.
- Show
Information Notification Action - Shows an information notification using an
INotificationManager. - Show
Notification Action - Shows a notification using an
INotificationManager. - Show
OnDouble Tapped Behavior - A behavior that allows to show control on double tapped event.
- Show
OnKey Down Behavior - A behavior that allows to show control on key down event: the
keyor thegestureshows it. - Show
OnTapped Behavior - A behavior that allows to show control on tapped event.
- Show
Pointer Position Behavior - Shows the position of the pointer over the associated control in the target text block.
- Show
Popup Action - Opens the popup, placed at the target control (or at the sender) when it has no placement target.
- Show
Success Notification Action - Shows a success notification using an
INotificationManager. - Show
Tool TipAction - Shows the
ToolTipof the associated or target control when executed. - Show
Warning Notification Action - Shows a warning notification using an
INotificationManager. - Show
Window Action - Shows the specified window when executed.
- Size
Changed Trigger - A behavior that triggers its actions whenever the associated control size changes.
- Slider
Validation Behavior - Validation behavior for range based controls like
Slidervalue. - Sliding
Animation - Slides an element into its place when it is loaded, from outside one of its edges.
- Special
Animations - Provides special animation helpers that do not fit other categories.
- Split
View Pane Closed Trigger - Executes actions when the
PaneClosedevent is raised. - Split
View Pane Closing Trigger - Executes actions when the
PaneClosingevent is raised. - Split
View Pane Opened Trigger - Executes actions when the
PaneOpenedevent is raised. - Split
View Pane Opening Trigger - Executes actions when the
PaneOpeningevent is raised. - Split
View State Behavior - Updates
SplitViewproperties based on size conditions. - Split
View State Setter - Describes a state for
SplitViewStateBehaviorusing size conditions. - Split
View State Setters - The split view state setters of a
SplitViewStateBehavior: a list ofSplitViewStateSetter. - Split
View Toggle Pane Action - Toggles the
is_pane_openstate of aSplitViewwhen executed. - Start
Animation Action - Starts an
Animationon the associated control. - Start
Built Animation Action - Starts an animation built in code on the associated control.
- Static
Render Target Bitmap Behavior - Behavior that draws once into a
RenderTargetBitmapand assigns it to the associatedImage. Rendering can be triggered by callingIRenderTargetBitmapRenderHost::render. - Switch
Case Action - An action that executes the actions of the first of its
cases(its content in markup) whose value equalsvalue, or itsdefault_actionswhen none does. - Switch
Case Behavior - A trigger that executes the actions of the first of its
cases(its content in markup) whose value equalsvalue, or itsdefault_actionswhen none does: once when it is initialized, then in a job of the dispatcher after each change of the value. - TabControl
KeyNavigation Behavior - Enables keyboard navigation for a
TabControlusing arrow keys. - TabControl
Next Action - Advances the target
TabControlto the next tab. - TabControl
Previous Action - Moves the target
TabControlto the previous tab. - TabControl
Selection Changed Trigger - Executes actions when the associated
TabControlchanges selection. - Tapped
Gesture Trigger - A trigger of
InputElement::tapped_event(a tap): while the associated visual is in the visual tree, the event runs the actions with its args (TappedEventArgs) as the parameter. - Tapped
Trigger - A trigger of
InputElement::tapped_event(a tap): while the associated visual is in the visual tree, the event runs the actions with its args (TappedEventArgs) as the parameter. - Text
BoxSelect AllOn GotFocus Behavior - A behavior that allows to select all
TextBoxtext on got focus event. - Text
BoxSelect AllText Behavior - Selects all the text of the associated
TextBoxwhen it is attached to the visual tree. - Text
BoxValidation Behavior - Validation behavior for
TextBoxtext. - Text
Input Method Client Requested Trigger - A trigger of
InputElement::text_input_method_client_requested_event(the request of the client of an input method): while the associated visual is in the visual tree, the event runs the actions with its args (TextInputMethodClientRequestedEventArgs) as the parameter. - Text
Input Trigger - A trigger of
InputElement::text_input_event: runs the actions with the text input args as the parameter when the text is input (any text when it is not set). - Theme
Variant Behavior - Sets the requested theme variant of the associated
ThemeVariantScopewhile it is in the visual tree, and restores the previous one when it leaves it. - Theme
Variant Trigger - Executes actions when the actual theme variant of the associated element matches the specified
theme_variant. - Tilt
Effect Behavior - A behavior that applies a 3D tilt rotation to the element based on the pointer position.
- Toggle
Class Action - Toggles a style class of the
styled_element, or to the sender when it is not set. - Toggle
IsExpanded OnDouble Tapped Behavior - Toggles the
IsExpandedproperty of theTreeViewItemparent of the associated control on theDoubleTappedevent. - Toggle
View Model Boolean Action - Toggles a boolean view model property when invoked.
- Tool
TipClosing Trigger - Trigger that listens for the
ToolTip::tool_tip_closing_event. - Tool
TipOpening Trigger - Trigger that listens for the
ToolTip::tool_tip_opening_event. - Transitions
Behavior - Sets the transitions collection on the associated control when attached.
- Transitions
Changed Trigger - Executes actions whenever the transitions collection changes.
- Tree
View Filter Behavior - Filters
TreeViewitems based on the text of a search box. - Tree
View Filter Text Changed Trigger - Executes actions when the search box text changes, with the args of the change as the parameter.
- Unloaded
Trigger - A trigger that executes its actions when the associated control is unloaded.
- Upload
Completed Trigger - Executes actions when the bound value becomes
true. - Upload
File Action - Asynchronously uploads a file to a specified URL and invokes a command when completed.
- Upload
File Behavior Base - Base class for behaviors that upload a file to a URL.
- Validation
Rules - The validation rules of a
PropertyValidationBehavior: a list of objects that implementIValidationRule. - Value
Changed Trigger Behavior - A behavior that performs actions when the bound data produces new value.
- View
Model Property Changed Trigger - Triggers when the specified view model property changes.
- Viewport
Behavior - Listens for the associated element entering or exiting the parent
ScrollViewerviewport. - Visual
Debug Behavior - A behavior that visualizes events on the attached control for debugging purposes: each time
the event fires, the actions run and the control is highlighted for
duration. - Window
Action - An action that performs common window operations.
- Window
Drag Move Behavior - A behavior that allows the user to drag the window by clicking and holding the associated control.
- Window
State Trigger - Executes actions when the window state matches the specified value.
- Writeable
Bitmap Behavior - Creates a
WriteableBitmapand optionally renders it once using a renderer. - Writeable
Bitmap Ref - A writeable bitmap held by a property.
- Writeable
Bitmap Render Action - Invokes an
IWriteableBitmapRendererto render into a bitmap. - Writeable
Bitmap Render Behavior - Creates a
WriteableBitmapand updates it using a renderer on a timer. - Writeable
Bitmap Timer Trigger - A trigger that fires its actions on a timer and passes a
WriteableBitmapas parameter. - Writeable
Bitmap Trigger - A trigger that executes its actions when
triggeris called, passing aWriteableBitmapas parameter.
Enums§
- Change
Size - The scroll amount of a
HorizontalScrollViewerBehaviorfor each wheel delta. - FiredOn
- Specifies which keyboard event will fire the trigger.
- Fluid
Move Scope - Determines if the behavior applies to the associated element or its children.
- KeyGesture
Trigger Fired On - Specifies when a
KeyGestureTriggershould be fired. - LogAction
Level - Specifies the severity level of the log message.
- Network
Status - Defines the network status to listen for.
- Sort
Direction - Sort order for tab items.
- Window
Action Type - Defines the window action types.
Statics§
- ASSEMBLY
- What this crate states about itself for markup: its assembly name and the namespaces the XML namespace of the framework maps to.
Traits§
- Actual
Theme Variant Changed Behavior Impl - The overridable members introduced by the class.
- Actual
Theme Variant Changed Behavior Impl Ext - Access to the base implementations of the overridable members.
- Attached
ToLogical Tree Behavior Impl - The overridable members introduced by the class.
- Attached
ToLogical Tree Behavior Impl Ext - Access to the base implementations of the overridable members.
- Attached
ToLogical Tree Trigger Base Impl - The overridable members introduced by the class.
- Attached
ToLogical Tree Trigger Base Impl Ext - Access to the base implementations of the overridable members.
- Attached
ToVisual Tree Behavior Impl - The overridable members introduced by the class.
- Attached
ToVisual Tree Behavior Impl Ext - Access to the base implementations of the overridable members.
- Attached
ToVisual Tree Trigger Base Impl - The overridable members introduced by the class.
- Attached
ToVisual Tree Trigger Base Impl Ext - Access to the base implementations of the overridable members.
- Data
Context Changed Behavior Impl - The overridable members introduced by the class.
- Data
Context Changed Behavior Impl Ext - Access to the base implementations of the overridable members.
- Execute
Command Behavior Base Impl - The overridable members introduced by the class.
- Execute
Command Behavior Base Impl Ext - Access to the base implementations of the overridable members.
- Focus
Behavior Base Impl - The overridable members introduced by the class.
- Focus
Behavior Base Impl Ext - Access to the base implementations of the overridable members.
- IAnimation
Builder - Provides a way to build
Animationinstances in code. - ICursor
Provider - Provides a custom cursor instance.
- IRender
Target Bitmap Render Host - Defines a render host that can update an underlying
RenderTargetBitmap. - IRender
Target Bitmap Renderer - Provides a method used by
RenderTargetBitmapBehaviorto draw onto a render target. - IRender
Target Bitmap Simple Renderer - Provides a method used by
StaticRenderTargetBitmapBehaviorto draw onto a render target. - IValidation
Rule - Defines a validation rule.
- IWriteable
Bitmap Renderer - Defines a method used to render into a
WriteableBitmap. - Initialized
Behavior Impl - The overridable members introduced by the class.
- Initialized
Behavior Impl Ext - Access to the base implementations of the overridable members.
- Items
Control Container Events Behavior Impl - The overridable members introduced by the class.
- Items
Control Container Events Behavior Impl Ext - Access to the base implementations of the overridable members.
- Loaded
Behavior Impl - The overridable members introduced by the class.
- Loaded
Behavior Impl Ext - Access to the base implementations of the overridable members.
- Resources
Changed Behavior Impl - The overridable members introduced by the class.
- Resources
Changed Behavior Impl Ext - Access to the base implementations of the overridable members.
- Routed
Event Trigger Base OfTImpl - The overridable members introduced by the class.
- Routed
Event Trigger Base OfTImpl Ext - Access to the base implementations of the overridable members.
- Routed
Event Trigger Impl - The overridable members introduced by the class.
- Routed
Event Trigger Impl Ext - Access to the base implementations of the overridable members.
- Selecting
Items Control Events Behavior Impl - The overridable members introduced by the class.
- Selecting
Items Control Events Behavior Impl Ext - Access to the base implementations of the overridable members.
Functions§
- register_
types - Registers the namespaces, the types, the markup metadata and the assembly of this crate (and of the crates it is built on). Cheap and idempotent.