Edit

Share via

Excel.AutorunEventCompletedOptions interface

Package:
excel

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies the options for completing an autorun event.

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Properties

allowEvent

Specifies whether to allow the event to proceed. The default value is false.
autorunEventType

Specifies the type of autorun event to be completed if allowed. The default value is unknown.
message

If provided, specifies an optional error message if the event isn't allowed to proceed. The default value is "" (empty string).

Property Details

allowEvent

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies whether to allow the event to proceed. The default value is false.

allowEvent: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

autorunEventType

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies the type of autorun event to be completed if allowed. The default value is unknown.

autorunEventType: Excel.AutorunEventType | "Unknown" | "OnDocumentSave" | "OnDocumentSaveAs";

Property Value

Excel.AutorunEventType | "Unknown" | "OnDocumentSave" | "OnDocumentSaveAs"

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

message

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies an optional error message if the event isn't allowed to proceed. The default value is "" (empty string).

message?: string;

Property Value

string

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]