WebExtensionTaskPane
WebExtensionTaskPane class
Represents a persisted taskpane object.
class WebExtensionTaskPane;
Methods
| Method | Description |
|---|---|
| getWebExtension() | Gets and sets the web extension part associated with the taskpane instance |
| setWebExtension(WebExtension) | Gets and sets the web extension part associated with the taskpane instance |
| getDockState() | Gets and sets the last-docked location of this taskpane object. |
| setDockState(string) | Gets and sets the last-docked location of this taskpane object. |
| isVisible() | Indicates whether the Task Pane shows as visible by default when the document opens. |
| setIsVisible(boolean) | Indicates whether the Task Pane shows as visible by default when the document opens. |
| isLocked() | Indicates whether the taskpane is locked to the document in the UI and cannot be closed by the user. |
| setIsLocked(boolean) | Indicates whether the taskpane is locked to the document in the UI and cannot be closed by the user. |
| getWidth() | Gets and sets the default width value for this taskpane instance. |
| setWidth(number) | Gets and sets the default width value for this taskpane instance. |
| getRow() | 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) | 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. |
getWebExtension()
Gets and sets the web extension part associated with the taskpane instance
getWebExtension() : WebExtension;
Returns
setWebExtension(WebExtension)
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()
Gets and sets the last-docked location of this taskpane object.
getDockState() : string;
setDockState(string)
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()
Indicates whether the Task Pane shows as visible by default when the document opens.
isVisible() : boolean;
setIsVisible(boolean)
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()
Indicates whether the taskpane is locked to the document in the UI and cannot be closed by the user.
isLocked() : boolean;
setIsLocked(boolean)
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()
Gets and sets the default width value for this taskpane instance.
getWidth() : number;
setWidth(number)
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()
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)
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(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;