WebExtensionTaskPane

WebExtensionTaskPane class

Represents a persisted taskpane object.

class WebExtensionTaskPane;

Properties

Property	Type	Description
webExtension	WebExtension	Gets and sets the web extension part associated with the taskpane instance
dockState	string	Gets and sets the last-docked location of this taskpane object.
isVisible	boolean	Indicates whether the Task Pane shows as visible by default when the document opens.
isLocked	boolean	Indicates whether the taskpane is locked to the document in the UI and cannot be closed by the user.
width	number	Gets and sets the default width value for this taskpane instance.
row	number	Gets and sets the index, enumerating from the outside to the inside, of this taskpane among other persisted taskpanes docked in the same default location.

Methods

Method	Description
getWebExtension()	@deprecated. Please use the ‘webExtension’ property instead. Gets and sets the web extension part associated with the taskpane instance
setWebExtension(WebExtension)	@deprecated. Please use the ‘webExtension’ property instead. Gets and sets the web extension part associated with the taskpane instance
getDockState()	@deprecated. Please use the ‘dockState’ property instead. Gets and sets the last-docked location of this taskpane object.
setDockState(string)	@deprecated. Please use the ‘dockState’ property instead. Gets and sets the last-docked location of this taskpane object.
isVisible()	@deprecated. Please use the ‘isVisible’ property instead. Indicates whether the Task Pane shows as visible by default when the document opens.
setIsVisible(boolean)	@deprecated. Please use the ‘isVisible’ property instead. Indicates whether the Task Pane shows as visible by default when the document opens.
isLocked()	@deprecated. Please use the ‘isLocked’ property instead. Indicates whether the taskpane is locked to the document in the UI and cannot be closed by the user.
setIsLocked(boolean)	@deprecated. Please use the ‘isLocked’ property instead. Indicates whether the taskpane is locked to the document in the UI and cannot be closed by the user.
getWidth()	@deprecated. Please use the ‘width’ property instead. Gets and sets the default width value for this taskpane instance.
setWidth(number)	@deprecated. Please use the ‘width’ property instead. Gets and sets the default width value for this taskpane instance.
getRow()	@deprecated. Please use the ‘row’ property instead. Gets and sets the index, enumerating from the outside to the inside, of this taskpane among other persisted taskpanes docked in the same default location.
setRow(number)	@deprecated. Please use the ‘row’ property instead. Gets and sets the index, enumerating from the outside to the inside, of this taskpane among other persisted taskpanes docked in the same default location.
isNull()	Checks whether the implementation object is null.

webExtension

Gets and sets the web extension part associated with the taskpane instance

webExtension : WebExtension;

dockState

Gets and sets the last-docked location of this taskpane object.

dockState : string;

isVisible

Indicates whether the Task Pane shows as visible by default when the document opens.

isVisible : boolean;

isLocked

Indicates whether the taskpane is locked to the document in the UI and cannot be closed by the user.

isLocked : boolean;

width

Gets and sets the default width value for this taskpane instance.

width : number;

row

Gets and sets the index, enumerating from the outside to the inside, of this taskpane among other persisted taskpanes docked in the same default location.

row : number;

getWebExtension()

@deprecated. Please use the ‘webExtension’ property instead. Gets and sets the web extension part associated with the taskpane instance

getWebExtension() : WebExtension;

Returns

WebExtension

setWebExtension(WebExtension)

@deprecated. Please use the ‘webExtension’ property instead. Gets and sets the web extension part associated with the taskpane instance

setWebExtension(value: WebExtension) : void;

Parameters:

Parameter	Type	Description
value	WebExtension	The value to set.

getDockState()

@deprecated. Please use the ‘dockState’ property instead. Gets and sets the last-docked location of this taskpane object.

getDockState() : string;

setDockState(string)

@deprecated. Please use the ‘dockState’ property instead. Gets and sets the last-docked location of this taskpane object.

setDockState(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

isVisible()

@deprecated. Please use the ‘isVisible’ property instead. Indicates whether the Task Pane shows as visible by default when the document opens.

isVisible() : boolean;

setIsVisible(boolean)

@deprecated. Please use the ‘isVisible’ property instead. Indicates whether the Task Pane shows as visible by default when the document opens.

setIsVisible(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isLocked()

@deprecated. Please use the ‘isLocked’ property instead. Indicates whether the taskpane is locked to the document in the UI and cannot be closed by the user.

isLocked() : boolean;

setIsLocked(boolean)

@deprecated. Please use the ‘isLocked’ property instead. Indicates whether the taskpane is locked to the document in the UI and cannot be closed by the user.

setIsLocked(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getWidth()

@deprecated. Please use the ‘width’ property instead. Gets and sets the default width value for this taskpane instance.

getWidth() : number;

setWidth(number)

@deprecated. Please use the ‘width’ property instead. Gets and sets the default width value for this taskpane instance.

setWidth(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getRow()

@deprecated. Please use the ‘row’ property instead. Gets and sets the index, enumerating from the outside to the inside, of this taskpane among other persisted taskpanes docked in the same default location.

getRow() : number;

setRow(number)

setRow(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;