Получение словаря всех именованных диапазонов в документе электронной таблицы

В этом разделе показано, как использовать классы в пакете SDK Open XML для Office для программного извлечения словаря, содержащего имена и диапазоны всех определенных имен в книге Microsoft Excel. Он содержит пример метода GetDefinedNames для иллюстрации этой задачи.

Метод GetDefinedNames

Метод GetDefinedNames принимает один параметр, указывающий имя документа, из которого извлекаются определенные имена. Метод возвращает Dictionary<TKey,TValue> экземпляр, содержащий сведения об определенных именах в указанной книге, которые могут быть пустыми, если нет определенных имен.

Принципы работы кода

Код открывает документ электронной таблицы с помощью метода Open , указывающего, что документ должен быть открыт для доступа только для чтения с окончательным параметром false. Учитывая открытую книгу, код использует свойство WorkbookPart для перехода к части книги main. Код сохраняет эту ссылку в переменной с именем wbPart.

C#

// 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;

Visual Basic

' Open the spreadsheet document for read-only access.
Using document As SpreadsheetDocument = SpreadsheetDocument.Open(fileName, False)
    ' Retrieve a reference to the workbook part.
    Dim wbPart = document.WorkbookPart

Получение определенных имен

С учетом части книги следующий шаг прост. Код использует свойство Workbook части книги для получения ссылки на содержимое книги, а затем извлекает коллекцию DefinedNames , предоставляемую пакетом SDK Open XML. Это свойство возвращает коллекцию всех определенных имен, содержащихся в книге. Если свойство возвращает значение, отличное от NULL, код затем выполняет итерацию по коллекции, извлекая сведения о каждой именованной части и добавляя имя ключа) и значение (описание диапазона) в словарь для каждого определенного имени.

C#

// 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);
        }
    }
}

Visual Basic

' Retrieve a reference to the defined names collection.
Dim definedNames As DefinedNames = wbPart?.Workbook?.DefinedNames

' If there are defined names, add them to the dictionary.
If definedNames IsNot Nothing Then
    For Each dn As DefinedName In definedNames
        If dn?.Name?.Value IsNot Nothing AndAlso dn?.Text IsNot Nothing Then
            returnValue.Add(dn.Name.Value, dn.Text)
        End If
    Next
End If

Пример кода

Ниже приведен полный пример кода GetDefinedNames в C# и Visual Basic.

C#

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;
}

Visual Basic

Function GetDefinedNames(fileName As String) As Dictionary(Of String, String)
    ' Given a workbook name, return a dictionary of defined names.
    ' The pairs include the range name and a string representing the range.
    Dim returnValue As New Dictionary(Of String, String)()

    ' Open the spreadsheet document for read-only access.
    Using document As SpreadsheetDocument = SpreadsheetDocument.Open(fileName, False)
        ' Retrieve a reference to the workbook part.
        Dim wbPart = document.WorkbookPart


        ' Retrieve a reference to the defined names collection.
        Dim definedNames As DefinedNames = wbPart?.Workbook?.DefinedNames

        ' If there are defined names, add them to the dictionary.
        If definedNames IsNot Nothing Then
            For Each dn As DefinedName In definedNames
                If dn?.Name?.Value IsNot Nothing AndAlso dn?.Text IsNot Nothing Then
                    returnValue.Add(dn.Name.Value, dn.Text)
                End If
            Next
        End If

    End Using

    Return returnValue
End Function

См. также

• Справочник по библиотеке классов пакета SDK Open XML