Edit

Share via

Visio.DataRefreshCompleteEventArgs interface

Package:
visio

Provides information about the document that raised the DataRefreshComplete event.

Remarks

[ API set: 1.1 ]

Examples

Visio.run(session, function (ctx) {
    const document1 = ctx.document;
    eventResult1 = document1.onDataRefreshComplete.add(
        function (args){
            console.log("Data Refresh Result: "+args.success);
        });

    return ctx.sync().then(function () {
       console.log("Success");
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

Properties

document

Gets the document object that raised the DataRefreshComplete event.
success

Gets the success or failure of the DataRefreshComplete event.

Property Details

document

Gets the document object that raised the DataRefreshComplete event.

document: Visio.Document;

Property Value

Visio.Document

Remarks

[ API set: 1.1 ]

success

Gets the success or failure of the DataRefreshComplete event.

success: boolean;

Property Value

boolean

Remarks

[ API set: 1.1 ]