Smrf.NodeXL.ExcelTemplate.TopNByMetricUserSettings.ToString C# (CSharp) Method

    ToString()
    {
        AssertValid();

        if (
            m_sWorksheetName != WorksheetNames.Vertices ||
            m_sTableName != TableNames.Vertices ||
            m_sItemNameColumnName != VertexTableColumnNames.VertexName
            )
        {
            // TopNByMetricsDialog is hard-coded for now to get the top
            // vertices from the vertex worksheet.  The dialog and this method
            // can be updated later to get the top items from any worksheet, if
            // necessary.

            throw new NotSupportedException();
        }

        Boolean bOneVertex = (m_iN == 1);

        return ( String.Format(
            "Top {0}{1}, Ranked by {2}"
            ,
            bOneVertex ? String.Empty : m_iN.ToString(),
            bOneVertex ? "Vertex" : " Vertices",
            m_sRankedColumnName
            ) );
    }