# GrapeCity.Documents.Common.LongOperationEventArgs

## Content

<div class="doc-site-dotnet-api-container">



  <h1 id="GrapeCity_Documents_Common_LongOperationEventArgs" data-uid="GrapeCity.Documents.Common.LongOperationEventArgs" class="text-break">LongOperationEventArgs Class
</h1>
  <div class="markdown level0 summary"><p>Describes arguments for the event fired periodically by a potentially
long operation. Can be used to provide feedback to the user and
to allow the user to cancel the operation.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
    <div class="level1"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.eventargs">EventArgs</a></div>
    <div class="level2"><span class="xref">LongOperationEventArgs</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="GrapeCity.Documents.Common.html">GrapeCity.Documents.Common</a></h6>
  <h6><strong>Assembly</strong>: DS.Documents.Imaging.dll</h6>
  <h5 id="GrapeCity_Documents_Common_LongOperationEventArgs_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class LongOperationEventArgs : EventArgs</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class LongOperationEventArgs
    Inherits EventArgs</code></pre>
  </div>
  <h3 id="constructors">Constructors
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="GrapeCity_Documents_Common_LongOperationEventArgs__ctor" data-uid="GrapeCity.Documents.Common.LongOperationEventArgs.#ctor">
          <a class="xref" href="GrapeCity.Documents.Common.LongOperationEventArgs.-ctor.html#GrapeCity_Documents_Common_LongOperationEventArgs__ctor">LongOperationEventArgs()</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a new instance of LongOperationEventArgs with default
properties (Complete=0, CanCancel=false).</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Common_LongOperationEventArgs__ctor_System_Boolean_" data-uid="GrapeCity.Documents.Common.LongOperationEventArgs.#ctor(System.Boolean)">
          <a class="xref" href="GrapeCity.Documents.Common.LongOperationEventArgs.-ctor.html#GrapeCity_Documents_Common_LongOperationEventArgs__ctor_System_Boolean_">LongOperationEventArgs(bool)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a new instance of LongOperationEventArgs with the
specified CanCancel value and Complete=0.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Common_LongOperationEventArgs__ctor_System_Single_" data-uid="GrapeCity.Documents.Common.LongOperationEventArgs.#ctor(System.Single)">
          <a class="xref" href="GrapeCity.Documents.Common.LongOperationEventArgs.-ctor.html#GrapeCity_Documents_Common_LongOperationEventArgs__ctor_System_Single_">LongOperationEventArgs(float)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a new instance of LongOperationEventArgs with the
specified complete value and CanCancel=false.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Common_LongOperationEventArgs__ctor_System_Single_System_Boolean_" data-uid="GrapeCity.Documents.Common.LongOperationEventArgs.#ctor(System.Single,System.Boolean)">
          <a class="xref" href="GrapeCity.Documents.Common.LongOperationEventArgs.-ctor.html#GrapeCity_Documents_Common_LongOperationEventArgs__ctor_System_Single_System_Boolean_">LongOperationEventArgs(float, bool)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a new instance of LongOperationEventArgs with the
specified complete and CanCancel values.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="properties">Properties
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="GrapeCity_Documents_Common_LongOperationEventArgs_CanCancel" data-uid="GrapeCity.Documents.Common.LongOperationEventArgs.CanCancel">
          <a class="xref" href="GrapeCity.Documents.Common.LongOperationEventArgs.CanCancel.html#GrapeCity_Documents_Common_LongOperationEventArgs_CanCancel">CanCancel</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the value indicating whether the event handler can cancel the current long operation
by setting the <a class="xref" href="GrapeCity.Documents.Common.LongOperationEventArgs.Cancel.html#GrapeCity_Documents_Common_LongOperationEventArgs_Cancel">Cancel</a> property to <b>true</b>.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Common_LongOperationEventArgs_Cancel" data-uid="GrapeCity.Documents.Common.LongOperationEventArgs.Cancel">
          <a class="xref" href="GrapeCity.Documents.Common.LongOperationEventArgs.Cancel.html#GrapeCity_Documents_Common_LongOperationEventArgs_Cancel">Cancel</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a value indicating whether the current long operation
should be canceled. (This property is ignored if <a class="xref" href="GrapeCity.Documents.Common.LongOperationEventArgs.CanCancel.html#GrapeCity_Documents_Common_LongOperationEventArgs_CanCancel">CanCancel</a> is <b>false</b>.)</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Common_LongOperationEventArgs_Complete" data-uid="GrapeCity.Documents.Common.LongOperationEventArgs.Complete">
          <a class="xref" href="GrapeCity.Documents.Common.LongOperationEventArgs.Complete.html#GrapeCity_Documents_Common_LongOperationEventArgs_Complete">Complete</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the approximate completed ratio, from 0 (0% complete) to 1 (100% complete).</p>
</td>
      </tr>
    </tbody>
  </table>

</div>