WebExtension
WebExtension class
Represents an Office Add-in instance.
class WebExtension;
Properties
Property | Type | Description |
---|---|---|
id | string | Gets and sets the uniquely identifies the Office Add-in instance in the current document. |
isFrozen | boolean | Indicates whether the user can interact with the Office Add-in or not. |
reference | WebExtensionReference | Readonly. Get the primary reference to an Office Add-in. |
alterReferences | WebExtensionReferenceCollection | Readonly. Gets a list of alter references. |
properties | WebExtensionPropertyCollection | Readonly. Gets all properties of web extension. |
bindings | WebExtensionBindingCollection | Readonly. Gets all bindings relationship between an Office Add-in and the data in the document. |
Methods
Method | Description |
---|---|
getId() | @deprecated. Please use the ‘id’ property instead. Gets and sets the uniquely identifies the Office Add-in instance in the current document. |
setId(string) | @deprecated. Please use the ‘id’ property instead. Gets and sets the uniquely identifies the Office Add-in instance in the current document. |
isFrozen() | @deprecated. Please use the ‘isFrozen’ property instead. Indicates whether the user can interact with the Office Add-in or not. |
setIsFrozen(boolean) | @deprecated. Please use the ‘isFrozen’ property instead. Indicates whether the user can interact with the Office Add-in or not. |
getReference() | @deprecated. Please use the ‘reference’ property instead. Get the primary reference to an Office Add-in. |
getAlterReferences() | @deprecated. Please use the ‘alterReferences’ property instead. Gets a list of alter references. |
getProperties() | @deprecated. Please use the ‘properties’ property instead. Gets all properties of web extension. |
getBindings() | @deprecated. Please use the ‘bindings’ property instead. Gets all bindings relationship between an Office Add-in and the data in the document. |
isNull() | Checks whether the implementation object is null. |
id
Gets and sets the uniquely identifies the Office Add-in instance in the current document.
id : string;
isFrozen
Indicates whether the user can interact with the Office Add-in or not.
isFrozen : boolean;
reference
Readonly. Get the primary reference to an Office Add-in.
reference : WebExtensionReference;
alterReferences
Readonly. Gets a list of alter references.
alterReferences : WebExtensionReferenceCollection;
properties
Readonly. Gets all properties of web extension.
properties : WebExtensionPropertyCollection;
bindings
Readonly. Gets all bindings relationship between an Office Add-in and the data in the document.
bindings : WebExtensionBindingCollection;
getId()
@deprecated. Please use the ‘id’ property instead. Gets and sets the uniquely identifies the Office Add-in instance in the current document.
getId() : string;
setId(string)
@deprecated. Please use the ‘id’ property instead. Gets and sets the uniquely identifies the Office Add-in instance in the current document.
setId(value: string) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | string | The value to set. |
isFrozen()
@deprecated. Please use the ‘isFrozen’ property instead. Indicates whether the user can interact with the Office Add-in or not.
isFrozen() : boolean;
setIsFrozen(boolean)
@deprecated. Please use the ‘isFrozen’ property instead. Indicates whether the user can interact with the Office Add-in or not.
setIsFrozen(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getReference()
@deprecated. Please use the ‘reference’ property instead. Get the primary reference to an Office Add-in.
getReference() : WebExtensionReference;
Returns
getAlterReferences()
@deprecated. Please use the ‘alterReferences’ property instead. Gets a list of alter references.
getAlterReferences() : WebExtensionReferenceCollection;
Returns
WebExtensionReferenceCollection
getProperties()
@deprecated. Please use the ‘properties’ property instead. Gets all properties of web extension.
getProperties() : WebExtensionPropertyCollection;
Returns
WebExtensionPropertyCollection
getBindings()
@deprecated. Please use the ‘bindings’ property instead. Gets all bindings relationship between an Office Add-in and the data in the document.
getBindings() : WebExtensionBindingCollection;
Returns
isNull()
Checks whether the implementation object is null.
isNull() : boolean;