C# Class Smrf.NodeXL.ExcelTemplate.ReadWorkbookContext

Provides access to objects needed for converting an Excel workbook to a NodeXL graph.

If the X, Y, and Locked columns of the vertex table should be read, set IgnoreVertexLocations to false and set to the rectangle the graph is being drawn within. Otherwise, leave IgnoreVertexLocations at its default value of true.

Set FillIDColumns to true to store an ID in each row of the edge and vertex tables.

Set PopulateVertexWorksheet to true to populate the vertex table with unique vertex names from the edge worksheet before the workbook is read.

Set ReadEdgeWeights to true to read the edge weight column in the edge table.

Set ReadGroups to true to read the group worksheets.

To read labels specified on the vertex, edge or group worksheets, set , ReadEdgeLabels or to true.

To read images specified on the vertex worksheet, set to true, then set and DefaultVertexShape.

To read all columns in the edge and vertex worksheets and store the cell values as metadata on the graph's edge and vertex objects, set to true.

Inheritance: Object

Datei anzeigen Open project: 2014-sed-team3/term-project Class Usage Examples

Protected Properties

Property	Type	Description
m_bFillIDColumns	System.Boolean
m_bIgnoreVertexLocations	System.Boolean
m_bPopulateVertexWorksheet	System.Boolean
m_bReadAllEdgeAndVertexColumns	System.Boolean
m_bReadEdgeLabels	System.Boolean
m_bReadEdgeWeights	System.Boolean
m_bReadGroupLabels	System.Boolean
m_bReadGroups	System.Boolean
m_bReadVertexColorFromGroups	System.Boolean
m_bReadVertexImages	System.Boolean
m_bReadVertexLabels	System.Boolean
m_bReadVertexShapeFromGroups	System.Boolean
m_eDefaultVertexShape	VertexShape
m_oBooleanConverter	BooleanConverter
m_oColorConverter2	ColorConverter2
m_oDefaultVertexImageSize	Nullable
m_oEdgeRowIDDictionary	IIdentityProvider>.Dictionary
m_oEdgeStyleConverter	EdgeStyleConverter
m_oEdgeWidthConverter	EdgeWidthConverter
m_oFontSizeConverter	FontSizeConverter
m_oGraphRectangle	System.Drawing.Rectangle
m_oVertexLocationConverter	VertexLocationConverter
m_oVertexNameDictionary	IVertex>.Dictionary
m_oVertexRadiusConverter	VertexRadiusConverter
m_oVertexRowIDDictionary	IIdentityProvider>.Dictionary

Public Methods

Method	Description
AddToRowIDDictionary ( ExcelTableReader row, IIdentityProvider edgeOrVertex, System.Boolean isEdge ) : void
ReadWorkbookContext ( ) : System	Initializes a new instance of the ReadWorkbookContext class.

Private Methods

Method	Description
AssertValid ( ) : void

Method Details

AddToRowIDDictionary() public method

public AddToRowIDDictionary ( ExcelTableReader row, IIdentityProvider edgeOrVertex, System.Boolean isEdge ) : void
row	Smrf.AppLib.ExcelTableReader
edgeOrVertex	IIdentityProvider
isEdge	System.Boolean
return	void

ReadWorkbookContext() public method

Initializes a new instance of the ReadWorkbookContext class.

public ReadWorkbookContext ( ) : System
return	System

Property Details

m_bFillIDColumns protected_oe property

protected Boolean,System m_bFillIDColumns
return	System.Boolean

m_bIgnoreVertexLocations protected_oe property

protected Boolean,System m_bIgnoreVertexLocations
return	System.Boolean

m_bPopulateVertexWorksheet protected_oe property

protected Boolean,System m_bPopulateVertexWorksheet
return	System.Boolean

m_bReadAllEdgeAndVertexColumns protected_oe property

protected Boolean,System m_bReadAllEdgeAndVertexColumns
return	System.Boolean

m_bReadEdgeLabels protected_oe property

protected Boolean,System m_bReadEdgeLabels
return	System.Boolean

m_bReadEdgeWeights protected_oe property

protected Boolean,System m_bReadEdgeWeights
return	System.Boolean

m_bReadGroupLabels protected_oe property

protected Boolean,System m_bReadGroupLabels
return	System.Boolean

m_bReadGroups protected_oe property

protected Boolean,System m_bReadGroups
return	System.Boolean

m_bReadVertexColorFromGroups protected_oe property

protected Boolean,System m_bReadVertexColorFromGroups
return	System.Boolean

m_bReadVertexImages protected_oe property

protected Boolean,System m_bReadVertexImages
return	System.Boolean

m_bReadVertexLabels protected_oe property

protected Boolean,System m_bReadVertexLabels
return	System.Boolean

m_bReadVertexShapeFromGroups protected_oe property

protected Boolean,System m_bReadVertexShapeFromGroups
return	System.Boolean

m_eDefaultVertexShape protected_oe property

protected VertexShape m_eDefaultVertexShape
return	VertexShape

m_oBooleanConverter protected_oe property

protected BooleanConverter m_oBooleanConverter
return	BooleanConverter

m_oColorConverter2 protected_oe property

protected ColorConverter2,Smrf.NodeXL.ExcelTemplate m_oColorConverter2
return	ColorConverter2

m_oDefaultVertexImageSize protected_oe property

protected Nullable m_oDefaultVertexImageSize
return	Nullable

m_oEdgeRowIDDictionary protected_oe property

protected Dictionary m_oEdgeRowIDDictionary
return	IIdentityProvider>.Dictionary

m_oEdgeStyleConverter protected_oe property

protected EdgeStyleConverter m_oEdgeStyleConverter
return	EdgeStyleConverter

m_oEdgeWidthConverter protected_oe property

protected EdgeWidthConverter,Smrf.NodeXL.ExcelTemplate m_oEdgeWidthConverter
return	EdgeWidthConverter

m_oFontSizeConverter protected_oe property

protected FontSizeConverter,Smrf.NodeXL.ExcelTemplate m_oFontSizeConverter
return	FontSizeConverter

m_oGraphRectangle protected_oe property

protected Rectangle,System.Drawing m_oGraphRectangle
return	System.Drawing.Rectangle

m_oVertexLocationConverter protected_oe property

protected VertexLocationConverter,Smrf.NodeXL.ExcelTemplate m_oVertexLocationConverter
return	VertexLocationConverter

m_oVertexNameDictionary protected_oe property

protected Dictionary m_oVertexNameDictionary
return	IVertex>.Dictionary

m_oVertexRadiusConverter protected_oe property

protected VertexRadiusConverter,Smrf.NodeXL.ExcelTemplate m_oVertexRadiusConverter
return	VertexRadiusConverter

m_oVertexRowIDDictionary protected_oe property

protected Dictionary m_oVertexRowIDDictionary
return	IIdentityProvider>.Dictionary