C# Class Smrf.NodeXL.ExcelTemplate.PerWorkbookSettings

Provides access to settings that are stored on a per-workbook basis.
The settings are stored in a table in a hidden worksheet.
Inheritance: WorksheetReaderBase
Show file Open project: 2014-sed-team3/term-project Class Usage Examples

Public Properties

Property Type Description
FieldSeparator Char[]
SubFieldSeparator Char[]

Protected Properties

Property Type Description
m_oSettings Object>.Dictionary
m_oWorkbook Microsoft.Office.Interop.Excel.Workbook

Public Methods

Method Description
AssertValid ( ) : void
OnWorkbookTablesCleared ( ) : void
PerWorkbookSettings ( Microsoft workbook ) : System

Initializes a new instance of the PerWorkbookSettings class.
SetGraphHistoryGroupingDescription ( String groupingDescription ) : void
SetGraphHistoryValue ( String graphHistoryKey, String graphHistoryValue ) : void

Protected Methods

Method Description
ClearAutoFillWorkbookResults ( ) : void
ClearGraphHistory ( ) : void
GetAllSettings ( ) : Object>.Dictionary
GetWorkbookSettingsCellSettingName ( Int32 iWorkbookSettingsCellNumberOneBased ) : String
PreserveWorkbookSettingsBackwardCompatibility ( String sWorkbookSettings ) : String
SetValue ( String settingName, Object value ) : void
TryGetPerWorkbookSettingsTable ( ListObject &oPerWorkbookSettingsTable ) : System.Boolean
TryGetValue ( String settingName, Type valueType, Object &value ) : System.Boolean
WriteAllSettings ( ) : void

Method Details

AssertValid() public method

public AssertValid ( ) : void
return void

ClearAutoFillWorkbookResults() protected method

protected ClearAutoFillWorkbookResults ( ) : void
return void

ClearGraphHistory() protected method

protected ClearGraphHistory ( ) : void
return void

GetAllSettings() protected method

protected GetAllSettings ( ) : Object>.Dictionary
return Object>.Dictionary

GetWorkbookSettingsCellSettingName() protected method

protected GetWorkbookSettingsCellSettingName ( Int32 iWorkbookSettingsCellNumberOneBased ) : String
iWorkbookSettingsCellNumberOneBased System.Int32
return String

OnWorkbookTablesCleared() public method

public OnWorkbookTablesCleared ( ) : void
return void

PerWorkbookSettings() public method

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

PreserveWorkbookSettingsBackwardCompatibility() protected method

protected PreserveWorkbookSettingsBackwardCompatibility ( String sWorkbookSettings ) : String
sWorkbookSettings String
return String

SetGraphHistoryGroupingDescription() public method

public SetGraphHistoryGroupingDescription ( String groupingDescription ) : void
groupingDescription String
return void

SetGraphHistoryValue() public method

public SetGraphHistoryValue ( String graphHistoryKey, String graphHistoryValue ) : void
graphHistoryKey String
graphHistoryValue String
return void

SetValue() protected method

protected SetValue ( String settingName, Object value ) : void
settingName String
value Object
return void

TryGetPerWorkbookSettingsTable() protected method

protected TryGetPerWorkbookSettingsTable ( ListObject &oPerWorkbookSettingsTable ) : System.Boolean
oPerWorkbookSettingsTable ListObject
return System.Boolean

TryGetValue() protected method

protected TryGetValue ( String settingName, Type valueType, Object &value ) : System.Boolean
settingName String
valueType System.Type
value Object
return System.Boolean

WriteAllSettings() protected method

protected WriteAllSettings ( ) : void
return void

Property Details

FieldSeparator public static property

public static Char[] FieldSeparator
return Char[]

SubFieldSeparator public static property

public static Char[] SubFieldSeparator
return Char[]

m_oSettings protected property

protected Dictionary m_oSettings
return Object>.Dictionary

m_oWorkbook protected property

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