OneNote.PageContent class
Represents a region on a page that contains top-level content types such as Outline or Image. A PageContent object can be assigned an XY position.
- Extends
Remarks
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| id | Gets the ID of the PageContent object. Read-only. |
| image | Gets the Image in the PageContent object. Throws an exception if PageContentType is not Image. |
| ink | Gets the ink in the PageContent object. Throws an exception if PageContentType is not Ink. |
| left | Gets or sets the left (X-axis) position of the PageContent object. |
| outline | Gets the Outline in the PageContent object. Throws an exception if PageContentType is not Outline. |
| parent |
Gets the page that contains the PageContent object. Read-only. |
| top | Gets or sets the top (Y-axis) position of the PageContent object. |
| type | Gets the type of the PageContent object. Read-only. |
Methods
| delete() | Deletes the PageContent object. |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| set(properties, options) | Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. |
| set(properties) | Sets multiple properties on the object at the same time, based on an existing loaded object. |
| toJSON() | Overrides the JavaScript |
| track() | Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for |
| untrack() | Release the memory associated with this object, if it has previously been tracked. This call is shorthand for |
Property Details
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
id
Gets the ID of the PageContent object. Read-only.
readonly id: string;Property Value
string
Remarks
image
Gets the Image in the PageContent object. Throws an exception if PageContentType is not Image.
readonly image: OneNote.Image;Property Value
Remarks
ink
Gets the ink in the PageContent object. Throws an exception if PageContentType is not Ink.
readonly ink: OneNote.FloatingInk;Property Value
Remarks
left
Gets or sets the left (X-axis) position of the PageContent object.
left: number;Property Value
number
Remarks
outline
Gets the Outline in the PageContent object. Throws an exception if PageContentType is not Outline.
readonly outline: OneNote.Outline;Property Value
Remarks
parentPage
Gets the page that contains the PageContent object. Read-only.
readonly parentPage: OneNote.Page;Property Value
Remarks
top
Gets or sets the top (Y-axis) position of the PageContent object.
top: number;Property Value
number
Remarks
type
Gets the type of the PageContent object. Read-only.
readonly type: OneNote.PageContentType | "Outline" | "Image" | "Ink" | "Other";Property Value
OneNote.PageContentType | "Outline" | "Image" | "Ink" | "Other"
Remarks
Method Details
delete()
Deletes the PageContent object.
delete(): void;Returns
void
Remarks
Examples
await OneNote.run(async (context) => {
const page = context.application.getActivePage();
const pageContents = page.contents;
const firstPageContent = pageContents.getItemAt(0);
firstPageContent.load('type');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
if (firstPageContent.isNullObject === false) {
firstPageContent.delete();
await context.sync();
}
});
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: OneNote.Interfaces.PageContentLoadOptions): OneNote.PageContent;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): OneNote.PageContent;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): OneNote.PageContent;Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
set(properties, options)
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties: Interfaces.PageContentUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameters
- properties
- OneNote.Interfaces.PageContentUpdateData
A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
- options
- OfficeExtension.UpdateOptions
Provides an option to suppress errors if the properties object tries to set any read-only properties.
Returns
void
set(properties)
Sets multiple properties on the object at the same time, based on an existing loaded object.
set(properties: OneNote.PageContent): void;Parameters
- properties
- OneNote.PageContent
Returns
void
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original OneNote.PageContent object is an API object, the toJSON method returns a plain JavaScript object (typed as OneNote.Interfaces.PageContentData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): OneNote.Interfaces.PageContentData;Returns
track()
Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
track(): OneNote.PageContent;Returns
untrack()
Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call context.sync() before the memory release takes effect.
untrack(): OneNote.PageContent;Returns
Office Add-ins