OfficeExtension.EventHandlers class

包:

office

注解

使用方

• Excel.Binding： onDataChanged， onSelectionChanged
• Excel.Chart： onActivated， onDeactivated
• Excel.ChartCollection： onActivated， onAdded， onDeactivated， onDeleted
• Excel.CommentCollection： onAdded， onChanged， onDeleted
• Excel.LinkedEntityDataDomainCollection： onLinkedEntityCellValueLoaded， onLinkedEntityDataDomainAdded， onRefreshCompleted， onRefreshModeChanged
• Excel.SettingCollection： onSettingsChanged
• Excel.Shape： onActivated， onDeactivated
• Excel.Table： onChanged， onFiltered， onSelectionChanged
• Excel.TableCollection： onAdded， onChanged， onDeleted， onFiltered
• Excel.Workbook： onActivated， onAutoSaveSettingChanged， onSelectionChanged
• Excel.Worksheet： onActivated， onCalculated， onCalculationBusy， onChanged， onColumnSorted， onDeactivated， onFiltered， onFormatChanged， onFormulaChanged， onNameChanged， onProtectionChanged， onRowHiddenChanged， onRowSorted， onSelectionChanged， onSingleClicked， onVisibilityChanged
• Excel.WorksheetCollection： onActivated， onAdded， onCalculated， onCalculationBusy， onChanged， onColumnSorted， onDeactivated， onDeleted， onFiltered， onFormatChanged， onFormulaChanged， onMoved， onNameChanged， onProtectionChanged， onRowHiddenChanged， onRowSorted， onSelectionChanged， onSingleClicked， onVisibilityChanged
• PowerPoint.Presentation： onSlideSelectionChanged
• Visio.Document： onDataRefreshComplete、 onDocumentError、 onDocumentLoadComplete、 onPageLoadComplete、 onSelectionChanged、 onShapeMouseEnter、 onShapeMouseLeave、 onTaskPaneStateChanged
• Word.正文：onCommentAdded、onCommentChanged、onCommentDeleted、onCommentDeselected、onCommentSelected
• Word.ContentControl： onCommentAdded， onCommentChanged， onCommentDeselected， onCommentSelected， onDataChanged， onDeleted， onEntered， onExited， onSelectionChanged
• Word.文档：onAnnotationClicked、onAnnotationHovered、onAnnotationInserted、onAnnotationPopupAction、onAnnotationRemoved、onContentControlAdded、onParagraphAdded、onParagraphChanged、onParagraphDeleted
• Word.段落：onCommentAdded、onCommentChanged、onCommentDeleted、onCommentDeselected、onCommentSelected
• Word.范围：onCommentAdded、onCommentChanged、onCommentDeselected、onCommentSelected

构造函数

(constructor)(context, parentObject, name, eventInfo)

构造类的新 EventHandlers 实例

方法

add(handler)	添加触发事件时要调用的函数。
remove(handler)	从事件处理程序列表中删除指定函数，以便不会在后续事件上调用它。 注意： 删除处理程序时，必须使用添加处理程序的同一 RequestContext 对象。 有关详细信息，请参阅 删除事件处理程序。

构造函数详细信息

(constructor)(context, parentObject, name, eventInfo)

构造类的新 EventHandlers 实例

constructor(context: ClientRequestContext, parentObject: ClientObject, name: string, eventInfo: EventInfo<T>);

参数

context

OfficeExtension.ClientRequestContext

parentObject

OfficeExtension.ClientObject

name

string

eventInfo

OfficeExtension.EventInfo<T>

方法详细信息

add(handler)

添加触发事件时要调用的函数。

add(handler: (args: T) => Promise<any>): EventHandlerResult<T>;

参数

handler

(args: T) => Promise<any>

一个基于 promise 的函数，采用任何相关事件参数。

返回

OfficeExtension.EventHandlerResult<T>

remove(handler)

从事件处理程序列表中删除指定函数，以便不会在后续事件上调用它。

注意： 删除处理程序时，必须使用添加处理程序的同一 RequestContext 对象。 有关详细信息，请参阅 删除事件处理程序。

remove(handler: (args: T) => Promise<any>): void;

参数

handler

(args: T) => Promise<any>

对以前作为事件处理程序提供给方法的 add 函数的引用。

返回

void