com.aspose.words

Interface IFieldUpdatingProgressCallback

public interface IFieldUpdatingProgressCallback

Implement this interface if you want to track field updating progress.

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
void	notify(FieldUpdatingProgressArgs args) A user defined method that is called when updating progress is changed.

Method Detail

notify

void notify(FieldUpdatingProgressArgs args)

A user defined method that is called when updating progress is changed.

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;
 }