Skip to content

DiGi.UI.WPF.Controls

github-actions[bot] edited this page Jul 15, 2026 · 2 revisions

DiGi.UI.WPF.Controls Namespace

Classes

CheckBoxTreeViewControl Class

Interaction logic for CheckBoxTreeViewControl.xaml

public class CheckBoxTreeViewControl : System.Windows.Controls.UserControl, System.Windows.Markup.IComponentConnector

Inheritance System.Object → System.Windows.Threading.DispatcherObject → System.Windows.DependencyObject → System.Windows.Media.Visual → System.Windows.UIElement → System.Windows.FrameworkElement → System.Windows.Controls.Control → System.Windows.Controls.ContentControl → System.Windows.Controls.UserControl → CheckBoxTreeViewControl

Implements System.Windows.Markup.IComponentConnector

Constructors

CheckBoxTreeViewControl() Constructor

Initializes a new instance of the CheckBoxTreeViewControl class.

public CheckBoxTreeViewControl();

Methods

CheckBoxTreeViewControl.CollapseAll() Method

Collapses all nodes within the tree view.

public void CollapseAll();

CheckBoxTreeViewControl.ExpandaAll() Method

Expands all nodes within the tree view.

public void ExpandaAll();

CheckBoxTreeViewControl.GetItems<T>(bool) Method

Retrieves a list of items of type T from the tree view, optionally filtered by their selection state.

public System.Collections.Generic.List<T>? GetItems<T>(bool selected=true);

Type parameters

T

The type of items to retrieve.

Parameters

selected System.Boolean

A boolean indicating whether only selected items should be returned. Defaults to true.

Returns

System.Collections.Generic.List<T>
A list of items of type T, or null if no matching items are found.

CheckBoxTreeViewControl.InitializeComponent() Method

InitializeComponent

public void InitializeComponent();

Implements InitializeComponent()

CheckBoxTreeViewControl.SetItems<T>(IEnumerable<T>) Method

Populates the tree view with a collection of items.

public void SetItems<T>(System.Collections.Generic.IEnumerable<T> values);

Type parameters

T

The type of values to be added to the tree view.

Parameters

values System.Collections.Generic.IEnumerable<T>

An enumerable collection of values to populate the control.

Events

CheckBoxTreeViewControl.ItemAdding Event

Occurs when an item is being added to the tree view, allowing for customization of the item's path and name.

public event CheckBoxTreeViewItemAddingEventHandler? ItemAdding;

Event Type

CheckBoxTreeViewItemAddingEventHandler(object, CheckBoxTreeViewItemAddingEventArgs)

ListBoxControl Class

Interaction logic for ListBoxControl.xaml

public class ListBoxControl : System.Windows.Controls.UserControl, DiGi.UI.WPF.Interfaces.IControl, DiGi.UI.WPF.Interfaces.IWPFObject, DiGi.Core.Interfaces.IObject, System.Windows.Markup.IComponentConnector

Inheritance System.Object → System.Windows.Threading.DispatcherObject → System.Windows.DependencyObject → System.Windows.Media.Visual → System.Windows.UIElement → System.Windows.FrameworkElement → System.Windows.Controls.Control → System.Windows.Controls.ContentControl → System.Windows.Controls.UserControl → ListBoxControl

Implements IControl, IWPFObject, DiGi.Core.Interfaces.IObject, System.Windows.Markup.IComponentConnector

Constructors

ListBoxControl() Constructor

Initializes a new instance of the ListBoxControl class.

public ListBoxControl();

Properties

ListBoxControl.SelectionMode Property

Gets or sets the SelectionMode of the list box.

public System.Windows.Controls.SelectionMode SelectionMode { get; set; }

Property Value

System.Windows.Controls.SelectionMode

Methods

ListBoxControl.ClearItems() Method

Clears all items from the list box.

public void ClearItems();

ListBoxControl.GetItems<T>(bool) Method

Retrieves a list of items of type T from the list box.

public System.Collections.Generic.List<T>? GetItems<T>(bool selected=true);

Type parameters

T

The type of items to retrieve.

Parameters

selected System.Boolean

If set to true, only selected items are returned; otherwise, all items are returned.

Returns

System.Collections.Generic.List<T>
A list containing the retrieved items of type T, or null if no items match the criteria.

ListBoxControl.InitializeComponent() Method

InitializeComponent

public void InitializeComponent();

Implements InitializeComponent()

ListBoxControl.SetItems<T>(IEnumerable<T>) Method

Sets the items in the list box using the provided collection of values.

public void SetItems<T>(System.Collections.Generic.IEnumerable<T> values);

Type parameters

T

The type of items to be added to the list box.

Parameters

values System.Collections.Generic.IEnumerable<T>

An enumerable collection of values to populate the list box with.

Events

ListBoxControl.ItemAdding Event

Occurs when an item is about to be added to the list box.

public event ListBoxItemAddingEventHandler? ItemAdding;

Event Type

ListBoxItemAddingEventHandler(object, ListBoxItemAddingEventArgs)

ListBoxControl.SelectionChanged Event

Occurs when the selection within the list box changes.

public event SelectionChangedEventHandler? SelectionChanged;

Event Type

System.Windows.Controls.SelectionChangedEventHandler

ProgressBarControl Class

Interaction logic for ProgressBarControl.xaml

public class ProgressBarControl : System.Windows.Controls.UserControl, DiGi.UI.WPF.Interfaces.IControl, DiGi.UI.WPF.Interfaces.IWPFObject, DiGi.Core.Interfaces.IObject, System.Windows.Markup.IComponentConnector

Inheritance System.Object → System.Windows.Threading.DispatcherObject → System.Windows.DependencyObject → System.Windows.Media.Visual → System.Windows.UIElement → System.Windows.FrameworkElement → System.Windows.Controls.Control → System.Windows.Controls.ContentControl → System.Windows.Controls.UserControl → ProgressBarControl

Implements IControl, IWPFObject, DiGi.Core.Interfaces.IObject, System.Windows.Markup.IComponentConnector

Constructors

ProgressBarControl() Constructor

Initializes a new instance of the ProgressBarControl class.

public ProgressBarControl();

Properties

ProgressBarControl.IsIndeterminate Property

Gets or sets a value indicating whether the progress bar is in an indeterminate state.

public bool IsIndeterminate { get; set; }

Property Value

System.Boolean

ProgressBarControl.Maximum Property

Gets or sets the maximum value for progress reporting.

public double Maximum { get; set; }

Property Value

System.Double

ProgressBarControl.Value Property

Gets or sets the current progress value.

public double Value { get; set; }

Property Value

System.Double

Methods

ProgressBarControl.InitializeComponent() Method

InitializeComponent

public void InitializeComponent();

Implements InitializeComponent()

ProgressBarControl.Update(double, string) Method

Updates the progress bar with a specific value and optional descriptive text.

public void Update(double value, string? text=null);

Parameters

value System.Double

The current progress value to be displayed.

text System.String

Optional text to display as a label for the progress bar.

TextBoxControl Class

Interaction logic for TextBoxControl.xaml

public class TextBoxControl : System.Windows.Controls.UserControl, System.Windows.Markup.IComponentConnector

Inheritance System.Object → System.Windows.Threading.DispatcherObject → System.Windows.DependencyObject → System.Windows.Media.Visual → System.Windows.UIElement → System.Windows.FrameworkElement → System.Windows.Controls.Control → System.Windows.Controls.ContentControl → System.Windows.Controls.UserControl → TextBoxControl

Implements System.Windows.Markup.IComponentConnector

Constructors

TextBoxControl() Constructor

Initializes a new instance of the TextBoxControl class.

public TextBoxControl();

Properties

TextBoxControl.Text Property

Gets or sets the text content displayed in the control's label.

public string? Text { get; set; }

Property Value

System.String

TextBoxControl.Validation Property

Gets or sets the validation function used to determine if a string input is valid.

public System.Func<string,bool>? Validation { get; set; }

Property Value

System.Func<System.String,System.Boolean>

TextBoxControl.Value Property

Gets or sets the text value of the internal text box.

public string? Value { get; set; }

Property Value

System.String

Methods

TextBoxControl.GetValue<T>() Method

Retrieves the current value of the control converted to the specified type.

public T? GetValue<T>();

Type parameters

T

The target type for conversion.

Returns

T
The converted value if successful; otherwise, the default value of type T.

TextBoxControl.GetValue<T>(T) Method

Retrieves the current value of the control converted to the specified type, or returns a provided default value if conversion fails.

public T? GetValue<T>(T? defaultValue);

Type parameters

T

The target type for conversion.

Parameters

defaultValue T

The value to return if the conversion cannot be performed.

Returns

T
The converted value if successful; otherwise, the specified defaultValue.

TextBoxControl.InitializeComponent() Method

InitializeComponent

public void InitializeComponent();

Implements InitializeComponent()

TextBoxControl.TryGetValue<T>(T) Method

Attempts to convert the current value of the control to the specified type.

public bool TryGetValue<T>(out T? value);

Type parameters

T

The target type for conversion.

Parameters

value T

When this method returns, contains the converted value if successful; otherwise, the default value of type T.

Returns

System.Boolean
true if the value was successfully converted; otherwise, false.

TreeViewControl Class

Interaction logic for TreeViewControl.xaml

public class TreeViewControl : System.Windows.Controls.UserControl, System.Windows.Markup.IComponentConnector

Inheritance System.Object → System.Windows.Threading.DispatcherObject → System.Windows.DependencyObject → System.Windows.Media.Visual → System.Windows.UIElement → System.Windows.FrameworkElement → System.Windows.Controls.Control → System.Windows.Controls.ContentControl → System.Windows.Controls.UserControl → TreeViewControl

Implements System.Windows.Markup.IComponentConnector

Constructors

TreeViewControl() Constructor

Initializes a new instance of the TreeViewControl class.

public TreeViewControl();

Methods

TreeViewControl.ClearItems() Method

Clears all items from the main TreeView control.

public void ClearItems();

TreeViewControl.CollapseAll() Method

Collapses all expandable nodes within the tree view.

public void CollapseAll();

TreeViewControl.ExpandaAll() Method

Expands all expandable nodes within the tree view.

public void ExpandaAll();

TreeViewControl.GetItems<T>(bool) Method

Retrieves a list of items of the specified type from the tree view.

public System.Collections.Generic.List<T>? GetItems<T>(bool selected=true);

Type parameters

T

The type of items to retrieve.

Parameters

selected System.Boolean

If set to true, only retrieves items that are currently selected; otherwise, retrieves all items of type T.

Returns

System.Collections.Generic.List<T>
A list of items of type T, or null if no matching items are found.

TreeViewControl.InitializeComponent() Method

InitializeComponent

public void InitializeComponent();

Implements InitializeComponent()

TreeViewControl.SetItems<T>(IEnumerable<T>) Method

Populates the tree view with a collection of values, organizing them by path and allowing custom item creation via the ItemAdding event.

public void SetItems<T>(System.Collections.Generic.IEnumerable<T> values);

Type parameters

T

The type of values to be added to the tree view.

Parameters

values System.Collections.Generic.IEnumerable<T>

The collection of values to set in the tree view.

Events

TreeViewControl.ItemAdding Event

Occurs when an item is being added to the tree view, allowing for modification of the item's path or name.

public event TreeViewItemAddingEventHandler? ItemAdding;

Event Type

TreeViewItemAddingEventHandler(object, TreeViewItemAddingEventArgs)

TreeViewControl.SelectedItemChanged Event

Occurs when the selected item in the tree view changes.

public event RoutedPropertyChangedEventHandler<object>? SelectedItemChanged;

Event Type

System.Windows.RoutedPropertyChangedEventHandler<System.Object>

VisualBackgroundTasksControl Class

VisualBackgroundTasksControl

public class VisualBackgroundTasksControl : System.Windows.Controls.UserControl, System.Windows.Markup.IComponentConnector

Inheritance System.Object → System.Windows.Threading.DispatcherObject → System.Windows.DependencyObject → System.Windows.Media.Visual → System.Windows.UIElement → System.Windows.FrameworkElement → System.Windows.Controls.Control → System.Windows.Controls.ContentControl → System.Windows.Controls.UserControl → VisualBackgroundTasksControl

Implements System.Windows.Markup.IComponentConnector

Constructors

VisualBackgroundTasksControl() Constructor

Initializes a new instance of the VisualBackgroundTasksControl class.

public VisualBackgroundTasksControl();

Fields

VisualBackgroundTasksControl.VisualBackgroundTasksProperty Field

Identifies the VisualBackgroundTasks dependency property.

public static readonly DependencyProperty VisualBackgroundTasksProperty;

Field Value

System.Windows.DependencyProperty

Properties

VisualBackgroundTasksControl.VisualBackgroundTasks Property

Gets or sets the collection of visual background tasks to be displayed and managed by the control.

public System.Collections.ObjectModel.ObservableCollection<DiGi.UI.WPF.Interfaces.IVisualBackgroundTask>? VisualBackgroundTasks { get; set; }

Property Value

System.Collections.ObjectModel.ObservableCollection<IVisualBackgroundTask>

Methods

VisualBackgroundTasksControl.InitializeComponent() Method

InitializeComponent

public void InitializeComponent();

Implements InitializeComponent()

Clone this wiki locally