Daniel's XL Toolbox NG
XLToolbox.Export.ViewModels.SettingsViewModelBase Class Referenceabstract

Abstract base class for the SingleExportSettingsViewModel and BatchExportSettingsViewModel classes. More...

Inheritance diagram for XLToolbox.Export.ViewModels.SettingsViewModelBase:
Collaboration diagram for XLToolbox.Export.ViewModels.SettingsViewModelBase:

Public Member Functions

 SettingsViewModelBase (Bovender.Mvvm.Models.ProcessModel exporter)
 
override object RevealModelObject ()
 

Protected Member Functions

abstract void DoExport ()
 Called when the ExportCommand is executed, triggers the export process. More...
 
abstract bool CanExport ()
 
string LoadExportPath ()
 Returns the default path for export; this is either the path that was previously used to export from the current workbook, or the last used path, or the path of the current workbook, or the path for 'My Documents'. More...
 
virtual void SaveExportPath ()
 Saves the current export path for reuse. More...
 
virtual void DoEditPresets ()
 

Properties

PresetViewModel SelectedPreset [get, set]
 
PresetsRepositoryViewModel PresetViewModels [get]
 
string FileName [get, set]
 
Settings Settings [get, set]
 
DelegatingCommand EditPresetsCommand [get]
 
DelegatingCommand ExportCommand [get]
 
Message< ViewModelMessageContentEditPresetsMessage [get]
 
static NLog.Logger Logger [get]
 

Detailed Description

Abstract base class for the SingleExportSettingsViewModel and BatchExportSettingsViewModel classes.

Rather than exposing a single PresetViewModel to subscribers, this view model has a PresetsRepository property so that subscribed views can select a preset from a preset repository. The last selected preset will be relayed to the wrapped Settings object.

Constructor & Destructor Documentation

◆ SettingsViewModelBase()

XLToolbox.Export.ViewModels.SettingsViewModelBase.SettingsViewModelBase ( Bovender.Mvvm.Models.ProcessModel  exporter)
inline

Member Function Documentation

◆ CanExport()

abstract bool XLToolbox.Export.ViewModels.SettingsViewModelBase.CanExport ( )
protectedpure virtual

◆ DoEditPresets()

virtual void XLToolbox.Export.ViewModels.SettingsViewModelBase.DoEditPresets ( )
inlineprotectedvirtual

◆ DoExport()

abstract void XLToolbox.Export.ViewModels.SettingsViewModelBase.DoExport ( )
protectedpure virtual

Called when the ExportCommand is executed, triggers the export process.

Implemented in XLToolbox.Export.ViewModels.BatchExportSettingsViewModel, and XLToolbox.Export.ViewModels.SingleExportSettingsViewModel.

◆ LoadExportPath()

string XLToolbox.Export.ViewModels.SettingsViewModelBase.LoadExportPath ( )
inlineprotected

Returns the default path for export; this is either the path that was previously used to export from the current workbook, or the last used path, or the path of the current workbook, or the path for 'My Documents'.

Returns
Default export path.

◆ RevealModelObject()

override object XLToolbox.Export.ViewModels.SettingsViewModelBase.RevealModelObject ( )
inline

◆ SaveExportPath()

virtual void XLToolbox.Export.ViewModels.SettingsViewModelBase.SaveExportPath ( )
inlineprotectedvirtual

Saves the current export path for reuse.

Reimplemented in XLToolbox.Export.ViewModels.SingleExportSettingsViewModel.

Property Documentation

◆ EditPresetsCommand

DelegatingCommand XLToolbox.Export.ViewModels.SettingsViewModelBase.EditPresetsCommand
get

◆ EditPresetsMessage

Message<ViewModelMessageContent> XLToolbox.Export.ViewModels.SettingsViewModelBase.EditPresetsMessage
get

◆ ExportCommand

DelegatingCommand XLToolbox.Export.ViewModels.SettingsViewModelBase.ExportCommand
get

◆ FileName

string XLToolbox.Export.ViewModels.SettingsViewModelBase.FileName
getset

◆ Logger

NLog.Logger XLToolbox.Export.ViewModels.SettingsViewModelBase.Logger
staticgetprotected

◆ PresetViewModels

PresetsRepositoryViewModel XLToolbox.Export.ViewModels.SettingsViewModelBase.PresetViewModels
get

◆ SelectedPreset

PresetViewModel XLToolbox.Export.ViewModels.SettingsViewModelBase.SelectedPreset
getset

◆ Settings

Settings XLToolbox.Export.ViewModels.SettingsViewModelBase.Settings
getsetprotected

The documentation for this class was generated from the following file: