Class
DBKit.Dialog
DBKit.Dialog
Description
Used to display DBKit controls with data from the current row of a database table to which it is assigned.
Only the members declared by DBKit.Dialog itself are described here; for the inherited members, see the parent class.
Properties
Name |
Type |
Read-Only |
Shared |
|---|---|---|---|
Property descriptions
DBKit.Dialog.AutomaticHints
AutomaticHints As Boolean
Whether the controls on this dialog automatically set their Hint from the database column's display name when no Hint is set.
The default is True.
DBKit.Dialog.ConfirmCancelButtonCaption
ConfirmCancelButtonCaption As String
The caption of the Cancel button in the unsaved-changes confirmation dialog.
The default is "Cancel".
DBKit.Dialog.ConfirmContinueButtonCaption
ConfirmContinueButtonCaption As String
The caption of the Continue button in the unsaved-changes confirmation dialog.
The default is "Continue".
DBKit.Dialog.CurrentRow
CurrentRow As DBKit.Row
The current row of the database table this dialog operates on.
DBKit.Dialog.Database
Database As Database
The database this dialog operates on.
DBKit.Dialog.DeleteConfirmExplanation
DeleteConfirmExplanation As String
The explanation text of the delete confirmation dialog.
The default is "This action cannot be undone."
DBKit.Dialog.DeleteConfirmMessage
DeleteConfirmMessage As String
The message text of the delete confirmation dialog.
The default is "Are you sure you want to delete this record?".
DBKit.Dialog.DeleteConfirmTitle
DeleteConfirmTitle As String
The title of the delete confirmation dialog.
The default is "Delete Record".
DBKit.Dialog.Limit
Limit As Integer
The maximum number of rows loaded from the database table.
DBKit.Dialog.OrderBy
OrderBy As String
The sort order used when loading rows from the database table.
DBKit.Dialog.TableName
TableName As String
The name of the database table this dialog operates on.
DBKit.Dialog.TableRelationships
TableRelationships As String
The relationships between this dialog's table and other tables, with one relationship per line in the format childTableName.childColumnName = parentTableName.parentColumnName. Appending = viaColumnName is optional and specifies the via column, which identifies which relationship to use when the child table has more than one foreign key to the same parent table.
The child column is the foreign key and the parent column is the primary key it refers to. The relationships are loaded when the dialog opens and are used to find related rows.
DBKit.Dialog.UnsavedChangesExplanation
UnsavedChangesExplanation As String
The explanation text of the unsaved-changes confirmation dialog.
The default is "If you continue, your changes will not be saved.".
DBKit.Dialog.UnsavedChangesMessage
UnsavedChangesMessage As String
The message text of the unsaved-changes confirmation dialog.
The default is "You have unsaved changes.".
DBKit.Dialog.UnsavedChangesTitle
UnsavedChangesTitle As String
The title of the unsaved-changes confirmation dialog.
The default is "Unsaved Changes".
DBKit.Dialog.Where
Where As String
The filter used when loading rows from the database table.
Notes
Using a dialog
To display a modal dialog on the web, create a DBKit.Dialog subclass and add DBKit controls to it like any other layout. To pass data in and out of the dialog, add public properties to the subclass: set them before calling Show, and read them in the dialog's Dismissed event. For example, the ChooseCustomerDialog in the DBKit Web example project has a CustomerID property: the page sets it to the current customer before showing the dialog, then reads it back in Dismissed to update the invoice. On desktop there is no DBKit.Dialog; use a DBKit.Window subclass shown with ShowModal instead.
Localization
Localize the layout's user-facing text (the delete-confirmation and unsaved-changes dialog text and the confirmation button captions) the standard Xojo way: assign a dynamic constant to each property and provide translations for as many languages as you need, or localize the property values directly.
Compatibility
Project Types |
Web |
Operating Systems |
All |