AllPagesHelpers
Helpers for use when reading all pages of the design.
Methods
openPagefunctionReads (and optionally updates) a page of the user's design.
Parameters
pageRefAbsolutePageRefReference to the page to be read.
typestringRead-onlyThe type of page.
The only valid value is "absolute".
lockedbooleanRead-onlyIf true, the page is locked and cannot be modified.
callbackDesignOpenPageCallback<AbsolutePage>A callback for operating on the page of the design.
For more information, see AbsolutePage.
Parameters
responseDesignEditing.OpenPageResult<AbsolutePage>Result received by the openPage callback.
pageDesignEditing.PageThe page of the design.
A page with either fixed or unbounded dimensions.
For more information, see AbsolutePage.
Represents something that's not supported by the Apps SDK.
typestringRead-onlyThe only valid value is "unsupported".
helpersPageHelpersThese are various utilities that allow apps to do more complex operations on the page.
For more information, see PageHelpers.
Returns
Promise<void>
Returns
A response indicating whether the callback was executed. This is a Promise that resolves with the following object:
The response from openPage if the callback was executed.
statusstringThe only valid value is "executed".
The response from openPage if the callback was not executed.
statusstringThe only valid value is "skipped".
reasonstringReason that the callback was not executed.
Parameters
pageRefUnsupportedRepresents something that's not supported by the Apps SDK.
typestringRead-onlyThe only valid value is "unsupported".
callbackDesignOpenPageCallback<Unsupported>A callback for operating on a page of the design.
Parameters
responseDesignEditing.OpenPageResult<Unsupported>Result received by the openPage callback.
pageDesignEditing.PageThe page of the design.
A page with either fixed or unbounded dimensions.
For more information, see AbsolutePage.
Represents something that's not supported by the Apps SDK.
typestringRead-onlyThe only valid value is "unsupported".
helpersPageHelpersThese are various utilities that allow apps to do more complex operations on the page.
For more information, see PageHelpers.
Returns
Promise<void>
Returns
The response from openPage indicating whether the callback was executed. This is a Promise that resolves with the following object:
The response from openPage if the callback was executed.
statusstringThe only valid value is "executed".
The response from openPage if the callback was not executed.
statusstringThe only valid value is "skipped".
reasonstringReason that the callback was not executed.
Parameters
pageRefPageRefA reference to a page.
For more information, see PageRef.
callbackDesignOpenPageCallbackA callback for operating on a page of the design.
Parameters
responseDesignEditing.OpenPageResult<DesignEditing.Page>Result received by the openPage callback.
pageDesignEditing.PageThe page of the design.
A page with either fixed or unbounded dimensions.
For more information, see AbsolutePage.
Represents something that's not supported by the Apps SDK.
typestringRead-onlyThe only valid value is "unsupported".
helpersPageHelpersThese are various utilities that allow apps to do more complex operations on the page.
For more information, see PageHelpers.
Returns
Promise<void>
Returns
The response from openPage indicating whether the callback was executed. This is a Promise that resolves with the following object:
The response from openPage if the callback was executed.
statusstringThe only valid value is "executed".
The response from openPage if the callback was not executed.
statusstringThe only valid value is "skipped".
reasonstringReason that the callback was not executed.