C# Class Smrf.NodeXL.ExcelTemplate.Ribbon

Represents the template's ribbon tab.
How the Ribbon is Connected to the Rest of the Application

The ribbon has direct access to the public methods and properties on the ThisWorkbook object. It does not have direct access to the TaskPane.

When the user clicks a ribbon control that is best handled by ThisWorkbook, the ribbon calls the appropriate public method on ThisWorkbook, passing the method whatever arguments are required to perform the requested task.

When the user clicks a ribbon control that is best handled by the TaskPane, the ribbon fires an event that gets handled by the TaskPane. The arguments required to perform the requested task get passed to the TaskPane via event arguments.

Inheritance: RibbonBase
Show file Open project: 2014-sed-team3/term-project

Protected Properties

Property Type Description
m_oLayoutManagerForRibbonDropDown LayoutManagerForRibbonDropDown

Public Methods

Method Description
EnableSetVisualAttributes ( VisualAttributes visualAttributes ) : void
Ribbon ( ) : System

Initializes a new instance of the Ribbon class.

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Clean up any resources being used.
GetPerWorkbookSettings ( ) : PerWorkbookSettings
OnWorkbookSettingsReplaced ( ) : void
SendCommand ( RunCommandEventArgs oRunCommandEventArgs ) : void
SendNoParamCommand ( NoParamCommand eNoParamCommand ) : void

Private Methods

Method Description
AssertValid ( ) : void
AutomateTasksOnOpen ( ) : void
CommandDispatcher_CommandSent ( Object sender, RunCommandEventArgs e ) : void
GroupCommandButton_Click ( object sender, RibbonControlEventArgs e ) : void
InitializeComponent ( ) : void

Required method for Designer support - do not modify the contents of this method with the code editor.
LoadUserSettings ( ) : void
Ribbon_Close ( object sender, EventArgs e ) : void
Ribbon_Load ( object sender, RibbonUIEventArgs e ) : void
SaveUserSettings ( ) : void
SendLoadUserSettingsCommand ( ) : void
SendSaveUserSettingsCommand ( ) : void
btnAbout_Click ( object sender, RibbonControlEventArgs e ) : void
btnCreateNodeXLWorkbook_Click ( object sender, RibbonControlEventArgs e ) : void
btnEnableAllNotifications_Click ( object sender, RibbonControlEventArgs e ) : void
btnExportOptions_Click ( object sender, RibbonControlEventArgs e ) : void
btnGroupByCluster_Click ( object sender, RibbonControlEventArgs e ) : void
btnHelp_Click ( object sender, RibbonControlEventArgs e ) : void
btnImportFromGraphDataProvider_Click ( object sender, RibbonControlEventArgs e ) : void
btnImportOptions_Click ( object sender, RibbonControlEventArgs e ) : void
btnMergeDuplicateEdges_Click ( object sender, RibbonControlEventArgs e ) : void
btnOpenSampleNodeXLWorkbook_Click ( object sender, RibbonControlEventArgs e ) : void
btnPopulateVertexWorksheet_Click ( object sender, RibbonControlEventArgs e ) : void
btnResetCurrentOptions_Click ( object sender, RibbonControlEventArgs e ) : void
btnRunNoParamCommand_Click ( object sender, RibbonControlEventArgs e ) : void
btnSetEdgeVisibility_Click ( object sender, RibbonControlEventArgs e ) : void
btnSetVertexShape_Click ( object sender, RibbonControlEventArgs e ) : void
btnSetVertexVisibility_Click ( object sender, RibbonControlEventArgs e ) : void
btnSetVisualAttribute_Click ( object sender, RibbonControlEventArgs e ) : void
btnShowOrHideAllColumnGroups_Click ( object sender, RibbonControlEventArgs e ) : void
btnShowOrHideAllGraphElements_Click ( object sender, RibbonControlEventArgs e ) : void
btnStartProcess_Click ( object sender, RibbonControlEventArgs e ) : void
btnUseCurrentOptionsForNew_Click ( object sender, RibbonControlEventArgs e ) : void
chkShowColumnGroups_Click ( object sender, RibbonControlEventArgs e ) : void
chkShowGraphAxes_Click ( object sender, RibbonControlEventArgs e ) : void
chkShowGraphLegend_Click ( object sender, RibbonControlEventArgs e ) : void
m_oLayoutManagerForRibbonDropDown_LayoutChanged ( object sender, EventArgs e ) : void
mnuGroups_ItemsLoading ( object sender, RibbonControlEventArgs e ) : void
mnuImport_ItemsLoading ( object sender, RibbonControlEventArgs e ) : void
mnuShowColumnGroups_ItemsLoading ( object sender, RibbonControlEventArgs e ) : void
rddGraphDirectedness_SelectionChanged ( object sender, RibbonControlEventArgs e ) : void
rddLayout_ButtonClick ( object sender, RibbonControlEventArgs 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

EnableSetVisualAttributes() public method

public EnableSetVisualAttributes ( VisualAttributes visualAttributes ) : void
visualAttributes VisualAttributes
return void

GetPerWorkbookSettings() protected method

protected GetPerWorkbookSettings ( ) : PerWorkbookSettings
return PerWorkbookSettings

OnWorkbookSettingsReplaced() protected method

protected OnWorkbookSettingsReplaced ( ) : void
return void

Ribbon() public method

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

SendCommand() protected method

protected SendCommand ( RunCommandEventArgs oRunCommandEventArgs ) : void
oRunCommandEventArgs RunCommandEventArgs
return void

SendNoParamCommand() protected method

protected SendNoParamCommand ( NoParamCommand eNoParamCommand ) : void
eNoParamCommand NoParamCommand
return void

Property Details

m_oLayoutManagerForRibbonDropDown protected property

protected LayoutManagerForRibbonDropDown,Smrf.NodeXL.ExcelTemplate m_oLayoutManagerForRibbonDropDown
return LayoutManagerForRibbonDropDown