Daniel's XL Toolbox NG
XLToolbox.Excel.ViewModels.SelectionViewModel Class Reference

View model for the current selection of a running Excel instance. Note that the selection wrapped by this view model always reflects the current selection of the Excel application; it is not fixed. More...

Inheritance diagram for XLToolbox.Excel.ViewModels.SelectionViewModel:
Collaboration diagram for XLToolbox.Excel.ViewModels.SelectionViewModel:

Public Member Functions

bool CopyToClipboard ()
 Copies the current selection to the clipboard. Returns true on success, false on failure. More...
 
void SaveToEmf (string fileName)
 
 SelectionViewModel (Application excelApplication)
 Constructs the view model by binding to a particular Excel application instance. More...
 
void Dispose ()
 
override object RevealModelObject ()
 Returns the model object that this view model wraps or null if there is no wrapped model object. More...
 
- Public Member Functions inherited from Bovender.Mvvm.ViewModels.ViewModelBase
bool IsViewModelOf (object model)
 Determines whether the current object is a view model of a particular model object. Returns false if either the model or the viewmodel's wrapped model object is null. More...
 
Window InjectInto< T > ()
 Injects the ViewModel into a newly created View and wires the RequestCloseView event. More...
 
Window InjectInto (Window view)
 Injects the view model into an existing view by setting the view's DataContext. More...
 
void InjectAndShowInThread< T > (IntPtr ownerForm)
 Creates a new thread that creates a new instance of the view T , sets its Forms owner and shows it modelessly. Use this to show views during asynchronous operations. More...
 
void InjectAndShowInThread< T > ()
 Creates a new thread that creates a new instance of the view T and shows it modelessly. Use this to show views during asynchronous operations. More...
 
void InjectAndShowDialogInThread< T > (IntPtr ownerForm)
 Creates a new thread that creates a new instance of the view T and shows it as a dialog. Use this to show dialogs during asynchronous operations. More...
 
bool IsViewModelOf (object model)
 Determines whether the current object is a view model of a particular model object. Returns false if either the model or the viewmodel's wrapped model object is null. More...
 
Window InjectInto< T > ()
 Injects the ViewModel into a newly created View and wires the RequestCloseView event. More...
 
Window InjectInto (Window view)
 Injects the view model into an existing view by setting the view's DataContext. More...
 
void InjectAndShowInThread< T > (IntPtr ownerForm)
 Creates a new thread that creates a new instance of the view T , sets its Forms owner and shows it modelessly. Use this to show views during asynchronous operations. More...
 
void InjectAndShowInThread< T > ()
 Creates a new thread that creates a new instance of the view T and shows it modelessly. Use this to show views during asynchronous operations. More...
 
void InjectAndShowDialogInThread< T > (IntPtr ownerForm)
 Creates a new thread that creates a new instance of the view T and shows it as a dialog. Use this to show dialogs during asynchronous operations. More...
 

Protected Member Functions

void Dispose (bool disposing)
 
void OnSelectionChanged ()
 
- Protected Member Functions inherited from Bovender.Mvvm.ViewModels.ViewModelBase
virtual void OnPropertyChanged (string propertyName)
 
virtual bool CanCloseView ()
 
virtual void DoCloseView ()
 
 ViewModelBase ()
 Does not allow public instantiation of this class. More...
 
virtual void OnPropertyChanged (string propertyName)
 
virtual bool CanCloseView ()
 
virtual void DoCloseView ()
 
 ViewModelBase ()
 Does not allow public instantiation of this class. More...
 

Properties

dynamic Selection [get]
 Exposes the bound application's Selection property. More...
 
Range Range [get]
 
bool IsRange [get]
 
Reference Reference [get]
 
Windows.Rect Bounds [get]
 
string Name [get]
 
- Properties inherited from Bovender.Mvvm.ViewModels.ViewModelBase
ICommand CloseViewCommand [get]
 
virtual string DisplayString [get, set]
 
bool IsSelected [get, set]
 
Dispatcher ViewDispatcher [get, set]
 
Dispatcher Dispatcher [get]
 Captures the dispatcher of the thread that the object was created in. More...
 

Events

EventHandler< SelectionChangedEventArgsSelectionChanged
 
- Events inherited from Bovender.Mvvm.ViewModels.ViewModelBase
EventHandler RequestCloseView
 Raised by the CloseView Command, signals that associated views are to be closed. More...
 
PropertyChangedEventHandler PropertyChanged
 

Detailed Description

View model for the current selection of a running Excel instance. Note that the selection wrapped by this view model always reflects the current selection of the Excel application; it is not fixed.

Constructor & Destructor Documentation

◆ SelectionViewModel()

XLToolbox.Excel.ViewModels.SelectionViewModel.SelectionViewModel ( Application  excelApplication)
inline

Constructs the view model by binding to a particular Excel application instance.

Parameters
excelApplicationExcel instance whose selection this view model wraps.

Member Function Documentation

◆ CopyToClipboard()

bool XLToolbox.Excel.ViewModels.SelectionViewModel.CopyToClipboard ( )
inline

Copies the current selection to the clipboard. Returns true on success, false on failure.

Returns

◆ Dispose() [1/2]

void XLToolbox.Excel.ViewModels.SelectionViewModel.Dispose ( )
inline

◆ Dispose() [2/2]

void XLToolbox.Excel.ViewModels.SelectionViewModel.Dispose ( bool  disposing)
inlineprotected

◆ OnSelectionChanged()

void XLToolbox.Excel.ViewModels.SelectionViewModel.OnSelectionChanged ( )
inlineprotected

◆ RevealModelObject()

override object XLToolbox.Excel.ViewModels.SelectionViewModel.RevealModelObject ( )
inlinevirtual

Returns the model object that this view model wraps or null if there is no wrapped model object.

This is a method rather than a property to make data binding more difficult (if not impossible), because binding directly to the model object is discouraged. However, certain users such as a ViewModelCollection might need access to the wrapped model object.

Returns
Model object.

Implements Bovender.Mvvm.ViewModels.ViewModelBase.

◆ SaveToEmf()

void XLToolbox.Excel.ViewModels.SelectionViewModel.SaveToEmf ( string  fileName)
inline

Property Documentation

◆ Bounds

Windows.Rect XLToolbox.Excel.ViewModels.SelectionViewModel.Bounds
get

◆ IsRange

bool XLToolbox.Excel.ViewModels.SelectionViewModel.IsRange
get

◆ Name

string XLToolbox.Excel.ViewModels.SelectionViewModel.Name
get

◆ Range

Range XLToolbox.Excel.ViewModels.SelectionViewModel.Range
get

◆ Reference

Reference XLToolbox.Excel.ViewModels.SelectionViewModel.Reference
get

◆ Selection

dynamic XLToolbox.Excel.ViewModels.SelectionViewModel.Selection
get

Exposes the bound application's Selection property.

Event Documentation

◆ SelectionChanged

EventHandler<SelectionChangedEventArgs> XLToolbox.Excel.ViewModels.SelectionViewModel.SelectionChanged

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