通过

检索电子表格文档中所有命名区域的字典

  • 项目

本主题演示如何使用 Open XML SDK for Office 中的类以编程方式检索包含Microsoft Excel 工作簿中所有定义名称的名称和范围的字典。 本文包含一个演示此任务的示例 GetDefinedNames 方法。

GetDefinedNames 方法

GetDefinedNames 方法接受单个参数，该参数指示要从中检索已定义名称的文档的名称。 方法返回一个 Dictionary<TKey,TValue> 实例，该实例包含有关指定工作簿中定义的名称的信息，如果没有定义的名称，该信息可能为空。

代码的工作方式

该代码使用 Open 方法打开电子表格文档，指示文档应打开，以便使用最终的 false 参数进行只读访问。 给定打开的工作簿，代码使用 WorkbookPart 属性导航到main工作簿部件。 代码将此引用存储在名为 wbPart 的变量中。

// Open the spreadsheet document for read-only access.
using (SpreadsheetDocument document = SpreadsheetDocument.Open(fileName, false))
{
    // Retrieve a reference to the workbook part.
    var wbPart = document.WorkbookPart;

检索已定义名称

提供此工作簿部件后，下一步便比较简单。 代码使用工作簿部件的 Workbook 属性检索对工作簿内容的引用，然后检索 Open XML SDK 提供的 DefinedNames 集合。 该属性将返回一个工作簿中包含的所有已定义名称的集合。 如果 属性返回非 null 值，则代码随后循环访问集合，检索有关每个命名部件的信息，并将键名) 和值 (范围说明) 添加到每个已定义名称的字典中。

// Retrieve a reference to the defined names collection.
DefinedNames? definedNames = wbPart?.Workbook?.DefinedNames;

// If there are defined names, add them to the dictionary.
if (definedNames is not null)
{
    foreach (DefinedName dn in definedNames)
    {
        if (dn?.Name?.Value is not null && dn?.Text is not null)
        {
            returnValue.Add(dn.Name.Value, dn.Text);
        }
    }
}

示例代码

下面是 C# 和 Visual Basic 中的完整 GetDefinedNames 示例代码。

static Dictionary<String, String>GetDefinedNames(String fileName)
{
    // Given a workbook name, return a dictionary of defined names.
    // The pairs include the range name and a string representing the range.
    var returnValue = new Dictionary<String, String>();

    // Open the spreadsheet document for read-only access.
    using (SpreadsheetDocument document = SpreadsheetDocument.Open(fileName, false))
    {
        // Retrieve a reference to the workbook part.
        var wbPart = document.WorkbookPart;


        // Retrieve a reference to the defined names collection.
        DefinedNames? definedNames = wbPart?.Workbook?.DefinedNames;

        // If there are defined names, add them to the dictionary.
        if (definedNames is not null)
        {
            foreach (DefinedName dn in definedNames)
            {
                if (dn?.Name?.Value is not null && dn?.Text is not null)
                {
                    returnValue.Add(dn.Name.Value, dn.Text);
                }
            }
        }

    }

    return returnValue;
}