C#: Excelドキュメントプロパティの読み取りと削除

Excelファイルには、その内容だけでなく、作成者、最終更新日、キーワードといったメタデータが含まれています。これらは「ドキュメントプロパティ」と呼ばれ、ファイルの管理、検索、セキュリティにおいて重要な役割を果たします。しかし、C#開発者にとって、これらのプロパティをプログラムで効率的に操作することは、時に課題となります。特に、組み込みプロパティとカスタムプロパティの違いを理解し、適切に読み書き・削除する方法を知ることは、アプリケーションの品質向上に直結します。

本記事では、C#開発者がSpire.XLS for .NETライブラリを使用して、Excelドキュメントプロパティを読み取り、そして削除する方法について、具体的なコード例を交えながら解説します。

1. Excelドキュメントプロパティとは何か、なぜ重要なのか

Excelドキュメントプロパティは、Excelファイル自体に関する情報を提供するメタデータです。これらは大きく分けて二種類あります。

• 組み込みプロパティ (Built-in Properties): Excelが自動的に管理するプロパティで、「作成者」「最終更新者」「作成日」「ファイルサイズ」「タイトル」「件名」などが含まれます。
• カスタムプロパティ (Custom Properties): ユーザーが任意に追加できるプロパティです。プロジェクトID、部門名、ステータスなど、特定の業務要件に合わせて柔軟に情報を付加できます。

これらのプロパティは、以下のような点で重要です。

• 検索と分類: ドキュメントプロパティを利用して、大量のExcelファイルを効率的に検索・分類できます。
• 情報管理: ファイルの内容を直接開かなくても、その概要を把握できます。
• セキュリティとコンプライアンス: 機密情報の有無やアクセス制限に関する情報をプロパティとして埋め込むことも可能です。

2. C#でExcelドキュメントプロパティを読み取る方法 (Spire.XLS for .NETを使用)

Spire.XLS for .NETは、ExcelファイルをC#で操作するための強力なライブラリです。これを使用すると、ドキュメントプロパティの読み取りも容易に行えます。

まず、NuGetパッケージマネージャーからSpire.XLSをプロジェクトに追加します。

組み込みプロパティの読み取り

組み込みプロパティは、Workbook.DocumentPropertiesを通じてアクセスできます。

using Spire.Xls;
using System;
using System.Text;

public class ExcelPropertyReader
{
    public static void ReadBuiltInProperties(string filePath)
    {
        Workbook workbook = new Workbook();
        workbook.LoadFromFile(filePath);

        Console.WriteLine($"--- 組み込みプロパティ ---");
        Console.WriteLine($"タイトル: {workbook.DocumentProperties.Title}");
        Console.WriteLine($"作成者: {workbook.DocumentProperties.Author}");
        Console.WriteLine($"最終更新者: {workbook.DocumentProperties.LastModifiedBy}");
        Console.WriteLine($"作成日: {workbook.DocumentProperties.CreatedTime}");
        Console.WriteLine($"最終保存日: {workbook.DocumentProperties.LastSavedTime}");
        Console.WriteLine($"件名: {workbook.DocumentProperties.Subject}");
        Console.WriteLine($"キーワード: {workbook.DocumentProperties.Keywords}");
        Console.WriteLine($"コメント: {workbook.DocumentProperties.Comments}");
        
        workbook.Dispose();
    }
}

カスタムプロパティの読み取り

カスタムプロパティは、Workbook.CustomDocumentPropertiesコレクションからアクセスします。名前またはインデックスで取得できます。

using Spire.Xls;
using System;
using System.Text;

public class ExcelPropertyReader
{
    public static void ReadCustomProperties(string filePath)
    {
        Workbook workbook = new Workbook();
        workbook.LoadFromFile(filePath);

        Console.WriteLine($"--- カスタムプロパティ ---");
        ICustomDocumentProperties customProperties = workbook.CustomDocumentProperties;

        foreach (DocumentProperty prop in customProperties)
        {
            Console.WriteLine($"{prop.Name}: {prop.Value} (タイプ: {prop.Type})");
        }
        
        // 特定のカスタムプロパティを名前で取得する例
        // DocumentProperty projectStatus = (DocumentProperty)customProperties["ProjectStatus"];
        // if (projectStatus != null)
        // {
        //     Console.WriteLine($"ProjectStatus: {projectStatus.Value}");
        // }

        workbook.Dispose();
    }
}

上記のコードスニペットは、Excelファイルからドキュメントプロパティを読み取る基本的な方法を示しています。

3. C#でExcelドキュメントプロパティを削除する方法 (Spire.XLS for .NETを使用)

不要になった、あるいは機密情報を含むカスタムプロパティは、削除することができます。Spire.XLS for .NETでは、CustomDocumentProperties.Remove()メソッドを使用します。

カスタムプロパティの削除

特定のカスタムプロパティを名前で指定して削除します。

using Spire.Xls;
using System;

public class ExcelPropertyRemover
{
    public static void RemoveCustomProperty(string filePath, string propertyName, string outputPath)
    {
        Workbook workbook = new Workbook();
        workbook.LoadFromFile(filePath);

        ICustomDocumentProperties customProperties = workbook.CustomDocumentProperties;

        if (customProperties.Contains(propertyName))
        {
            customProperties.Remove(propertyName);
            Console.WriteLine($"カスタムプロパティ '{propertyName}' を削除しました。");
            workbook.SaveToFile(outputPath, ExcelVersion.Version2016);
            Console.WriteLine($"変更を '{outputPath}' に保存しました。");
        }
        else
        {
            Console.WriteLine($"カスタムプロパティ '{propertyName}' は存在しません。");
        }
        
        workbook.Dispose();
    }
}

組み込みプロパティの変更/削除に関する注意点:
組み込みプロパティは、直接削除することはできませんが、その値を変更することは可能です（例: workbook.DocumentProperties.Author = "新しい作成者";）。ただし、一部のプロパティ（ファイルサイズなど）はOSやアプリケーションによって自動管理されるため、プログラムからの変更は推奨されません。

結論

Excelドキュメントプロパティの管理は、C#アプリケーションにおいてファイルのメタデータを効率的に扱う上で不可欠です。Spire.XLS for .NETライブラリを利用することで、組み込みプロパティやカスタムプロパティの読み取り、そしてカスタムプロパティの削除といった操作を、直感的かつ少ないコード量で実現できます。

本記事で紹介したコードスニペットと解説が、C#開発者の皆様がExcelファイルのドキュメントプロパティを管理する際の具体的な解決策となり、日々の開発業務の一助となれば幸いです。Spire.XLS for .NETは、これらの基本的な操作に加えて、Excelの高度な機能にも対応しており、その利便性は多岐にわたります。