com.aspose.words

Class FieldUpdatingProgressArgs

java.lang.Object

com.aspose.words.FieldUpdatingProgressArgs

public class FieldUpdatingProgressArgs
extends java.lang.Object

Provides data for the field updating progress event.

Examples:

Shows how to use callback methods during a field update.

 
 public void fieldUpdatingCallbackTest() throws Exception
 {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     builder.insertField(" DATE \\@ \"dddd, d MMMM yyyy\" ");
     builder.insertField(" TIME ");
     builder.insertField(" REVNUM ");
     builder.insertField(" AUTHOR  \"John Doe\" ");
     builder.insertField(" SUBJECT \"My Subject\" ");
     builder.insertField(" QUOTE \"Hello world!\" ");

     FieldUpdatingCallback callback = new FieldUpdatingCallback();
     doc.getFieldOptions().setFieldUpdatingCallback(callback);

     doc.updateFields();

     Assert.assertTrue(callback.getFieldUpdatedCalls().contains("Updating John Doe"));
 }

 /// <summary>
 /// Implement this interface if you want to have your own custom methods called during a field update.
 /// </summary>
 public static class FieldUpdatingCallback implements IFieldUpdatingCallback
 {
     public FieldUpdatingCallback()
     {
         mFieldUpdatedCalls = new ArrayList<String>();
     }

     /// <summary>
     /// A user defined method that is called just before a field is updated.
     /// </summary>
     public void fieldUpdating(Field field) {
         if (field.getType() == FieldType.FIELD_AUTHOR)
         {
             FieldAuthor fieldAuthor = (FieldAuthor) field;
             try {
                 fieldAuthor.setAuthorName("Updating John Doe");
             } catch (Exception e) {
                 e.printStackTrace();
             }
         }
     }

     /// <summary>
     /// A user defined method that is called just after a field is updated.
     /// </summary>
     public void fieldUpdated(Field field)
     {
         getFieldUpdatedCalls().add(field.getResult());
     }

     public ArrayList<String> getFieldUpdatedCalls() { return mFieldUpdatedCalls; };

     private ArrayList<String> mFieldUpdatedCalls;
 }
 
 

Method Summary

Modifier and Type	Method and Description
int	getTotalFieldsCount() Gets the total fields count to be updated.
boolean	getUpdateCompleted() Gets a value indicating whether field updating is completed.
int	getUpdatedFieldsCount() Gets the number of updated fields.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getTotalFieldsCount

public int getTotalFieldsCount()

Gets the total fields count to be updated.

Remarks:

The value is not constant and may be increased during updating process.

Examples:

Shows how to use callback methods during a field update.

 
 public void fieldUpdatingCallbackTest() throws Exception
 {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     builder.insertField(" DATE \\@ \"dddd, d MMMM yyyy\" ");
     builder.insertField(" TIME ");
     builder.insertField(" REVNUM ");
     builder.insertField(" AUTHOR  \"John Doe\" ");
     builder.insertField(" SUBJECT \"My Subject\" ");
     builder.insertField(" QUOTE \"Hello world!\" ");

     FieldUpdatingCallback callback = new FieldUpdatingCallback();
     doc.getFieldOptions().setFieldUpdatingCallback(callback);

     doc.updateFields();

     Assert.assertTrue(callback.getFieldUpdatedCalls().contains("Updating John Doe"));
 }

 /// <summary>
 /// Implement this interface if you want to have your own custom methods called during a field update.
 /// </summary>
 public static class FieldUpdatingCallback implements IFieldUpdatingCallback
 {
     public FieldUpdatingCallback()
     {
         mFieldUpdatedCalls = new ArrayList<String>();
     }

     /// <summary>
     /// A user defined method that is called just before a field is updated.
     /// </summary>
     public void fieldUpdating(Field field) {
         if (field.getType() == FieldType.FIELD_AUTHOR)
         {
             FieldAuthor fieldAuthor = (FieldAuthor) field;
             try {
                 fieldAuthor.setAuthorName("Updating John Doe");
             } catch (Exception e) {
                 e.printStackTrace();
             }
         }
     }

     /// <summary>
     /// A user defined method that is called just after a field is updated.
     /// </summary>
     public void fieldUpdated(Field field)
     {
         getFieldUpdatedCalls().add(field.getResult());
     }

     public ArrayList<String> getFieldUpdatedCalls() { return mFieldUpdatedCalls; };

     private ArrayList<String> mFieldUpdatedCalls;
 }
 
 

Returns:

The total fields count to be updated.

getUpdatedFieldsCount

public int getUpdatedFieldsCount()

Gets the number of updated fields.

Examples:

Shows how to use callback methods during a field update.

 
 public void fieldUpdatingCallbackTest() throws Exception
 {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     builder.insertField(" DATE \\@ \"dddd, d MMMM yyyy\" ");
     builder.insertField(" TIME ");
     builder.insertField(" REVNUM ");
     builder.insertField(" AUTHOR  \"John Doe\" ");
     builder.insertField(" SUBJECT \"My Subject\" ");
     builder.insertField(" QUOTE \"Hello world!\" ");

     FieldUpdatingCallback callback = new FieldUpdatingCallback();
     doc.getFieldOptions().setFieldUpdatingCallback(callback);

     doc.updateFields();

     Assert.assertTrue(callback.getFieldUpdatedCalls().contains("Updating John Doe"));
 }

 /// <summary>
 /// Implement this interface if you want to have your own custom methods called during a field update.
 /// </summary>
 public static class FieldUpdatingCallback implements IFieldUpdatingCallback
 {
     public FieldUpdatingCallback()
     {
         mFieldUpdatedCalls = new ArrayList<String>();
     }

     /// <summary>
     /// A user defined method that is called just before a field is updated.
     /// </summary>
     public void fieldUpdating(Field field) {
         if (field.getType() == FieldType.FIELD_AUTHOR)
         {
             FieldAuthor fieldAuthor = (FieldAuthor) field;
             try {
                 fieldAuthor.setAuthorName("Updating John Doe");
             } catch (Exception e) {
                 e.printStackTrace();
             }
         }
     }

     /// <summary>
     /// A user defined method that is called just after a field is updated.
     /// </summary>
     public void fieldUpdated(Field field)
     {
         getFieldUpdatedCalls().add(field.getResult());
     }

     public ArrayList<String> getFieldUpdatedCalls() { return mFieldUpdatedCalls; };

     private ArrayList<String> mFieldUpdatedCalls;
 }
 
 

Returns:

The number of updated fields.

getUpdateCompleted

public boolean getUpdateCompleted()

Gets a value indicating whether field updating is completed.

Examples:

Shows how to use callback methods during a field update.

 
 public void fieldUpdatingCallbackTest() throws Exception
 {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     builder.insertField(" DATE \\@ \"dddd, d MMMM yyyy\" ");
     builder.insertField(" TIME ");
     builder.insertField(" REVNUM ");
     builder.insertField(" AUTHOR  \"John Doe\" ");
     builder.insertField(" SUBJECT \"My Subject\" ");
     builder.insertField(" QUOTE \"Hello world!\" ");

     FieldUpdatingCallback callback = new FieldUpdatingCallback();
     doc.getFieldOptions().setFieldUpdatingCallback(callback);

     doc.updateFields();

     Assert.assertTrue(callback.getFieldUpdatedCalls().contains("Updating John Doe"));
 }

 /// <summary>
 /// Implement this interface if you want to have your own custom methods called during a field update.
 /// </summary>
 public static class FieldUpdatingCallback implements IFieldUpdatingCallback
 {
     public FieldUpdatingCallback()
     {
         mFieldUpdatedCalls = new ArrayList<String>();
     }

     /// <summary>
     /// A user defined method that is called just before a field is updated.
     /// </summary>
     public void fieldUpdating(Field field) {
         if (field.getType() == FieldType.FIELD_AUTHOR)
         {
             FieldAuthor fieldAuthor = (FieldAuthor) field;
             try {
                 fieldAuthor.setAuthorName("Updating John Doe");
             } catch (Exception e) {
                 e.printStackTrace();
             }
         }
     }

     /// <summary>
     /// A user defined method that is called just after a field is updated.
     /// </summary>
     public void fieldUpdated(Field field)
     {
         getFieldUpdatedCalls().add(field.getResult());
     }

     public ArrayList<String> getFieldUpdatedCalls() { return mFieldUpdatedCalls; };

     private ArrayList<String> mFieldUpdatedCalls;
 }
 
 

Returns:

A value indicating whether field updating is completed.