C# Class SIL.FieldWorks.Common.PrintLayout.HFSetView

This is the small view that the Header/Footer setup dialog uses to display the header or footer previews
Inheritance: SIL.FieldWorks.Common.RootSites.SimpleRootSite
Mostra file Open project: sillsdev/FieldWorks Class Usage Examples

Public Methods

Method Description
HFSetView ( ISilDataAccess sda, SIL.FieldWorks.Common.PrintLayout.HeaderFooterVc vc, int hvoHeader ) : System

Creates a new HFSetView
MakeRoot ( ) : void

Makes the rootbox for the view.

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Executes in two distinct scenarios. 1. If disposing is true, the method has been called directly or indirectly by a user's code via the Dispose method. Both managed and unmanaged resources can be disposed. 2. If disposing is false, the method has been called by the runtime from inside the finalizer and you should not reference (access) other managed objects, as they already have been garbage collected. Only unmanaged resources can be disposed.

If any exceptions are thrown, that is fine. If the method is being done in a finalizer, it will be ignored. If it is thrown by client code calling Dispose, it needs to be handled by fixing the bug. If subclasses override this method, they should call the base implementation.

OnKeyPress ( KeyPressEventArgs e ) : void

Handles OnKeyPress to remove any formatting before passing the keystroke along. This prevents the gray background used for ORC strings from bleeding over into literal text.

Method Details

Dispose() protected method

Executes in two distinct scenarios. 1. If disposing is true, the method has been called directly or indirectly by a user's code via the Dispose method. Both managed and unmanaged resources can be disposed. 2. If disposing is false, the method has been called by the runtime from inside the finalizer and you should not reference (access) other managed objects, as they already have been garbage collected. Only unmanaged resources can be disposed.
If any exceptions are thrown, that is fine. If the method is being done in a finalizer, it will be ignored. If it is thrown by client code calling Dispose, it needs to be handled by fixing the bug. If subclasses override this method, they should call the base implementation.
protected Dispose ( bool disposing ) : void
disposing bool
return void

HFSetView() public method

Creates a new HFSetView
public HFSetView ( ISilDataAccess sda, SIL.FieldWorks.Common.PrintLayout.HeaderFooterVc vc, int hvoHeader ) : System
sda ISilDataAccess The ISilDataAccess for the view
vc SIL.FieldWorks.Common.PrintLayout.HeaderFooterVc The view constructor used to create the view
hvoHeader int The id of the PubHeader used to get the Header/Footer /// information to display in the view
return System

MakeRoot() public method

Makes the rootbox for the view.
public MakeRoot ( ) : void
return void

OnKeyPress() protected method

Handles OnKeyPress to remove any formatting before passing the keystroke along. This prevents the gray background used for ORC strings from bleeding over into literal text.
protected OnKeyPress ( KeyPressEventArgs e ) : void
e System.Windows.Forms.KeyPressEventArgs
return void