Ribbon.cs

#region Copyright 2018-2023 C. Augusto Proiete & Contributors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#endregion

using System;
using System.IO;
using System.Runtime.InteropServices;
using ExcelDna.Integration;
using ExcelDna.Integration.CustomUI;
using ExcelDna.Logging;
using Serilog;
using static SampleAddIn.AddIn;

namespace SampleAddIn
{
    [ComVisible(true)]
    public class Ribbon : ExcelRibbon
    {
        private ILogger _log = Log.Logger;
        private IRibbonUI _ribbonUi;

        public override string GetCustomUI(string ribbonId)
        {
            try
            {
                _log = Log.ForContext<Ribbon>();
                _log.Debug("Loading ribbon {ribbonId} via GetCustomUI", ribbonId);

                var xllFolderPath = Path.GetDirectoryName(ExcelDnaUtil.XllPath) ?? string.Empty;
                var ribbonXmlFilePath = Path.Combine(xllFolderPath, $"{nameof(Ribbon)}.xml");

                if (!File.Exists(ribbonXmlFilePath))
                {
                    throw new FileNotFoundException($"File not found: {ribbonXmlFilePath}", ribbonXmlFilePath);
                }

                var ribbonXml = File.ReadAllText(ribbonXmlFilePath);

                _log.Debug("Ribbon XML {ribbonXml}", ribbonXml);

                return ribbonXml;
            }
            catch (Exception ex)
            {
                ProcessUnhandledException(ex);
                return null;
            }
        }

        public void OnLoad(IRibbonUI ribbonUi)
        {
            try
            {
                _log.Information("Loading Ribbon...");
                _ribbonUi = ribbonUi;
            }
            catch (Exception ex)
            {
                ProcessUnhandledException(ex);
            }
        }

        public string SampleTab_GetLabel(IRibbonControl control)
        {
            try
            {
                var ribbonLabel = "Serilog -> LogDisplay";

                // Excel 2013
                if (Math.Abs(ExcelDnaUtil.ExcelVersion - 15.0) < double.Epsilon)
                {
                    ribbonLabel = ribbonLabel.ToUpperInvariant();
                }

                return ribbonLabel;
            }
            catch (Exception ex)
            {
                ProcessUnhandledException(ex);
                return control.Id;
            }
        }

        public void VerboseButton_OnAction(IRibbonControl control)
        {
            try
            {
                _log.Verbose("This is a **Verbose** message");
            }
            catch (Exception ex)
            {
                ProcessUnhandledException(ex);
            }
        }

        public void DebugButton_OnAction(IRibbonControl control)
        {
            try
            {
                _log.Debug("This is a **Debug** message");
            }
            catch (Exception ex)
            {
                ProcessUnhandledException(ex);
            }
        }

        public void InformationButton_OnAction(IRibbonControl control)
        {
            try
            {
                _log.Information("This is an **Information** message");
            }
            catch (Exception ex)
            {
                ProcessUnhandledException(ex);
            }
        }

        public void WarningButton_OnAction(IRibbonControl control)
        {
            try
            {
                _log.Warning("This is a **Warning** message");
            }
            catch (Exception ex)
            {
                ProcessUnhandledException(ex);
            }
        }

        public void ErrorButton_OnAction(IRibbonControl control)
        {
            try
            {
                _log.Error("This is an **Error** message");
            }
            catch (Exception ex)
            {
                ProcessUnhandledException(ex);
            }
        }

        public void ViewLogDisplayButton_OnAction(IRibbonControl control)
        {
            try
            {
                LogDisplay.Show();
            }
            catch (Exception ex)
            {
                ProcessUnhandledException(ex);
            }
        }

        public void ClearLogDisplayButton_OnAction(IRibbonControl control)
        {
            try
            {
                LogDisplay.Clear();
            }
            catch (Exception ex)
            {
                ProcessUnhandledException(ex);
            }
        }

        public string DisplayOrderMenu_GetImage(IRibbonControl control)
        {
            try
            {
                switch (LogDisplay.DisplayOrder)
                {
                    case DisplayOrder.NewestLast:
                        return "EndOfDocument";

                    case DisplayOrder.NewestFirst:
                        return "StartOfDocument";

                    default:
                        throw new NotImplementedException(LogDisplay.DisplayOrder.ToString());
                }
            }
            catch (Exception ex)
            {
                ProcessUnhandledException(ex);
                return null;
            }
        }

        public bool LogNewestLastButton_GetPressed(IRibbonControl control)
        {
            try
            {
                return LogDisplay.DisplayOrder == DisplayOrder.NewestLast;
            }
            catch (Exception ex)
            {
                ProcessUnhandledException(ex);
            }

            return false;
        }

        public void LogNewestLastButton_OnAction(IRibbonControl control, bool pressed)
        {
            try
            {
                LogDisplay.DisplayOrder = DisplayOrder.NewestLast;
                _ribbonUi.InvalidateControl("DisplayOrderMenu");
                _ribbonUi.InvalidateControl("LogNewestLastButton");
                _ribbonUi.InvalidateControl("LogNewestFirstButton");
            }
            catch (Exception ex)
            {
                ProcessUnhandledException(ex);
            }
        }

        public bool LogNewestFirstButton_GetPressed(IRibbonControl control)
        {
            try
            {
                return LogDisplay.DisplayOrder == DisplayOrder.NewestFirst;
            }
            catch (Exception ex)
            {
                ProcessUnhandledException(ex);
            }

            return false;
        }

        public void LogNewestFirstButton_OnAction(IRibbonControl control, bool pressed)
        {
            try
            {
                LogDisplay.DisplayOrder = DisplayOrder.NewestFirst;
                _ribbonUi.InvalidateControl("DisplayOrderMenu");
                _ribbonUi.InvalidateControl("LogNewestFirstButton");
                _ribbonUi.InvalidateControl("LogNewestLastButton");
            }
            catch (Exception ex)
            {
                ProcessUnhandledException(ex);
            }
        }
    }
}