How Dialog Forms Work - Revision history

Adrian: /* How the FormDialog loads the templates */

2021-12-09T15:01:50Z

How the FormDialog loads the templates

Adrian: /* How the FormDialog loads the templates */

2021-12-09T14:45:43Z

How the FormDialog loads the templates

Adrian at 19:26, 8 December 2021

2021-12-08T19:26:46Z

Adrian: Added section describing the associations needed to create a new form

2021-12-08T19:06:46Z

Added section describing the associations needed to create a new form

Adrian: /* UI Guide Menu */

2021-11-30T15:29:17Z

UI Guide Menu

Adrian: /* Overview */

2021-11-22T15:44:09Z

Overview

Adrian at 15:43, 22 November 2021

2021-11-22T15:43:03Z

Adrian: /* Overview */

2021-11-22T15:42:39Z

Overview

Adrian: /* Overview */

2021-11-22T15:41:14Z

Overview

Adrian at 15:40, 22 November 2021

2021-11-22T15:40:53Z

← Older revision		Revision as of 15:01, 9 December 2021
Line 97:		Line 97:
	The TModel, or in this case the MediaModel, will contain the data stored in the database		The TModel, or in this case the MediaModel, will contain the data stored in the database

−	[File:DialogForm-Views-and-Models-00.png]	+	<div style="display:flex; justify-content:center">[[File:DialogForm-Views-and-Models-00.png\|1000px\|Standard Image Usage]]</div>

← Older revision		Revision as of 14:45, 9 December 2021
Line 96:		Line 96:

	The TModel, or in this case the MediaModel, will contain the data stored in the database		The TModel, or in this case the MediaModel, will contain the data stored in the database
		+
		+	[File:DialogForm-Views-and-Models-00.png]

← Older revision		Revision as of 19:26, 8 December 2021
Line 71:		Line 71:

	As seen above, the Template source registers the Media.xaml page as a resource that can be searched. The Key and FormTemplateName must match for the proper form to be loaded into the dialog.		As seen above, the Template source registers the Media.xaml page as a resource that can be searched. The Key and FormTemplateName must match for the proper form to be loaded into the dialog.
		+
		+	== How the FormDialog loads the templates ==
		+	<br/>
		+	A FormDialogViewModel takes two Generic parameters that determine which form to use.
		+	FormDialogViewModel<TForm, TFormItem>
		+
		+	In the intended View/ViewModel, a FormDialog parameter is loaded via dependency injection. The proper generics are inserted in the View/ViewModel.
		+	public FormDialogViewModel<b><MediaForm, MediaViewModel></b> FormDialog { get; set; }
		+
		+	public MediaMenuViewModel(FormDialogViewModel<MediaForm, MediaViewModel> formDialog)
		+	{ FormDialog = formDialog; }
		+
		+	The Generic determine which form to use. Above we've used <b>MediaForm</b> and <b>MediaViewModel</b>.
		+
		+	The MediaForm class extends BaseFormViewModel, which also contain generics for the Form's ViewModel and the Model that the form is using/updating.
		+	abstract class BaseFormViewModel<TFormItem, TModel>
		+
		+	In this MediaForm/BaseFormViewModel, this class will contain all the code that occurs when the form is New(Instantiated)/Updated/Saved/Deleted.
		+
		+	Since MediaForm extends the abstract class BaseFormViewModel, it'll need the generics defined.
		+	public class MediaForm : BaseFormViewModel<MediaViewModel, MediaModel>
		+
		+	The TFormItem, or in this case MediaViewModel, will contain the data presented to the form or UI.
		+
		+	The TModel, or in this case the MediaModel, will contain the data stored in the database

← Older revision		Revision as of 19:06, 8 December 2021
Line 40:		Line 40:
	\|-		\|-
	\|}		\|}
		+
		+	==Creating a New Form==
		+
		+	If you need to create a new form, you need to create the appropriate xamls and classes <b>from above</b> and then register them in Templates.xaml.
		+
		+	<b>In addition</b>, for the FormDialog to find the correct FormTemplate, the following need to match:
		+
		+	::{\| class="wikitable"
		+	! Resource
		+	! Code
		+	\|-
		+	\| Media.xaml
		+	\|
		+	<DataTemplate x:Key="MediaForm">
		+	\|-
		+	\| MediaForm.cs
		+	\|
		+	public override IFormDialogSettings GetFormDialogSettings(FormMode mode)
		+	{
		+	var settings = new TruxtonClientFormDialogSettings()
		+	{
		+	NegativeButtonText = "Cancel",
		+	FormTemplateName = "MediaForm"
		+	};
		+	\|-
		+	\| Templates.xaml
		+	\|
		+	<pc:SharedResourceDictionary Source="/Truxton Analyst;component/Templates/Forms/Media.xaml" />
		+	\|}
		+
		+	As seen above, the Template source registers the Media.xaml page as a resource that can be searched. The Key and FormTemplateName must match for the proper form to be loaded into the dialog.

@@ Line 11: / Line 11: @@
 :# [[ How Reports are Displayed ]]
 :# [[ How Dialog Forms Work ]]
 == Overview ==

@@ Line 25: / Line 25: @@
 |-
 | PageViewModel.cs
-| This class loads and manages the data on the <b>page</b>, the view that you look at when you navigate using the navigation menu.
+| This class loads and manages the data on the <b>page</b>, the view that you look at when you navigate using the navigation menu. The page will contain a form but the form's logic and UI is stored elsewhere.
 |-
 | Form.cs

← Older revision		Revision as of 15:43, 22 November 2021
Line 37:		Line 37:
	\|-		\|-
	\|}		\|}
−
−	~~== Main Files ==~~
−
−	~~::{\| class="wikitable"~~
−	~~! File~~
−	~~! Summary~~
−	~~! Path~~
−	\|-
−	~~\| ReportSection.xaml~~
−	~~\| This view has a WebBrowser element that displays the HTML. It's loaded using the Binding HTMLReport.Stream~~
−	~~\| \Truxton\Client\TruxtonClient\TruxtonClient\Templates\ReportSection.xaml~~
−	\|-
−	~~\| ReportSectionViewModel.cs~~
−	~~\| This is the ViewModel for the ReportSection~~
−	~~\| \Truxton\Client\TruxtonClient\TruxtonClient\ViewModels\Reports\ReportSectionViewModel.cs~~
−	\|-
−	~~\| HTMLReportViewModel.cs~~
−	~~\| This is where the report-generating functions are called in loadReportContent~~
−	~~\| \Truxton\Client\TruxtonClient\TruxtonClient\ViewModels\Reports\HTMLReportViewModel.cs~~
−	\|-
−	\|}
−
−
−	~~=== HTMLReportViewModel.cs ===~~
−
−	~~::In the <b>loadReportContent</b> function,~~
−
−	~~::the relevant reportFactory is selected.~~
−
−	~~<div style="display:flex;justify-content:center;">~~
−	~~{\| class="wikitable"~~
−	~~! loadReportContent~~
−	\|-
−	\|
−	~~var reportFactory = _ctx.ReportService.GetReportFactory(req.ReporterID);~~
−	\|-
−	\|}
−	~~</div>~~
−
−	~~::Then, the report is generated resulting in a ITruxtonReport.~~
−
−	~~<div style="display:flex;justify-content:center;">~~
−	~~{\| class="wikitable"~~
−	~~! loadReportContent~~
−	\|-
−	\|
−	~~var report = await reportFactory.GenerateAsync(req.ReportConfig, req.CTS.Token);~~
−	\|-
−	\|}
−	~~</div>~~
−
−	~~::Next, the reportContent(HTML) is generated resulting in a string that contains the HTML.~~
−
−	~~<div style="display:flex;justify-content:center;">~~
−	~~{\| class="wikitable"~~
−	~~! loadReportContent~~
−	\|-
−	\|
−	~~string reportContent = await report.GetReportContentAsync(req.CTS.Token);~~
−	\|-
−	\|}
−	~~</div>~~
−
−	~~::Eventually, the string is converted into a stream then assigned so that it's available for dataBinding.~~
−
−	~~<div style="display:flex;justify-content:center;">~~
−	~~{\| class="wikitable"~~
−	~~! loadReportContent~~
−	\|-
−	\|
−	~~Stream = req.Stream;~~
−	\|-
−	\|}
−	~~</div>~~
−
−	~~::For quick reference, the databinding can be found in <b>ReportSection.xaml</b>.~~
−
−	~~<div style="display:flex;justify-content:center;">~~
−	~~{\| class="wikitable"~~
−	~~! ReportSection.xaml~~
−	\|-
−	\|
−	~~<controls:WebBrowser x:Name="WebBrowser" Stream="{Binding <b>HTMLReport.Stream</b>}" />~~
−	\|-
−	\|}
−	~~</div>~~
−
−	~~::Here's the full snippet of loadReportConent with the relevant code.</b>.~~
−
−	~~<div style="display:flex;justify-content:center;">~~
−	~~{\| class="wikitable"~~
−	~~! loadReportContent~~
−	\|-
−	\|
−	~~var reportFactory = _ctx.ReportService.GetReportFactory(req.ReporterID);~~
−	~~if (reportFactory != null)~~
−	{
−	~~var report = await reportFactory.GenerateAsync(req.ReportConfig, req.CTS.Token);~~
−	~~report.ReportFormatter = ReportFormatter;~~
−	~~string reportContent = await report.GetReportContentAsync(req.CTS.Token);~~
−	~~if (!req.CTS.Token.IsCancellationRequested)~~
−	{
−	~~var bytes = Encoding.UTF8.GetBytes(reportContent);~~
−	~~req.Stream = new CancellableStream(bytes);~~
−	~~Stream = req.Stream;~~
−
−	~~string message = getActionMessage(req, reportFactory.Name);~~
−	~~await _ctx.InvestigationContext.AddActionAsync(message, CancellationToken.None);~~
−	}
−	}
−	\|-
−	\|}
−	~~</div>~~

@@ Line 32: / Line 32: @@
 | ViewModel.cs
 | This class defines the Model for the FormItem. The FormItem is the model loaded by -Form.cs that contains all the data from the UI.
 |-
 |}

@@ Line 28: / Line 28: @@
 |-
 | Form.cs
-| This class loads and manages the data on the Dialog Form, the form that you see when you're on the page and you click the "add" or "new" button. The xaml bindings are here mostly. The FormItems properties are loaded here <b>but they are not defined here</b>.
+| This class loads and manages the data on the Dialog Form, the form that you see when you're on the page and you click the "add" or "new" button. The xaml bindings are here mostly. The FormItems properties are loaded here <b>but they are not defined here</b>. This class also converts the FormItem model to the main Model.
 |-
-| ViewModelRegistrar.cs
+| ViewModel.cs
-| Registers the ViewModels so that the WorkspaceFactory can associate the View with the ViewModel
+| This class defines the Model for the FormItem. The FormItem is the model loaded by -Form.cs that contains all the data from the UI.
 | \Truxton\Client\TruxtonClient\TruxtonClient\PresentationCore\ViewModelRegistrar.cs
 |-
 |}