C# Class Smrf.NodeXL.ExcelTemplate.DynamicFilterSettings

Provides access to settings for dynamic filtering.
A dynamic filter is a control that can be adjusted to selectively show and hide edges and vertices in the graph in real time. This class maintains the filter settings, which are stored in a table in a hidden worksheet.

Call the Open method to gain access to the settings, then use TryGetSettings and SetSettings to get and set the settings for one filter.

Inheritance: WorksheetReaderBase
Show file Open project: 2014-sed-team3/term-project Class Usage Examples

Protected Properties

Property Type Description
m_oDynamicFilterSettingsDictionary SettingsForOneFilter>.Dictionary
m_oDynamicFilterSettingsTable ListObject
m_oWorkbook Microsoft.Office.Interop.Excel.Workbook

Public Methods

Method Description
AssertValid ( ) : void
DynamicFilterSettings ( Microsoft workbook ) : System

Initializes a new instance of the DynamicFilterSettings class.
Open ( ) : void
SetSettings ( String tableName, String columnName, Decimal selectedMinimum, Decimal selectedMaximum, String &selectedMinimumAddress, String &selectedMaximumAddress ) : void
TryGetSettings ( String tableName, String columnName, Decimal &selectedMinimum, Decimal &selectedMaximum, String &selectedMinimumAddress, String &selectedMaximumAddress ) : System.Boolean

Protected Methods

Method Description
CheckOpen ( ) : void
GetDictionaryKey ( String sTableName, String sColumnName ) : String

Method Details

AssertValid() public method

public AssertValid ( ) : void
return void

CheckOpen() protected method

protected CheckOpen ( ) : void
return void

DynamicFilterSettings() public method

Initializes a new instance of the DynamicFilterSettings class.
public DynamicFilterSettings ( Microsoft workbook ) : System
workbook Microsoft /// The workbook containing the settings. ///
return System

GetDictionaryKey() protected method

protected GetDictionaryKey ( String sTableName, String sColumnName ) : String
sTableName String
sColumnName String
return String

Open() public method

public Open ( ) : void
return void

SetSettings() public method

public SetSettings ( String tableName, String columnName, Decimal selectedMinimum, Decimal selectedMaximum, String &selectedMinimumAddress, String &selectedMaximumAddress ) : void
tableName String
columnName String
selectedMinimum Decimal
selectedMaximum Decimal
selectedMinimumAddress String
selectedMaximumAddress String
return void

TryGetSettings() public method

public TryGetSettings ( String tableName, String columnName, Decimal &selectedMinimum, Decimal &selectedMaximum, String &selectedMinimumAddress, String &selectedMaximumAddress ) : System.Boolean
tableName String
columnName String
selectedMinimum Decimal
selectedMaximum Decimal
selectedMinimumAddress String
selectedMaximumAddress String
return System.Boolean

Property Details

m_oDynamicFilterSettingsDictionary protected property

protected Dictionary m_oDynamicFilterSettingsDictionary
return SettingsForOneFilter>.Dictionary

m_oDynamicFilterSettingsTable protected property

protected ListObject m_oDynamicFilterSettingsTable
return ListObject

m_oWorkbook protected property

protected Workbook,Microsoft.Office.Interop.Excel m_oWorkbook
return Microsoft.Office.Interop.Excel.Workbook