View model for the Settings class. More...

Inheritance diagram for XLToolbox.Export.ViewModels.BatchExportSettingsViewModel:

Collaboration diagram for XLToolbox.Export.ViewModels.BatchExportSettingsViewModel:

Public Member Functions
void	SanitizeOptions ()
	Makes sure that no disabled options are selected. More...

	BatchExportSettingsViewModel ()

	BatchExportSettingsViewModel (BatchExportSettings settings)

	BatchExportSettingsViewModel (BatchExporter batchExporter)

Public Member Functions inherited from XLToolbox.Export.ViewModels.SettingsViewModelBase
	SettingsViewModelBase (Bovender.Mvvm.Models.ProcessModel exporter)

override object	RevealModelObject ()

Static Public Member Functions
static BatchExportSettingsViewModel	FromLastUsed ()
	Returns a BatchExportSettingsViewModel object that wraps the last used BatchExportSettings stored in the assembly's Properties, or Null if no stored object exists. More...

static BatchExportSettingsViewModel	FromLastUsed (Workbook workbookContext)
	Returns a BatchExportSettingsViewModel object that wraps the last used BatchExportSettings stored in the workbookContent's hidden storage area, or the one stored in the assembly's Properties, or Null if no stored object exists. More...

Protected Member Functions
override void	UpdateProcessMessageContent (ProcessMessageContent processMessageContent)

override void	DoExport ()
	Called when the ExportCommand is executed, triggers the export process. More...

override bool	CanExport ()

Protected Member Functions inherited from XLToolbox.Export.ViewModels.SettingsViewModelBase
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
EnumProvider< BatchExportScope >	Scope `[get]`

EnumProvider< BatchExportLayout >	Layout `[get]`

EnumProvider< BatchExportObjects >	Objects `[get]`

string	Path `[get, set]`

bool	Screenshot `[get, set]`

bool	IsPresetEnabled `[get]`

bool	IsActiveSheetEnabled `[get, set]`

bool	IsActiveWorkbookEnabled `[get, set]`

bool	IsOpenWorkbooksEnabled `[get, set]`

bool	IsChartsEnabled `[get, set]`

bool	IsChartsAndShapesEnabled `[get, set]`

bool	IsSingleItemsEnabled `[get, set]`

bool	IsSheetLayoutEnabled `[get, set]`

DelegatingCommand	ChooseFolderCommand `[get]`
	Causes the ChooseFolderMessage to be sent. Upon confirmation of the message by a view, the Export process will be started. More...

Message< FileNameMessageContent >	ChooseFolderMessage `[get]`

Properties inherited from XLToolbox.Export.ViewModels.SettingsViewModelBase
PresetViewModel	SelectedPreset `[get, set]`

PresetsRepositoryViewModel	PresetViewModels `[get]`

string	FileName `[get, set]`

Settings	Settings `[get, set]`

DelegatingCommand	EditPresetsCommand `[get]`

DelegatingCommand	ExportCommand `[get]`

Message< ViewModelMessageContent >	EditPresetsMessage `[get]`

static NLog.Logger	Logger `[get]`

Detailed Description

View model for the Settings class.

Constructor & Destructor Documentation

◆ BatchExportSettingsViewModel() [1/3]

XLToolbox.Export.ViewModels.BatchExportSettingsViewModel.BatchExportSettingsViewModel ( )

inline

◆ BatchExportSettingsViewModel() [2/3]

XLToolbox.Export.ViewModels.BatchExportSettingsViewModel.BatchExportSettingsViewModel ( BatchExportSettings settings )

inline

◆ BatchExportSettingsViewModel() [3/3]

XLToolbox.Export.ViewModels.BatchExportSettingsViewModel.BatchExportSettingsViewModel ( BatchExporter batchExporter )

inline

Member Function Documentation

◆ CanExport()

override bool XLToolbox.Export.ViewModels.BatchExportSettingsViewModel.CanExport ( )

inlineprotectedvirtual

Implements XLToolbox.Export.ViewModels.SettingsViewModelBase.

◆ DoExport()

override void XLToolbox.Export.ViewModels.BatchExportSettingsViewModel.DoExport ( )

inlineprotectedvirtual

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

Implements XLToolbox.Export.ViewModels.SettingsViewModelBase.

◆ FromLastUsed() [1/2]

static BatchExportSettingsViewModel XLToolbox.Export.ViewModels.BatchExportSettingsViewModel.FromLastUsed ( )

inlinestatic

Returns a BatchExportSettingsViewModel object that wraps the last used BatchExportSettings stored in the assembly's Properties, or Null if no stored object exists.

Returns: BatchExportSettingsViewModel object with last used settings model, or Null if no such object exists.

◆ FromLastUsed() [2/2]

static BatchExportSettingsViewModel XLToolbox.Export.ViewModels.BatchExportSettingsViewModel.FromLastUsed ( Workbook workbookContext )

inlinestatic

Returns a BatchExportSettingsViewModel object that wraps the last used BatchExportSettings stored in the workbookContent's hidden storage area, or the one stored in the assembly's Properties, or Null if no stored object exists.

Parameters

workbookContext

Returns: BatchExportSettingsViewModel object with last used settings model, or Null if no such object exists.

◆ SanitizeOptions()

void XLToolbox.Export.ViewModels.BatchExportSettingsViewModel.SanitizeOptions ( )

inline

Makes sure that no disabled options are selected.

This method is not automatically called in the constructor in order to allow subscribed views to decide whether to 'sanitize' or not. For example, the QuickExporter.ExportBatch() method deliberately refrains from 'sanitizing' so that the user can see what options are selected, but disabled.

◆ UpdateProcessMessageContent()

override void XLToolbox.Export.ViewModels.BatchExportSettingsViewModel.UpdateProcessMessageContent ( ProcessMessageContent processMessageContent )

inlineprotected

Property Documentation

◆ ChooseFolderCommand

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

XLToolbox/Export/ViewModels/BatchExportSettingsViewModel.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ BatchExportSettingsViewModel() [1/3]

◆ BatchExportSettingsViewModel() [2/3]

◆ BatchExportSettingsViewModel() [3/3]

Member Function Documentation

◆ CanExport()

◆ DoExport()

◆ FromLastUsed() [1/2]

◆ FromLastUsed() [2/2]

◆ SanitizeOptions()

◆ UpdateProcessMessageContent()

Property Documentation

◆ ChooseFolderCommand

◆ ChooseFolderMessage

◆ IsActiveSheetEnabled

◆ IsActiveWorkbookEnabled

◆ IsChartsAndShapesEnabled

◆ IsChartsEnabled

◆ IsOpenWorkbooksEnabled

◆ IsPresetEnabled

◆ IsSheetLayoutEnabled

◆ IsSingleItemsEnabled

◆ Layout

◆ Objects

◆ Path

◆ Scope

◆ Screenshot