Sunji-posv-net/pos/POSV.Excel/LimitEventArgs.cs

namespace com.azkoss.excellite
{
    using System;

    ///<summary>
    ///Event parameters used for the <see cref="com.azkoss.excellite.ExcelFile.LimitNear">ExcelFile.LimitNear</see>
    ///and <see cref="com.azkoss.excellite.ExcelFile.LimitReached">ExcelFile.LimitReached</see> events.
    ///</summary>
    ///<example> Following code demonstrates how to handle <see cref="com.azkoss.excellite.ExcelFile.LimitNear">LimitNear</see>
    ///and <see cref="com.azkoss.excellite.ExcelFile.LimitReached">LimitReached</see> events in <b>ExcelLite Free</b>.
    ///This sample disables warning worksheet in <see cref="com.azkoss.excellite.ExcelFile.LimitNear">LimitNear</see> event
    ///handler and displays console messages in
    ///<see cref="com.azkoss.excellite.ExcelFile.LimitReached">LimitReached</see> event handler.
    ///<code lang="Visual Basic">
    ///Sub Main()
    ///Dim ef As ExcelFile = New ExcelFile
    ///
    ///AddHandler ef.LimitNear, AddressOf ef_LimitNear
    ///AddHandler ef.LimitReached, AddressOf ef_LimitReached
    ///
    ///Dim ws As ExcelWorksheet = ef.Worksheets.Add("Sheet1")
    ///
    ///Dim i As Integer
    ///For i = 0 To 172 - 1 Step i + 1
    ///ws.Cells(i, 0).Value = i
    ///Next
    ///
    ///ef.SaveXls("Test.xls")
    ///End Sub
    ///
    ///Private Sub ef_LimitNear(ByVal sender As Object, ByVal e As LimitEventArgs)
    ///e.WriteWarningWorksheet = False
    ///End Sub
    ///
    ///Private Sub ef_LimitReached(ByVal sender As Object, ByVal e As LimitEventArgs)
    ///Select Case e.Operation
    ///Case LimitEventOperation.XlsReading
    ///Console.WriteLine("Data truncated while reading XLS file: " + e.FileName)
    ///
    ///Case LimitEventOperation.CsvReading
    ///Console.WriteLine("Data truncated while reading CSV file: " + e.FileName)
    ///
    ///Case LimitEventOperation.XlsWriting
    ///Console.WriteLine("Data truncated while writing XLS file: " + e.FileName)
    ///e.WriteWarningWorksheet = False
    ///
    ///Case LimitEventOperation.CsvWriting
    ///Console.WriteLine("Data truncated while writing CSV file: " + e.FileName)
    ///
    ///End Select
    ///End Sub
    ///</code>
    ///<code lang="C#">
    ///static void Main(string[] args)
    ///{
    ///ExcelFile ef = new ExcelFile();
    ///
    ///ef.LimitNear += new LimitEventHandler(ef_LimitNear);
    ///ef.LimitReached += new LimitEventHandler(ef_LimitReached);
    ///
    ///ExcelWorksheet ws = ef.Worksheets.Add("Sheet1");
    ///
    ///for(int i=0; i!=172; i++)
    ///ws.Cells[i, 0].Value = i;
    ///
    ///ef.SaveXls("Test.xls");
    ///}
    ///
    ///private static void ef_LimitNear(object sender, LimitEventArgs e)
    ///{
    ///e.WriteWarningWorksheet = false;
    ///}
    ///
    ///private static void ef_LimitReached(object sender, LimitEventArgs e)
    ///{
    ///switch(e.Operation)
    ///{
    ///case LimitEventOperation.XlsReading:
    ///Console.WriteLine("Data truncated while reading XLS file: " + e.FileName);
    ///break;
    ///
    ///case LimitEventOperation.CsvReading:
    ///Console.WriteLine("Data truncated while reading CSV file: " + e.FileName);
    ///break;
    ///
    ///case LimitEventOperation.XlsWriting:
    ///Console.WriteLine("Data truncated while writing XLS file: " + e.FileName);
    ///e.WriteWarningWorksheet = false;
    ///break;
    ///
    ///case LimitEventOperation.CsvWriting:
    ///Console.WriteLine("Data truncated while writing CSV file: " + e.FileName);
    ///break;
    ///}
    ///}
    ///</code>
    ///</example>
    public class LimitEventArgs : EventArgs
    {
        // Methods
        internal LimitEventArgs(string fileName, LimitEventOperation operation, int maxRowCount, int worksheetCount, bool writeWarningWorksheet)
        {
            this.fileName = fileName;
            this.operation = operation;
            this.maxRowCount = maxRowCount;
            this.worksheetCount = worksheetCount;
            this.writeWarningWorksheet = writeWarningWorksheet;
        }


        // Properties
        ///<summary>
        ///Gets the file name passed to the XLS / CSV file reading / writing method.
        ///</summary>
        ///<remarks>
        ///You can use this property to handle different files in a different way inside your event handlers.
        ///</remarks>
        ///<example> Following code demonstrates how to handle <see cref="com.azkoss.excellite.ExcelFile.LimitNear">LimitNear</see>
        ///and <see cref="com.azkoss.excellite.ExcelFile.LimitReached">LimitReached</see> events in <b>ExcelLite Free</b>.
        ///This sample disables warning worksheet in <see cref="com.azkoss.excellite.ExcelFile.LimitNear">LimitNear</see> event
        ///handler and displays console messages in
        ///<see cref="com.azkoss.excellite.ExcelFile.LimitReached">LimitReached</see> event handler.
        ///<code lang="Visual Basic">
        ///Sub Main()
        ///Dim ef As ExcelFile = New ExcelFile
        ///
        ///AddHandler ef.LimitNear, AddressOf ef_LimitNear
        ///AddHandler ef.LimitReached, AddressOf ef_LimitReached
        ///
        ///Dim ws As ExcelWorksheet = ef.Worksheets.Add("Sheet1")
        ///
        ///Dim i As Integer
        ///For i = 0 To 172 - 1 Step i + 1
        ///ws.Cells(i, 0).Value = i
        ///Next
        ///
        ///ef.SaveXls("Test.xls")
        ///End Sub
        ///
        ///Private Sub ef_LimitNear(ByVal sender As Object, ByVal e As LimitEventArgs)
        ///e.WriteWarningWorksheet = False
        ///End Sub
        ///
        ///Private Sub ef_LimitReached(ByVal sender As Object, ByVal e As LimitEventArgs)
        ///Select Case e.Operation
        ///Case LimitEventOperation.XlsReading
        ///Console.WriteLine("Data truncated while reading XLS file: " + e.FileName)
        ///
        ///Case LimitEventOperation.CsvReading
        ///Console.WriteLine("Data truncated while reading CSV file: " + e.FileName)
        ///
        ///Case LimitEventOperation.XlsWriting
        ///Console.WriteLine("Data truncated while writing XLS file: " + e.FileName)
        ///e.WriteWarningWorksheet = False
        ///
        ///Case LimitEventOperation.CsvWriting
        ///Console.WriteLine("Data truncated while writing CSV file: " + e.FileName)
        ///
        ///End Select
        ///End Sub
        ///</code>
        ///<code lang="C#">
        ///static void Main(string[] args)
        ///{
        ///ExcelFile ef = new ExcelFile();
        ///
        ///ef.LimitNear += new LimitEventHandler(ef_LimitNear);
        ///ef.LimitReached += new LimitEventHandler(ef_LimitReached);
        ///
        ///ExcelWorksheet ws = ef.Worksheets.Add("Sheet1");
        ///
        ///for(int i=0; i!=172; i++)
        ///ws.Cells[i, 0].Value = i;
        ///
        ///ef.SaveXls("Test.xls");
        ///}
        ///
        ///private static void ef_LimitNear(object sender, LimitEventArgs e)
        ///{
        ///e.WriteWarningWorksheet = false;
        ///}
        ///
        ///private static void ef_LimitReached(object sender, LimitEventArgs e)
        ///{
        ///switch(e.Operation)
        ///{
        ///case LimitEventOperation.XlsReading:
        ///Console.WriteLine("Data truncated while reading XLS file: " + e.FileName);
        ///break;
        ///
        ///case LimitEventOperation.CsvReading:
        ///Console.WriteLine("Data truncated while reading CSV file: " + e.FileName);
        ///break;
        ///
        ///case LimitEventOperation.XlsWriting:
        ///Console.WriteLine("Data truncated while writing XLS file: " + e.FileName);
        ///e.WriteWarningWorksheet = false;
        ///break;
        ///
        ///case LimitEventOperation.CsvWriting:
        ///Console.WriteLine("Data truncated while writing CSV file: " + e.FileName);
        ///break;
        ///}
        ///}
        ///</code>
        ///</example>
        public string FileName
        {
            get
            {
                return this.fileName;
            }
        }

        ///<summary>
        ///Gets the maximum number of rows used.
        ///</summary>
        public int MaxRowCount
        {
            get
            {
                return this.maxRowCount;
            }
        }

        ///<summary>
        ///Indicates which operation caused this event to fire.
        ///</summary>
        ///<remarks>
        ///You can use this property to handle XLS / CSV or reading / writing operations differently
        ///inside your event handlers.
        ///</remarks>
        ///<example> Following code demonstrates how to handle <see cref="com.azkoss.excellite.ExcelFile.LimitNear">LimitNear</see>
        ///and <see cref="com.azkoss.excellite.ExcelFile.LimitReached">LimitReached</see> events in <b>ExcelLite Free</b>.
        ///This sample disables warning worksheet in <see cref="com.azkoss.excellite.ExcelFile.LimitNear">LimitNear</see> event
        ///handler and displays console messages in
        ///<see cref="com.azkoss.excellite.ExcelFile.LimitReached">LimitReached</see> event handler.
        ///<code lang="Visual Basic">
        ///Sub Main()
        ///Dim ef As ExcelFile = New ExcelFile
        ///
        ///AddHandler ef.LimitNear, AddressOf ef_LimitNear
        ///AddHandler ef.LimitReached, AddressOf ef_LimitReached
        ///
        ///Dim ws As ExcelWorksheet = ef.Worksheets.Add("Sheet1")
        ///
        ///Dim i As Integer
        ///For i = 0 To 172 - 1 Step i + 1
        ///ws.Cells(i, 0).Value = i
        ///Next
        ///
        ///ef.SaveXls("Test.xls")
        ///End Sub
        ///
        ///Private Sub ef_LimitNear(ByVal sender As Object, ByVal e As LimitEventArgs)
        ///e.WriteWarningWorksheet = False
        ///End Sub
        ///
        ///Private Sub ef_LimitReached(ByVal sender As Object, ByVal e As LimitEventArgs)
        ///Select Case e.Operation
        ///Case LimitEventOperation.XlsReading
        ///Console.WriteLine("Data truncated while reading XLS file: " + e.FileName)
        ///
        ///Case LimitEventOperation.CsvReading
        ///Console.WriteLine("Data truncated while reading CSV file: " + e.FileName)
        ///
        ///Case LimitEventOperation.XlsWriting
        ///Console.WriteLine("Data truncated while writing XLS file: " + e.FileName)
        ///e.WriteWarningWorksheet = False
        ///
        ///Case LimitEventOperation.CsvWriting
        ///Console.WriteLine("Data truncated while writing CSV file: " + e.FileName)
        ///
        ///End Select
        ///End Sub
        ///</code>
        ///<code lang="C#">
        ///static void Main(string[] args)
        ///{
        ///ExcelFile ef = new ExcelFile();
        ///
        ///ef.LimitNear += new LimitEventHandler(ef_LimitNear);
        ///ef.LimitReached += new LimitEventHandler(ef_LimitReached);
        ///
        ///ExcelWorksheet ws = ef.Worksheets.Add("Sheet1");
        ///
        ///for(int i=0; i!=172; i++)
        ///ws.Cells[i, 0].Value = i;
        ///
        ///ef.SaveXls("Test.xls");
        ///}
        ///
        ///private static void ef_LimitNear(object sender, LimitEventArgs e)
        ///{
        ///e.WriteWarningWorksheet = false;
        ///}
        ///
        ///private static void ef_LimitReached(object sender, LimitEventArgs e)
        ///{
        ///switch(e.Operation)
        ///{
        ///case LimitEventOperation.XlsReading:
        ///Console.WriteLine("Data truncated while reading XLS file: " + e.FileName);
        ///break;
        ///
        ///case LimitEventOperation.CsvReading:
        ///Console.WriteLine("Data truncated while reading CSV file: " + e.FileName);
        ///break;
        ///
        ///case LimitEventOperation.XlsWriting:
        ///Console.WriteLine("Data truncated while writing XLS file: " + e.FileName);
        ///e.WriteWarningWorksheet = false;
        ///break;
        ///
        ///case LimitEventOperation.CsvWriting:
        ///Console.WriteLine("Data truncated while writing CSV file: " + e.FileName);
        ///break;
        ///}
        ///}
        ///</code>
        ///</example>
        public LimitEventOperation Operation
        {
            get
            {
                return this.operation;
            }
        }

        ///<summary>
        ///Gets the number of worksheets used.
        ///</summary>
        ///<remarks>
        ///<p>For CSV files, this is always 1 (as only
        ///<see cref="com.azkoss.excellite.ExcelWorksheetCollection.ActiveWorksheet">ActiveWorksheet</see> is used).</p>
        ///<p>When writing XLS files, warning worksheet is not counted.</p>
        ///</remarks>
        public int WorksheetCount
        {
            get
            {
                return this.worksheetCount;
            }
        }

        ///<summary>
        ///Gets or sets whether the warning worksheet should be created when writing XLS file.
        ///</summary>
        ///<remarks>
        ///This property is ignored for CSV files and when reading XLS files.
        ///</remarks>
        ///<example> Following code demonstrates how to handle <see cref="com.azkoss.excellite.ExcelFile.LimitNear">LimitNear</see>
        ///and <see cref="com.azkoss.excellite.ExcelFile.LimitReached">LimitReached</see> events in <b>ExcelLite Free</b>.
        ///This sample disables warning worksheet in <see cref="com.azkoss.excellite.ExcelFile.LimitNear">LimitNear</see> event
        ///handler and displays console messages in
        ///<see cref="com.azkoss.excellite.ExcelFile.LimitReached">LimitReached</see> event handler.
        ///<code lang="Visual Basic">
        ///Sub Main()
        ///Dim ef As ExcelFile = New ExcelFile
        ///
        ///AddHandler ef.LimitNear, AddressOf ef_LimitNear
        ///AddHandler ef.LimitReached, AddressOf ef_LimitReached
        ///
        ///Dim ws As ExcelWorksheet = ef.Worksheets.Add("Sheet1")
        ///
        ///Dim i As Integer
        ///For i = 0 To 172 - 1 Step i + 1
        ///ws.Cells(i, 0).Value = i
        ///Next
        ///
        ///ef.SaveXls("Test.xls")
        ///End Sub
        ///
        ///Private Sub ef_LimitNear(ByVal sender As Object, ByVal e As LimitEventArgs)
        ///e.WriteWarningWorksheet = False
        ///End Sub
        ///
        ///Private Sub ef_LimitReached(ByVal sender As Object, ByVal e As LimitEventArgs)
        ///Select Case e.Operation
        ///Case LimitEventOperation.XlsReading
        ///Console.WriteLine("Data truncated while reading XLS file: " + e.FileName)
        ///
        ///Case LimitEventOperation.CsvReading
        ///Console.WriteLine("Data truncated while reading CSV file: " + e.FileName)
        ///
        ///Case LimitEventOperation.XlsWriting
        ///Console.WriteLine("Data truncated while writing XLS file: " + e.FileName)
        ///e.WriteWarningWorksheet = False
        ///
        ///Case LimitEventOperation.CsvWriting
        ///Console.WriteLine("Data truncated while writing CSV file: " + e.FileName)
        ///
        ///End Select
        ///End Sub
        ///</code>
        ///<code lang="C#">
        ///static void Main(string[] args)
        ///{
        ///ExcelFile ef = new ExcelFile();
        ///
        ///ef.LimitNear += new LimitEventHandler(ef_LimitNear);
        ///ef.LimitReached += new LimitEventHandler(ef_LimitReached);
        ///
        ///ExcelWorksheet ws = ef.Worksheets.Add("Sheet1");
        ///
        ///for(int i=0; i!=172; i++)
        ///ws.Cells[i, 0].Value = i;
        ///
        ///ef.SaveXls("Test.xls");
        ///}
        ///
        ///private static void ef_LimitNear(object sender, LimitEventArgs e)
        ///{
        ///e.WriteWarningWorksheet = false;
        ///}
        ///
        ///private static void ef_LimitReached(object sender, LimitEventArgs e)
        ///{
        ///switch(e.Operation)
        ///{
        ///case LimitEventOperation.XlsReading:
        ///Console.WriteLine("Data truncated while reading XLS file: " + e.FileName);
        ///break;
        ///
        ///case LimitEventOperation.CsvReading:
        ///Console.WriteLine("Data truncated while reading CSV file: " + e.FileName);
        ///break;
        ///
        ///case LimitEventOperation.XlsWriting:
        ///Console.WriteLine("Data truncated while writing XLS file: " + e.FileName);
        ///e.WriteWarningWorksheet = false;
        ///break;
        ///
        ///case LimitEventOperation.CsvWriting:
        ///Console.WriteLine("Data truncated while writing CSV file: " + e.FileName);
        ///break;
        ///}
        ///}
        ///</code>
        ///</example>
        public bool WriteWarningWorksheet
        {
            get
            {
                return this.writeWarningWorksheet;
            }
            set
            {
                this.writeWarningWorksheet = value;
            }
        }


        // Fields
        private string fileName;
        private int maxRowCount;
        private LimitEventOperation operation;
        private int worksheetCount;
        private bool writeWarningWorksheet;
    }
}