EPPlus/ExcelProtection.cs

/*******************************************************************************
 * You may amend and distribute as you like, but don't remove this header!
 *
 * EPPlus provides server-side generation of Excel 2007/2010 spreadsheets.
 * See http://www.codeplex.com/EPPlus for details.
 *
 * Copyright (C) 2011  Jan Källman
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.

 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * The GNU Lesser General Public License can be viewed at http://www.opensource.org/licenses/lgpl-license.php
 * If you unfamiliar with this license or have questions about it, here is an http://www.gnu.org/licenses/gpl-faq.html
 *
 * All code and executables are provided "as is" with no warranty either express or implied.
 * The author accepts no liability for any damage or loss of business that this product may cause.
 *
 * Code change notes:
 *
 * Author							Change						Date
 * ******************************************************************************
 * Jan Källman		    Added		10-AUG-2010
 * Jan Källman		    License changed GPL-->LGPL 2011-12-27
 *******************************************************************************/

using System.Collections.Immutable;
using System.Xml;

namespace OfficeOpenXml;

/// <summary>
/// Sets protection on the workbook level
///<seealso cref="ExcelEncryption"/>
///<seealso cref="ExcelSheetProtection"/>
/// </summary>
public class ExcelProtection : XmlHelper {
  protected override ImmutableArray<string> SchemaNodeOrder =>
    ExcelWorkbook.WorkbookSchemaNodeOrder;

  internal ExcelProtection(XmlNamespaceManager ns, XmlNode topNode)
      : base(ns, topNode) {}

  private const string _lockStructurePath = "d:workbookProtection/@lockStructure";

  /// <summary>
  /// Locks the structure,which prevents users from adding or deleting worksheets or from displaying hidden worksheets.
  /// </summary>
  public bool LockStructure {
    get => GetXmlNodeBool(_lockStructurePath, false);
    set => SetXmlNodeBool(_lockStructurePath, value, false);
  }

  private const string _lockWindowsPath = "d:workbookProtection/@lockWindows";

  /// <summary>
  /// Locks the position of the workbook window.
  /// </summary>
  public bool LockWindows {
    get => GetXmlNodeBool(_lockWindowsPath, false);
    set => SetXmlNodeBool(_lockWindowsPath, value, false);
  }

  private const string _lockRevisionPath = "d:workbookProtection/@lockRevision";

  /// <summary>
  /// Lock the workbook for revision
  /// </summary>
  public bool LockRevision {
    get => GetXmlNodeBool(_lockRevisionPath, false);
    set => SetXmlNodeBool(_lockRevisionPath, value, false);
  }
}