OneNote.ParagraphCollection class
Represents a collection of Paragraph objects.
- 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. |
| count | Returns the number of paragraphs in the page. Read-only. |
| items | Gets the loaded child items in this collection. |
Methods
| get |
Gets a Paragraph object by ID or by its index in the collection. Read-only. |
| get |
Gets a paragraph on its position in the collection. |
| 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 |
| 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
count
Returns the number of paragraphs in the page. Read-only.
readonly count: number;Property Value
number
Remarks
items
Gets the loaded child items in this collection.
readonly items: OneNote.Paragraph[];Property Value
Method Details
getItem(index)
Gets a Paragraph object by ID or by its index in the collection. Read-only.
getItem(index: number | string): OneNote.Paragraph;Parameters
- index
-
number | string
The ID of the Paragraph object, or the index location of the Paragraph object in the collection.
Returns
Remarks
getItemAt(index)
Gets a paragraph on its position in the collection.
getItemAt(index: number): OneNote.Paragraph;Parameters
- index
-
number
Index value of the object to be retrieved. Zero-indexed.
Returns
Remarks
Examples
await OneNote.run(async (context) => {
// Get the collection of pageContent items from the page.
const pageContents = context.application.getActivePage().contents;
// Get the first PageContent on the page, and then get its Outline's first paragraph.
const pageContent = pageContents.getItemAt(0);
const paragraphs = pageContent.outline.paragraphs;
const firstParagraph = paragraphs.getItemAt(0);
// Queue a command to load the id and type properties of this paragraph.
firstParagraph.load("id,type");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Write text from paragraph to console.
console.log(
"First Paragraph found with id : " +
firstParagraph.id + " and type " + firstParagraph.type);
});
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.ParagraphCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions): OneNote.ParagraphCollection;Parameters
- options
-
OneNote.Interfaces.ParagraphCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions
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.ParagraphCollection;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
Examples
await OneNote.run(async (context) => {
// Get the collection of pageContent items from the page.
const pageContents = context.application.getActivePage().contents;
// Get the first PageContent on the page, and then get its Outline's first paragraph.
const pageContent = pageContents.getItem(0);
const paragraphs = pageContent.outline.paragraphs;
// Queue a command to load the id and type of each paragraph.
paragraphs.load("id,type");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
const firstParagraph = paragraphs.items[0];
// Write text from first paragraph to console.
console.log(
"First Paragraph found with id : " +
firstParagraph.id + " and type " + firstParagraph.type);
});
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?: OfficeExtension.LoadOption): OneNote.ParagraphCollection;Parameters
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
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.ParagraphCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as OneNote.Interfaces.ParagraphCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
toJSON(): OneNote.Interfaces.ParagraphCollectionData;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.ParagraphCollection;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.ParagraphCollection;Returns
Office Add-ins