WebExtension

WebExtension class

Represents an Office Add-in instance.

class WebExtension;

Methods

MethodDescription
getId()Gets and sets the uniquely identifies the Office Add-in instance in the current document.
setId(string)Gets and sets the uniquely identifies the Office Add-in instance in the current document.
isFrozen()Indicates whether the user can interact with the Office Add-in or not.
setIsFrozen(boolean)Indicates whether the user can interact with the Office Add-in or not.
getReference()Get the primary reference to an Office Add-in.
getAlterReferences()Gets a list of alter references.
getProperties()Gets all properties of web extension.
getBindings()Gets all bindings relationship between an Office Add-in and the data in the document.

getId()

Gets and sets the uniquely identifies the Office Add-in instance in the current document.

getId() : string;

setId(string)

Gets and sets the uniquely identifies the Office Add-in instance in the current document.

setId(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

isFrozen()

Indicates whether the user can interact with the Office Add-in or not.

isFrozen() : boolean;

setIsFrozen(boolean)

Indicates whether the user can interact with the Office Add-in or not.

setIsFrozen(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getReference()

Get the primary reference to an Office Add-in.

getReference() : WebExtensionReference;

Returns

WebExtensionReference

getAlterReferences()

Gets a list of alter references.

getAlterReferences() : WebExtensionReferenceCollection;

Returns

WebExtensionReferenceCollection

getProperties()

Gets all properties of web extension.

getProperties() : WebExtensionPropertyCollection;

Returns

WebExtensionPropertyCollection

getBindings()

Gets all bindings relationship between an Office Add-in and the data in the document.

getBindings() : WebExtensionBindingCollection;

Returns

WebExtensionBindingCollection