アクティブなシートを取得/設定

シートが3つあり、Sheet3がアクティブな状態のExcelを使用

ExcelVBA

Sub Sample()
    Dim BookObj     As Workbook
    Dim FilePath    As String
    Dim SheetObj    As Worksheet
    
    'ファイルパス作成
    FilePath = ThisWorkbook.Path & "\sample.xlsx"
    
    'ブックを開く
    Set BookObj = Workbooks.Open(FilePath)
    
    'Activeなシートを取得
    Set SheetObj = BookObj.ActiveSheet
    Debug.Print "Activeなシート名:" & SheetObj.Name ' Activeなシート名:Sheet3
    
    'Activeなシートを変更
    BookObj.Sheets(2).Activate
    
    'Activeなシートを取得
    Set SheetObj = BookObj.ActiveSheet
    Debug.Print "Activeなシート名:" & SheetObj.Name ' Activeなシート名:Sheet2
    
    BookObj.Close (False)
    
    Set BookObj = Nothing
    Set SheetObj = Nothing
End Sub

Excel(COM)

using Excel = Microsoft.Office.Interop.Excel;
using System.Runtime.InteropServices;
using System.Reflection;
using System.IO;
using System;
using System.Data;
using Microsoft.Office.Interop.Excel;

namespace SampleCode; // C#10~

internal class SampleExcel
{
    static void Main(string[] args)
    {
        Excel.Application? application = null;
        Excel.Workbooks? workbooks = null;
        Excel.Workbook? workbook = null;
        Excel.Sheets? worksheets = null;
        Excel.Worksheet? worksheet = null;
        try
        {
            // 実行ファイルのあるフォルダパス取得
            var folderPath = Path.GetDirectoryName(Assembly.GetEntryAssembly()?.Location);
            if (folderPath == null) { return; }

            // Excelファイルパスを作成
            var filePath = Path.Combine(folderPath, "sample.xlsx");

            // Excelを開く
            application = new Excel.Application();
            application.Visible = true;

            // ブックを開く
            workbooks = application.Workbooks;
            workbook = workbooks.Open(filePath);

            // Activeなシートを取得
            worksheet = workbook.ActiveSheet;
            Console.WriteLine($"Activeなシート名:{worksheet.Name}"); // Activeなシート名:Sheet3
            CleanUpComObject(ref worksheet);

            // Activeなシートを変更
            worksheets = workbook.Sheets;
            worksheet = worksheets[2];
            worksheet.Activate();
            CleanUpComObject(ref worksheet);

            // Activeなシートを取得
            worksheet = workbook.ActiveSheet;
            Console.WriteLine($"Activeなシート名:{worksheet.Name}"); // Activeなシート名:Sheet2
            CleanUpComObject(ref worksheet);
        }
        catch (Exception ex)
        {
            Console.WriteLine(ex.Message);
        }
        finally
        {
            CleanUpComObject(ref worksheet);
            CleanUpComObject(ref worksheets);
            CleanUpComObject(ref workbook, true, false);
            CleanUpComObject(ref workbooks);
            CleanUpComObject(ref application);

            // RCW強制解放(残留プロセス対策)
            GC.Collect();
            GC.WaitForPendingFinalizers();
            GC.Collect();
            GC.WaitForPendingFinalizers();
        }
    }

    static void CleanUpComObject<T>(ref T comObject, bool shouldClose = true, bool saveChanges = false)
    {
        // フラグによってWorkbookはClose / ApplicationはQuitする
        if (shouldClose && comObject != null)
        {
            // 型をチェックする
            if (comObject is Microsoft.Office.Interop.Excel.Workbook workbook)
            {
                // Workbookの場合
                workbook.Close(saveChanges);
            }
            else if (comObject is Microsoft.Office.Interop.Excel.Application application)
            {
                // Applicationの場合
                application.Quit();
            }
        }

        // Objectを解放
        if (comObject != null && Marshal.IsComObject(comObject))
        {
            Marshal.ReleaseComObject(comObject);
            comObject = default!;
        }
    }
}

補足:Microsoft.Office.Interop.Excel でオブジェクトの解放について

ClosedXML

using ClosedXML.Excel;
using System;
using System.IO;
using System.Linq;
using System.Reflection;

namespace SampleCode; // C#10~

internal class SampleClosedXML
{
    static void Main(string[] args)
    {
        try
        {
            // 実行ファイルのあるフォルダパス取得
            var folderPath = Path.GetDirectoryName(Assembly.GetEntryAssembly()?.Location);
            if (folderPath == null) { return; }

            // Excelファイルパスを作成
            var filePath = Path.Combine(folderPath, "sample.xlsx");

            // ブックを開く、読み書きモード、共有なし(排他)
            using (var fileStream = new FileStream(filePath, FileMode.Open, FileAccess.ReadWrite, FileShare.None))
            using (var workbook = new XLWorkbook(fileStream))
            {
                // Activeなシートを取得
                var sheet = workbook.Worksheets.First(ws => ws.TabActive);
                Console.WriteLine($"Activeなシート名:{sheet.Name}"); // Activeなシート名:Sheet3

                // Activeなシートを変更
                workbook.Worksheet("Sheet2").SetTabActive();

                // Activeなシートを取得
                sheet = workbook.Worksheets.First(ws => ws.TabActive);
                Console.WriteLine($"Activeなシート名:{sheet.Name}"); // Activeなシート名:Sheet2
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine(ex.Message);
        }
    }
}

EPPlus

using OfficeOpenXml;
using System;
using System.IO;
using System.Reflection;

namespace SampleCode; // C#10~

internal class SampleEPPlus
{
    static void Main(string[] args)
    {
        // Ver8.0のソースです
        // 非商用個人利用の場合 名前を設定
        ExcelPackage.License.SetNonCommercialPersonal("SampleTarou");

        try
        {
            // 実行ファイルのあるフォルダパス取得
            var folderPath = Path.GetDirectoryName(Assembly.GetEntryAssembly()?.Location);
            if (folderPath == null) { return; }

            // Excelファイルパスを作成
            var filePath = Path.Combine(folderPath, "sample.xlsx");

            // ブックを開く、読み書きモード、共有なし(排他)
            using (var stream = new FileStream(filePath, FileMode.Open, FileAccess.ReadWrite, FileShare.None))
            using (var package = new ExcelPackage(stream))
            {
                // Activeなシート番号を取得(シート番号は0から)
                var sheetNo = package.Workbook.View.ActiveTab; // 2

                // Activeなシートを取得
                var sheet = package.Workbook.Worksheets[sheetNo];
                Console.WriteLine($"Activeなシート名:{sheet.Name}"); // Activeなシート名:Sheet3

                // Activeなシートを変更(シート番号は0から)
                sheetNo = 1;
                package.Workbook.View.ActiveTab = sheetNo;

                // Activeなシートだけtrueにし、それ以外はfalseにする
                for(var n = 0; n < package.Workbook.Worksheets.Count; n++)
                {
                    package.Workbook.Worksheets[n].View.TabSelected = (n == sheetNo);
                }

                // Activeなシートを取得
                sheet = package.Workbook.Worksheets[sheetNo];
                Console.WriteLine($"Activeなシート名:{sheet.Name}"); // Activeなシート名:Sheet2
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine(ex.Message);
        }
    }
}

ExcelDataReader

該当機能なし

NPOI

□xls

using NPOI.HSSF.UserModel;
using System;
using System.IO;
using System.Reflection;


namespace SampleCode; // C#10~

internal class SampleNPOI_xls
{
    static void Main(string[] args)
    {
        var filePath = "";

        try
        {
            // 実行ファイルのあるフォルダパス取得
            var folderPath = Path.GetDirectoryName(Assembly.GetEntryAssembly()?.Location);
            if (folderPath == null) { return; }

            // Excelファイルパスを作成
            filePath = Path.Combine(folderPath, "sample.xls");

            // ブックを開く、読み書きモード、共有なし(排他)
            using (var fileStream = new FileStream(filePath, FileMode.Open, FileAccess.ReadWrite, FileShare.None))
            using (var workbook = new HSSFWorkbook(fileStream))
            {
                // ■Activeなシートの取得
                // Activeなシート番号を取得(シート番号は0から)
                var sheetNo = workbook.ActiveSheetIndex; // 2

                // Activeなシートを取得
                var sheet = workbook.GetSheetAt(sheetNo);
                Console.WriteLine($"Activeなシート名:{sheet.SheetName}");

                // ■Activeなシートの変更
                // Activeなシートを変更
                sheetNo = 1;
                workbook.SetActiveSheet(sheetNo); // Sheet2をActiveに設定する(これを変えただけじゃかわらない)
                workbook.SetSelectedTab(sheetNo); //こちらも変えるといいとのこと

                // 上記2つの設定で変わったが・・・
                // IsSelectedまで返ると完璧とのこと
                for(var n = 0; n < workbook.NumberOfSheets; n++)
                {
                    workbook.GetSheetAt(n).IsSelected = (n == sheetNo);
                }

                // Activeなシートを取得
                sheet = workbook.GetSheetAt(sheetNo);
                Console.WriteLine($"Activeなシート名:{sheet.SheetName}");
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine(ex.Message);
        }
    }
}

□xlsx

using NPOI.XSSF.UserModel;
using System;
using System.IO;
using System.Reflection;

namespace SampleCode; // C#10~

internal class SampleNPOI_xlsx
{
    static void Main(string[] args)
    {
        var filePath = "";

        try
        {
            // 実行ファイルのあるフォルダパス取得
            var folderPath = Path.GetDirectoryName(Assembly.GetEntryAssembly()?.Location);
            if (folderPath == null) { return; }

            // Excelファイルパスを作成
            filePath = Path.Combine(folderPath, "sample.xlsx");

            // ブックを開く、読み書きモード、共有なし(排他)
            using (var fileStream = new FileStream(filePath, FileMode.Open, FileAccess.ReadWrite, FileShare.None))
            using (var workbook = new XSSFWorkbook(fileStream))
            {
                // ■Activeなシートの取得
                // Activeなシート番号を取得(シート番号は0から)
                var sheetNo = workbook.ActiveSheetIndex; // 2

                // Activeなシートを取得
                var sheet = workbook.GetSheetAt(sheetNo);
                Console.WriteLine($"Activeなシート名:{sheet.SheetName}");

                // ■Activeなシートの変更
                // Activeなシートを変更
                sheetNo = 1;
                workbook.SetActiveSheet(sheetNo); // Sheet2をActiveに設定する(これを変えただけじゃかわらない)
                workbook.SetSelectedTab(sheetNo); //こちらも変えるといいとのこと

                // 上記2つの設定で変わったが・・・
                // IsSelectedまで返ると完璧とのこと
                for (var n = 0; n < workbook.NumberOfSheets; n++)
                {
                    workbook.GetSheetAt(n).IsSelected = (n == sheetNo);
                }

                // Activeなシートを取得
                sheet = workbook.GetSheetAt(sheetNo);
                Console.WriteLine($"Activeなシート名:{sheet.SheetName}");
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine(ex.Message);
        }
    }
}

□xlsもxlsxも扱う場合
Program.cs

using System;
using System.IO;
using System.Reflection;

namespace SampleCode; // C#10~

internal class SampleNPOI
{
    static void Main(string[] args)
    {
        var filePath = "";

        try
        {
            // 実行ファイルのあるフォルダパス取得
            var folderPath = Path.GetDirectoryName(Assembly.GetEntryAssembly()?.Location);
            if (folderPath == null) { return; }

            // Excelファイルパスを作成
            filePath = Path.Combine(folderPath, "sample.xlsx");

            var extension = Path.GetExtension(filePath);

            // ブックを開く、読み書きモード、共有なし(排他)
            using (var fileStream = new FileStream(filePath, FileMode.Open, FileAccess.ReadWrite, FileShare.None))
            using (var workbook = WorkbookFactory.Create(fileStream, extension))
            {
                // ■Activeなシートの取得
                // Activeなシート番号を取得(シート番号は0から)
                var sheetNo = workbook.ActiveSheetIndex; // 2

                // Activeなシートを取得
                var sheet = workbook.GetSheetAt(sheetNo);
                Console.WriteLine($"Activeなシート名:{sheet.SheetName}");

                // ■Activeなシートの変更
                // Activeなシートを変更
                sheetNo = 1;
                workbook.SetActiveSheet(sheetNo); // Sheet2をActiveに設定する(これを変えただけじゃかわらない)
                workbook.SetSelectedTab(sheetNo); //こちらも変えるといいとのこと

                // 上記2つの設定で変わったが・・・
                // IsSelectedまで返ると完璧とのこと
                for (var n = 0; n < workbook.NumberOfSheets; n++)
                {
                    workbook.GetSheetAt(n).IsSelected = (n == sheetNo);
                }

                // Activeなシートを取得
                sheet = workbook.GetSheetAt(sheetNo);
                Console.WriteLine($"Activeなシート名:{sheet.SheetName}");
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine(ex.Message);
        }
    }
}

WorkbookFactory.cs

using NPOI.HSSF.UserModel;
using NPOI.SS.UserModel;
using NPOI.XSSF.UserModel;
using System;
using System.IO;

namespace SampleCode
{
    public class WorkbookFactory
    {
        public static IWorkbook Create(Stream stream, string extension)
        {
            extension = extension.ToLower();

            return extension switch
            {
                ".xls" => new HSSFWorkbook(stream),
                ".xlsx" => new XSSFWorkbook(stream),
                _ => throw new NotSupportedException("対象外の拡張子です")
            };
        }

        public static IWorkbook Create(string extension)
        {
            extension = extension.ToLower();

            return extension switch
            {
                ".xls" => new HSSFWorkbook(),
                ".xlsx" => new XSSFWorkbook(),
                _ => throw new NotSupportedException("対象外の拡張子です")
            };
        }
    }
}
投稿日時: 2025-05-24 18:23:24
更新日時: 2025-05-27 15:13:27

内部リンク

Comment

最近の投稿

最近のコメント

タグ

アーカイブ

その他