Daniel's XL Toolbox NG
Bovender.HtmlFiles.HtmlFileViewModel Class Reference

View model for a HTML file. More...

Inheritance diagram for Bovender.HtmlFiles.HtmlFileViewModel:
Collaboration diagram for Bovender.HtmlFiles.HtmlFileViewModel:

Public Member Functions

 HtmlFileViewModel (string packUri)
 Constructor that loads a HTML file from a qualified pack URI. More...
 
 HtmlFileViewModel (string assemblyName, string filePath)
 Constructor that loads a HTML file given an assembly name and a path to a file that has its build action set to "Resource". More...
 
 HtmlFileViewModel (string caption, string assemblyName, string filePath)
 Loads a HTML file given an assembly name and file name and sets a caption. More...
 
override object RevealModelObject ()
 Returns the model object that this view model wraps or null if there is no wrapped model object. More...
 
 HtmlFileViewModel (string packUri)
 Constructor that loads a HTML file from a qualified pack URI. More...
 
 HtmlFileViewModel (string assemblyName, string filePath)
 Constructor that loads a HTML file given an assembly name and a path to a file that has its build action set to "Resource". More...
 
 HtmlFileViewModel (string caption, string assemblyName, string filePath)
 Loads a HTML file given an assembly name and file name and sets a caption. More...
 
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...
 

Properties

string Caption [get, set]
 
Stream HtmlStream [get, set]
 
- 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...
 

Additional Inherited Members

- 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...
 
- 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 a HTML file.

Constructor & Destructor Documentation

◆ HtmlFileViewModel() [1/6]

Bovender.HtmlFiles.HtmlFileViewModel.HtmlFileViewModel ( string  packUri)
inline

Constructor that loads a HTML file from a qualified pack URI.

Parameters
packUriValid absolute pack URI (e.g. "pack://application:,,,/ASSEMBLYNAME;component/FILENAME"

The build action of the file to be loaded must be "Resource".

◆ HtmlFileViewModel() [2/6]

Bovender.HtmlFiles.HtmlFileViewModel.HtmlFileViewModel ( string  assemblyName,
string  filePath 
)
inline

Constructor that loads a HTML file given an assembly name and a path to a file that has its build action set to "Resource".

Parameters
assemblyNameAssembly name
filePathHTML file in the assembly (build action must be "Resource")

◆ HtmlFileViewModel() [3/6]

Bovender.HtmlFiles.HtmlFileViewModel.HtmlFileViewModel ( string  caption,
string  assemblyName,
string  filePath 
)
inline

Loads a HTML file given an assembly name and file name and sets a caption.

Parameters
captionCustom caption
assemblyNameAssembly name
filePathHTML file in the assembly (build action must be "Resource")

◆ HtmlFileViewModel() [4/6]

Bovender.HtmlFiles.HtmlFileViewModel.HtmlFileViewModel ( string  packUri)
inline

Constructor that loads a HTML file from a qualified pack URI.

Parameters
packUriValid absolute pack URI (e.g. "pack://application:,,,/ASSEMBLYNAME;component/FILENAME"

The build action of the file to be loaded must be "Resource".

◆ HtmlFileViewModel() [5/6]

Bovender.HtmlFiles.HtmlFileViewModel.HtmlFileViewModel ( string  assemblyName,
string  filePath 
)
inline

Constructor that loads a HTML file given an assembly name and a path to a file that has its build action set to "Resource".

Parameters
assemblyNameAssembly name
filePathHTML file in the assembly (build action must be "Resource")

◆ HtmlFileViewModel() [6/6]

Bovender.HtmlFiles.HtmlFileViewModel.HtmlFileViewModel ( string  caption,
string  assemblyName,
string  filePath 
)
inline

Loads a HTML file given an assembly name and file name and sets a caption.

Parameters
captionCustom caption
assemblyNameAssembly name
filePathHTML file in the assembly (build action must be "Resource")

Member Function Documentation

◆ RevealModelObject() [1/2]

override object Bovender.HtmlFiles.HtmlFileViewModel.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.

◆ RevealModelObject() [2/2]

override object Bovender.HtmlFiles.HtmlFileViewModel.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.

Property Documentation

◆ Caption

string Bovender.HtmlFiles.HtmlFileViewModel.Caption
getset

◆ HtmlStream

Stream Bovender.HtmlFiles.HtmlFileViewModel.HtmlStream
getset

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