OfficeExtension
ClientObject
An abstract object representing the active Office document
context | the request context associated with the object. | |
isNullObject | you must call context.sync before checking this property. |
ClientRequestContext
An abstract object that facilitates requests to the host Office application.
The Excel.run method provides a request context.
debugInfo | P | |
requestHeaders | P | |
trackedObjects | P | |
load | M | |
loadRecursive | M | |
sync | M | |
trace | M |
ClientResult
Contains the result for methods that return primitive types.
The objects value property is retrieved from the document after context.sync is involved.
value | P |
DebugInfo
Provides useful information about an error.
code | P | (string) |
errorLocation | P | (string) |
fullStatements | P | (string[]) |
innerError | P | |
message | P | (string) |
statements | P | (string) |
surroundingStatements | P | (string) |
EmbeddedOptions
An interface with these properties
container | P | (HTMLElement) |
height | P | (string) |
id | P | (string) |
sessionKey | P | (string) |
timeoutInMilliseconds | P | (string) |
width | P | (string) |
EmbeddedSession
An abstract class
init | M | (HTMLElement) |
Error
The error object that is returned by "context.sync()" when a promise is rejected while processing the request.
code | P | (string) short name of the error |
debugInfo | P | (OfficeExtension.DebugInfo) more useful information |
innerError | P | (Error) inner message, if applicable |
message | P | (string) description of the error |
name | P | (string) always OfficeExtension.Error |
stack | P | (string) stack trace, if applicable |
traceMessage | P | (string[]) trace messages added via context.trace() |
ErrorCodes
An abstract class
accessDenied | P | (string) |
activityLimitReached | P | (string) |
apiNotFound | P | (string) |
cannotRegisterEvent | P | (string) |
connectionFailure | P | (string) |
generalException | P | (string) |
invalidArgument | P | (string) |
invalidObjectPath | P | (string) |
invalidRequestContext | P | (string) |
propertyNotLoaded | P | (string) |
runMustReturnPromise | P | (string) |
valueNotLoaded | P | (string) |
EventHandlerResult
??
context | P | |
remove | M |
EventHandlers
??
add | M | |
remove | M |
EventInfo
An interface with these properties
eventArgsTransformFunc | P | |
registerFunc | P | |
unregisterFunc | P |
LoadOption
Specifies which properties of an object should be loaded.
This load happens when the sync method is executed.
context.load(paragraphs, 'text,font/size');
paragraphs.load('text,font/size');
paragraphs.load( { select: 'text,font/size' , expand:'font' , top:50 , skip:50 });
expand | P |
select | P |
skip | P |
top | P |
Promise
Available in ExcelApi 1.2 or WordApi 1.2 or higher.. The examples below will use OfficeExtension.Promise, as it's the
easiest way to get started.
You can use OfficeExtension.Promise in place of the global Promise object. because Office.js includes its own Promise poly-filla.
(page 74)
RequestContextDebugInfo
Contains debug information about the request context
pendingStatements | P |
RequestUrlAndHeaderInfo
An interface to specify the request URL and headers.
headers | P | |
url | P |
RunOptions
Additional options that can be passed to the HOST.run() method.
previousObjects | P | |
session | P |
TrackedObjects
Collection of tracked objects contained within a request.
add | M | |
remove | M |
UpdateOptions
Provides an option for supressing an error when the object that is used to set multiple properties tries to set read-only properties.
throwOnReadOnly | P |
© 2023 Better Solutions Limited. All Rights Reserved. © 2023 Better Solutions Limited TopPrevNext