C# Class Smrf.NodeXL.ExcelTemplate.GroupManager

Manages vertex groups in a NodeXL workbook.

Call GetGroupCommandsToEnable to determine which group commands to enable in the Ribbon. Call TryRunGroupCommand to run a command.

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

Public Methods

Method	Description
GetExcelFormulaForVertexID ( ) : String
GetGroupCommandsToEnable ( Microsoft workbook ) : GroupCommands
GetVertexAttributes ( Int32 groupIndex, Int32 totalGroups, Color &color, VertexShape &shape ) : void
GroupCommandsIncludeGroupCommand ( GroupCommands groupCommands, GroupCommands groupCommand ) : System.Boolean
TryRunGroupCommand ( GroupCommands groupCommand, Microsoft workbook, Sheet2 vertexWorksheet, Sheet5 groupWorksheet ) : System.Boolean

Private Methods

Method	Description
GetGroupCommandsToEnableInternal ( Microsoft oWorkbook ) : GroupCommands
SetVertexAttributesForAllGroups ( ListObject oGroupTable ) : void
TryAddSelectedVerticesToGroup ( Microsoft oWorkbook, Sheet2 oVertexWorksheet ) : System.Boolean
TryCollapseOrExpandAllGroups ( Microsoft oWorkbook, System.Boolean bCollapse ) : System.Boolean
TryCollapseOrExpandSelectedGroups ( Microsoft oWorkbook, System.Boolean bCollapse ) : System.Boolean
TryRemoveAllGroups ( Microsoft oWorkbook ) : System.Boolean
TryRemoveSelectedGroups ( Microsoft oWorkbook, Sheet5 oGroupWorksheet ) : System.Boolean
TryRemoveSelectedVerticesFromGroups ( Microsoft oWorkbook, Sheet2 oVertexWorksheet, ICollection &oSelectedVertexNames ) : System.Boolean
TrySelectAllGroups ( Microsoft oWorkbook ) : System.Boolean
TrySelectGroupsWithSelectedVertices ( Microsoft oWorkbook, Sheet2 oVertexWorksheet, Sheet5 oGroupWorksheet ) : System.Boolean

Method Details

GetExcelFormulaForVertexID() public static method

public static GetExcelFormulaForVertexID ( ) : String
return	String

GetGroupCommandsToEnable() public static method

public static GetGroupCommandsToEnable ( Microsoft workbook ) : GroupCommands
workbook	Microsoft
return	GroupCommands

GetVertexAttributes() public static method

public static GetVertexAttributes ( Int32 groupIndex, Int32 totalGroups, Color &color, VertexShape &shape ) : void
groupIndex	System.Int32
totalGroups	System.Int32
color	Color
shape	VertexShape
return	void

GroupCommandsIncludeGroupCommand() public static method

public static GroupCommandsIncludeGroupCommand ( GroupCommands groupCommands, GroupCommands groupCommand ) : System.Boolean
groupCommands	GroupCommands
groupCommand	GroupCommands
return	System.Boolean

TryRunGroupCommand() public static method

public static TryRunGroupCommand ( GroupCommands groupCommand, Microsoft workbook, Sheet2 vertexWorksheet, Sheet5 groupWorksheet ) : System.Boolean
groupCommand	GroupCommands
workbook	Microsoft
vertexWorksheet	Sheet2
groupWorksheet	Sheet5
return	System.Boolean