C# Class Smrf.NodeXL.ExcelTemplate.HeaderFooterControl

Control for getting header and footer text.
Set the IncludeHeader, HeaderText, , and FooterText properties after the control is created. To retrieve the edited properties, call , and if Validate returns true, read the properties.

This control uses the following keyboard shortcuts: I, F

Inheritance: System.Windows.Forms.UserControl
Show file Open project: 2014-sed-team3/term-project

Protected Properties

Property Type Description
m_bIncludeFooter System.Boolean
m_bIncludeHeader System.Boolean
m_sFooterText String
m_sHeaderText String

Public Methods

Method Description
HeaderFooterControl ( ) : System

Initializes a new instance of the HeaderFooterControl class.
Validate ( ) : System.Boolean

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Clean up any resources being used.
DoDataExchange ( System.Boolean bFromControls ) : System.Boolean
EnableControls ( ) : void

Private Methods

Method Description
AssertValid ( ) : void
InitializeComponent ( ) : void

Required method for Designer support - do not modify the contents of this method with the code editor.
OnEventThatRequiresControlEnabling ( object sender, EventArgs e ) : void

Method Details

Dispose() protected method

Clean up any resources being used.
protected Dispose ( bool disposing ) : void
disposing bool true if managed resources should be disposed; otherwise, false.
return void

DoDataExchange() protected method

protected DoDataExchange ( System.Boolean bFromControls ) : System.Boolean
bFromControls System.Boolean
return System.Boolean

EnableControls() protected method

protected EnableControls ( ) : void
return void

HeaderFooterControl() public method

Initializes a new instance of the HeaderFooterControl class.
public HeaderFooterControl ( ) : System
return System

Validate() public method

public Validate ( ) : System.Boolean
return System.Boolean

Property Details

m_bIncludeFooter protected property

protected Boolean,System m_bIncludeFooter
return System.Boolean

m_bIncludeHeader protected property

protected Boolean,System m_bIncludeHeader
return System.Boolean

m_sFooterText protected property

protected String m_sFooterText
return String

m_sHeaderText protected property

protected String m_sHeaderText
return String