Table of Contents

Namespace Tripous.Desktop

Classes

AppForm

A base class for a UI embeddable in Avalonia.Controls.TabItem controls.

AppFormDialog

Shows a modal window with an embedded form (UserControl)

AppFormPagerHandler

Handles a tab control which displays forms (UserControls) embedded in TabItems.

AvaloniaAssets

Handles Avalonia resources.

CommandTreeViewForm

Displays application commands in a tree view.

ConfigDialog

Displays and edits registered application configuration properties.

ControlBinding

Binding information for simple controls (single-line controls, lookup combo-boxes and locator boxes).

ControlBindingHelper

Provides helper methods for binding Avalonia controls to data rows.

DataForm

A data form with a List part and an Item part.

All user initiated form actions should enter through Execute(DataFormAction). The ExecuteXXXX() methods are the action handlers and they are the only methods that should directly change, or eventually cause a change to, the FormState.

Low level data operation methods, such as ListSelect(), Insert(), Load(object), Delete(object) and Save(), should be called only by the corresponding ExecuteXXXX() method. This keeps UI commands, keyboard shortcuts and toolbar buttons on the same execution path.

The cancel flow is intentionally split. ExecuteCancel() handles the Cancel action. ExecuteCancelEdit() handles only rejecting item changes. When an item has changes, Cancel asks for confirmation, rejects the changes, refreshes the item controls and stays in the Item part. A second Cancel, with no changes left, returns to the List part.

Startup is the only intentional exception to the general rule. ExecuteStartAction() may call ExecuteEdit(RowId) or ExecuteInsert() directly and delayed through the UI dispatcher. At startup the list part may not be loaded yet, so Execute(Edit) cannot always resolve the desired row through the current list row. This exception is for bootstrapping only; normal UI actions should still use Execute(DataFormAction).

DataFormContext

Holds the created objects and result data of a form opening operation.

DbConnectionEditDialog

Dialog used to edit database connection information.

DesktopExceptionHandler

Handles exceptions in the desktop application.

DesktopRegistry

A registry of FormDef instances.

DetailGridCommandContext

Provides the runtime context used by detail table grid commands.

DialogInfo

Provides context and result data for a dialog window.

DialogWindow

Base class for modal dialog windows.

FirstRunBoxData

Contains first run dialog data.

FirstRunDialog

Dialog used to collect first run user information.

FormContext

Holds the created objects and result data of a form opening operation.

FormDef

Describes a form

GridColumnDef

Used with group grids, i.e. grids with groups, summaries, etc.

GridCommand

Describes a command exposed by a grid toolbar, shortcut, or context menu.

GridCommandContext

Provides the runtime context used when a grid command is checked or executed.

GroupGridBinder

Provides helper methods for binding group grids to data tables and definitions.

GroupGridColumnBinding

Binding information for a group grid column.

GroupGridLocatorInplaceEditor

Provides a Tripous locator in-place editor for GroupGrid cells.

Highlighters

Provides syntax highlighter lookup methods.

InputBox

Dialog used to request a text value from the user.

InputBoxData

Contains input box dialog data.

ItemBinder

Binds to single (Item) controls, no grids.

It watches for CurrentRow changes and notifies its controls.

ItemFactBoxControl

Base class for desktop controls that render item FactBox data.

ItemInfoFactBoxControl

The built-in desktop FactBox control that displays item and structure information.

ItemPage

The item part of a DataForm

ItemStructureFactBoxControl

Desktop FactBox control that displays item module structure information.

LocatorBox

A composite locator editor.

LocatorBoxRowEventArgs

Event arguments for locator row selection.

LogBox

Provides thread-safe logging to a text box.

LoginBoxData

Contains login dialog data.

LoginDialog

Dialog used to collect login credentials.

LookupDisplayConverter

Converts lookup values to display text.

MenuExtensions

Provides extension methods for creating menu items.

MessageBox

Displays a modal message box.

ReferenceContextMenu

Common context menu for controls that edit reference values, such as lookup and locator controls.

ReferenceMenuCommandContext

Provides the runtime context used by a reference context menu action.

SqlFilterInfo

Holds UI controls associated with a SQL filter definition.

SqlFilterPanelHandler

Creates and manages SQL filter controls in a panel.

ToolBar

Helper class for creating and managing toolbar controls.

TripousAvalonExtensions

Provides extension methods for Avalonia controls.

TripousBinding

Base class for Tripous UI bindings.

TripousDesktopException

Represents errors that occur in Tripous desktop services and UI.

Ui

Constants

UiDetailTableInfo

Information about a detail grid UI.

UiFactory

Creates reusable controls used by item page layouts and field editors.

UiFieldInfo

UI information regarding the association of a FieldDef and a Control.

UiGlobalSettings

Global settings for the UI.

UiItemContext

Holds the shared state required while building and binding an item page UI.

UiItemDetails

Creates the UI for item page details, including detail tabs, one-to-one detail sections and detail grids.

UiItemInfo

Creates and populates the metadata objects used while building an item page UI.

UiItemPage

Builds the main layout of an item page, including field groups, field rows and top-table layouts.

UiTableInfo

UI information regarding a single-row TableDef in an ItemPage form.

Interfaces

IConfigEditor

Provides a desktop editor for a complex configuration property.

IGridHandler

Provides commands and executes them for a grid.

IReferenceContextMenuHost

Provides command handling for a reference context menu.

Enums

DataFormAction

The action of a data-form, as a result of a button or mouse item click, or any other cause.

DataFormState

The state of a data-form indicates the UI the form is currently displaying

FormDisplayMode

Indicates how a form is opened and hosted.

GridActionType

Defines the standard command action types a grid may support.

HighlightMode

Defines supported syntax highlighting modes.

ImageSizeType

Defines common image size categories.

MessageBoxMode

Defines the display mode of a message box.

ModalResult

Defines the result of a modal dialog.

ReferenceMenuActionType

Defines the standard actions of a reference context menu.