C# Class SIL.FieldWorks.XWorks.GeneratedHtmlViewer

Summary description for GeneratedHtmlViewer.

IxCoreColleague is included in the IxCoreContentControl definition.

Inheritance: System.Windows.Forms.UserControl, IxCoreContentControl, IFWDisposable

ファイルを表示 Open project: sillsdev/FieldWorks

Protected Properties

Property	Type	Description
m_htmlControl	HtmlControl
m_iMaxURLCount	int
m_iURLCounter	int
m_mediator	Mediator
m_outputDirectory	string

Private Properties

Property	Type	Description
ApplyTransform	string
CopyFile	void
CountParams	int
CreateParameterList	System.Xml.Xsl.XsltArgumentList
DetermineNumberOfPrompts	void
DetermineNumberOfTransforms	void
DoAlsoSaveAs	void
GetExtensionFromNode	string
GetNormalStyleFontSize	string
GetParameters	System.Xml.Xsl.XsltArgumentList
GetTransform	System.Xml.Xsl.XslCompiledTransform
GetTransformFromFile	System.Xml.Xsl.XslCompiledTransform
InitAlsoSaveDialog	void
InitHtmlControl	void
InitProgressDialog	SIL.FieldWorks.Common.Controls.ProgressDialogWorkingOn
InitSaveAsWebpageDialog	void
InitializeComponent	void
OnBackButtonClick	void
OnForwardButtonClick	void
OnSaveAsHtmlButtonClick	void
PerformTransformations	void
ProduceSketch	void
ReadParameters	void
ReadRegistry	void
RemoveWriteProtection	void
ResetURLCount	void
SetAlsoSaveInfo	void
SetBackButtonEnabledState	void
SetForwardButtonEnabledState	void
SetStrings	void
ShowGeneratingPage	void
ShowSketch	void
UpdateProgress	void
WriteRegistry	void

Public Methods

Method	Description
CheckDisposed ( ) : void	Check to see if the object has been disposed. All public Properties and Methods should call this before doing anything else.
GeneratedHtmlViewer ( ) : System
GetMessageTargets ( ) : IxCoreColleague[]	Return an array of all of the objects which should 1) be queried when looking for someone to deliver a message to 2) be potential recipients of a broadcast
Init ( XCore.Mediator mediator, XmlNode configurationParameters ) : void	Initialize.
OnBeforeNavigate ( object sender, HtmlControlEventArgs e ) : void
OnDisplayExport ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool
OnDisplayMasterRefresh ( object commandObject, UIItemDisplayProperties &display ) : bool	Refresh doesn't make any sense for us -- regenerating the HTML sketch via m_GenerateBtn makes more sense. See LT-3961. Note that OnMasterRefresh is enabled by default if there is no OnDisplayMasterRefresh target method available.
OnDisplayShowTreeBar ( object commandObject, UIItemDisplayProperties &display ) : bool	see if it makes sense to display a menu controlling the "ShowRecordList" property
OnExport ( object argument ) : bool
OnSaveAsWebpage ( object parameterObj ) : bool
PerformRetrieval ( string &outputPath, ProgressDialogWorkingOn dlg ) : void
PopulateCtrlTabTargetCandidateList ( List targetCandidates ) : Control
PrepareToGoAway ( ) : bool	From IxCoreContentControl

Protected Methods

Method	Description
Browser_DocumentCompleted ( object sender, System.Windows.Forms.WebBrowserDocumentCompletedEventArgs e ) : void
CreateAccessibilityInstance ( ) : System.Windows.Forms.AccessibleObject
Dispose ( bool disposing ) : void	Clean up any resources being used.
OnGenerateButtonClick ( object obj, EventArgs ea ) : void

Private Methods

Method	Description
ApplyTransform ( string inputFile, XmlNode node, SIL.FieldWorks.Common.Controls.ProgressDialogWorkingOn dlg ) : string
CopyFile ( string sFileName, string outPath ) : void
CountParams ( XmlNode node ) : int
CreateParameterList ( XmlNode node ) : XsltArgumentList
DetermineNumberOfPrompts ( ) : void
DetermineNumberOfTransforms ( ) : void
DoAlsoSaveAs ( ISaveFileDialog dlg ) : void
GetExtensionFromNode ( XmlNode node ) : string
GetNormalStyleFontSize ( int ws ) : string
GetParameters ( XmlNode rNode ) : XsltArgumentList
GetTransform ( string xslName, string xslAssembly ) : XslCompiledTransform
GetTransformFromFile ( string xslPath ) : XslCompiledTransform
InitAlsoSaveDialog ( ISaveFileDialog dlg ) : void
InitHtmlControl ( ) : void
InitProgressDialog ( ) : SIL.FieldWorks.Common.Controls.ProgressDialogWorkingOn
InitSaveAsWebpageDialog ( ISaveFileDialog dlg ) : void
InitializeComponent ( ) : void	Required method for Designer support - do not modify the contents of this method with the code editor.
OnBackButtonClick ( object sender, EventArgs e ) : void
OnForwardButtonClick ( object sender, EventArgs e ) : void
OnSaveAsHtmlButtonClick ( object sender, EventArgs e ) : void
PerformTransformations ( string sLastFile, ProgressDialogWorkingOn dlg ) : void
ProduceSketch ( ) : void
ReadParameters ( ) : void
ReadRegistry ( ) : void
RemoveWriteProtection ( string dlgFileName ) : void
ResetURLCount ( ) : void
SetAlsoSaveInfo ( ) : void
SetBackButtonEnabledState ( ) : void
SetForwardButtonEnabledState ( ) : void
SetStrings ( ) : void
ShowGeneratingPage ( ) : void
ShowSketch ( ) : void
UpdateProgress ( string sMessage, ProgressDialogWorkingOn dlg ) : void
WriteRegistry ( ) : void

Method Details

Browser_DocumentCompleted() protected method

protected Browser_DocumentCompleted ( object sender, System.Windows.Forms.WebBrowserDocumentCompletedEventArgs e ) : void
sender	object
e	System.Windows.Forms.WebBrowserDocumentCompletedEventArgs
return	void

CheckDisposed() public method

Check to see if the object has been disposed. All public Properties and Methods should call this before doing anything else.

public CheckDisposed ( ) : void
return	void

CreateAccessibilityInstance() protected method

protected CreateAccessibilityInstance ( ) : System.Windows.Forms.AccessibleObject
return	System.Windows.Forms.AccessibleObject

Dispose() protected method

Clean up any resources being used.

protected Dispose ( bool disposing ) : void
disposing	bool
return	void

GeneratedHtmlViewer() public method

public GeneratedHtmlViewer ( ) : System
return	System

GetMessageTargets() public method

Return an array of all of the objects which should 1) be queried when looking for someone to deliver a message to 2) be potential recipients of a broadcast

public GetMessageTargets ( ) : IxCoreColleague[]
return	IxCoreColleague[]

Init() public method

Initialize.

public Init ( XCore.Mediator mediator, XmlNode configurationParameters ) : void
mediator	XCore.Mediator
configurationParameters	System.Xml.XmlNode
return	void

OnBeforeNavigate() public method

public OnBeforeNavigate ( object sender, HtmlControlEventArgs e ) : void
sender	object
e	XCore.HtmlControlEventArgs
return	void

OnDisplayExport() public method

public OnDisplayExport ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool
commandObject	object
display	XCore.UIItemDisplayProperties
return	bool

OnDisplayMasterRefresh() public method

Refresh doesn't make any sense for us -- regenerating the HTML sketch via m_GenerateBtn makes more sense. See LT-3961. Note that OnMasterRefresh is enabled by default if there is no OnDisplayMasterRefresh target method available.

public OnDisplayMasterRefresh ( object commandObject, UIItemDisplayProperties &display ) : bool
commandObject	object
display	UIItemDisplayProperties
return	bool

OnDisplayShowTreeBar() public method

see if it makes sense to display a menu controlling the "ShowRecordList" property

public OnDisplayShowTreeBar ( object commandObject, UIItemDisplayProperties &display ) : bool
commandObject	object	The command object.
display	UIItemDisplayProperties	The display.
return	bool

OnExport() public method

public OnExport ( object argument ) : bool
argument	object
return	bool

OnGenerateButtonClick() protected method

protected OnGenerateButtonClick ( object obj, EventArgs ea ) : void
obj	object
ea	EventArgs
return	void

OnSaveAsWebpage() public method

public OnSaveAsWebpage ( object parameterObj ) : bool
parameterObj	object
return	bool

PerformRetrieval() public method

public PerformRetrieval ( string &outputPath, ProgressDialogWorkingOn dlg ) : void
outputPath	string
dlg	ProgressDialogWorkingOn
return	void

PopulateCtrlTabTargetCandidateList() public method

public PopulateCtrlTabTargetCandidateList ( List targetCandidates ) : Control
targetCandidates	List
return	Control

PrepareToGoAway() public method

From IxCoreContentControl

public PrepareToGoAway ( ) : bool
return	bool

Property Details

m_htmlControl protected_oe property

The control that shows the HTML data.

protected HtmlControl m_htmlControl
return	HtmlControl

m_iMaxURLCount protected_oe property

protected int m_iMaxURLCount
return	int

m_iURLCounter protected_oe property

Back/Forward counter to keep track of state and control enable/disable of back adn forward buttons

protected int m_iURLCounter
return	int

m_mediator protected_oe property

Mediator that passes off messages.

protected Mediator m_mediator
return	Mediator

m_outputDirectory protected_oe property

protected string m_outputDirectory
return	string