OneNote.Paragraph class
Ein Container für den sichtbaren Inhalt auf einer Seite. Ein Absatz kann beliebige ParagraphType-Inhaltstypen enthalten.
- Extends
Hinweise
Eigenschaften
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| id | Ruft die ID des Paragraph-Objekts ab. |
| image | Ruft das Image-Objekt im Absatz ab. Löst eine Ausnahme aus, wenn ParagraphType nicht vom Typ „Image“ ist. |
| ink |
Ruft die Ink-Auflistung im Absatz ab. Löst eine Ausnahme aus, wenn ParagraphType nicht vom Typ „Ink“ ist. |
| outline | Ruft das Outline-Objekt ab, das den Absatz enthält. |
| paragraphs | Die Auflistung von Absätzen unter diesem Absatz. |
| parent |
Ruft das übergeordnete Paragraph-Objekt ab. Löst eine Ausnahme aus, wenn kein übergeordneter Absatz vorhanden ist. |
| parent |
Ruft das übergeordnete Paragraph-Objekt ab. Gibt NULL zurück, wenn kein übergeordneter Absatz vorhanden ist. |
| parent |
Ruft das TableCell-Objekt ab, das das Paragraph-Objekt (falls vorhanden) enthält. Wenn parent keine TableCell ist, löst ItemNotFound aus. |
| parent |
Ruft das TableCell-Objekt ab, das das Paragraph-Objekt (falls vorhanden) enthält. Wenn parent keine TableCell ist, gibt NULL zurück. |
| rich |
Ruft das RichText-Objekt im Absatz ab. Löst eine Ausnahme aus, wenn ParagraphType nicht vom Typ „RichText“ ist. Schreibgeschützt |
| table | Ruft das Table-Objekt im Absatz ab. Löst eine Ausnahme aus, wenn ParagraphType nicht Table ist. |
| type | Ruft den Typ des Paragraph-Objekts ab. |
Methoden
| add |
Fügen Sie dem Absatz NoteTag hinzu. |
| add |
Fügen Sie dem Absatz NoteTag hinzu. |
| delete() | Löscht den Absatz. |
| get |
Abrufen von Listeninformationen des Absatzes |
| insert |
Fügt den angegebenen HTML-Inhalt ein. |
| insert |
Fügt den angegebenen HTML-Inhalt ein. |
| insert |
Fügt das Bild an der angegebenen Einfügeposition ein. |
| insert |
Fügt das Bild an der angegebenen Einfügeposition ein. |
| insert |
Fügt den Text des Absatzes an der angegebenen Einfügeposition ein. |
| insert |
Fügt den Text des Absatzes an der angegebenen Einfügeposition ein. |
| insert |
Fügt eine Tabelle mit der angegebenen Anzahl von Zeilen und Spalten vor oder nach dem aktuellen Absatz hinzu. |
| insert |
Fügt eine Tabelle mit der angegebenen Anzahl von Zeilen und Spalten vor oder nach dem aktuellen Absatz hinzu. |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| set(properties, options) | Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben. |
| set(properties) | Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| toJSON() | Überschreibt die JavaScript-Methode |
| track() | Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über |
| untrack() | Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen |
Details zur Eigenschaft
context
Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
id
Ruft die ID des Paragraph-Objekts ab.
readonly id: string;Eigenschaftswert
string
Hinweise
image
Ruft das Image-Objekt im Absatz ab. Löst eine Ausnahme aus, wenn ParagraphType nicht vom Typ „Image“ ist.
readonly image: OneNote.Image;Eigenschaftswert
Hinweise
inkWords
Ruft die Ink-Auflistung im Absatz ab. Löst eine Ausnahme aus, wenn ParagraphType nicht vom Typ „Ink“ ist.
readonly inkWords: OneNote.InkWordCollection;Eigenschaftswert
Hinweise
outline
Ruft das Outline-Objekt ab, das den Absatz enthält.
readonly outline: OneNote.Outline;Eigenschaftswert
Hinweise
paragraphs
Die Auflistung von Absätzen unter diesem Absatz.
readonly paragraphs: OneNote.ParagraphCollection;Eigenschaftswert
Hinweise
parentParagraph
Ruft das übergeordnete Paragraph-Objekt ab. Löst eine Ausnahme aus, wenn kein übergeordneter Absatz vorhanden ist.
readonly parentParagraph: OneNote.Paragraph;Eigenschaftswert
Hinweise
parentParagraphOrNull
Ruft das übergeordnete Paragraph-Objekt ab. Gibt NULL zurück, wenn kein übergeordneter Absatz vorhanden ist.
readonly parentParagraphOrNull: OneNote.Paragraph;Eigenschaftswert
Hinweise
parentTableCell
Ruft das TableCell-Objekt ab, das das Paragraph-Objekt (falls vorhanden) enthält. Wenn parent keine TableCell ist, löst ItemNotFound aus.
readonly parentTableCell: OneNote.TableCell;Eigenschaftswert
Hinweise
parentTableCellOrNull
Ruft das TableCell-Objekt ab, das das Paragraph-Objekt (falls vorhanden) enthält. Wenn parent keine TableCell ist, gibt NULL zurück.
readonly parentTableCellOrNull: OneNote.TableCell;Eigenschaftswert
Hinweise
richText
Ruft das RichText-Objekt im Absatz ab. Löst eine Ausnahme aus, wenn ParagraphType nicht vom Typ „RichText“ ist. Schreibgeschützt
readonly richText: OneNote.RichText;Eigenschaftswert
Hinweise
table
Ruft das Table-Objekt im Absatz ab. Löst eine Ausnahme aus, wenn ParagraphType nicht Table ist.
readonly table: OneNote.Table;Eigenschaftswert
Hinweise
type
Ruft den Typ des Paragraph-Objekts ab.
readonly type: OneNote.ParagraphType | "RichText" | "Image" | "Table" | "Ink" | "Other";Eigenschaftswert
OneNote.ParagraphType | "RichText" | "Image" | "Table" | "Ink" | "Other"
Hinweise
Details zur Methode
addNoteTag(type, status)
Fügen Sie dem Absatz NoteTag hinzu.
addNoteTag(type: OneNote.NoteTagType, status: OneNote.NoteTagStatus): OneNote.NoteTag;Parameter
- type
- OneNote.NoteTagType
Der Typ des NoteTags.
- status
- OneNote.NoteTagStatus
Die status des NoteTags.
Gibt zurück
Hinweise
addNoteTag(typeString, statusString)
Fügen Sie dem Absatz NoteTag hinzu.
addNoteTag(typeString: "Unknown" | "ToDo" | "Important" | "Question" | "Contact" | "Address" | "PhoneNumber" | "Website" | "Idea" | "Critical" | "ToDoPriority1" | "ToDoPriority2", statusString: "Unknown" | "Normal" | "Completed" | "Disabled" | "OutlookTask" | "TaskNotSyncedYet" | "TaskRemoved"): OneNote.NoteTag;Parameter
- typeString
-
"Unknown" | "ToDo" | "Important" | "Question" | "Contact" | "Address" | "PhoneNumber" | "Website" | "Idea" | "Critical" | "ToDoPriority1" | "ToDoPriority2"
Der Typ des NoteTags.
- statusString
-
"Unknown" | "Normal" | "Completed" | "Disabled" | "OutlookTask" | "TaskNotSyncedYet" | "TaskRemoved"
Die status des NoteTags.
Gibt zurück
Hinweise
delete()
Löscht den Absatz.
delete(): void;Gibt zurück
void
Hinweise
Beispiele
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 assuming its an outline, get the outline's paragraphs.
const pageContent = pageContents.getItemAt(0);
const paragraphs = pageContent.outline.paragraphs;
const firstParagraph = paragraphs.getItemAt(0);
// Queue a command to load the id and type of the first paragraph.
firstParagraph.load("id,type");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Queue a command to delete the first paragraph.
firstParagraph.delete();
// Run the command to delete it.
await context.sync();
});
getParagraphInfo()
Abrufen von Listeninformationen des Absatzes
getParagraphInfo(): OfficeExtension.ClientResult<OneNote.ParagraphInfo>;Gibt zurück
Hinweise
insertHtmlAsSibling(insertLocation, html)
Fügt den angegebenen HTML-Inhalt ein.
insertHtmlAsSibling(insertLocation: OneNote.InsertLocation, html: string): void;Parameter
- insertLocation
- OneNote.InsertLocation
Die Position von neuen Inhalten relativ zum aktuellen Absatz.
- html
-
string
Eine HTML-Zeichenfolge, die die visuelle Darstellung des Inhalts beschreibt. Weitere Informationen finden Sie unter Unterstütztes HTML für die JavaScript-API für OneNote-Add-Ins.
Gibt zurück
void
Hinweise
Beispiele
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.
// Assuming its an outline, get the outline's paragraphs.
const pageContent = pageContents.getItemAt(0);
const paragraphs = pageContent.outline.paragraphs;
const firstParagraph = paragraphs.getItemAt(0);
// Queue a command to load the id and type of the first paragraph.
firstParagraph.load("id,type");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Queue commands to insert before and after the first paragraph.
firstParagraph.insertHtmlAsSibling("Before", "<p>ContentBeforeFirstParagraph</p>");
firstParagraph.insertHtmlAsSibling("After", "<p>ContentAfterFirstParagraph</p>");
// Run the command to run inserts.
await context.sync();
});
insertHtmlAsSibling(insertLocationString, html)
Fügt den angegebenen HTML-Inhalt ein.
insertHtmlAsSibling(insertLocationString: "Before" | "After", html: string): void;Parameter
- insertLocationString
-
"Before" | "After"
Die Position von neuen Inhalten relativ zum aktuellen Absatz.
- html
-
string
Eine HTML-Zeichenfolge, die die visuelle Darstellung des Inhalts beschreibt. Weitere Informationen finden Sie unter Unterstütztes HTML für die JavaScript-API für OneNote-Add-Ins.
Gibt zurück
void
Hinweise
insertImageAsSibling(insertLocation, base64EncodedImage, width, height)
Fügt das Bild an der angegebenen Einfügeposition ein.
insertImageAsSibling(insertLocation: OneNote.InsertLocation, base64EncodedImage: string, width: number, height: number): OneNote.Image;Parameter
- insertLocation
- OneNote.InsertLocation
Die Position der Tabelle relativ zum aktuellen Absatz.
- base64EncodedImage
-
string
HTML-Zeichenfolge, die angefügt werden soll.
- width
-
number
Optional. Breite in der Maßeinheit Punkt. Der Standardwert ist null, und die Bildbreite wird beachtet.
- height
-
number
Optional. Höhe in der Maßeinheit Punkt. Der Standardwert ist null, und die Bildhöhe wird beachtet.
Gibt zurück
Hinweise
Beispiele
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.
// Assuming its an outline, get the outline's paragraphs.
const pageContent = pageContents.getItemAt(0);
const paragraphs = pageContent.outline.paragraphs;
const firstParagraph = paragraphs.getItemAt(0);
// Queue a command to load the id and type of the first paragraph.
firstParagraph.load("id,type");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Queue commands to insert before and after the first paragraph.
firstParagraph.insertImageAsSibling("Before", "R0lGODlhDwAPAKECAAAAzMzM/////wAAACwAAAAADwAPAAACIISPeQHsrZ5ModrLlN48CXF8m2iQ3YmmKqVlRtW4MLwWACH+H09wdGltaXplZCBieSBVbGVhZCBTbWFydFNhdmVyIQAAOw==");
firstParagraph.insertImageAsSibling("After", "R0lGODlhDwAPAKECAAAAzMzM/////wAAACwAAAAADwAPAAACIISPeQHsrZ5ModrLlN48CXF8m2iQ3YmmKqVlRtW4MLwWACH+H09wdGltaXplZCBieSBVbGVhZCBTbWFydFNhdmVyIQAAOw==");
// Run the command to insert images.
await context.sync();
});
insertImageAsSibling(insertLocationString, base64EncodedImage, width, height)
Fügt das Bild an der angegebenen Einfügeposition ein.
insertImageAsSibling(insertLocationString: "Before" | "After", base64EncodedImage: string, width: number, height: number): OneNote.Image;Parameter
- insertLocationString
-
"Before" | "After"
Die Position der Tabelle relativ zum aktuellen Absatz.
- base64EncodedImage
-
string
HTML-Zeichenfolge, die angefügt werden soll.
- width
-
number
Optional. Breite in der Maßeinheit Punkt. Der Standardwert ist null, und die Bildbreite wird beachtet.
- height
-
number
Optional. Höhe in der Maßeinheit Punkt. Der Standardwert ist null, und die Bildhöhe wird beachtet.
Gibt zurück
Hinweise
insertRichTextAsSibling(insertLocation, paragraphText)
Fügt den Text des Absatzes an der angegebenen Einfügeposition ein.
insertRichTextAsSibling(insertLocation: OneNote.InsertLocation, paragraphText: string): OneNote.RichText;Parameter
- insertLocation
- OneNote.InsertLocation
Die Position der Tabelle relativ zum aktuellen Absatz.
- paragraphText
-
string
HTML-Zeichenfolge, die angefügt werden soll.
Gibt zurück
Hinweise
Beispiele
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 assuming its an outline, get the outline's paragraphs.
const pageContent = pageContents.getItemAt(0);
const paragraphs = pageContent.outline.paragraphs;
const firstParagraph = paragraphs.getItemAt(0);
// Queue a command to load the id and type of the first paragraph.
firstParagraph.load("id,type");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Queue commands to insert before and after the first paragraph.
firstParagraph.insertRichTextAsSibling("Before", "Text Appears Before Paragraph");
firstParagraph.insertRichTextAsSibling("After", "Text Appears After Paragraph");
// Run the command to insert text contents.
await context.sync();
});
insertRichTextAsSibling(insertLocationString, paragraphText)
Fügt den Text des Absatzes an der angegebenen Einfügeposition ein.
insertRichTextAsSibling(insertLocationString: "Before" | "After", paragraphText: string): OneNote.RichText;Parameter
- insertLocationString
-
"Before" | "After"
Die Position der Tabelle relativ zum aktuellen Absatz.
- paragraphText
-
string
HTML-Zeichenfolge, die angefügt werden soll.
Gibt zurück
Hinweise
insertTableAsSibling(insertLocation, rowCount, columnCount, values)
Fügt eine Tabelle mit der angegebenen Anzahl von Zeilen und Spalten vor oder nach dem aktuellen Absatz hinzu.
insertTableAsSibling(insertLocation: OneNote.InsertLocation, rowCount: number, columnCount: number, values?: string[][]): OneNote.Table;Parameter
- insertLocation
- OneNote.InsertLocation
Die Position der Tabelle relativ zum aktuellen Absatz.
- rowCount
-
number
Die Anzahl der Zeilen in der Tabelle.
- columnCount
-
number
Die Anzahl der Spalten in der Tabelle.
- values
-
string[][]
Optionales 2D-Array. Wenn die entsprechenden Zeichenfolgen im Array angegeben sind, werden die Zellen gefüllt.
Gibt zurück
Hinweise
insertTableAsSibling(insertLocationString, rowCount, columnCount, values)
Fügt eine Tabelle mit der angegebenen Anzahl von Zeilen und Spalten vor oder nach dem aktuellen Absatz hinzu.
insertTableAsSibling(insertLocationString: "Before" | "After", rowCount: number, columnCount: number, values?: string[][]): OneNote.Table;Parameter
- insertLocationString
-
"Before" | "After"
Die Position der Tabelle relativ zum aktuellen Absatz.
- rowCount
-
number
Die Anzahl der Zeilen in der Tabelle.
- columnCount
-
number
Die Anzahl der Spalten in der Tabelle.
- values
-
string[][]
Optionales 2D-Array. Wenn die entsprechenden Zeichenfolgen im Array angegeben sind, werden die Zellen gefüllt.
Gibt zurück
Hinweise
load(options)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(options?: OneNote.Interfaces.ParagraphLoadOptions): OneNote.Paragraph;Parameter
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
Gibt zurück
load(propertyNames)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames?: string | string[]): OneNote.Paragraph;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
Beispiele
await OneNote.run(async (context) => {
// Get the collection of pageContent items from the page.
const pageContents = context.application.getActivePage().contents;
// Queue a command to load the outline property of each pageContent.
pageContents.load("outline");
// Get the first PageContent on the page, and then get its Outline.
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();
// Write the text.
$.each(paragraphs.items, function(index, paragraph) {
console.log("Paragraph type: " + paragraph.type);
console.log("Paragraph ID: " + paragraph.id);
});
});
load(propertyNamesAndPaths)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): OneNote.Paragraph;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
set(properties, options)
Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties: Interfaces.ParagraphUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- OneNote.Interfaces.ParagraphUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: OneNote.Paragraph): void;Parameter
- properties
- OneNote.Paragraph
Gibt zurück
void
toJSON()
Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche OneNote.Paragraph Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als OneNote.Interfaces.ParagraphData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): OneNote.Interfaces.ParagraphData;Gibt zurück
track()
Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde.
track(): OneNote.Paragraph;Gibt zurück
untrack()
Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): OneNote.Paragraph;Gibt zurück
Office Add-ins